Creates a panel_widget for setting dynamically generated properties. More...

#include <pqDynamicPropertiesWidget.h>

Inheritance diagram for pqDynamicPropertiesWidget:

Collaboration diagram for pqDynamicPropertiesWidget:

Public Slots
void	setHeaderLabel (const QString &str)

void	setPushPropertyName (const QByteArray &pName)

Public Slots inherited from pqPropertyWidget
virtual void	setView (pqView *)
	called to set the active view. More...

Signals
void	widgetModified ()

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
	pqDynamicPropertiesWidget (vtkSMProxy proxy, vtkSMProperty property, QWidget *parent=nullptr)

	~pqDynamicPropertiesWidget () override

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

	~pqPropertyWidget () override

virtual void	apply ()

virtual void	reset ()

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...

virtual void	setReadOnly (bool readOnly)
	Set widget in read-only mode. More...

void	setProperty (vtkSMProperty *property)

virtual void	select ()
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

virtual void	selectPort (int portIndex)
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

virtual void	deselect ()
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

bool	isSelected () const
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

Protected Slots
void	updateProperty ()
	Start a timer that calls updatePropertyImpl. More...

void	updatePropertyImpl ()
	Update the Qt property with current widget state. More...

Protected Member Functions
bool	eventFilter (QObject obj, QEvent e) override

void	propertyChanged ()
	Update the widget state from the PropertyLink Qt property. 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...

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...

static std::vector< std::string >	parseComponentLabels (vtkPVXMLElement *hints, unsigned int elemCount=0)
	Parse a XML element as a list of label to use for this widget. More...

Detailed Description

Creates a panel_widget for setting dynamically generated properties.

The properties are specified using a JSON file. The JSON contains a version and an array of parameters, and possible additional key: value parameters which are ignored. each parameter has a name, type, description, default, min, max the type is an int given vtkDynamicProperties::Type (such as vtkDynamicProperties::Type) default, min and max have the specified type. Example: { "library": "environment" "renderer": "ao", "version": "1.0" "parameters": [ { "name" : "sampleLimit", "type" : <vtkDynamicProperties::Type> "default" : 128, "value": 0, "description" : "stop refining the frame after this number of samples", "max" : 100, "min" : 0, }, ... ] } The key names and types are defined in vtkDynamicProperties class.

See also: vtkDynamicProperties The "library" and "renderer" key,values are for debugging and are ignored by the dynamic properties panel.

See:

vtkPVRenderView::GetANARIRendererParameters for the JSON description of properties associated with an ANARI renderer
vtkDynamicProperties for the keys and types that can be used in the JSON file.
ANARIRenderParameter XML property definiton for the RenderViewProxy in view_removingviews.xml
pqIndexSelectionWidget for a similar dynamic widget that works only for int properties.

Definition at line 66 of file pqDynamicPropertiesWidget.h.

Constructor & Destructor Documentation

◆ pqDynamicPropertiesWidget()

pqDynamicPropertiesWidget::pqDynamicPropertiesWidget	(	vtkSMProxy *	proxy,
		vtkSMProperty *	property,
		QWidget *	parent = `nullptr`
	)

◆ ~pqDynamicPropertiesWidget()

pqDynamicPropertiesWidget::~pqDynamicPropertiesWidget ( )

override

Member Function Documentation

◆ setHeaderLabel

void pqDynamicPropertiesWidget::setHeaderLabel ( const QString & str )

slot

◆ setPushPropertyName

void pqDynamicPropertiesWidget::setPushPropertyName ( const QByteArray & pName )

slot

◆ widgetModified

void pqDynamicPropertiesWidget::widgetModified ( )

signal

◆ updateProperty

void pqDynamicPropertiesWidget::updateProperty ( )

protectedslot

Start a timer that calls updatePropertyImpl.

This slot is triggered when a widget is modified.

◆ updatePropertyImpl

void pqDynamicPropertiesWidget::updatePropertyImpl ( )

protectedslot

Update the Qt property with current widget state.

Emits widgetModified.

◆ eventFilter()

bool pqDynamicPropertiesWidget::eventFilter	(	QObject *	obj,
		QEvent *	e
	)

overrideprotected

◆ propertyChanged()

void pqDynamicPropertiesWidget::propertyChanged ( )

protected

Update the widget state from the PropertyLink Qt property.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Components/pqDynamicPropertiesWidget.h

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members