pqView.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#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: // NOLINT(readability-redundant-access-specifiers)
  virtual void render();

  virtual void forceRender();

  void cancelPendingRenders();

  virtual void undo() {}

  virtual void redo() {}

  virtual void resetDisplay(bool closest = false) { (void)closest; }

public: // NOLINT(readability-redundant-access-specifiers)
  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;

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 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 = nullptr);

  void initialize() override;

  virtual QWidget* createWidget() = 0;

private:
  Q_DISABLE_COPY(pqView)

  pqViewInternal* Internal;
  QString ViewType;
};

#endif