superclass for all SM properties More...

#include <vtkSMProperty.h>

Inheritance diagram for vtkSMProperty:

Collaboration diagram for vtkSMProperty:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	IsInDomains ()
int	IsInDomains (vtkSMDomain **domain)
virtual void	UnRegister (vtkObjectBase *obj)
vtkSMDomainIterator *	NewDomainIterator ()
vtkSMDomain *	GetDomain (const char *name)
vtkSMDomain *	FindDomain (const char *classname)
unsigned int	GetNumberOfDomains ()
void	UpdateDependentDomains ()
void	AddDomain (const char name, vtkSMDomain dom)
virtual void	Copy (vtkSMProperty *src)
void	ResetToDefault ()
vtkSMProxy *	GetParent ()
virtual bool	IsStateIgnored ()

virtual void	SetCommand (const char *)
virtual char *	GetCommand ()

virtual void	SetImmediateUpdate (int)
virtual int	GetImmediateUpdate ()

virtual int	GetInformationOnly ()

virtual int	GetIgnoreSynchronization ()

virtual vtkSMProperty *	GetInformationProperty ()

virtual void	SetAnimateable (int)
virtual int	GetAnimateable ()

virtual void	SetIsInternal (int)
virtual int	GetIsInternal ()

virtual void	SetPanelVisibility (const char *)

virtual char *	GetPanelVisibility ()

virtual void	SetPanelVisibilityDefaultForRepresentation (const char *)

virtual char *	GetPanelVisibilityDefaultForRepresentation ()

virtual vtkSMDocumentation *	GetDocumentation ()

virtual char *	GetXMLLabel ()

virtual int	GetRepeatable ()

virtual vtkPVXMLElement *	GetHints ()

virtual void	Modified ()
Static Public Member Functions
static vtkSMProperty *	New ()
static int	IsTypeOf (const char *type)
static vtkSMProperty *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMProperty ()
	~vtkSMProperty ()
virtual void	WriteTo (vtkSMMessage *msg)
virtual void	UpdateAllInputs ()
vtkSMProperty *	NewProperty (const char *name)
void	AddDependent (vtkSMDomain *dom)
void	RemoveAllDependents ()
virtual void	SaveStateValues (vtkPVXMLElement *propertyElement)
virtual void	SaveDomainState (vtkPVXMLElement propertyElement, const char uid)
virtual int	LoadState (vtkPVXMLElement element, vtkSMProxyLocator loader)
void	SetHints (vtkPVXMLElement *hints)
virtual void	SetXMLLabel (const char *)
virtual void	SetInformationOnly (int)
virtual void	SetIgnoreSynchronization (int)
void	SetInformationProperty (vtkSMProperty *ip)
void	SetDocumentation (vtkSMDocumentation *)
virtual void	ResetToDefaultInternal ()
void	SetParent (vtkSMProxy *proxy)
virtual void	SetStateIgnored (bool)
virtual void	StateIgnoredOn ()
virtual void	StateIgnoredOff ()

virtual void	ReadFrom (const vtkSMMessage , int vtkNotUsed(message_offset), vtkSMProxyLocator )

virtual int	ReadXMLAttributes (vtkSMProxy parent, vtkPVXMLElement element)

virtual void	SetXMLName (const char *)

virtual char *	GetXMLName ()

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

bool	SetBlockModifiedEvents (bool block)

virtual bool	GetPendingModifiedEvents ()
Protected Attributes
vtkPVXMLElement *	Hints
char *	Command
vtkSMPropertyInternals *	PInternals
int	ImmediateUpdate
int	Animateable
int	IsInternal
char *	XMLName
char *	XMLLabel
char *	PanelVisibility
char *	PanelVisibilityDefaultForRepresentation
vtkSMDomainIterator *	DomainIterator
int	InformationOnly
int	IgnoreSynchronization
vtkSMInformationHelper *	InformationHelper
vtkSMProperty *	InformationProperty
vtkSMDocumentation *	Documentation
int	Repeatable
vtkWeakPointer< vtkSMProxy >	Proxy
bool	StateIgnored
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 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. vtkSMPropery only supports methods with no arguments. Sub-classes support methods with different arguments types and numbers. A property can also be marked as an "information" property in which case it's values are obtained from the server with the UpdateInformation() call. This call is forwarded to an information helper. The type of the information helper used is specified in the XML file. Each property can have one or more sub-properties. The sub-properties can be accessed using an iterator. It is possible to create composite properties of any depth this way. Each property can have one or more domains. A domain represents a set of acceptable values the property can have. An Attempt to set a value outside the domain will fail. If more than one domain is specified, the actual domain is the intersection of all domains.

A property can be marked "animateable". "animateable" attribute can have value {0, 1, 2}. 0 :-- property is not animateable at all. 1 :-- property is shown as animateable on the key frame animation interface in the non-advanced mode. 2 :-- property is animateable but only shown in the advanced mode. Properties that are not vector properties or that don't have domain or that are information_only properties can never be animated irrespective of the "animateable" attribute's value. All vector properties (vtkSMIntVectorProperty, vtkSMDoubleVectorPropery, vtkSMStringVectorProperty, vtkSMIdTypeVectorProperty) by default have have animateable="2".

A property can be marked "is_internal". "internal" attribute can have value {0, 1}. 0 :-- property is not internal.

1 :-- property is internal. Hence, it is not saved when saving SM state or batch script. An instance of vtkSMProperty is always internal. All other concrete subclasses are by default not internal (i.e. vtkSMProxyProperty and subclasses and vtkSMVectorProperty subclasses).

See also:: vtkSMProxyProperty vtkSMInputProperty vtkSMVectorProperty vtkSMDoubleVectorPropery vtkSMIntVectorPropery vtkSMStringVectorProperty vtkSMDomain vtkSMInformationHelper

Definition at line 83 of file vtkSMProperty.h.

Constructor & Destructor Documentation

vtkSMProperty::vtkSMProperty ( ) [protected]

vtkSMProperty::~vtkSMProperty ( ) [protected]

Member Function Documentation

static vtkSMProperty* vtkSMProperty::New ( ) [static]

Reimplemented from vtkSMObject.

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

virtual const char* vtkSMProperty::GetClassName ( ) [virtual]

Reimplemented from vtkSMObject.

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

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

Reimplemented from vtkSMObject.

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

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

Reimplemented from vtkSMObject.

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

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

Reimplemented from vtkSMObject.

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

void vtkSMProperty::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkSMObject.

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

virtual void vtkSMProperty::SetCommand ( const char * ) [virtual]

The command name used to set the value on the server object. For example: SetThetaResolution

virtual char* vtkSMProperty::GetCommand ( ) [virtual]

The command name used to set the value on the server object. For example: SetThetaResolution

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

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

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.

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 NULL when all domain checks pass.

virtual void vtkSMProperty::UnRegister ( vtkObjectBase * obj ) [virtual]

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

Reimplemented from vtkObject.

vtkSMDomainIterator* vtkSMProperty::NewDomainIterator ( )

Creates, initializes and returns a new domain iterator. The user has to delete the iterator.

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

Returns a domain give a name.

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

Returns the first domain which is of the specified type.

unsigned int vtkSMProperty::GetNumberOfDomains ( )

Returns the number of domains this property has. This can be used to specify a valid index for GetDomain(index).

void vtkSMProperty::UpdateDependentDomains ( )

Calls Update() on all domains contained by the property as well as all dependant domains. This is usually called after SetUncheckedXXX() to tell all dependant domains to update themselves according to the new value. Note that when calling Update() on domains contained by this property, a NULL 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.

virtual int vtkSMProperty::GetInformationOnly ( ) [virtual]

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

virtual int vtkSMProperty::GetIgnoreSynchronization ( ) [virtual]

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

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.

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 propery and its values.

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.

virtual int vtkSMProperty::GetAnimateable ( ) [virtual]

Get/Set if the property is animateable. Non-animateable properties are shown in the GUI only in advanced mode.

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.

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.

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, all properties have "advanced" visibility.

virtual char* vtkSMProperty::GetPanelVisibility ( ) [virtual]

Returns the panel visibility for the property.

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

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

virtual char* vtkSMProperty::GetPanelVisibilityDefaultForRepresentation ( ) [virtual]

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

virtual void vtkSMProperty::Copy ( vtkSMProperty * src ) [virtual]

Copy all property values.

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

virtual vtkSMDocumentation* vtkSMProperty::GetDocumentation ( ) [virtual]

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

void vtkSMProperty::ResetToDefault ( )

Iterates over all domains and calls SetDefaultValues() on each until one of then returns 1, implying that it updated the property value. This is used to reset the property to its default value. Currently default values that depend on domain are reset. This method can also be called to reset the property value to the default specified in the configuration XML. If none of the domains updates the property value, then some property subclassess (viz. IntVectorProperty, DoubleVectorProperty and IdTypeVectorProperty) update the current value to that specified in the configuration XML.

virtual char* vtkSMProperty::GetXMLLabel ( ) [virtual]

The label assigned by the xml parser.

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

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

virtual void vtkSMProperty::Modified ( ) [inline, virtual]

Overridden to support blocking of modified events.

Reimplemented from vtkObject.

Definition at line 252 of file vtkSMProperty.h.

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

virtual bool vtkSMProperty::IsStateIgnored ( ) [inline, virtual]

Definition at line 273 of file vtkSMProperty.h.

virtual void vtkSMProperty::WriteTo ( vtkSMMessage * msg ) [protected, virtual]

Let the property write its content into the stream

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

virtual void vtkSMProperty::ReadFrom	(	const vtkSMMessage *	,
		int	vtkNotUsedmessage_offset,
		vtkSMProxyLocator *
	)		`[inline, protected, virtual]`

Let the property read and set its content from the stream

Definition at line 293 of file vtkSMProperty.h.

virtual int vtkSMProperty::ReadXMLAttributes	(	vtkSMProxy *	parent,
		vtkPVXMLElement *	element
	)		`[protected, virtual]`

Set the appropriate ivars from the xml element. Should be overwritten by subclass if adding ivars.

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

virtual void vtkSMProperty::UpdateAllInputs ( ) [inline, protected, virtual]

Update all proxies referred by this property (if any). Overwritten by vtkSMProxyProperty and sub-classes.

Definition at line 306 of file vtkSMProperty.h.

virtual void vtkSMProperty::SetXMLName ( const char * ) [protected, 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.

virtual char* vtkSMProperty::GetXMLName ( ) [protected, 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.

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.

void vtkSMProperty::AddDependent ( vtkSMDomain * dom ) [protected]

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

void vtkSMProperty::RemoveAllDependents ( ) [protected]

Removes all dependents.

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

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

virtual void vtkSMProperty::SaveStateValues ( vtkPVXMLElement * propertyElement ) [protected, virtual]

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

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