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

property representing a vector of integers More...

#include <vtkSMIdTypeVectorProperty.h>

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

Public Types

typedef vtkSMVectorProperty Superclass
 
- Public Types inherited from vtkSMVectorProperty
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
 
unsigned int GetNumberOfElements () override
 Returns the size of the vector. More...
 
void SetNumberOfElements (unsigned int num) override
 Sets the size of the vector. More...
 
int SetElement (unsigned int idx, vtkIdType value)
 Set the value of 1 element. More...
 
int SetElements1 (vtkIdType value0)
 Set the value of 1st element. More...
 
int SetElements2 (vtkIdType value0, vtkIdType value1)
 Set the values of the first 2 elements. More...
 
int SetElements3 (vtkIdType value0, vtkIdType value1, vtkIdType value2)
 Set the values of the first 3 elements. More...
 
int AppendElements (const vtkIdType *values, unsigned int numValues)
 Append the values. More...
 
int AppendUncheckedElements (const vtkIdType *values, unsigned int numValues)
 Append the values to the unchecked elements. More...
 
vtkIdType GetElement (unsigned int idx)
 Returns the value of 1 element. More...
 
vtkIdType GetUncheckedElement (unsigned int idx)
 Returns the value of 1 unchecked element. More...
 
void SetUncheckedElement (unsigned int idx, vtkIdType value)
 Set the value of 1 unchecked element. More...
 
unsigned int GetNumberOfUncheckedElements () override
 Returns the size of unchecked elements. More...
 
void Copy (vtkSMProperty *src) override
 Copy all property values. More...
 
void ClearUncheckedElements () override
 API for setting unchecked element values. More...
 
void ResetToXMLDefaults () override
 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...
 
int SetElements (const vtkIdType *values)
 Set the values of all elements. More...
 
int SetElements (const vtkIdType *values, unsigned int numValues)
 Set the values of all elements. More...
 
int SetUncheckedElements (const vtkIdType *values)
 Sets the values of all the unchecked elements. More...
 
int SetUncheckedElements (const vtkIdType *values, unsigned int numValues)
 Sets the values of all the unchecked elements. More...
 
const std::vector< vtkIdType > & GetElements () const
 Another API to access elements. More...
 
const std::vector< vtkIdType > & GetUncheckedElements () const
 Another API to access elements. More...
 
virtual int GetArgumentIsArray ()
 If ArgumentIsArray is true, multiple elements are passed in as array arguments. More...
 
virtual void SetArgumentIsArray (int)
 If ArgumentIsArray is true, multiple elements are passed in as array arguments. More...
 
virtual void ArgumentIsArrayOn ()
 If ArgumentIsArray is true, multiple elements are passed in as array arguments. More...
 
virtual void ArgumentIsArrayOff ()
 If ArgumentIsArray is true, multiple elements are passed in as array arguments. More...
 
- Public Member Functions inherited from vtkSMVectorProperty
void PrintSelf (ostream &os, vtkIndent indent) override
 
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 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...
 
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)
 Set/Get whether the property should ignore custom default settings. More...
 
virtual int GetNoCustomDefault ()
 Set/Get whether the property should ignore custom default settings. More...
 
virtual void SetPanelVisibility (const char *)
 Set/Get the panel visibility for the property. More...
 
virtual char * GetPanelVisibility ()
 Set/Get the panel visibility for the property. More...
 
virtual void SetPanelVisibilityDefaultForRepresentation (const char *)
 Set/Get the panel visibility to default if the current representation type matches representation. More...
 
virtual char * GetPanelVisibilityDefaultForRepresentation ()
 Set/Get the panel visibility to default if the current representation type matches representation. More...
 
virtual void SetPanelWidget (const char *)
 Set/Get the name of the custom panel widget to use for the property. More...
 
virtual char * GetPanelWidget ()
 Set/Get the name of the custom panel widget to use for the property. More...
 
virtual void SetDisableSubTrace (const char *)
 Set/Get the tracing of sub property of this property. More...
 
virtual char * GetDisableSubTrace ()
 Set/Get the tracing of sub property of this property. More...
 
virtual 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 vtkSMIdTypeVectorPropertyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMIdTypeVectorPropertySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMVectorProperty
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 std::string CreatePrettyLabel (const std::string &name)
 Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...
 
- Static Public Member Functions inherited from vtkObject
static 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

 vtkSMIdTypeVectorProperty ()
 
 ~vtkSMIdTypeVectorProperty () override
 
void WriteTo (vtkSMMessage *) override
 Let the property write its content into the stream. More...
 
void ReadFrom (const vtkSMMessage *, int msg_offset, vtkSMProxyLocator *) override
 Let the property read and set its content from the stream. More...
 
int ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element) override
 Set the appropriate ivars from the xml element. More...
 
void SetNumberOfUncheckedElements (unsigned int num) override
 Sets the size of unchecked elements. More...
 
int LoadState (vtkPVXMLElement *element, vtkSMProxyLocator *loader) override
 Load the XML state. More...
 
void SaveStateValues (vtkPVXMLElement *propElement) override
 This method must be overridden by concrete class in order to save the real property data. More...
 
- Protected Member Functions inherited from vtkSMVectorProperty
 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 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 SaveDomainState (vtkPVXMLElement *propertyElement, const char *uid)
 Save property domain. 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 ArgumentIsArray
 
- Protected Attributes inherited from vtkSMVectorProperty
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

property representing a vector of integers

vtkSMIdTypeVectorProperty is a concrete sub-class of vtkSMVectorProperty representing a vector of integers (vtkIdType, possibly 64 bit).

See also
vtkSMVectorProperty vtkSMDoubleVectorProperty vtkSMStringVectorProperty

Definition at line 23 of file vtkSMIdTypeVectorProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 27 of file vtkSMIdTypeVectorProperty.h.

Constructor & Destructor Documentation

◆ vtkSMIdTypeVectorProperty()

vtkSMIdTypeVectorProperty::vtkSMIdTypeVectorProperty ( )
protected

◆ ~vtkSMIdTypeVectorProperty()

vtkSMIdTypeVectorProperty::~vtkSMIdTypeVectorProperty ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMIdTypeVectorProperty* vtkSMIdTypeVectorProperty::New ( )
static

◆ GetClassName()

virtual const char* vtkSMIdTypeVectorProperty::GetClassName ( )
virtual

Reimplemented from vtkSMVectorProperty.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMVectorProperty.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkObject.

◆ GetNumberOfElements()

unsigned int vtkSMIdTypeVectorProperty::GetNumberOfElements ( )
overridevirtual

Returns the size of the vector.

Implements vtkSMVectorProperty.

◆ SetNumberOfElements()

void vtkSMIdTypeVectorProperty::SetNumberOfElements ( unsigned int  num)
overridevirtual

Sets the size of the vector.

If num is larger than the current number of elements, this may cause reallocation and copying.

Implements vtkSMVectorProperty.

◆ SetElement()

int vtkSMIdTypeVectorProperty::SetElement ( unsigned int  idx,
vtkIdType  value 
)

Set the value of 1 element.

The vector is resized as necessary. Returns 0 if Set fails either because the property is read only or the value is not in all domains. Returns 1 otherwise.

◆ SetElements() [1/2]

int vtkSMIdTypeVectorProperty::SetElements ( const vtkIdType values)

Set the values of all elements.

The size of the values array has to be equal or larger to the size of the vector. Returns 0 if Set fails either because the property is read only or one or more of the values is not in all domains. Returns 1 otherwise.

◆ SetElements() [2/2]

int vtkSMIdTypeVectorProperty::SetElements ( const vtkIdType values,
unsigned int  numValues 
)

Set the values of all elements.

The size of the values array has to be equal or larger to the size of the vector. Returns 0 if Set fails either because the property is read only or one or more of the values is not in all domains. Returns 1 otherwise.

◆ SetUncheckedElements() [1/2]

int vtkSMIdTypeVectorProperty::SetUncheckedElements ( const vtkIdType values)

Sets the values of all the unchecked elements.

◆ SetUncheckedElements() [2/2]

int vtkSMIdTypeVectorProperty::SetUncheckedElements ( const vtkIdType values,
unsigned int  numValues 
)

Sets the values of all the unchecked elements.

◆ SetElements1()

int vtkSMIdTypeVectorProperty::SetElements1 ( vtkIdType  value0)

Set the value of 1st element.

The vector is resized as necessary. Returns 0 if Set fails either because the property is read only or one or more of the values is not in all domains. Returns 1 otherwise.

◆ SetElements2()

int vtkSMIdTypeVectorProperty::SetElements2 ( vtkIdType  value0,
vtkIdType  value1 
)

Set the values of the first 2 elements.

The vector is resized as necessary. Returns 0 if Set fails either because the property is read only or one or more of the values is not in all domains. Returns 1 otherwise.

◆ SetElements3()

int vtkSMIdTypeVectorProperty::SetElements3 ( vtkIdType  value0,
vtkIdType  value1,
vtkIdType  value2 
)

Set the values of the first 3 elements.

The vector is resized as necessary. Returns 0 if Set fails either because the property is read only or one or more of the values is not in all domains. Returns 1 otherwise.

◆ AppendElements()

int vtkSMIdTypeVectorProperty::AppendElements ( const vtkIdType values,
unsigned int  numValues 
)

Append the values.

The vector is resized as necessary.

◆ AppendUncheckedElements()

int vtkSMIdTypeVectorProperty::AppendUncheckedElements ( const vtkIdType values,
unsigned int  numValues 
)

Append the values to the unchecked elements.

The vector is resized as necessary.

◆ GetElement()

vtkIdType vtkSMIdTypeVectorProperty::GetElement ( unsigned int  idx)

Returns the value of 1 element.

◆ GetUncheckedElement()

vtkIdType vtkSMIdTypeVectorProperty::GetUncheckedElement ( unsigned int  idx)

Returns the value of 1 unchecked element.

These are used by domains. SetElement() first sets the value of 1 unchecked element and then calls IsInDomain and updates the value of the corresponding element only if IsInDomain passes.

◆ SetUncheckedElement()

void vtkSMIdTypeVectorProperty::SetUncheckedElement ( unsigned int  idx,
vtkIdType  value 
)

Set the value of 1 unchecked element.

This can be used to check if a value is in all domains of the property. Call this and call IsInDomains().

◆ GetNumberOfUncheckedElements()

unsigned int vtkSMIdTypeVectorProperty::GetNumberOfUncheckedElements ( )
overridevirtual

Returns the size of unchecked elements.

Usually this is the same as the number of elements but can be different before a domain check is performed.

Implements vtkSMVectorProperty.

◆ GetElements()

const std::vector<vtkIdType>& vtkSMIdTypeVectorProperty::GetElements ( ) const

Another API to access elements.

◆ GetUncheckedElements()

const std::vector<vtkIdType>& vtkSMIdTypeVectorProperty::GetUncheckedElements ( ) const

Another API to access elements.

◆ GetArgumentIsArray()

virtual int vtkSMIdTypeVectorProperty::GetArgumentIsArray ( )
virtual

If ArgumentIsArray is true, multiple elements are passed in as array arguments.

For example, 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 array(1, 2)
* * Invoke obj SetFoo array(3, 4)
* * Invoke obj SetFoo array(5, 6)
* 

◆ SetArgumentIsArray()

virtual void vtkSMIdTypeVectorProperty::SetArgumentIsArray ( int  )
virtual

If ArgumentIsArray is true, multiple elements are passed in as array arguments.

For example, 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 array(1, 2)
* * Invoke obj SetFoo array(3, 4)
* * Invoke obj SetFoo array(5, 6)
* 

◆ ArgumentIsArrayOn()

virtual void vtkSMIdTypeVectorProperty::ArgumentIsArrayOn ( )
virtual

If ArgumentIsArray is true, multiple elements are passed in as array arguments.

For example, 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 array(1, 2)
* * Invoke obj SetFoo array(3, 4)
* * Invoke obj SetFoo array(5, 6)
* 

◆ ArgumentIsArrayOff()

virtual void vtkSMIdTypeVectorProperty::ArgumentIsArrayOff ( )
virtual

If ArgumentIsArray is true, multiple elements are passed in as array arguments.

For example, 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 array(1, 2)
* * Invoke obj SetFoo array(3, 4)
* * Invoke obj SetFoo array(5, 6)
* 

◆ Copy()

void vtkSMIdTypeVectorProperty::Copy ( vtkSMProperty src)
overridevirtual

Copy all property values.

Reimplemented from vtkSMProperty.

◆ ClearUncheckedElements()

void vtkSMIdTypeVectorProperty::ClearUncheckedElements ( )
overridevirtual

API for setting unchecked element values.

Implements vtkSMVectorProperty.

◆ ResetToXMLDefaults()

void vtkSMIdTypeVectorProperty::ResetToXMLDefaults ( )
overridevirtual

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

Reimplemented from vtkSMProperty.

◆ WriteTo()

void vtkSMIdTypeVectorProperty::WriteTo ( vtkSMMessage )
overrideprotectedvirtual

Let the property write its content into the stream.

Reimplemented from vtkSMProperty.

◆ ReadFrom()

void vtkSMIdTypeVectorProperty::ReadFrom ( const vtkSMMessage ,
int  msg_offset,
vtkSMProxyLocator  
)
overrideprotected

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

◆ ReadXMLAttributes()

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

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMProperty.

◆ SetNumberOfUncheckedElements()

void vtkSMIdTypeVectorProperty::SetNumberOfUncheckedElements ( unsigned int  num)
overrideprotectedvirtual

Sets the size of unchecked elements.

Usually this is the same as the number of elements but can be different before a domain check is performed.

Implements vtkSMVectorProperty.

◆ LoadState()

int vtkSMIdTypeVectorProperty::LoadState ( vtkPVXMLElement element,
vtkSMProxyLocator loader 
)
overrideprotectedvirtual

Load the XML state.

Reimplemented from vtkSMProperty.

◆ SaveStateValues()

void vtkSMIdTypeVectorProperty::SaveStateValues ( vtkPVXMLElement propertyElement)
overrideprotectedvirtual

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

Reimplemented from vtkSMProperty.

Member Data Documentation

◆ ArgumentIsArray

int vtkSMIdTypeVectorProperty::ArgumentIsArray
protected

Definition at line 185 of file vtkSMIdTypeVectorProperty.h.


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