property representing a vector of doubles More...

#include <vtkSMDoubleVectorProperty.h>

Inheritance diagram for vtkSMDoubleVectorProperty:

Collaboration diagram for vtkSMDoubleVectorProperty:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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)
virtual void	ClearUncheckedElements ()

int	SetElements (const double *values)
int	SetElements (const double *values, unsigned int numValues)
double *	GetElements ()

int	SetUncheckedElements (const double *values)
int	SetUncheckedElements (const double *values, unsigned int numValues)

virtual int	GetArgumentIsArray ()
virtual void	SetArgumentIsArray (int)

virtual void	SetPrecision (int)
virtual int	GetPrecision ()
Static Public Member Functions
static vtkSMDoubleVectorProperty *	New ()
static int	IsTypeOf (const char *type)
static vtkSMDoubleVectorProperty *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMDoubleVectorProperty ()
	~vtkSMDoubleVectorProperty ()
virtual void	WriteTo (vtkSMMessage *)
virtual void	ReadFrom (const vtkSMMessage , int msg_offset, vtkSMProxyLocator )
virtual int	ReadXMLAttributes (vtkSMProxy parent, vtkPVXMLElement element)
virtual void	SetNumberOfUncheckedElements (unsigned int num)
virtual void	ResetToDefaultInternal ()
virtual void	SaveStateValues (vtkPVXMLElement *propElement)
virtual int	SetElementAsString (int idx, const char *value)
Protected Attributes
int	Precision
int	ArgumentIsArray
Friends
class	vtkSMRenderViewProxy

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 31 of file vtkSMDoubleVectorProperty.h.

Constructor & Destructor Documentation

vtkSMDoubleVectorProperty::vtkSMDoubleVectorProperty ( ) [protected]

vtkSMDoubleVectorProperty::~vtkSMDoubleVectorProperty ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkSMProperty.

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

Reimplemented from vtkSMVectorProperty.

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

Reimplemented from vtkSMVectorProperty.

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

Reimplemented from vtkSMVectorProperty.

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

Reimplemented from vtkSMVectorProperty.

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

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.

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

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::SetUncheckedElements ( const double * values )

Sets the values of all the unchecked elements.

int vtkSMDoubleVectorProperty::SetUncheckedElements	(	const double *	values,
		unsigned int	numValues
	)

Sets the values of all the unchecked elements.

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.

Reimplemented from vtkSMVectorProperty.

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::SetPrecision ( int ) [virtual]

Get/Set the precision to use while saving the state for this property. If 0 (or negative), then default ostream precision will be used. Precision can be defined in ServerManager configuration XML using the attribute "precision".

virtual int vtkSMDoubleVectorProperty::GetPrecision ( ) [virtual]

Get/Set the precision to use while saving the state for this property. If 0 (or negative), then default ostream precision will be used. Precision can be defined in ServerManager configuration XML using the attribute "precision".

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

Copy all property values.

Reimplemented from vtkSMVectorProperty.

virtual void vtkSMDoubleVectorProperty::ClearUncheckedElements ( ) [virtual]

Reimplemented from vtkSMVectorProperty.

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

Let the property write its content into the stream

Reimplemented from vtkSMProperty.

virtual void vtkSMDoubleVectorProperty::ReadFrom	(	const vtkSMMessage *	,
		int	msg_offset,
		vtkSMProxyLocator *
	)		`[protected, virtual]`

Let the property read and set its content from the stream

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

Set the appropriate ivars from the xml element.

Reimplemented from vtkSMVectorProperty.

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.

Reimplemented from vtkSMVectorProperty.

virtual void vtkSMDoubleVectorProperty::ResetToDefaultInternal ( ) [protected, virtual]

Reimplemented from vtkSMProperty.

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

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

Reimplemented from vtkSMProperty.

virtual int vtkSMDoubleVectorProperty::SetElementAsString	(	int	idx,
		const char *	value
	)		`[protected, virtual]`

Generic implementation that use SetElementAsString to push the value the property

Implements vtkSMVectorProperty.

Friends And Related Function Documentation

friend class vtkSMRenderViewProxy [friend]

Definition at line 139 of file vtkSMDoubleVectorProperty.h.

Member Data Documentation

int vtkSMDoubleVectorProperty::Precision [protected]

Definition at line 150 of file vtkSMDoubleVectorProperty.h.

int vtkSMDoubleVectorProperty::ArgumentIsArray [protected]

Definition at line 151 of file vtkSMDoubleVectorProperty.h.

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

dox/ParaViewCore/ServerManager/vtkSMDoubleVectorProperty.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation