pqView.h

Go to the documentation of this file.

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

   Program: ParaView
   Module:    pqView.h

   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/
#ifndef pqView_h
#define pqView_h

#include "pqProxy.h"
#include <QSize> // needed for QSize.

class pqOutputPort;
class pqPipelineSource;
class pqRepresentation;
class pqServer;
class pqUndoStack;
class pqViewInternal;
class QWidget;
class vtkSMSourceProxy;
class vtkSMViewProxy;
class vtkView;

class PQCORE_EXPORT pqView : public pqProxy
{
  Q_OBJECT
  typedef pqProxy Superclass;

public:
  enum SelectionModifier
  {
    PV_SELECTION_DEFAULT = 0,
    PV_SELECTION_ADDITION,
    PV_SELECTION_SUBTRACTION,
    PV_SELECTION_TOGGLE
  };

  ~pqView() override;

  vtkSMViewProxy* getViewProxy() const;

  virtual vtkView* getClientSideView() const;

  QWidget* widget();

  virtual bool supportsUndo() const { return false; }

  virtual bool supportsCapture() const { return false; }

  QString getViewType() const { return this->ViewType; }

public Q_SLOTS:
  virtual void render();

  virtual void forceRender();

  void cancelPendingRenders();

  virtual void undo() {}

  virtual void redo() {}

  virtual void resetDisplay() {}

public:
  virtual bool canUndo() const { return false; }

  virtual bool canRedo() const { return false; }

  virtual QSize getSize();

  bool hasRepresentation(pqRepresentation* repr) const;

  int getNumberOfRepresentations() const;

  // Returns the number of representations currently visible in the view.
  int getNumberOfVisibleRepresentations() const;
  int getNumberOfVisibleDataRepresentations() const;

  pqRepresentation* getRepresentation(int index) const;

  QList<pqRepresentation*> getRepresentations() const;

  bool canDisplay(pqOutputPort* opPort) const;

  virtual void emitSelectionSignals(bool frustum);

Q_SIGNALS:
  void updateDataEvent();

  void representationAdded(pqRepresentation*);

  void representationRemoved(pqRepresentation*);

  void beginRender();

  void endRender();

  void representationVisibilityChanged(pqRepresentation* repr, bool visible);

  void canUndoChanged(bool);

  void canRedoChanged(bool);

  void selected(pqOutputPort* opport);

  void selectionModeChanged(bool frustum);

  void picked(pqOutputPort* opport);

  void beginProgress();

  void endProgress();

  void progress(const QString& message, int percent_progress);

  void multipleSelected(QList<pqOutputPort*> opports);

private Q_SLOTS:
  void onRepresentationsChanged();

  void onRepresentationVisibilityChanged(bool);

  void representationCreated(pqRepresentation* repr);

  void tryRender();

  void onBeginRender();
  void onEndRender();

protected:
  pqView(const QString& type, const QString& group, const QString& name, vtkSMViewProxy* view,
    pqServer* server, QObject* parent = NULL);

  void initialize() override;

  virtual QWidget* createWidget() = 0;

private:
  Q_DISABLE_COPY(pqView)

  pqViewInternal* Internal;
  QString ViewType;
};

#endif