vtkSMDoubleVectorProperty Class Reference

property representing a vector of doubles More...

#include <vtkSMDoubleVectorProperty.h>

Inheritance diagram for vtkSMDoubleVectorProperty:

[legend]Collaboration diagram for vtkSMDoubleVectorProperty:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkSMDoubleVectorProperty, vtkSMVectorProperty)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual unsigned int	GetNumberOfElements ()
virtual void	SetNumberOfElements (unsigned int num)
int	SetElement (unsigned int idx, double value)
int	SetElements1 (double value0)
int	SetElements2 (double value0, double value1)
int	SetElements3 (double value0, double value1, double value2)
int	SetElements4 (double value0, double value1, double value2, double value3)
double	GetElement (unsigned int idx)
virtual unsigned int	GetNumberOfUncheckedElements ()
double	GetUncheckedElement (unsigned int idx)
void	SetUncheckedElement (unsigned int idx, double value)
virtual void	Copy (vtkSMProperty *src)
int	SetElements (const double *values)
double *	GetElements ()
virtual int	GetArgumentIsArray ()
virtual void	SetArgumentIsArray (int)
Static Public Member Functions
vtkSMDoubleVectorProperty *	New ()
Protected Member Functions
	vtkSMDoubleVectorProperty ()
	~vtkSMDoubleVectorProperty ()
virtual int	ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element)
virtual void	SaveState (const char *name, ostream *file, vtkIndent indent)
virtual void	SetNumberOfUncheckedElements (unsigned int num)
virtual void	AppendCommandToStream (vtkSMProxy *, vtkClientServerStream *stream, vtkClientServerID objectId)
virtual void	SetSetNumberCommand (const char *)
virtual char *	GetSetNumberCommand ()
Protected Attributes
vtkSMDoubleVectorPropertyInternals *	Internals
int	ArgumentIsArray
char *	SetNumberCommand

---

Detailed Description

property representing a vector of doubles

vtkSMDoubleVectorProperty is a concrete sub-class of vtkSMVectorProperty representing a vector of doubles.

See also:

vtkSMVectorProperty vtkSMIntVectorProperty vtkSMStringVectorProperty

Definition at line 33 of file vtkSMDoubleVectorProperty.h.

---

Constructor & Destructor Documentation

vtkSMDoubleVectorProperty::vtkSMDoubleVectorProperty (   )  [protected]

vtkSMDoubleVectorProperty::~vtkSMDoubleVectorProperty (   )  [protected]

---

Member Function Documentation

vtkSMDoubleVectorProperty* vtkSMDoubleVectorProperty::New (   )  [static]

Reimplemented from vtkSMProperty.

vtkSMDoubleVectorProperty::vtkTypeRevisionMacro (  vtkSMDoubleVectorProperty  , vtkSMVectorProperty  )

void vtkSMDoubleVectorProperty::PrintSelf (  ostream &  os, vtkIndent  indent )

Reimplemented from vtkSMVectorProperty.

virtual unsigned int vtkSMDoubleVectorProperty::GetNumberOfElements (   )  [virtual]

Returns the size of the vector. Implements vtkSMVectorProperty.

virtual void vtkSMDoubleVectorProperty::SetNumberOfElements (  unsigned int  num  )  [virtual]

Sets the size of the vector. If num is larger than the current number of elements, this may cause reallocation and copying. Implements vtkSMVectorProperty.

int vtkSMDoubleVectorProperty::SetElement (  unsigned int  idx, double  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.

int vtkSMDoubleVectorProperty::SetElements (  const double *  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.

double* vtkSMDoubleVectorProperty::GetElements (   )

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.

int vtkSMDoubleVectorProperty::SetElements1 (  double  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.

int vtkSMDoubleVectorProperty::SetElements2 (  double  value0, double  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.

int vtkSMDoubleVectorProperty::SetElements3 (  double  value0, double  value1, double  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.

int vtkSMDoubleVectorProperty::SetElements4 (  double  value0, double  value1, double  value2, double  value3 )

Set the values of the first 4 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.

double vtkSMDoubleVectorProperty::GetElement (  unsigned int  idx  )

Returns the value of 1 element.

virtual unsigned int vtkSMDoubleVectorProperty::GetNumberOfUncheckedElements (   )  [virtual]

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.

double vtkSMDoubleVectorProperty::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.

void vtkSMDoubleVectorProperty::SetUncheckedElement (  unsigned int  idx, double  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().

virtual int vtkSMDoubleVectorProperty::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)

virtual void vtkSMDoubleVectorProperty::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)

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

Copy all property values. Reimplemented from vtkSMVectorProperty.

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

Set the appropriate ivars from the xml element. Reimplemented from vtkSMVectorProperty.

virtual void vtkSMDoubleVectorProperty::AppendCommandToStream (  vtkSMProxy *  , vtkClientServerStream *  stream, vtkClientServerID  objectId )  [protected, virtual]

Append a command to update the vtk object with the property values(s). The proxy objects create a stream by calling this method on all the modified properties. Reimplemented from vtkSMProperty.

virtual void vtkSMDoubleVectorProperty::SaveState (  const char *  name, ostream *  file, vtkIndent  indent )  [protected, virtual]

Save the state in XML. Reimplemented from vtkSMProperty.

virtual void vtkSMDoubleVectorProperty::SetNumberOfUncheckedElements (  unsigned int  num  )  [protected, virtual]

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.

virtual void vtkSMDoubleVectorProperty::SetSetNumberCommand (  const char *   )  [protected, virtual]

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

virtual char* vtkSMDoubleVectorProperty::GetSetNumberCommand (   )  [protected, virtual]

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

---

Member Data Documentation

vtkSMDoubleVectorPropertyInternals* vtkSMDoubleVectorProperty::Internals [protected]

Definition at line 134 of file vtkSMDoubleVectorProperty.h.

int vtkSMDoubleVectorProperty::ArgumentIsArray [protected]

Definition at line 136 of file vtkSMDoubleVectorProperty.h.

char* vtkSMDoubleVectorProperty::SetNumberCommand [protected]

Definition at line 152 of file vtkSMDoubleVectorProperty.h.

---

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

• Servers/ServerManager/vtkSMDoubleVectorProperty.h

---