pqInteractivePropertyWidgetAbstract.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 pqInteractivePropertyWidgetAbstract_h
#define pqInteractivePropertyWidgetAbstract_h

#include "pqApplicationComponentsModule.h"
#include "pqPropertyWidget.h"
#include "pqSMProxy.h"
#include "vtkBoundingBox.h"
#include <QScopedPointer>

class pqServer;
class vtkObject;
class vtkSMNewWidgetRepresentationProxy;
class vtkSMPropertyGroup;
class vtkSMNewWidgetRepresentationProxyAbstract;

class PQAPPLICATIONCOMPONENTS_EXPORT pqInteractivePropertyWidgetAbstract : public pqPropertyWidget
{
  Q_OBJECT
  typedef pqPropertyWidget Superclass;
  Q_PROPERTY(pqSMProxy dataSource READ dataSource WRITE setDataSource);

public:
  pqInteractivePropertyWidgetAbstract(const char* widget_smgroup, const char* widget_smname,
    vtkSMProxy* proxy, vtkSMPropertyGroup* smgroup, QWidget* parent = nullptr);
  ~pqInteractivePropertyWidgetAbstract() override;

  void reset() override;

  void setView(pqView* view) override;

  bool isWidgetVisible() const;

  vtkSMProxy* dataSource() const;


  void select() override;
  void deselect() override;
  void selectPort(int portIndex) final;

  vtkBoundingBox dataBounds(bool visibleOnly = false) const;

  vtkSMPropertyGroup* propertyGroup() const;

  void hideEvent(QHideEvent*) override;

  void showEvent(QShowEvent*) override;

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  virtual void setWidgetVisible(bool val);

  void setDataSource(vtkSMProxy* dataSource);

protected Q_SLOTS:
  virtual void placeWidget() = 0;

  void render();

  virtual void updateWidgetVisibility();

Q_SIGNALS:
  void widgetVisibilityToggled(bool);

  void widgetVisibilityUpdated(bool);


  void startInteraction();
  void interaction();
  void endInteraction();

protected:
  virtual vtkSMNewWidgetRepresentationProxyAbstract* internalWidgetProxy() = 0;

  void setupConnections(vtkSMNewWidgetRepresentationProxyAbstract* widget,
    vtkSMPropertyGroup* smgroup, vtkSMProxy* smproxy);

  void setupUserObserver(vtkSMProxy* smproxy);

  bool VisibleState = true;
  bool WidgetVisibility = false;
  int LinkedPortIndex = -1;

private:
  Q_DISABLE_COPY(pqInteractivePropertyWidgetAbstract)

  void handleUserEvent(vtkObject*, unsigned long, void*);

  struct pqInternals;
  QScopedPointer<pqInternals> Internals;
};

#endif