pqInteractivePropertyWidget is an abstract pqPropertyWidget subclass designed to serve as the superclass for all pqPropertyWidget types that have interactive widget (also called 3D Widgets) associated with them. More...

#include <pqInteractivePropertyWidget.h>

Inheritance diagram for pqInteractivePropertyWidget:

[legend]

Collaboration diagram for pqInteractivePropertyWidget:

[legend]

Public Slots
void	setWidgetVisible (bool val)
	Toggle the interactive widget's visibility. More...

void	setDataSource (vtkSMProxy *dataSource)
	DataSource is used by interactive widgets to determine now to place the widget in the view e.g. More...

Public Slots inherited from pqPropertyWidget

Signals
void	widgetVisibilityToggled (bool)
	Fired whenever setWidgetVisible() changes the widget's visibility. More...

void	widgetVisibilityUpdated (bool)
	Fired whenever the widgets visibility is updated for whatever reason, be it because the panel was selected/deselected or the view changed, etc. More...

void	startInteraction ()
	Signals fired when the interactive widget proxy fires the corresponding events. More...

void	interaction ()

void	endInteraction ()

void	dummySignal ()

Signals inherited from pqPropertyWidget
void	viewChanged (pqView *view)
	This signal is emitted when the current view changes. More...

void	changeAvailable ()
	This signal is fired as soon as the user starts editing in the widget. More...

void	changeFinished ()
	This signal is fired as soon as the user is done with making an atomic change. More...

void	restartRequired ()
	Indicates that a restart of the program is required for the setting to take effect. More...

Public Member Functions
	pqInteractivePropertyWidget (const char widget_smgroup, const char widget_smname, vtkSMProxy proxy, vtkSMPropertyGroup smgroup, QWidget *parent=0)

	~pqInteractivePropertyWidget () override

void	reset () override
	Overridden to call this->render() to ensure that the widget is redrawn. More...

vtkSMNewWidgetRepresentationProxy *	widgetProxy () const
	Returns the proxy for the interactive widget. More...

void	setView (pqView *view) override
	Overridden to show the widget proxy in the new view. More...

bool	isWidgetVisible () const
	Returns the interactive widget's visibility. More...

vtkSMProxy *	dataSource () const
	Returns the data source. More...

void	select () override
	In these methods, we show/hide the widget since the interactive widget is not supposed to be visible except when the panel is "active" or "selected". More...

void	deselect () override

vtkBoundingBox	dataBounds () const
	Returns bounds from the dataSource, if possible. More...

vtkSMPropertyGroup *	propertyGroup () const
	Returns the vtkSMPropertyGroup pass to the constructor. More...

void	hideEvent (QHideEvent *) override
	Overriden in order to hide the VTK widget. More...

void	showEvent (QShowEvent *) override
	Overriden in order to show the VTK widget. More...

Public Member Functions inherited from pqPropertyWidget
	pqPropertyWidget (vtkSMProxy proxy, QWidget parent=0)

	~pqPropertyWidget () override

virtual void	apply ()

bool	isSelected () const

virtual void	updateWidget (bool showing_advanced_properties)

pqView *	view () const

vtkSMProxy *	proxy () const

vtkSMProperty *	property () const

virtual char *	panelVisibility () const
	Forward calls to vtkSMProperty. More...

virtual void	setPanelVisibility (const char *vis)

virtual bool	isSingleRowItem () const
	Determines if the PropertyWidget must be constructed using a single row. More...

bool	showLabel () const

const QList< QPointer< pqPropertyWidgetDecorator > > &	decorators () const
	Provides access to the decorators for this widget. More...

void	setProperty (vtkSMProperty *property)

Protected Slots
virtual void	placeWidget ()=0
	Places the interactive widget using current data source information. More...

void	render ()
	Safe call render on the view. More...

Protected Attributes
bool	VisibleState = true

Properties
pqSMProxy	dataSource

Additional Inherited Members
Static Public Member Functions inherited from pqPropertyWidget
template<class T >
static QString	getXMLName (T *object)
	Description: This static utility method returns the XML name for an object as a QString. More...

static QString	getTooltip (vtkSMProperty *property)
	Returns the tooltip to use for the property. More...

static int	hintsWidgetHeightNumberOfRows (vtkPVXMLElement *hints, int defaultValue=10)
	Helper method to return value from WidgetHeight XML hint, if any. More...

Protected Member Functions inherited from pqPropertyWidget
void	addPropertyLink (QObject qobject, const char qproperty, const char qsignal, vtkSMProperty smproperty, int smindex=-1)

void	addPropertyLink (QObject qobject, const char qproperty, const char qsignal, vtkSMProxy smproxy, vtkSMProperty *smproperty, int smindex=-1)

void	removePropertyLink (QObject qobject, const char qproperty, const char qsignal, vtkSMProperty smproperty, int smindex=-1)

void	removePropertyLink (QObject qobject, const char qproperty, const char qsignal, vtkSMProxy smproxy, vtkSMProperty *smproperty, int smindex=-1)

void	setShowLabel (bool show)

void	setChangeAvailableAsChangeFinished (bool status)
	For most pqPropertyWidget subclasses a changeAvailable() signal, corresponds to a changeFinished() signal. More...

void	addDecorator (pqPropertyWidgetDecorator *)
	Register a decorator. More...

void	removeDecorator (pqPropertyWidgetDecorator *)
	Unregisters a decorator. More...

pqPropertyLinks &	links ()
	Provides access to the pqPropertyLinks instance. More...

Detailed Description

pqInteractivePropertyWidget is an abstract pqPropertyWidget subclass designed to serve as the superclass for all pqPropertyWidget types that have interactive widget (also called 3D Widgets) associated with them.

pqInteractivePropertyWidget is intended to provide a Qt widget (along with an interactive widget in the active view) for controlling properties on the proxy identified by a vtkSMPropertyGroup passed to the constructor. Subclasses are free to determine which interactive widget to create and how to setup the UI for it.

Definition at line 56 of file pqInteractivePropertyWidget.h.

Constructor & Destructor Documentation

◆ pqInteractivePropertyWidget()

pqInteractivePropertyWidget::pqInteractivePropertyWidget	(	const char *	widget_smgroup,
		const char *	widget_smname,
		vtkSMProxy *	proxy,
		vtkSMPropertyGroup *	smgroup,
		QWidget *	parent = `0`
	)

◆ ~pqInteractivePropertyWidget()

pqInteractivePropertyWidget::~pqInteractivePropertyWidget ( )

override

Member Function Documentation

◆ reset()

void pqInteractivePropertyWidget::reset ( )

overridevirtual

Overridden to call this->render() to ensure that the widget is redrawn.

Reimplemented from pqPropertyWidget.

◆ widgetProxy()

vtkSMNewWidgetRepresentationProxy* pqInteractivePropertyWidget::widgetProxy ( ) const

Returns the proxy for the interactive widget.

◆ setView()

void pqInteractivePropertyWidget::setView ( pqView * view )

overridevirtual

Overridden to show the widget proxy in the new view.

Reimplemented from pqPropertyWidget.

◆ isWidgetVisible()

bool pqInteractivePropertyWidget::isWidgetVisible ( ) const

Returns the interactive widget's visibility.

Note that the widget may still not be visible in the view if the pqPropertyWidget is not selected. An interactive widget may be visible in the view when this->isWidgetVisible() and this->isSelected() both return true and the view is of the right type.

◆ dataSource()

vtkSMProxy* pqInteractivePropertyWidget::dataSource ( ) const

Returns the data source.

◆ select()

void pqInteractivePropertyWidget::select ( )

overridevirtual

In these methods, we show/hide the widget since the interactive widget is not supposed to be visible except when the panel is "active" or "selected".

Reimplemented from pqPropertyWidget.

◆ deselect()

void pqInteractivePropertyWidget::deselect ( )

overridevirtual

Reimplemented from pqPropertyWidget.

◆ dataBounds()

vtkBoundingBox pqInteractivePropertyWidget::dataBounds ( ) const

Returns bounds from the dataSource, if possible.

May return invalid bounds when no dataSource exists of hasn't been updated to produce valid data.

◆ propertyGroup()

vtkSMPropertyGroup* pqInteractivePropertyWidget::propertyGroup ( ) const

Returns the vtkSMPropertyGroup pass to the constructor.

◆ hideEvent()

void pqInteractivePropertyWidget::hideEvent ( QHideEvent * )

override

Overriden in order to hide the VTK widget.

◆ showEvent()

void pqInteractivePropertyWidget::showEvent ( QShowEvent * )

override

Overriden in order to show the VTK widget.

◆ setWidgetVisible

void pqInteractivePropertyWidget::setWidgetVisible ( bool val )

slot

Toggle the interactive widget's visibility.

This, along with pqPropertyWidget's selected state controls whether the widget proxy is visible in a view.

◆ setDataSource

void pqInteractivePropertyWidget::setDataSource ( vtkSMProxy * dataSource )

slot

DataSource is used by interactive widgets to determine now to place the widget in the view e.g.

the bounds to use for placing the widget or when re-centering the interactive widget.

◆ placeWidget

virtual void pqInteractivePropertyWidget::placeWidget ( )

protectedpure virtualslot

Places the interactive widget using current data source information.

◆ render

void pqInteractivePropertyWidget::render ( )

protectedslot

Safe call render on the view.

◆ widgetVisibilityToggled

void pqInteractivePropertyWidget::widgetVisibilityToggled ( bool )

signal

Fired whenever setWidgetVisible() changes the widget's visibility.

◆ widgetVisibilityUpdated

void pqInteractivePropertyWidget::widgetVisibilityUpdated ( bool )

signal

Fired whenever the widgets visibility is updated for whatever reason, be it because the panel was selected/deselected or the view changed, etc.

◆ startInteraction

void pqInteractivePropertyWidget::startInteraction ( )

signal

Signals fired when the interactive widget proxy fires the corresponding events.

◆ interaction

void pqInteractivePropertyWidget::interaction ( )

signal

◆ endInteraction

void pqInteractivePropertyWidget::endInteraction ( )

signal

◆ dummySignal

void pqInteractivePropertyWidget::dummySignal ( )

signal

Member Data Documentation

◆ VisibleState

bool pqInteractivePropertyWidget::VisibleState = true

protected

Definition at line 181 of file pqInteractivePropertyWidget.h.

Property Documentation

◆ dataSource

pqSMProxy pqInteractivePropertyWidget::dataSource

readwrite

Definition at line 60 of file pqInteractivePropertyWidget.h.

The documentation for this class was generated from the following file:

/builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents/pqInteractivePropertyWidget.h

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pqInteractivePropertyWidget()

◆ ~pqInteractivePropertyWidget()

Member Function Documentation

◆ reset()

◆ widgetProxy()

◆ setView()

◆ isWidgetVisible()

◆ dataSource()

◆ select()

◆ deselect()

◆ dataBounds()

◆ propertyGroup()

◆ hideEvent()

◆ showEvent()

◆ setWidgetVisible

◆ setDataSource

◆ placeWidget

◆ render

◆ widgetVisibilityToggled

◆ widgetVisibilityUpdated

◆ startInteraction

◆ interaction

◆ endInteraction

◆ dummySignal

Member Data Documentation

◆ VisibleState

Property Documentation

◆ dataSource