abstract superclass for all vector properties More...
#include <vtkSMVectorProperty.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual unsigned int | GetNumberOfElements ()=0 |
| virtual void | SetNumberOfElements (unsigned int num)=0 |
| virtual unsigned int | GetNumberOfUncheckedElements () |
| virtual void | SetNumberOfUncheckedElements (unsigned int num) |
| virtual void | Copy (vtkSMProperty *src) |
| virtual void | ClearUncheckedElements () |
| virtual void | SetInitialString (const char *) |
| virtual char * | GetInitialString () |
| 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 () |
| virtual void | SetSetNumberCommand (const char *) |
| virtual char * | GetSetNumberCommand () |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkSMVectorProperty * | SafeDownCast (vtkObject *o) |
Public Attributes | |
| char * | SetNumberCommand |
Protected Member Functions | |
| vtkSMVectorProperty () | |
| ~vtkSMVectorProperty () | |
| virtual int | LoadState (vtkPVXMLElement *element, vtkSMProxyLocator *loader) |
| virtual int | SetElementAsString (int idx, const char *value)=0 |
| virtual int | ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element) |
Protected Attributes | |
| int | RepeatCommand |
| int | NumberOfElementsPerCommand |
| int | UseIndex |
| char * | CleanCommand |
| char * | InitialString |
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
| virtual const char* vtkSMVectorProperty::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSMProperty.
Reimplemented in vtkSMStringVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMIntVectorProperty.
| static int vtkSMVectorProperty::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkSMProperty.
Reimplemented in vtkSMStringVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMIntVectorProperty.
| virtual int vtkSMVectorProperty::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkSMProperty.
Reimplemented in vtkSMStringVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMIntVectorProperty.
| static vtkSMVectorProperty* vtkSMVectorProperty::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSMProperty.
Reimplemented in vtkSMStringVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMIntVectorProperty.
| void vtkSMVectorProperty::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSMProperty.
Reimplemented in vtkSMStringVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMIntVectorProperty.
| virtual unsigned int vtkSMVectorProperty::GetNumberOfElements | ( | ) | [pure virtual] |
Returns the size of the vector.
Implemented in vtkSMStringVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMIntVectorProperty.
| virtual void vtkSMVectorProperty::SetNumberOfElements | ( | unsigned int | num | ) | [pure virtual] |
Sets the size of the vector.
Implemented in vtkSMStringVectorProperty, vtkSMDoubleVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMIntVectorProperty.
| virtual unsigned int vtkSMVectorProperty::GetNumberOfUncheckedElements | ( | ) | [inline, virtual] |
Reimplemented in vtkSMStringVectorProperty, vtkSMIntVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMDoubleVectorProperty.
Definition at line 42 of file vtkSMVectorProperty.h.
| virtual void vtkSMVectorProperty::SetNumberOfUncheckedElements | ( | unsigned int | num | ) | [inline, virtual] |
Reimplemented in vtkSMDoubleVectorProperty, vtkSMIntVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMStringVectorProperty.
Definition at line 43 of file vtkSMVectorProperty.h.
| 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, vtkSMIntVectorProperty, vtkSMIdTypeVectorProperty, and vtkSMStringVectorProperty.
| virtual void vtkSMVectorProperty::SetSetNumberCommand | ( | const char * | ) | [virtual] |
If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter.
| virtual char* vtkSMVectorProperty::GetSetNumberCommand | ( | ) | [virtual] |
If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter.
| virtual void vtkSMVectorProperty::ClearUncheckedElements | ( | ) | [virtual] |
Reimplemented in vtkSMDoubleVectorProperty, vtkSMIntVectorProperty, vtkSMStringVectorProperty, and vtkSMIdTypeVectorProperty.
| virtual void vtkSMVectorProperty::SetInitialString | ( | const char * | ) | [virtual] |
| virtual char* vtkSMVectorProperty::GetInitialString | ( | ) | [virtual] |
| virtual int vtkSMVectorProperty::LoadState | ( | vtkPVXMLElement * | element, |
| vtkSMProxyLocator * | loader | ||
| ) | [protected, virtual] |
Generic implementation that use SetElementAsString to push the value the property
Reimplemented from vtkSMProperty.
| virtual int vtkSMVectorProperty::SetElementAsString | ( | int | idx, |
| const char * | value | ||
| ) | [protected, pure virtual] |
Generic implementation that use SetElementAsString to push the value the property
Implemented in vtkSMDoubleVectorProperty, vtkSMIntVectorProperty, vtkSMStringVectorProperty, and vtkSMIdTypeVectorProperty.
| virtual int vtkSMVectorProperty::ReadXMLAttributes | ( | vtkSMProxy * | parent, |
| vtkPVXMLElement * | element | ||
| ) | [protected, virtual] |
Set the appropriate ivars from the xml element.
Reimplemented from vtkSMProperty.
Reimplemented in vtkSMDoubleVectorProperty, vtkSMIntVectorProperty, vtkSMStringVectorProperty, and vtkSMIdTypeVectorProperty.
Member Data Documentation
Definition at line 100 of file vtkSMVectorProperty.h.
int vtkSMVectorProperty::RepeatCommand [protected] |
Definition at line 119 of file vtkSMVectorProperty.h.
int vtkSMVectorProperty::NumberOfElementsPerCommand [protected] |
Definition at line 120 of file vtkSMVectorProperty.h.
int vtkSMVectorProperty::UseIndex [protected] |
Definition at line 121 of file vtkSMVectorProperty.h.
char* vtkSMVectorProperty::CleanCommand [protected] |
Definition at line 123 of file vtkSMVectorProperty.h.
char* vtkSMVectorProperty::InitialString [protected] |
Definition at line 125 of file vtkSMVectorProperty.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMVectorProperty.h
