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

vtkSMVectorProperty Class Reference

abstract superclass for all vector properties More...

#include <vtkSMVectorProperty.h>

Inheritance diagram for vtkSMVectorProperty:

Inheritance graph
[legend]
Collaboration diagram for vtkSMVectorProperty:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeRevisionMacro (vtkSMVectorProperty, vtkSMProperty)
void PrintSelf (ostream &os, vtkIndent indent)
virtual unsigned int GetNumberOfElements ()=0
virtual void SetNumberOfElements (unsigned int num)=0
virtual void Copy (vtkSMProperty *src)
virtual int GetRepeatCommand ()
virtual void SetRepeatCommand (int)
virtual void RepeatCommandOn ()
virtual void RepeatCommandOff ()
virtual int GetNumberOfElementsPerCommand ()
virtual void SetNumberOfElementsPerCommand (int)
virtual int GetUseIndex ()
virtual void SetUseIndex (int)
virtual void UseIndexOn ()
virtual void UseIndexOff ()
virtual void SetCleanCommand (const char *)
virtual char * GetCleanCommand ()

Protected Member Functions

 vtkSMVectorProperty ()
 ~vtkSMVectorProperty ()
virtual int ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element)

Protected Attributes

int RepeatCommand
int NumberOfElementsPerCommand
int UseIndex
char * CleanCommand

Detailed Description

abstract superclass for all vector properties

vtkSMVectorProperty defines an interface common to all vector properties as well as some common settings. A vector property contains a list of values passed to one or more invocations of a command. How the values are distributed to the different invocations is controlled by several parameters.

Definition at line 30 of file vtkSMVectorProperty.h.

Constructor & Destructor Documentation

vtkSMVectorProperty::vtkSMVectorProperty (   )  [protected]
 

vtkSMVectorProperty::~vtkSMVectorProperty (   )  [protected]
 

Member Function Documentation

vtkSMVectorProperty::vtkTypeRevisionMacro (  vtkSMVectorProperty  ,
vtkSMProperty 
) 
 

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

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, vtkSMIntVectorProperty, and vtkSMStringVectorProperty.

virtual unsigned int vtkSMVectorProperty::GetNumberOfElements (   )  [pure virtual]
 

Returns the size of the vector.

Implemented in vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, vtkSMIntVectorProperty, and vtkSMStringVectorProperty.

virtual void vtkSMVectorProperty::SetNumberOfElements (  unsigned int  num  )  [pure virtual]
 

Sets the size of the vector.

Implemented in vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, vtkSMIntVectorProperty, and vtkSMStringVectorProperty.

virtual int vtkSMVectorProperty::GetRepeatCommand (   )  [virtual]
 

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. 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 1 2 * Invoke obj SetFoo 3 4 *
      Invoke obj SetFoo 5 6

virtual void vtkSMVectorProperty::SetRepeatCommand (  int   )  [virtual]
 

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. 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 1 2 * Invoke obj SetFoo 3 4 *
      Invoke obj SetFoo 5 6

virtual void vtkSMVectorProperty::RepeatCommandOn (   )  [virtual]
 

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. 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 1 2 * Invoke obj SetFoo 3 4 *
      Invoke obj SetFoo 5 6

virtual void vtkSMVectorProperty::RepeatCommandOff (   )  [virtual]
 

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. 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 1 2 * Invoke obj SetFoo 3 4 *
      Invoke obj SetFoo 5 6

virtual int vtkSMVectorProperty::GetNumberOfElementsPerCommand (   )  [virtual]
 

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. 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 1 2 * Invoke obj SetFoo 3 4 *
      Invoke obj SetFoo 5 6

virtual void vtkSMVectorProperty::SetNumberOfElementsPerCommand (  int   )  [virtual]
 

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. 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 1 2 * Invoke obj SetFoo 3 4 *
      Invoke obj SetFoo 5 6

virtual int vtkSMVectorProperty::GetUseIndex (   )  [virtual]
 

If UseIndex and RepeatCommand are true, the property will add an index integer before each command. For example, if UseIndex and RepeatCommand are true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 5 6 7 8 9 10, the resulting stream will have: 

 * Invoke obj SetFoo 0 5 6 * Invoke obj SetFoo 1 7 8 *
      Invoke obj SetFoo 2 9 10

virtual void vtkSMVectorProperty::SetUseIndex (  int   )  [virtual]
 

If UseIndex and RepeatCommand are true, the property will add an index integer before each command. For example, if UseIndex and RepeatCommand are true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 5 6 7 8 9 10, the resulting stream will have: 

 * Invoke obj SetFoo 0 5 6 * Invoke obj SetFoo 1 7 8 *
      Invoke obj SetFoo 2 9 10

virtual void vtkSMVectorProperty::UseIndexOn (   )  [virtual]
 

If UseIndex and RepeatCommand are true, the property will add an index integer before each command. For example, if UseIndex and RepeatCommand are true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 5 6 7 8 9 10, the resulting stream will have: 

 * Invoke obj SetFoo 0 5 6 * Invoke obj SetFoo 1 7 8 *
      Invoke obj SetFoo 2 9 10

virtual void vtkSMVectorProperty::UseIndexOff (   )  [virtual]
 

If UseIndex and RepeatCommand are true, the property will add an index integer before each command. For example, if UseIndex and RepeatCommand are true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 5 6 7 8 9 10, the resulting stream will have: 

 * Invoke obj SetFoo 0 5 6 * Invoke obj SetFoo 1 7 8 *
      Invoke obj SetFoo 2 9 10

virtual void vtkSMVectorProperty::SetCleanCommand (  const char *   )  [virtual]
 

Command that can be used to remove all values. Typically used when RepeatCommand = 1. If set, the clean command is called before the main Command.

virtual char* vtkSMVectorProperty::GetCleanCommand (   )  [virtual]
 

Command that can be used to remove all values. Typically used when RepeatCommand = 1. If set, the clean command is called before the main Command.

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

Copy all property values.

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, vtkSMIntVectorProperty, and vtkSMStringVectorProperty.

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

Set the appropriate ivars from the xml element.

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, vtkSMIntVectorProperty, and vtkSMStringVectorProperty.

Member Data Documentation

int vtkSMVectorProperty::RepeatCommand [protected]
 

Definition at line 92 of file vtkSMVectorProperty.h.

int vtkSMVectorProperty::NumberOfElementsPerCommand [protected]
 

Definition at line 93 of file vtkSMVectorProperty.h.

int vtkSMVectorProperty::UseIndex [protected]
 

Definition at line 94 of file vtkSMVectorProperty.h.

char* vtkSMVectorProperty::CleanCommand [protected]
 

Definition at line 96 of file vtkSMVectorProperty.h.

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