vtkSMIntVectorProperty Class Reference

property representing a vector of integers More...

#include <vtkSMIntVectorProperty.h>

Inheritance diagram for vtkSMIntVectorProperty:

Collaboration diagram for vtkSMIntVectorProperty:

List of all members.

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, int value)
int	SetElements1 (int value0)
int	SetElements2 (int value0, int value1)
int	SetElements3 (int value0, int value1, int value2)
int	GetElement (unsigned int idx)
int	GetUncheckedElement (unsigned int idx)
void	SetUncheckedElement (unsigned int idx, int value)
virtual unsigned int	GetNumberOfUncheckedElements ()
virtual void	Copy (vtkSMProperty *src)
int	GetDefaultValue (int idx)
virtual void	ClearUncheckedElements ()
int	SetElements (const int *values)
int	SetElements (const int *values, unsigned int numElems)
int *	GetElements ()
int	SetUncheckedElements (const int *values)
int	SetUncheckedElements (const int *values, unsigned int numValues)
virtual int	GetArgumentIsArray ()
virtual void	SetArgumentIsArray (int)
virtual void	ArgumentIsArrayOn ()
virtual void	ArgumentIsArrayOff ()
Static Public Member Functions
static vtkSMIntVectorProperty *	New ()
static int	IsTypeOf (const char *type)
static vtkSMIntVectorProperty *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMIntVectorProperty ()
	~vtkSMIntVectorProperty ()
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
vtkInternals *	Internals
int	ArgumentIsArray

---

Detailed Description

property representing a vector of integers

vtkSMIntVectorProperty is a concrete sub-class of vtkSMVectorProperty representing a vector of integers.

See also:

vtkSMVectorProperty vtkSMDoubleVectorProperty vtkSMStringVectorProperty

Definition at line 31 of file vtkSMIntVectorProperty.h.

---

Constructor & Destructor Documentation

vtkSMIntVectorProperty::vtkSMIntVectorProperty

(

)

[protected]

vtkSMIntVectorProperty::~vtkSMIntVectorProperty

(

)

[protected]

---

Member Function Documentation

static vtkSMIntVectorProperty* vtkSMIntVectorProperty::New

(

)

[static]

Reimplemented from vtkSMProperty.

virtual const char* vtkSMIntVectorProperty::GetClassName

(

)

[virtual]

Reimplemented from vtkSMVectorProperty.

static int vtkSMIntVectorProperty::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkSMVectorProperty.

virtual int vtkSMIntVectorProperty::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkSMVectorProperty.

static vtkSMIntVectorProperty* vtkSMIntVectorProperty::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkSMVectorProperty.

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

Reimplemented from vtkSMVectorProperty.

virtual unsigned int vtkSMIntVectorProperty::GetNumberOfElements

(

)

[virtual]

Returns the size of the vector.

Implements vtkSMVectorProperty.

virtual void vtkSMIntVectorProperty::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 vtkSMIntVectorProperty::SetElement	(	unsigned int	idx,
		int	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 vtkSMIntVectorProperty::SetElements

(

const int *

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 vtkSMIntVectorProperty::SetElements	(	const int *	values,
		unsigned int	numElems
	)

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* vtkSMIntVectorProperty::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 vtkSMIntVectorProperty::SetUncheckedElements

(

const int *

values

)

Sets the values of all the unchecked elements.

int vtkSMIntVectorProperty::SetUncheckedElements	(	const int *	values,
		unsigned int	numValues
	)

Sets the values of all the unchecked elements.

int vtkSMIntVectorProperty::SetElements1

(

int

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 vtkSMIntVectorProperty::SetElements2	(	int	value0,
		int	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 vtkSMIntVectorProperty::SetElements3	(	int	value0,
		int	value1,
		int	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 vtkSMIntVectorProperty::GetElement

(

unsigned int

idx

)

Returns the value of 1 element.

int vtkSMIntVectorProperty::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 vtkSMIntVectorProperty::SetUncheckedElement	(	unsigned int	idx,
		int	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 unsigned int vtkSMIntVectorProperty::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.

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

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

virtual void vtkSMIntVectorProperty::Copy

(

vtkSMProperty *

src

)

[virtual]

Copy all property values.

Reimplemented from vtkSMVectorProperty.

int vtkSMIntVectorProperty::GetDefaultValue

(

int

idx

)

Returns the default value, if any, specified in the XML.

virtual void vtkSMIntVectorProperty::ClearUncheckedElements

(

)

[virtual]

Reimplemented from vtkSMVectorProperty.

virtual void vtkSMIntVectorProperty::WriteTo

(

vtkSMMessage *

)

[protected, virtual]

Let the property write its content into the stream

Reimplemented from vtkSMProperty.

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

Let the property read and set its content from the stream

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

Set the appropriate ivars from the xml element.

Reimplemented from vtkSMVectorProperty.

virtual void vtkSMIntVectorProperty::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 vtkSMIntVectorProperty::ResetToDefaultInternal

(

)

[protected, virtual]

Reimplemented from vtkSMProperty.

virtual void vtkSMIntVectorProperty::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 vtkSMIntVectorProperty::SetElementAsString	(	int	idx,
		const char *	value
	)		[protected, virtual]

Generic implementation that use SetElementAsString to push the value the property

Implements vtkSMVectorProperty.

---

Member Data Documentation

vtkInternals* vtkSMIntVectorProperty::Internals [protected]

Definition at line 137 of file vtkSMIntVectorProperty.h.

int vtkSMIntVectorProperty::ArgumentIsArray [protected]

Definition at line 140 of file vtkSMIntVectorProperty.h.

---

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

• dox/ParaViewCore/ServerManager/vtkSMIntVectorProperty.h