/*=========================================================================

  Program:   ParaView
  Module:    vtkSMComparativeViewProxy.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
/**
 * @class   vtkSMComparativeViewProxy
 * @brief   view for comparative visualization/
 * film-strips.
 *
 * vtkSMComparativeViewProxy is the view used to generate/view comparative
 * visualizations/film-strips. vtkSMComparativeViewProxy works together with
 * vtkPVComparativeView -- the vtk-object for which this represents the proxy.
 * vtkPVComparativeView is a client-side VTK object which literally uses the
 * view and representation proxies to simulate the comparative view. Refer to
 * vtkPVComparativeView for details.
*/

#ifndef vtkSMComparativeViewProxy_h
#define vtkSMComparativeViewProxy_h

#include "vtkPVServerManagerRenderingModule.h" //needed for exports
#include "vtkSMViewProxy.h"

class vtkCollection;

class VTKPVSERVERMANAGERRENDERING_EXPORT vtkSMComparativeViewProxy : public vtkSMViewProxy
{
public:
  static vtkSMComparativeViewProxy* New();
  vtkTypeMacro(vtkSMComparativeViewProxy, vtkSMViewProxy);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  /**
   * Updates the data pipelines for all visible representations.
   */
  virtual void Update() VTK_OVERRIDE;

  /**
   * Get all the internal views. The views should only be used to be layed out
   * by the GUI. It's not recommended to directly change the properties of the
   * views.
   */
  void GetViews(vtkCollection* collection);

  //@{
  /**
   * Get all internal vtkSMRepresentations for a given view.  If the given
   * view is not managed by this comparative view it will be ignored.  The
   * representations should only be used by the GUI for creating representation
   * clones.  It is not recommended to directly change the properties of the returned
   * representations.
   */
  void GetRepresentationsForView(vtkSMViewProxy*, vtkCollection*);
  void GetRepresentations(int x, int y, vtkCollection*);
  //@}

  /**
   * Returns the root view proxy.
   */
  vtkSMViewProxy* GetRootView();

  /**
   * Dirty means this algorithm will execute during next update.
   * This all marks all consumers as dirty.
   */
  virtual void MarkDirty(vtkSMProxy* modifiedProxy) VTK_OVERRIDE;

  /**
   * Overridden to forward the call to the internal root view proxy.
   */
  virtual const char* GetRepresentationType(
    vtkSMSourceProxy* producer, int outputPort) VTK_OVERRIDE;

  /**
   * Returns the render-window used by the root view, if any.
   */
  virtual vtkRenderWindow* GetRenderWindow() VTK_OVERRIDE
  {
    return this->GetRootView() ? this->GetRootView()->GetRenderWindow() : NULL;
  }
  virtual vtkRenderWindowInteractor* GetInteractor() VTK_OVERRIDE
  {
    return this->GetRootView() ? this->GetRootView()->GetInteractor() : NULL;
  }

  /**
   * To avoid misuse of this method for comparative views, this method will
   * raise an error. Client code should set up interactor for each of the
   * internal views explicitly.
   */
  virtual void SetupInteractor(vtkRenderWindowInteractor* iren) VTK_OVERRIDE;

  /**
   * Overridden to call MakeRenderWindowInteractor() on each of the internal
   * views.
   */
  virtual bool MakeRenderWindowInteractor(bool quiet = false) VTK_OVERRIDE;

protected:
  vtkSMComparativeViewProxy();
  ~vtkSMComparativeViewProxy();

  /**
   * Overridden to do the capturing of images from each of the internal views
   * and then stitching them together.
   */
  virtual vtkImageData* CaptureWindowInternal(int magnification) VTK_OVERRIDE;

  void InvokeConfigureEvent();

  virtual void CreateVTKObjects() VTK_OVERRIDE;

private:
  vtkSMComparativeViewProxy(const vtkSMComparativeViewProxy&) VTK_DELETE_FUNCTION;
  void operator=(const vtkSMComparativeViewProxy&) VTK_DELETE_FUNCTION;
};

#endif
