ParaView
|
abstract superclass for all vector properties More...
#include <vtkSMVectorProperty.h>
Public Types | |
typedef vtkSMProperty | Superclass |
![]() | |
typedef vtkSMObject | Superclass |
![]() | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
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... | |
virtual void | Copy (vtkSMProperty *src) |
Copy all property values. More... | |
virtual void | SetInitialString (const char *) |
virtual char * | GetInitialString () |
virtual bool | ResetToDomainDefaults (bool use_unchecked_values=false) |
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... | |
virtual void | ClearUncheckedElements ()=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... | |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
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... | |
virtual void | UnRegister (vtkObjectBase *obj) |
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... | |
unsigned int | GetNumberOfDomains () |
Returns the number of domains this property has. More... | |
void | UpdateDependentDomains () |
Calls Update() on all domains contained by the property as well as all dependant domains. 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... | |
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 | 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 beeing 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) |
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 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... | |
virtual void | Modified () |
Overridden to support blocking of modified events. More... | |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkSMVectorProperty * | SafeDownCast (vtkObject *o) |
![]() | |
static vtkSMProperty * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMProperty * | SafeDownCast (vtkObject *o) |
![]() | |
static vtkSMObject * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMObject * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
vtkSMVectorProperty () | |
~vtkSMVectorProperty () | |
virtual int | ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element) |
Set the appropriate ivars from the xml element. More... | |
![]() | |
vtkSMProperty () | |
~vtkSMProperty () | |
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... | |
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 dependant 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 overiden 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... | |
![]() | |
vtkSMObject () | |
~vtkSMObject () | |
Protected Attributes | |
int | RepeatCommand |
int | NumberOfElementsPerCommand |
int | UseIndex |
char * | CleanCommand |
char * | SetNumberCommand |
char * | InitialString |
![]() | |
vtkPVXMLElement * | Hints |
char * | Command |
vtkSMPropertyInternals * | PInternals |
int | ImmediateUpdate |
int | Animateable |
int | IsInternal |
int | NoCustomDefault |
char * | XMLName |
char * | XMLLabel |
char * | PanelVisibility |
char * | PanelVisibilityDefaultForRepresentation |
char * | PanelWidget |
vtkSMDomainIterator * | DomainIterator |
int | InformationOnly |
int | IgnoreSynchronization |
vtkSMInformationHelper * | InformationHelper |
vtkSMProperty * | InformationProperty |
vtkSMDocumentation * | Documentation |
int | Repeatable |
vtkWeakPointer< vtkSMProxy > | Proxy |
bool | StateIgnored |
vtkSMPropertyLink * | Links |
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.
Definition at line 35 of file vtkSMVectorProperty.h.
|
protected |
|
protected |
|
virtual |
Reimplemented from vtkSMProperty.
Reimplemented in vtkSMStringVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMIntVectorProperty.
|
static |
|
virtual |
Reimplemented from vtkSMProperty.
Reimplemented in vtkSMStringVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMIntVectorProperty.
|
static |
void vtkSMVectorProperty::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
pure virtual |
Returns the size of the vector.
Implemented in vtkSMStringVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMIntVectorProperty.
|
pure virtual |
Sets the size of the vector.
Implemented in vtkSMStringVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMIntVectorProperty.
|
pure virtual |
API for setting unchecked element values.
Implemented in vtkSMStringVectorProperty, vtkSMIntVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMDoubleVectorProperty.
|
pure virtual |
API for setting unchecked element values.
Implemented in vtkSMDoubleVectorProperty, vtkSMIntVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMStringVectorProperty.
|
pure virtual |
API for setting unchecked element values.
Reimplemented from vtkSMProperty.
Implemented in vtkSMDoubleVectorProperty, vtkSMStringVectorProperty, vtkSMIntVectorProperty, and vtkSMIdTypeVectorProperty.
|
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 *
|
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 *
|
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 *
|
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 *
|
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 *
|
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 *
|
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 *
|
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 *
|
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 *
|
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 *
|
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.
|
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.
|
virtual |
Copy all property values.
Reimplemented from vtkSMProperty.
Reimplemented in vtkSMDoubleVectorProperty, vtkSMStringVectorProperty, vtkSMIntVectorProperty, and vtkSMIdTypeVectorProperty.
|
virtual |
If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter.
|
virtual |
If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter.
|
virtual |
|
virtual |
|
virtual |
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.
|
protectedvirtual |
Set the appropriate ivars from the xml element.
Reimplemented from vtkSMProperty.
Reimplemented in vtkSMDoubleVectorProperty, vtkSMStringVectorProperty, vtkSMIntVectorProperty, and vtkSMIdTypeVectorProperty.
|
protected |
Definition at line 150 of file vtkSMVectorProperty.h.
|
protected |
Definition at line 151 of file vtkSMVectorProperty.h.
|
protected |
Definition at line 152 of file vtkSMVectorProperty.h.
|
protected |
Definition at line 154 of file vtkSMVectorProperty.h.
|
protected |
Definition at line 155 of file vtkSMVectorProperty.h.
|
protected |
Definition at line 156 of file vtkSMVectorProperty.h.