Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMVectorProperty Class Referenceabstract

abstract superclass for all vector properties More...

#include <vtkSMVectorProperty.h>

Inheritance diagram for vtkSMVectorProperty:
Inheritance graph
[legend]
Collaboration diagram for vtkSMVectorProperty:
Collaboration graph
[legend]

Public Types

typedef vtkSMProperty Superclass
 
- Public Types inherited from vtkSMProperty
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
 
virtual unsigned int GetNumberOfElements ()=0
 Returns the size of the vector. More...
 
virtual void SetNumberOfElements (unsigned int num)=0
 Sets the size of the vector. More...
 
void Copy (vtkSMProperty *src) override
 Copy all property values. More...
 
virtual void SetInitialString (const char *)
 
virtual char * GetInitialString ()
 
bool ResetToDomainDefaults (bool use_unchecked_values=false) override
 Overridden to add support to load defaults from this->GetInformationProperty(), if one exists. More...
 
virtual unsigned int GetNumberOfUncheckedElements ()=0
 API for setting unchecked element values. More...
 
virtual void SetNumberOfUncheckedElements (unsigned int num)=0
 API for setting unchecked element values. More...
 
void ClearUncheckedElements () override=0
 API for setting unchecked element values. More...
 
virtual int GetRepeatCommand ()
 If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...
 
virtual void SetRepeatCommand (int)
 If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...
 
virtual void RepeatCommandOn ()
 If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...
 
virtual void RepeatCommandOff ()
 If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...
 
virtual int GetNumberOfElementsPerCommand ()
 If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...
 
virtual void SetNumberOfElementsPerCommand (int)
 If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...
 
virtual int GetUseIndex ()
 If UseIndex and RepeatCommand are true, the property will add an index integer before each command. More...
 
virtual void SetUseIndex (int)
 If UseIndex and RepeatCommand are true, the property will add an index integer before each command. More...
 
virtual void UseIndexOn ()
 If UseIndex and RepeatCommand are true, the property will add an index integer before each command. More...
 
virtual void UseIndexOff ()
 If UseIndex and RepeatCommand are true, the property will add an index integer before each command. More...
 
virtual void SetCleanCommand (const char *)
 Command that can be used to remove all values. More...
 
virtual char * GetCleanCommand ()
 Command that can be used to remove all values. More...
 
virtual void SetSetNumberCommand (const char *)
 If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter. More...
 
virtual char * GetSetNumberCommand ()
 If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter. More...
 
- Public Member Functions inherited from vtkSMProperty
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...
 
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...
 
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 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 int IsTypeOf (const char *type)
 
static vtkSMVectorPropertySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMProperty
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

 vtkSMVectorProperty ()
 
 ~vtkSMVectorProperty () override
 
int ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element) override
 Set the appropriate ivars from the xml element. More...
 
- Protected Member Functions inherited from vtkSMProperty
 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 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

int RepeatCommand
 
int NumberOfElementsPerCommand
 
int UseIndex
 
char * CleanCommand
 
char * SetNumberCommand
 
char * InitialString
 
- Protected Attributes inherited from vtkSMProperty
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
 

Detailed Description

abstract superclass for all vector properties

vtkSMVectorProperty defines an interface common to all vector properties as well as some common settings. A vector property contains a list of values passed to one or more invocations of a command. How the values are distributed to the different invocations is controlled by several parameters.

Definition at line 32 of file vtkSMVectorProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 35 of file vtkSMVectorProperty.h.

Constructor & Destructor Documentation

◆ vtkSMVectorProperty()

vtkSMVectorProperty::vtkSMVectorProperty ( )
protected

◆ ~vtkSMVectorProperty()

vtkSMVectorProperty::~vtkSMVectorProperty ( )
overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkSMVectorProperty::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSMVectorProperty::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkSMProperty.

◆ GetNumberOfElements()

virtual unsigned int vtkSMVectorProperty::GetNumberOfElements ( )
pure virtual

◆ SetNumberOfElements()

virtual void vtkSMVectorProperty::SetNumberOfElements ( unsigned int  num)
pure virtual

◆ GetNumberOfUncheckedElements()

virtual unsigned int vtkSMVectorProperty::GetNumberOfUncheckedElements ( )
pure virtual

API for setting unchecked element values.

Implemented in vtkSMStringVectorProperty, vtkSMIdTypeVectorProperty, vtkSMIntVectorProperty, and vtkSMDoubleVectorProperty.

◆ SetNumberOfUncheckedElements()

virtual void vtkSMVectorProperty::SetNumberOfUncheckedElements ( unsigned int  num)
pure virtual

API for setting unchecked element values.

Implemented in vtkSMIntVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMStringVectorProperty.

◆ ClearUncheckedElements()

void vtkSMVectorProperty::ClearUncheckedElements ( )
overridepure virtual

API for setting unchecked element values.

Reimplemented from vtkSMProperty.

Implemented in vtkSMStringVectorProperty, vtkSMIdTypeVectorProperty, vtkSMDoubleVectorProperty, and vtkSMIntVectorProperty.

◆ GetRepeatCommand()

virtual int vtkSMVectorProperty::GetRepeatCommand ( )
virtual

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values.

For example, if RepeatCommand is true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 1 2 3 4 5 6, the resulting stream will have:

* * Invoke obj SetFoo 1 2
* * Invoke obj SetFoo 3 4
* * Invoke obj SetFoo 5 6
* 

◆ SetRepeatCommand()

virtual void vtkSMVectorProperty::SetRepeatCommand ( int  )
virtual

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values.

For example, if RepeatCommand is true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 1 2 3 4 5 6, the resulting stream will have:

* * Invoke obj SetFoo 1 2
* * Invoke obj SetFoo 3 4
* * Invoke obj SetFoo 5 6
* 

◆ RepeatCommandOn()

virtual void vtkSMVectorProperty::RepeatCommandOn ( )
virtual

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values.

For example, if RepeatCommand is true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 1 2 3 4 5 6, the resulting stream will have:

* * Invoke obj SetFoo 1 2
* * Invoke obj SetFoo 3 4
* * Invoke obj SetFoo 5 6
* 

◆ RepeatCommandOff()

virtual void vtkSMVectorProperty::RepeatCommandOff ( )
virtual

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values.

For example, if RepeatCommand is true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 1 2 3 4 5 6, the resulting stream will have:

* * Invoke obj SetFoo 1 2
* * Invoke obj SetFoo 3 4
* * Invoke obj SetFoo 5 6
* 

◆ GetNumberOfElementsPerCommand()

virtual int vtkSMVectorProperty::GetNumberOfElementsPerCommand ( )
virtual

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values.

For example, if RepeatCommand is true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 1 2 3 4 5 6, the resulting stream will have:

* * Invoke obj SetFoo 1 2
* * Invoke obj SetFoo 3 4
* * Invoke obj SetFoo 5 6
* 

◆ SetNumberOfElementsPerCommand()

virtual void vtkSMVectorProperty::SetNumberOfElementsPerCommand ( int  )
virtual

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values.

For example, if RepeatCommand is true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 1 2 3 4 5 6, the resulting stream will have:

* * Invoke obj SetFoo 1 2
* * Invoke obj SetFoo 3 4
* * Invoke obj SetFoo 5 6
* 

◆ GetUseIndex()

virtual int vtkSMVectorProperty::GetUseIndex ( )
virtual

If UseIndex and RepeatCommand are true, the property will add an index integer before each command.

For example, if UseIndex and RepeatCommand are true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 5 6 7 8 9 10, the resulting stream will have:

* * Invoke obj SetFoo 0 5 6
* * Invoke obj SetFoo 1 7 8
* * Invoke obj SetFoo 2 9 10
* 

◆ SetUseIndex()

virtual void vtkSMVectorProperty::SetUseIndex ( int  )
virtual

If UseIndex and RepeatCommand are true, the property will add an index integer before each command.

For example, if UseIndex and RepeatCommand are true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 5 6 7 8 9 10, the resulting stream will have:

* * Invoke obj SetFoo 0 5 6
* * Invoke obj SetFoo 1 7 8
* * Invoke obj SetFoo 2 9 10
* 

◆ UseIndexOn()

virtual void vtkSMVectorProperty::UseIndexOn ( )
virtual

If UseIndex and RepeatCommand are true, the property will add an index integer before each command.

For example, if UseIndex and RepeatCommand are true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 5 6 7 8 9 10, the resulting stream will have:

* * Invoke obj SetFoo 0 5 6
* * Invoke obj SetFoo 1 7 8
* * Invoke obj SetFoo 2 9 10
* 

◆ UseIndexOff()

virtual void vtkSMVectorProperty::UseIndexOff ( )
virtual

If UseIndex and RepeatCommand are true, the property will add an index integer before each command.

For example, if UseIndex and RepeatCommand are true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 5 6 7 8 9 10, the resulting stream will have:

* * Invoke obj SetFoo 0 5 6
* * Invoke obj SetFoo 1 7 8
* * Invoke obj SetFoo 2 9 10
* 

◆ SetCleanCommand()

virtual void vtkSMVectorProperty::SetCleanCommand ( const char *  )
virtual

Command that can be used to remove all values.

Typically used when RepeatCommand = 1. If set, the clean command is called before the main Command.

◆ GetCleanCommand()

virtual char* vtkSMVectorProperty::GetCleanCommand ( )
virtual

Command that can be used to remove all values.

Typically used when RepeatCommand = 1. If set, the clean command is called before the main Command.

◆ Copy()

void vtkSMVectorProperty::Copy ( vtkSMProperty src)
overridevirtual

Copy all property values.

Reimplemented from vtkSMProperty.

◆ SetSetNumberCommand()

virtual void vtkSMVectorProperty::SetSetNumberCommand ( const char *  )
virtual

If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter.

◆ GetSetNumberCommand()

virtual char* vtkSMVectorProperty::GetSetNumberCommand ( )
virtual

If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter.

◆ SetInitialString()

virtual void vtkSMVectorProperty::SetInitialString ( const char *  )
virtual

◆ GetInitialString()

virtual char* vtkSMVectorProperty::GetInitialString ( )
virtual

◆ ResetToDomainDefaults()

bool vtkSMVectorProperty::ResetToDomainDefaults ( bool  use_unchecked_values = false)
overridevirtual

Overridden to add support to load defaults from this->GetInformationProperty(), if one exists.

If the superclass (which checks for defaults from all domains) doesn't end up picking a default, as a last resort, we check if the property has a non-empty information_property. If so, we copy its values to this property as the default.

Reimplemented from vtkSMProperty.

◆ ReadXMLAttributes()

int vtkSMVectorProperty::ReadXMLAttributes ( vtkSMProxy parent,
vtkPVXMLElement element 
)
overrideprotectedvirtual

Set the appropriate ivars from the xml element.

Reimplemented from vtkSMProperty.

Member Data Documentation

◆ RepeatCommand

int vtkSMVectorProperty::RepeatCommand
protected

Definition at line 150 of file vtkSMVectorProperty.h.

◆ NumberOfElementsPerCommand

int vtkSMVectorProperty::NumberOfElementsPerCommand
protected

Definition at line 151 of file vtkSMVectorProperty.h.

◆ UseIndex

int vtkSMVectorProperty::UseIndex
protected

Definition at line 152 of file vtkSMVectorProperty.h.

◆ CleanCommand

char* vtkSMVectorProperty::CleanCommand
protected

Definition at line 154 of file vtkSMVectorProperty.h.

◆ SetNumberCommand

char* vtkSMVectorProperty::SetNumberCommand
protected

Definition at line 155 of file vtkSMVectorProperty.h.

◆ InitialString

char* vtkSMVectorProperty::InitialString
protected

Definition at line 156 of file vtkSMVectorProperty.h.


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