Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkSMProperty Class Reference

superclass for all SM properties More...

#include <vtkSMProperty.h>

Inheritance diagram for vtkSMProperty:
Inheritance graph
[legend]
Collaboration diagram for vtkSMProperty:
Collaboration graph
[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...
 
vtkSMDomainIteratorNewDomainIterator ()
 Creates, initializes and returns a new domain iterator. More...
 
vtkSMDomainGetDomain (const char *name)
 Returns a domain give a name. More...
 
vtkSMDomainFindDomain (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...
 
vtkSMProxyGetParent ()
 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 vtkSMPropertyGetInformationProperty ()
 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)
 Sets whether the property should ignore custom default settings. More...
 
virtual int GetNoCustomDefault ()
 Gets whether the property should ignore custom default settings. More...
 
virtual void SetPanelVisibility (const char *)
 Sets the panel visibility for the property. More...
 
virtual char * GetPanelVisibility ()
 Returns the panel visibility for the property. More...
 
virtual void SetPanelVisibilityDefaultForRepresentation (const char *)
 Sets the panel visibility to default if the current representation type matches representation. More...
 
virtual char * GetPanelVisibilityDefaultForRepresentation ()
 Returns which representation type the property will be shown by default for. More...
 
virtual void SetPanelWidget (const char *)
 Sets the name of the custom panel widget to use for the property. More...
 
virtual char * GetPanelWidget ()
 Returns name of the panel widget for the property. More...
 
virtual void SetDisableSubTrace (const char *)
 Sets the tracing of sub property of this property. More...
 
virtual char * GetDisableSubTrace ()
 Returns the tracing state of the properties of this property. More...
 
virtual vtkSMDocumentationGetDocumentation ()
 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 vtkPVXMLElementGetHints ()
 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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkSMPropertyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMPropertySafeDownCast (vtkObject *o)
 
static const char * CreateNewPrettyLabel (const char *name)
 Given the string, this method will create and set a well-formated string as XMLLabel and returns it. More...
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

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

vtkPVXMLElementHints
 
char * Command
 
vtkSMPropertyInternalsPInternals
 
int ImmediateUpdate
 
int Animateable
 
int IsInternal
 
int NoCustomDefault
 
char * XMLName
 
char * XMLLabel
 
char * PanelVisibility
 
char * PanelVisibilityDefaultForRepresentation
 
char * PanelWidget
 
char * DisableSubTrace
 
vtkSMDomainIteratorDomainIterator
 
int InformationOnly
 
int IgnoreSynchronization
 
vtkSMInformationHelper * InformationHelper
 
vtkSMPropertyInformationProperty
 
vtkSMDocumentationDocumentation
 
int Repeatable
 
vtkWeakPointer< vtkSMProxyProxy
 
bool StateIgnored
 
vtkSMPropertyLinkLinks
 
- 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:

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

Definition at line 155 of file vtkSMProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 159 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

◆ IsTypeOf()

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

◆ IsA()

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

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

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

Definition at line 750 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

Sets whether the property should ignore custom default settings.

◆ GetNoCustomDefault()

virtual int vtkSMProperty::GetNoCustomDefault ( )
virtual

Gets whether the property should ignore custom default settings.

◆ SetPanelVisibility()

virtual void vtkSMProperty::SetPanelVisibility ( const char *  )
virtual

Sets 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

Returns the panel visibility for the property.

◆ SetPanelVisibilityDefaultForRepresentation()

virtual void vtkSMProperty::SetPanelVisibilityDefaultForRepresentation ( const char *  )
virtual

Sets the panel visibility to default if the current representation type matches representation.

◆ GetPanelVisibilityDefaultForRepresentation()

virtual char* vtkSMProperty::GetPanelVisibilityDefaultForRepresentation ( )
virtual

Returns which representation type the property will be shown by default for.

◆ SetPanelWidget()

virtual void vtkSMProperty::SetPanelWidget ( const char *  )
virtual

Sets the name of the custom panel widget to use for the property.

◆ GetPanelWidget()

virtual char* vtkSMProperty::GetPanelWidget ( )
virtual

Returns name of the panel widget for the property.

◆ SetDisableSubTrace()

virtual void vtkSMProperty::SetDisableSubTrace ( const char *  )
virtual

Sets the tracing of sub property of this property.

◆ GetDisableSubTrace()

virtual char* vtkSMProperty::GetDisableSubTrace ( )
virtual

Returns the tracing state of the properties 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 426 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 491 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 514 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 521 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 533 of file vtkSMProperty.h.

◆ CreateNewPrettyLabel()

static const char* vtkSMProperty::CreateNewPrettyLabel ( const char *  name)
static

Given the string, this method will create and set a well-formated string as XMLLabel and returns it.

Need to be deleted after use. Add space: (1) - before every uppercase letter succeded by a lowercase letter (2) - after every lowercase letter succeded by an uppercase letter

◆ WriteTo()

virtual void vtkSMProperty::WriteTo ( vtkSMMessage msg)
protectedvirtual

◆ 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 564 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 576 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

◆ 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 686 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 548 of file vtkSMProperty.h.

◆ vtkSMProxy

friend class vtkSMProxy
friend

Definition at line 549 of file vtkSMProperty.h.

◆ vtkSMSubPropertyIterator

friend class vtkSMSubPropertyIterator
friend

Definition at line 550 of file vtkSMProperty.h.

◆ vtkSMDomainIterator

friend class vtkSMDomainIterator
friend

Definition at line 551 of file vtkSMProperty.h.

◆ vtkSMSourceProxy

friend class vtkSMSourceProxy
friend

Definition at line 552 of file vtkSMProperty.h.

◆ vtkSMDomain

friend class vtkSMDomain
friend

Definition at line 553 of file vtkSMProperty.h.

◆ vtkSMPropertyModificationUndoElement

Definition at line 554 of file vtkSMProperty.h.

Member Data Documentation

◆ Hints

vtkPVXMLElement* vtkSMProperty::Hints
protected

Definition at line 644 of file vtkSMProperty.h.

◆ Command

char* vtkSMProperty::Command
protected

Definition at line 646 of file vtkSMProperty.h.

◆ PInternals

vtkSMPropertyInternals* vtkSMProperty::PInternals
protected

Definition at line 648 of file vtkSMProperty.h.

◆ ImmediateUpdate

int vtkSMProperty::ImmediateUpdate
protected

Definition at line 650 of file vtkSMProperty.h.

◆ Animateable

int vtkSMProperty::Animateable
protected

Definition at line 651 of file vtkSMProperty.h.

◆ IsInternal

int vtkSMProperty::IsInternal
protected

Definition at line 652 of file vtkSMProperty.h.

◆ NoCustomDefault

int vtkSMProperty::NoCustomDefault
protected

Definition at line 653 of file vtkSMProperty.h.

◆ XMLName

char* vtkSMProperty::XMLName
protected

Definition at line 655 of file vtkSMProperty.h.

◆ XMLLabel

char* vtkSMProperty::XMLLabel
protected

Definition at line 656 of file vtkSMProperty.h.

◆ PanelVisibility

char* vtkSMProperty::PanelVisibility
protected

Definition at line 657 of file vtkSMProperty.h.

◆ PanelVisibilityDefaultForRepresentation

char* vtkSMProperty::PanelVisibilityDefaultForRepresentation
protected

Definition at line 660 of file vtkSMProperty.h.

◆ PanelWidget

char* vtkSMProperty::PanelWidget
protected

Definition at line 661 of file vtkSMProperty.h.

◆ DisableSubTrace

char* vtkSMProperty::DisableSubTrace
protected

Definition at line 662 of file vtkSMProperty.h.

◆ DomainIterator

vtkSMDomainIterator* vtkSMProperty::DomainIterator
protected

Definition at line 664 of file vtkSMProperty.h.

◆ InformationOnly

int vtkSMProperty::InformationOnly
protected

Definition at line 666 of file vtkSMProperty.h.

◆ IgnoreSynchronization

int vtkSMProperty::IgnoreSynchronization
protected

Definition at line 669 of file vtkSMProperty.h.

◆ InformationHelper

vtkSMInformationHelper* vtkSMProperty::InformationHelper
protected

Definition at line 672 of file vtkSMProperty.h.

◆ InformationProperty

vtkSMProperty* vtkSMProperty::InformationProperty
protected

Definition at line 675 of file vtkSMProperty.h.

◆ Documentation

vtkSMDocumentation* vtkSMProperty::Documentation
protected

Definition at line 677 of file vtkSMProperty.h.

◆ Repeatable

int vtkSMProperty::Repeatable
protected

Definition at line 680 of file vtkSMProperty.h.

◆ Proxy

vtkWeakPointer<vtkSMProxy> vtkSMProperty::Proxy
protected

Definition at line 705 of file vtkSMProperty.h.

◆ StateIgnored

bool vtkSMProperty::StateIgnored
protected

Definition at line 709 of file vtkSMProperty.h.

◆ Links

vtkSMPropertyLink* vtkSMProperty::Links
protected

Definition at line 711 of file vtkSMProperty.h.


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