Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkSMIntVectorProperty Class Reference

property representing a vector of integers More...

#include <vtkSMIntVectorProperty.h>

Inheritance diagram for vtkSMIntVectorProperty:

Inheritance graph
[legend]
Collaboration diagram for vtkSMIntVectorProperty:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeRevisionMacro (vtkSMIntVectorProperty, vtkSMVectorProperty)
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 SetElements (const int *values)
int * GetElements ()
virtual int GetArgumentIsArray ()
virtual void SetArgumentIsArray (int)
virtual void ArgumentIsArrayOn ()
virtual void ArgumentIsArrayOff ()

Static Public Member Functions

vtkSMIntVectorProperty * New ()

Protected Member Functions

 vtkSMIntVectorProperty ()
 ~vtkSMIntVectorProperty ()
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)

Protected Attributes

vtkSMIntVectorPropertyInternals * 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 33 of file vtkSMIntVectorProperty.h.

Constructor & Destructor Documentation

vtkSMIntVectorProperty::vtkSMIntVectorProperty (   )  [protected]
 

vtkSMIntVectorProperty::~vtkSMIntVectorProperty (   )  [protected]
 

Member Function Documentation

vtkSMIntVectorProperty* vtkSMIntVectorProperty::New (   )  [static]
 

Reimplemented from vtkSMProperty.

vtkSMIntVectorProperty::vtkTypeRevisionMacro (  vtkSMIntVectorProperty  ,
vtkSMVectorProperty 
) 
 

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

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

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.

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

Set the appropriate ivars from the xml element.

Reimplemented from vtkSMVectorProperty.

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

Save the state in XML.

Reimplemented from vtkSMProperty.

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.

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

Member Data Documentation

vtkSMIntVectorPropertyInternals* vtkSMIntVectorProperty::Internals [protected]
 

Definition at line 119 of file vtkSMIntVectorProperty.h.

int vtkSMIntVectorProperty::ArgumentIsArray [protected]
 

Definition at line 121 of file vtkSMIntVectorProperty.h.

The documentation for this class was generated from the following file:
Generated on Tue May 30 12:39:25 2006 for ParaView by doxygen 1.3.5