superclass for all SM properties More...

#include <vtkSMProperty.h>

Inheritance diagram for vtkSMProperty:

[legend]

Collaboration diagram for vtkSMProperty:

[legend]

Public Types
typedef vtkSMObject	Superclass

Public Types inherited from vtkSMObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

int	IsInDomains ()
	Returns true if all values are in all domains, false otherwise. More...

int	IsInDomains (vtkSMDomain **domain)
	Overload of IsInDomains() that provides a mechanism to return the first domain that fails the check. More...

void	UnRegister (vtkObjectBase *obj) override
	Overloaded to break the reference loop caused by the internal domain iterator. More...

vtkSMDomainIterator *	NewDomainIterator ()
	Creates, initializes and returns a new domain iterator. More...

vtkSMDomain *	GetDomain (const char *name)
	Returns a domain give a name. More...

vtkSMDomain *	FindDomain (const char *classname)
	Returns the first domain which is of the specified type. More...

template<class DomainType >
DomainType *	FindDomain ()
	Same as FindDomain(classname), except the classname is deduced from the type. More...

unsigned int	GetNumberOfDomains ()
	Returns the number of domains this property has. More...

void	AddDomain (const char name, vtkSMDomain dom)
	Properties can have one or more domains. More...

virtual void	AddLinkedProperty (vtkSMProperty *targetProperty)
	Add a link to a property whose value should be synchronized with this property value. More...

virtual void	RemoveLinkedProperty (vtkSMProperty *targetProperty)
	Remove a link to a property added with AddLinkedProperty() More...

virtual void	RemoveFromSourceLink ()
	Remove a link from the source property. More...

virtual void	Copy (vtkSMProperty *src)
	Copy all property values. More...

void	ResetToDefault ()
	Simply calls this->ResetToDomainDefaults() and if that returns false, calls this->ResetToXMLDefaults(). More...

virtual void	ResetToXMLDefaults ()
	For properties that support specifying defaults in XML configuration, this method will reset the property value to the default values specified in the XML. More...

virtual bool	ResetToDomainDefaults (bool use_unchecked_values=false)
	Iterates over all domains and call SetDefaultValues() on each domain until the first one returns true i.e. More...

vtkSMProxy *	GetParent ()
	Get the proxy to which this property belongs. More...

virtual bool	IsStateIgnored ()

virtual bool	IsValueDefault ()
	Returns true if the property's value is different from the default value. More...

bool	HasDomainsWithRequiredProperties ()
	Returns true if the property has a domain with required properties. More...

virtual void	ClearUncheckedElements ()
	Use this method to clear unchecked values set of this property. More...


virtual void	SetCommand (const char *)
	The command name used to set the value on the server object. More...

virtual char *	GetCommand ()
	The command name used to set the value on the server object. More...


virtual void	SetImmediateUpdate (int)
	If ImmediateUpdate is true, the value of the property will be pushed to the server as soon as it is modified. More...

virtual int	GetImmediateUpdate ()
	If ImmediateUpdate is true, the value of the property will be pushed to the server as soon as it is modified. More...


virtual int	GetInformationOnly ()
	Is InformationOnly is set to true, this property is used to get information from server instead of setting values. More...


virtual int	GetIgnoreSynchronization ()
	If IgnoreSynchronization is set to true, this property is used to prevent that property from being updated when changed remotely by another collaborative client. More...


virtual vtkSMProperty *	GetInformationProperty ()
	Get the associated information property. More...


virtual void	SetAnimateable (int)
	Get/Set if the property is animateable. More...

virtual int	GetAnimateable ()
	Get/Set if the property is animateable. More...


virtual void	SetIsInternal (int)
	Get/Set if the property is internal to server manager. More...

virtual int	GetIsInternal ()
	Get/Set if the property is internal to server manager. More...


virtual void	SetNoCustomDefault (int)
	Set/Get whether the property should ignore custom default settings. More...

virtual int	GetNoCustomDefault ()
	Set/Get whether the property should ignore custom default settings. More...


virtual void	SetPanelVisibility (const char *)
	Set/Get the panel visibility for the property. More...

virtual char *	GetPanelVisibility ()
	Set/Get the panel visibility for the property. More...


virtual void	SetPanelVisibilityDefaultForRepresentation (const char *)
	Set/Get the panel visibility to default if the current representation type matches `representation`. More...

virtual char *	GetPanelVisibilityDefaultForRepresentation ()
	Set/Get the panel visibility to default if the current representation type matches `representation`. More...


virtual void	SetPanelWidget (const char *)
	Set/Get the name of the custom panel widget to use for the property. More...

virtual char *	GetPanelWidget ()
	Set/Get the name of the custom panel widget to use for the property. More...


virtual void	SetDisableSubTrace (const char *)
	Set/Get the tracing of sub property of this property. More...

virtual char *	GetDisableSubTrace ()
	Set/Get the tracing of sub property of this property. More...


virtual vtkSMDocumentation *	GetDocumentation ()
	Returns the documentation for this proxy. More...


virtual char *	GetXMLLabel ()
	The label assigned by the xml parser. More...


virtual char *	GetXMLName ()
	The name assigned by the xml parser. More...


virtual int	GetRepeatable ()
	If repeatable, a property can have 1 or more values of the same kind. More...


virtual vtkPVXMLElement *	GetHints ()
	The server manager configuration XML may define `<Hints/>` element for a property. More...

void	SetHints (vtkPVXMLElement *hints)
	The server manager configuration XML may define `<Hints/>` element for a property. More...


void	Modified () override
	Overridden to support blocking of modified events. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkSMProperty *	New ()

static int	IsTypeOf (const char *type)

static vtkSMProperty *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMProperty ()

	~vtkSMProperty () override

virtual void	WriteTo (vtkSMMessage *msg)
	Let the property write its content into the stream. More...

virtual void	ReadFrom (const vtkSMMessage , int vtkNotUsed(message_offset), vtkSMProxyLocator )
	Let the property read and set its content from the stream. More...

virtual int	ReadXMLAttributes (vtkSMProxy parent, vtkPVXMLElement element)
	Set the appropriate ivars from the xml element. More...

virtual void	UpdateAllInputs ()
	Update all proxies referred by this property (if any). More...

vtkSMProperty *	NewProperty (const char *name)
	Internal. More...

void	AddDependent (vtkSMDomain *dom)
	Internal. More...

void	RemoveAllDependents ()
	Removes all dependents. More...

void	UpdateDomains ()
	Calls Update() on all domains contained by the property as well as all dependent domains. More...

virtual void	SaveState (vtkPVXMLElement parent, const char property_name, const char *uid, int saveDomains=1)
	Save the property state in XML. More...

virtual void	SaveStateValues (vtkPVXMLElement *propertyElement)
	This method must be overridden by concrete class in order to save the real property data. More...

virtual void	SaveDomainState (vtkPVXMLElement propertyElement, const char uid)
	Save property domain. More...

virtual int	LoadState (vtkPVXMLElement element, vtkSMProxyLocator loader)
	Updates state from an XML element. More...

virtual void	SetXMLLabel (const char *)

virtual void	SetInformationOnly (int)

virtual void	SetIgnoreSynchronization (int)

void	SetInformationProperty (vtkSMProperty *ip)

void	SetDocumentation (vtkSMDocumentation *)

void	SetParent (vtkSMProxy *proxy)

virtual void	SetStateIgnored (bool)

virtual void	StateIgnoredOn ()

virtual void	StateIgnoredOff ()


virtual void	SetXMLName (const char *)
	The name assigned by the xml parser. More...


bool	SetBlockModifiedEvents (bool block)
	Block/unblock modified events, returns the current state of the block flag. More...


virtual bool	GetPendingModifiedEvents ()
	Returns if any modified evetns are pending. More...

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

	~vtkSMObject () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkPVXMLElement *	Hints

char *	Command

vtkSMPropertyInternals *	PInternals

int	ImmediateUpdate

int	Animateable

int	IsInternal

int	NoCustomDefault

char *	XMLName

char *	XMLLabel

char *	PanelVisibility

char *	PanelVisibilityDefaultForRepresentation

char *	PanelWidget

char *	DisableSubTrace

vtkSMDomainIterator *	DomainIterator

int	InformationOnly

int	IgnoreSynchronization

vtkSMInformationHelper *	InformationHelper

vtkSMProperty *	InformationProperty

vtkSMDocumentation *	Documentation

int	Repeatable

vtkWeakPointer< vtkSMProxy >	Proxy

bool	StateIgnored

vtkSMPropertyLink *	Links

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkSMSessionProxyManager

class	vtkSMProxy

class	vtkSMSubPropertyIterator

class	vtkSMDomainIterator

class	vtkSMSourceProxy

class	vtkSMDomain

class	vtkSMPropertyModificationUndoElement

Detailed Description

superclass for all SM properties

Each instance of vtkSMProperty or a sub-class represents a method and associated arguments (if any) of a VTK object stored on one or more client manager or server nodes. It may have a state and can push this state to the vtk object it refers to. vtkSMProperty only supports methods with no arguments. Sub-classes support methods with different arguments types and numbers.

vtkSMProperty is typically meant for pushing its values to a VTK object. However, a property may be marked as an InformationOnly property in which case its values are obtained from the server with the UpdateInformation() call.

Each non-information property can have one or more domains. A domain represents a set of acceptable values the property can have. Domains provide applications mechanisms to extract semantic information from a property.

A property has two kinds of values: regular (or checked) values and unchecked values. Regular values are the ones that are pushed to the VTK object when the property is updated. These are the ones that get saved in state, etc. Unchecked values are provided so that domains can update their conditions without having the change the property's value e.g. if the domain range for the IsoContour property changes based on the value of the ArrayName property which selects the array to contour with, the can set the unchecked value on the ArrayName property to each of the available arrays to determine what the domain would be without having to modify the property and update its VTK object. If a property has no unchecked-values explicitly set, then the "Get" methods that access the unchecked-values should simply return the checked values. If the checked values are changed, the unchecked values are reset to match the checked values.

A property fires the following events:

vtkCommand::ModifiedEvent : fired when property's value(s) is(are) modified. This must be fired only when values are really changed, not just the "set" methods are called. This event must be fired no matter how the property's values are changed.

vtkCommand::UncheckedPropertyModifiedEvent : fired when the property's unchecked-value(s) is(are) changed. Note that when a property's checked values change, it's unchecked values are reset to match the checked values, so technically, vtkCommand::UncheckedPropertyModifiedEvent must be fired every time vtkCommand::ModifiedEvent is fired.

vtkCommand::DomainModifiedEvent : fired when any of this properties domain's fire the same event.

Properties are typically constructed from ServerManager XML configuration files. Attributes available on a Property XML are as follows:

name: string: This is the name for the property. This typically ends up being the name used by the Proxy to refer to this property. It must be unique for all properties on a Proxy.

label: string:This is the user-friendly label. Ideally, the label should be same as the name, however traditionally that hasn't been the case.

command: string: This is the name of the method to call on the VTK update for the property.

repeatable or repeat_command: {0,1}: This used to indicate that the command can be called repeatedly to update the VTK object. e.g. for multiple inputs, one must call AddInput(..) repeatedly. It also implies that the number of elements/items in the property can change.

information_only: {0,1}: When set, it implies that this property is used to obtain values from the VTK object, rather than the default behavior which is to set values on the VTK object.

information_property: string: Value is the name of the property on the proxy to which this property belongs that can is information_only property corresponding to this. This is useful when the variable that this property sets can be changed by other means besides this property e.g. through interaction. Applications can use this information to update the value of this property to reflect the VTK-side state.

immediate_update: {0,1}: When set, the Proxy will attempt to push the value for this property to the VTK object as soon as the property is changed. It is no longer common and should be avoided. It may be deprecated in near future.

state_ignored: {0,1}: When set, changes to this property are not captured in undo-redo stacks. Unlike is_internal, the value for this property is saved in state files.

ignore_synchronization: {0,1}: When set, changes to this property are not synchronized among client-processes in collaborative mode.

is_internal: {0,1}: When set, the property is treated as internal which implies that it will not be shown in the UI; its value will not be pushed when the proxy is created, nor saved in state files or undo-redo stacks.

animateable: {0,1}: When set, the property is considered as animatable which the UI can use to build the animation interface.

panel_visibility: {default,advanced,never}: Indicates to the UI that the widget corresponding to this property should be shown in the default or advanced mode, or never at all.

panel_widget: string: provides a hint to the UI to determine which widget to create to edit this property.

no_custom_default: {0,1}: When set, vtkSMSettings will neither change the value of a property upon creation nor save the property value as a default.

disable_sub_trace: {0,1}: When set on a ProxyProperty, the python trace generated by smtrace.py will not contain the properties of the proxy pointed by the proxy property.

If you want to avoid having a default You can you use:

<Hints>
  <NoDefault/>
</Hints>

Definition at line 150 of file vtkSMProperty.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkSMProperty::Superclass

Definition at line 154 of file vtkSMProperty.h.

Constructor & Destructor Documentation

◆ vtkSMProperty()

vtkSMProperty::vtkSMProperty ( )

protected

◆ ~vtkSMProperty()

vtkSMProperty::~vtkSMProperty ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMProperty* vtkSMProperty::New ( )

static

◆ GetClassName()

virtual const char* vtkSMProperty::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMProxyProperty, vtkSMStringVectorProperty, vtkSMInputProperty, vtkSMIdTypeVectorProperty, vtkSMDoubleVectorProperty, vtkSMIntVectorProperty, vtkSMDoubleMapProperty, vtkSMVectorProperty, and vtkSMMapProperty.

◆ IsTypeOf()

static int vtkSMProperty::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkSMProperty::IsA ( const char * type )

virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMProxyProperty, vtkSMStringVectorProperty, vtkSMInputProperty, vtkSMIdTypeVectorProperty, vtkSMDoubleVectorProperty, vtkSMIntVectorProperty, vtkSMDoubleMapProperty, vtkSMVectorProperty, and vtkSMMapProperty.

◆ SafeDownCast()

static vtkSMProperty* vtkSMProperty::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkSMProperty::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMProxyProperty, vtkSMStringVectorProperty, and vtkSMVectorProperty.

◆ SetCommand()

virtual void vtkSMProperty::SetCommand ( const char * )

virtual

The command name used to set the value on the server object.

For example: SetThetaResolution

◆ GetCommand()

virtual char* vtkSMProperty::GetCommand ( )

virtual

The command name used to set the value on the server object.

For example: SetThetaResolution

◆ SetImmediateUpdate()

virtual void vtkSMProperty::SetImmediateUpdate ( int )

virtual

If ImmediateUpdate is true, the value of the property will be pushed to the server as soon as it is modified.

Properties that do not have values can be pushed by calling Modified().

◆ GetImmediateUpdate()

virtual int vtkSMProperty::GetImmediateUpdate ( )

virtual

If ImmediateUpdate is true, the value of the property will be pushed to the server as soon as it is modified.

Properties that do not have values can be pushed by calling Modified().

◆ IsInDomains() [1/2]

int vtkSMProperty::IsInDomains ( )

Returns true if all values are in all domains, false otherwise.

The domains will check the unchecked values (SetUncheckedXXX()) instead of the actual values.

Domains that return vtkSMDomain::NOT_APPLICABLE for vtkSMDomain::IsInDomain are skipped.

◆ IsInDomains() [2/2]

int vtkSMProperty::IsInDomains ( vtkSMDomain ** domain )

Overload of IsInDomains() that provides a mechanism to return the first domain that fails the check.

domain is set to nullptr when all domain checks pass.

Domains that return vtkSMDomain::NOT_APPLICABLE for vtkSMDomain::IsInDomain are skipped.

◆ UnRegister()

void vtkSMProperty::UnRegister ( vtkObjectBase * obj )

overridevirtual

Overloaded to break the reference loop caused by the internal domain iterator.

Reimplemented from vtkObjectBase.

◆ NewDomainIterator()

vtkSMDomainIterator* vtkSMProperty::NewDomainIterator ( )

Creates, initializes and returns a new domain iterator.

The user has to delete the iterator.

◆ GetDomain()

vtkSMDomain* vtkSMProperty::GetDomain ( const char * name )

Returns a domain give a name.

Avoids using this method and use FindDomain instead.

◆ FindDomain() [1/2]

vtkSMDomain* vtkSMProperty::FindDomain ( const char * classname )

Returns the first domain which is of the specified type.

◆ FindDomain() [2/2]

template<class DomainType >

DomainType * vtkSMProperty::FindDomain ( )

inline

Same as FindDomain(classname), except the classname is deduced from the type.

#include <vtkSMEnumerationDomain.h>
...
vtkSMProperty* prop = ...
auto enumDomain = prop->FindDomain<vtkSMEnumerationDomain>();
...

Definition at line 699 of file vtkSMProperty.h.

◆ GetNumberOfDomains()

unsigned int vtkSMProperty::GetNumberOfDomains ( )

Returns the number of domains this property has.

One can use a domain iterator to access domains then.

◆ GetInformationOnly()

virtual int vtkSMProperty::GetInformationOnly ( )

virtual

Is InformationOnly is set to true, this property is used to get information from server instead of setting values.

◆ GetIgnoreSynchronization()

virtual int vtkSMProperty::GetIgnoreSynchronization ( )

virtual

If IgnoreSynchronization is set to true, this property is used to prevent that property from being updated when changed remotely by another collaborative client.

◆ GetInformationProperty()

virtual vtkSMProperty* vtkSMProperty::GetInformationProperty ( )

virtual

Get the associated information property.

This allows applications to have access to both the in and out properties. The information property has to be specified in the xml configuration file.

◆ AddDomain()

void vtkSMProperty::AddDomain	(	const char *	name,
		vtkSMDomain *	dom
	)

Properties can have one or more domains.

These are assigned by the proxy manager and can be used to obtain information other than given by the type of the property and its values.

◆ AddLinkedProperty()

virtual void vtkSMProperty::AddLinkedProperty ( vtkSMProperty * targetProperty )

virtual

Add a link to a property whose value should be synchronized with this property value.

◆ RemoveLinkedProperty()

virtual void vtkSMProperty::RemoveLinkedProperty ( vtkSMProperty * targetProperty )

virtual

Remove a link to a property added with AddLinkedProperty()

◆ RemoveFromSourceLink()

virtual void vtkSMProperty::RemoveFromSourceLink ( )

virtual

Remove a link from the source property.

This is a useful way for target properties to unlink themselves from a source property prior to, for instance, the deletion of the target property instance. This method only does any work if this instance was passed as the argument to AddLinkedProperty() on a different property instance at some point. Otherwise, it is a no-op.

◆ SetAnimateable()

virtual void vtkSMProperty::SetAnimateable ( int )

virtual

Get/Set if the property is animateable.

Non-animateable properties are shown in the GUI only in advanced mode.

◆ GetAnimateable()

virtual int vtkSMProperty::GetAnimateable ( )

virtual

Get/Set if the property is animateable.

Non-animateable properties are shown in the GUI only in advanced mode.

◆ SetIsInternal()

virtual void vtkSMProperty::SetIsInternal ( int )

virtual

Get/Set if the property is internal to server manager.

Internal properties are not saved in state and should not be displayed in the user interface.

◆ GetIsInternal()

virtual int vtkSMProperty::GetIsInternal ( )

virtual

Get/Set if the property is internal to server manager.

Internal properties are not saved in state and should not be displayed in the user interface.

◆ SetNoCustomDefault()

virtual void vtkSMProperty::SetNoCustomDefault ( int )

virtual

Set/Get whether the property should ignore custom default settings.

◆ GetNoCustomDefault()

virtual int vtkSMProperty::GetNoCustomDefault ( )

virtual

Set/Get whether the property should ignore custom default settings.

◆ SetPanelVisibility()

virtual void vtkSMProperty::SetPanelVisibility ( const char * )

virtual

Set/Get the panel visibility for the property.

The value can be one of:

"default": Show the property by default.
"advanced": Only show the property in the advanced view.
"never": Never show the property on the panel.

By default, standard properties have "default" visibility, while information_only properties have "never" visibility.

◆ GetPanelVisibility()

virtual char* vtkSMProperty::GetPanelVisibility ( )

virtual

Set/Get the panel visibility for the property.

The value can be one of:

"default": Show the property by default.
"advanced": Only show the property in the advanced view.
"never": Never show the property on the panel.

By default, standard properties have "default" visibility, while information_only properties have "never" visibility.

◆ SetPanelVisibilityDefaultForRepresentation()

virtual void vtkSMProperty::SetPanelVisibilityDefaultForRepresentation ( const char * )

virtual

Set/Get the panel visibility to default if the current representation type matches representation.

◆ GetPanelVisibilityDefaultForRepresentation()

virtual char* vtkSMProperty::GetPanelVisibilityDefaultForRepresentation ( )

virtual

Set/Get the panel visibility to default if the current representation type matches representation.

◆ SetPanelWidget()

virtual void vtkSMProperty::SetPanelWidget ( const char * )

virtual

Set/Get the name of the custom panel widget to use for the property.

◆ GetPanelWidget()

virtual char* vtkSMProperty::GetPanelWidget ( )

virtual

Set/Get the name of the custom panel widget to use for the property.

◆ SetDisableSubTrace()

virtual void vtkSMProperty::SetDisableSubTrace ( const char * )

virtual

Set/Get the tracing of sub property of this property.

◆ GetDisableSubTrace()

virtual char* vtkSMProperty::GetDisableSubTrace ( )

virtual

Set/Get the tracing of sub property of this property.

◆ Copy()

virtual void vtkSMProperty::Copy ( vtkSMProperty * src )

virtual

Copy all property values.

This will copy both checked and unchecked values, if applicable.

Reimplemented in vtkSMStringVectorProperty, vtkSMIdTypeVectorProperty, vtkSMDoubleVectorProperty, vtkSMProxyProperty, vtkSMIntVectorProperty, vtkSMVectorProperty, vtkSMDoubleMapProperty, and vtkSMMapProperty.

◆ GetDocumentation()

virtual vtkSMDocumentation* vtkSMProperty::GetDocumentation ( )

virtual

Returns the documentation for this proxy.

The return value may be nullptr if no documentation is defined in the XML for this property.

◆ ResetToDefault()

void vtkSMProperty::ResetToDefault ( )

Simply calls this->ResetToDomainDefaults() and if that returns false, calls this->ResetToXMLDefaults().

◆ ResetToXMLDefaults()

virtual void vtkSMProperty::ResetToXMLDefaults ( )

inlinevirtual

For properties that support specifying defaults in XML configuration, this method will reset the property value to the default values specified in the XML.

Default implementation does nothing.

Reimplemented in vtkSMStringVectorProperty, vtkSMProxyProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, vtkSMIntVectorProperty, and vtkSMDoubleMapProperty.

Definition at line 390 of file vtkSMProperty.h.

◆ ResetToDomainDefaults()

virtual bool vtkSMProperty::ResetToDomainDefaults ( bool use_unchecked_values = false )

virtual

Iterates over all domains and call SetDefaultValues() on each domain until the first one returns true i.e.

indicate that it can set a default value and did so. Returns true if any domain can setup a default value for this property. Otherwise false.

vtkSMVectorProperty overrides this method to add support for setting default values using information_property.

In symmetric MPI mode (i.e. when vtkProcessModule::GetSymmetricMPIMode() == true), domains need not have correct values since data information is not collected by doing any reduction in parallel. To avoid setting incorrect values, or worse, different values on different ranks, this method does nothing in the case. Except for vtkSMProxyProperty. For vtkSMProxyProperty, we don't have any domain that is runtime data dependent and hence we let the property reset itself. This ensures that properties with vtkSMProxyListDomain, for example, are initialized correctly.

Reimplemented in vtkSMVectorProperty.

◆ GetXMLLabel()

virtual char* vtkSMProperty::GetXMLLabel ( )

virtual

The label assigned by the xml parser.

◆ GetXMLName()

virtual char* vtkSMProperty::GetXMLName ( )

virtual

The name assigned by the xml parser.

Used to get the property from a proxy. Note that the name used to obtain a property that is on a subproxy may be different from the XMLName of the property, see the note on ExposedProperties for vtkSMProxy.

◆ GetRepeatable()

virtual int vtkSMProperty::GetRepeatable ( )

virtual

If repeatable, a property can have 1 or more values of the same kind.

This ivar is configured when the xml file is read and is mainly useful for information (for example from python).

◆ GetHints()

virtual vtkPVXMLElement* vtkSMProperty::GetHints ( )

virtual

The server manager configuration XML may define <Hints/> element for a property.

Hints are metadata associated with the property. The Server Manager does not (and should not) interpret the hints. Hints provide a mechanism to add GUI pertinant information to the server manager XML. Returns the XML element for the hints associated with this property, if any, otherwise returns nullptr.

◆ SetHints()

void vtkSMProperty::SetHints ( vtkPVXMLElement * hints )

The server manager configuration XML may define <Hints/> element for a property.

Hints are metadata associated with the property. The Server Manager does not (and should not) interpret the hints. Hints provide a mechanism to add GUI pertinant information to the server manager XML. Returns the XML element for the hints associated with this property, if any, otherwise returns nullptr.

◆ Modified()

void vtkSMProperty::Modified ( )

inlineoverridevirtual

Overridden to support blocking of modified events.

Reimplemented from vtkObject.

Definition at line 455 of file vtkSMProperty.h.

◆ GetParent()

vtkSMProxy* vtkSMProperty::GetParent ( )

Get the proxy to which this property belongs.

Note that is this property is belong to a sub-proxy of a proxy, the returned value will indeed be that sub-proxy (and not the outer container proxy).

◆ IsStateIgnored()

virtual bool vtkSMProperty::IsStateIgnored ( )

inlinevirtual

Definition at line 478 of file vtkSMProperty.h.

◆ IsValueDefault()

virtual bool vtkSMProperty::IsValueDefault ( )

inlinevirtual

Returns true if the property's value is different from the default value.

This is used as a hint by the state saving code to determine if the value should be written to the file or if the defaults are sufficient.

Reimplemented in vtkSMStringVectorProperty, vtkSMProxyProperty, vtkSMDoubleVectorProperty, vtkSMIntVectorProperty, and vtkSMMapProperty.

Definition at line 485 of file vtkSMProperty.h.

◆ HasDomainsWithRequiredProperties()

bool vtkSMProperty::HasDomainsWithRequiredProperties ( )

Returns true if the property has a domain with required properties.

This typically indicates that the property has a domain whose values change at runtime based on input dataset or file being processed.

◆ ClearUncheckedElements()

virtual void vtkSMProperty::ClearUncheckedElements ( )

inlinevirtual

Use this method to clear unchecked values set of this property.

Reimplemented in vtkSMStringVectorProperty, vtkSMIdTypeVectorProperty, vtkSMDoubleVectorProperty, vtkSMIntVectorProperty, vtkSMProxyProperty, and vtkSMVectorProperty.

Definition at line 497 of file vtkSMProperty.h.

◆ WriteTo()

virtual void vtkSMProperty::WriteTo ( vtkSMMessage * msg )

protectedvirtual

Let the property write its content into the stream.

Reimplemented in vtkSMStringVectorProperty, vtkSMProxyProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, vtkSMIntVectorProperty, and vtkSMDoubleMapProperty.

◆ ReadFrom()

virtual void vtkSMProperty::ReadFrom	(	const vtkSMMessage *	,
		int	vtkNotUsedmessage_offset,
		vtkSMProxyLocator *
	)

inlineprotectedvirtual

Let the property read and set its content from the stream.

Definition at line 519 of file vtkSMProperty.h.

◆ ReadXMLAttributes()

virtual int vtkSMProperty::ReadXMLAttributes	(	vtkSMProxy *	parent,
		vtkPVXMLElement *	element
	)

protectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented in vtkSMStringVectorProperty, vtkSMProxyProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, vtkSMIntVectorProperty, vtkSMVectorProperty, vtkSMDoubleMapProperty, vtkSMInputProperty, and vtkSMMapProperty.

◆ UpdateAllInputs()

virtual void vtkSMProperty::UpdateAllInputs ( )

inlineprotectedvirtual

Update all proxies referred by this property (if any).

Overwritten by vtkSMProxyProperty and sub-classes.

Reimplemented in vtkSMProxyProperty.

Definition at line 531 of file vtkSMProperty.h.

◆ SetXMLName()

virtual void vtkSMProperty::SetXMLName ( const char * )

protectedvirtual

The name assigned by the xml parser.

Used to get the property from a proxy. Note that the name used to obtain a property that is on a subproxy may be different from the XMLName of the property, see the note on ExposedProperties for vtkSMProxy.

◆ NewProperty()

vtkSMProperty* vtkSMProperty::NewProperty ( const char * name )

protected

Internal.

Used during XML parsing to get a property with given name. Used by the domains when setting required properties.

◆ AddDependent()

void vtkSMProperty::AddDependent ( vtkSMDomain * dom )

protected

Internal.

Used by the domains that require this property. They add themselves as dependents.

◆ RemoveAllDependents()

void vtkSMProperty::RemoveAllDependents ( )

protected

Removes all dependents.

◆ UpdateDomains()

void vtkSMProperty::UpdateDomains ( )

protected

Calls Update() on all domains contained by the property as well as all dependent domains.

This is automatically called after SetUncheckedXXX() to tell all dependent domains to update themselves according to the new value. Note that when calling Update() on domains contained by this property, a nullptr is passed as the argument. This is because the domain does not really "depend" on the property. When calling Update() on dependent domains, the property passes itself as the argument.

Note: as of ParaView 5.10, this method skips updating domains for prototype proxies. See description in .cxx for details behind this change.

◆ SaveState()

virtual void vtkSMProperty::SaveState	(	vtkPVXMLElement *	parent,
		const char *	property_name,
		const char *	uid,
		int	saveDomains = `1`
	)

protectedvirtual

Save the property state in XML.

This method create the property definition and rely on SaveStateValues to fill this definition with the concrete property values

◆ SaveStateValues()

virtual void vtkSMProperty::SaveStateValues ( vtkPVXMLElement * propertyElement )

protectedvirtual

This method must be overridden by concrete class in order to save the real property data.

Reimplemented in vtkSMStringVectorProperty, vtkSMIntVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, vtkSMProxyProperty, and vtkSMDoubleMapProperty.

◆ SaveDomainState()

virtual void vtkSMProperty::SaveDomainState	(	vtkPVXMLElement *	propertyElement,
		const char *	uid
	)

protectedvirtual

Save property domain.

◆ LoadState()

virtual int vtkSMProperty::LoadState	(	vtkPVXMLElement *	element,
		vtkSMProxyLocator *	loader
	)

protectedvirtual

Updates state from an XML element.

Returns 0 on failure.

Reimplemented in vtkSMStringVectorProperty, vtkSMProxyProperty, vtkSMIntVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, vtkSMDoubleMapProperty, and vtkSMMapProperty.

◆ SetXMLLabel()

virtual void vtkSMProperty::SetXMLLabel ( const char * )

protectedvirtual

◆ SetInformationOnly()

virtual void vtkSMProperty::SetInformationOnly ( int )

protectedvirtual

◆ SetIgnoreSynchronization()

virtual void vtkSMProperty::SetIgnoreSynchronization ( int )

protectedvirtual

◆ SetInformationProperty()

void vtkSMProperty::SetInformationProperty ( vtkSMProperty * ip )

protected

◆ SetDocumentation()

void vtkSMProperty::SetDocumentation ( vtkSMDocumentation * )

protected

◆ SetBlockModifiedEvents()

bool vtkSMProperty::SetBlockModifiedEvents ( bool block )

inlineprotected

Block/unblock modified events, returns the current state of the block flag.

Definition at line 641 of file vtkSMProperty.h.

◆ GetPendingModifiedEvents()

virtual bool vtkSMProperty::GetPendingModifiedEvents ( )

protectedvirtual

Returns if any modified evetns are pending.

This gets cleared when Modified() is called.

◆ SetParent()

void vtkSMProperty::SetParent ( vtkSMProxy * proxy )

protected

◆ SetStateIgnored()

virtual void vtkSMProperty::SetStateIgnored ( bool )

protectedvirtual

◆ StateIgnoredOn()

virtual void vtkSMProperty::StateIgnoredOn ( )

protectedvirtual

◆ StateIgnoredOff()

virtual void vtkSMProperty::StateIgnoredOff ( )

protectedvirtual

Friends And Related Function Documentation

◆ vtkSMSessionProxyManager

friend class vtkSMSessionProxyManager

friend

Definition at line 503 of file vtkSMProperty.h.

◆ vtkSMProxy

friend class vtkSMProxy

friend

Definition at line 504 of file vtkSMProperty.h.

◆ vtkSMSubPropertyIterator

friend class vtkSMSubPropertyIterator

friend

Definition at line 505 of file vtkSMProperty.h.

◆ vtkSMDomainIterator

friend class vtkSMDomainIterator

friend

Definition at line 506 of file vtkSMProperty.h.

◆ vtkSMSourceProxy

friend class vtkSMSourceProxy

friend

Definition at line 507 of file vtkSMProperty.h.

◆ vtkSMDomain

friend class vtkSMDomain

friend

Definition at line 508 of file vtkSMProperty.h.

◆ vtkSMPropertyModificationUndoElement

friend class vtkSMPropertyModificationUndoElement

friend

Definition at line 509 of file vtkSMProperty.h.

Member Data Documentation

◆ Hints

vtkPVXMLElement* vtkSMProperty::Hints

protected

Definition at line 599 of file vtkSMProperty.h.

◆ Command

char* vtkSMProperty::Command

protected

Definition at line 601 of file vtkSMProperty.h.

◆ PInternals

vtkSMPropertyInternals* vtkSMProperty::PInternals

protected

Definition at line 603 of file vtkSMProperty.h.

◆ ImmediateUpdate

int vtkSMProperty::ImmediateUpdate

protected

Definition at line 605 of file vtkSMProperty.h.

◆ Animateable

int vtkSMProperty::Animateable

protected

Definition at line 606 of file vtkSMProperty.h.

◆ IsInternal

int vtkSMProperty::IsInternal

protected

Definition at line 607 of file vtkSMProperty.h.

◆ NoCustomDefault

int vtkSMProperty::NoCustomDefault

protected

Definition at line 608 of file vtkSMProperty.h.

◆ XMLName

char* vtkSMProperty::XMLName

protected

Definition at line 610 of file vtkSMProperty.h.

◆ XMLLabel

char* vtkSMProperty::XMLLabel

protected

Definition at line 611 of file vtkSMProperty.h.

◆ PanelVisibility

char* vtkSMProperty::PanelVisibility

protected

Definition at line 612 of file vtkSMProperty.h.

◆ PanelVisibilityDefaultForRepresentation

char* vtkSMProperty::PanelVisibilityDefaultForRepresentation

protected

Definition at line 615 of file vtkSMProperty.h.

◆ PanelWidget

char* vtkSMProperty::PanelWidget

protected

Definition at line 616 of file vtkSMProperty.h.

◆ DisableSubTrace

char* vtkSMProperty::DisableSubTrace

protected

Definition at line 617 of file vtkSMProperty.h.

◆ DomainIterator

vtkSMDomainIterator* vtkSMProperty::DomainIterator

protected

Definition at line 619 of file vtkSMProperty.h.

◆ InformationOnly

int vtkSMProperty::InformationOnly

protected

Definition at line 621 of file vtkSMProperty.h.

◆ IgnoreSynchronization

int vtkSMProperty::IgnoreSynchronization

protected

Definition at line 624 of file vtkSMProperty.h.

◆ InformationHelper

vtkSMInformationHelper* vtkSMProperty::InformationHelper

protected

Definition at line 627 of file vtkSMProperty.h.

◆ InformationProperty

vtkSMProperty* vtkSMProperty::InformationProperty

protected

Definition at line 630 of file vtkSMProperty.h.

◆ Documentation

vtkSMDocumentation* vtkSMProperty::Documentation

protected

Definition at line 632 of file vtkSMProperty.h.

◆ Repeatable

int vtkSMProperty::Repeatable

protected

Definition at line 635 of file vtkSMProperty.h.

◆ Proxy

vtkWeakPointer<vtkSMProxy> vtkSMProperty::Proxy

protected

Definition at line 660 of file vtkSMProperty.h.

◆ StateIgnored

bool vtkSMProperty::StateIgnored

protected

Definition at line 664 of file vtkSMProperty.h.

◆ Links

vtkSMPropertyLink* vtkSMProperty::Links

protected

Definition at line 666 of file vtkSMProperty.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMProperty.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMProperty()

◆ ~vtkSMProperty()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetCommand()

◆ GetCommand()

◆ SetImmediateUpdate()

◆ GetImmediateUpdate()

◆ IsInDomains() [1/2]

◆ IsInDomains() [2/2]

◆ UnRegister()

◆ NewDomainIterator()

◆ GetDomain()

◆ FindDomain() [1/2]

◆ FindDomain() [2/2]

◆ GetNumberOfDomains()

◆ GetInformationOnly()

◆ GetIgnoreSynchronization()

◆ GetInformationProperty()

◆ AddDomain()

◆ AddLinkedProperty()

◆ RemoveLinkedProperty()

◆ RemoveFromSourceLink()

◆ SetAnimateable()

◆ GetAnimateable()

◆ SetIsInternal()

◆ GetIsInternal()

◆ SetNoCustomDefault()

◆ GetNoCustomDefault()

◆ SetPanelVisibility()

◆ GetPanelVisibility()

◆ SetPanelVisibilityDefaultForRepresentation()

◆ GetPanelVisibilityDefaultForRepresentation()

◆ SetPanelWidget()

◆ GetPanelWidget()

◆ SetDisableSubTrace()

◆ GetDisableSubTrace()

◆ Copy()

◆ GetDocumentation()

◆ ResetToDefault()

◆ ResetToXMLDefaults()

◆ ResetToDomainDefaults()

◆ GetXMLLabel()

◆ GetXMLName()

◆ GetRepeatable()

◆ GetHints()

◆ SetHints()

◆ Modified()

◆ GetParent()

◆ IsStateIgnored()

◆ IsValueDefault()

◆ HasDomainsWithRequiredProperties()

◆ ClearUncheckedElements()

◆ WriteTo()

◆ ReadFrom()

◆ ReadXMLAttributes()

◆ UpdateAllInputs()

◆ SetXMLName()

◆ NewProperty()

◆ AddDependent()

◆ RemoveAllDependents()

◆ UpdateDomains()

◆ SaveState()

◆ SaveStateValues()

◆ SaveDomainState()