Abstract class for SIProperty that hold an array of values. More...

#include <vtkSIVectorProperty.h>

Inheritance diagram for vtkSIVectorProperty:

[legend]

Collaboration diagram for vtkSIVectorProperty:

[legend]

Public Types
typedef vtkSIProperty	Superclass

Public Types inherited from vtkSIProperty
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual char *	GetInitialString ()


virtual int	GetNumberOfElementsPerCommand ()
	If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...


virtual bool	GetUseIndex ()
	If UseIndex and RepeatCommand are true, the property will add an index integer before each command. More...


virtual char *	GetCleanCommand ()
	Command that can be used to remove all values. More...


virtual char *	GetSetNumberCommand ()
	If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter. More...

Public Member Functions inherited from vtkSIProperty
virtual char *	GetXMLName ()
	The name assigned by the xml parser. More...

virtual char *	GetCommand ()
	The command name used to set the value on the server object. More...

virtual bool	GetInformationOnly ()
	Is InformationOnly is set to true, this property is used to get information from server instead of setting values. More...

virtual bool	GetRepeatable ()
	If repeatable, a property can have 1 or more values of the same kind. More...

virtual void	SetIsInternal (bool)
	This ivar is configured when the xml file is read and is mainly useful to trigger a method call. More...

virtual bool	GetIsInternal ()
	This ivar is configured when the xml file is read and is mainly useful to trigger a method call. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkSIVectorProperty *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSIProperty
static vtkSIProperty *	New ()

static int	IsTypeOf (const char *type)

static vtkSIProperty *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSIVectorProperty ()

	~vtkSIVectorProperty () override

virtual void	SetCleanCommand (const char *)

virtual void	SetSetNumberCommand (const char *)

virtual void	SetInitialString (const char *)

bool	ReadXMLAttributes (vtkSIProxy proxyhelper, vtkPVXMLElement element) override
	Set the appropriate ivars from the xml element. More...

Protected Member Functions inherited from vtkSIProperty
	vtkSIProperty ()

	~vtkSIProperty () override

vtkSIObject *	GetSIObject (vtkTypeUInt32 globalid)
	Convenience method to obtain a vtkSIObject subclass given its global id. More...

virtual bool	Push (vtkSMMessage *, int)
	Push a new state to the underneath implementation. More...

virtual bool	Pull (vtkSMMessage *)
	Pull the current state of the underneath implementation. More...

virtual void	SetCommand (const char *)

virtual void	SetXMLName (const char *)

void	SaveValueToCache (vtkSMMessage *proxyStateUpdate, int offset)

bool	ProcessMessage (vtkClientServerStream &stream)
	Interprets the message. More...

const vtkClientServerStream &	GetLastResult ()
	Interprets the message. More...

vtkObjectBase *	GetVTKObject ()
	Interprets the message. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	SetNumberCommand

char *	CleanCommand

bool	UseIndex

int	NumberOfElementsPerCommand

char *	InitialString

Protected Attributes inherited from vtkSIProperty
char *	XMLName

char *	Command

bool	InformationOnly

bool	Repeatable

bool	IsInternal

vtkWeakPointer< vtkSIProxy >	SIProxyObject

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Abstract class for SIProperty that hold an array of values.

Define the array management API

Definition at line 16 of file vtkSIVectorProperty.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSIProperty vtkSIVectorProperty::Superclass

Definition at line 19 of file vtkSIVectorProperty.h.

Constructor & Destructor Documentation

◆ vtkSIVectorProperty()

vtkSIVectorProperty::vtkSIVectorProperty ( )

protected

◆ ~vtkSIVectorProperty()

vtkSIVectorProperty::~vtkSIVectorProperty ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkSIVectorProperty::GetClassName ( )

virtual

Reimplemented from vtkSIProperty.

Reimplemented in vtkSIDoubleVectorProperty, vtkSIIdTypeVectorProperty, vtkSIIntVectorProperty, vtkSIStringVectorProperty, and vtkSIVectorPropertyTemplate< T, force_idtype >.

◆ IsTypeOf()

static int vtkSIVectorProperty::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkSIVectorProperty::IsA ( const char * type )

virtual

Reimplemented from vtkSIProperty.

Reimplemented in vtkSIDoubleVectorProperty, vtkSIIdTypeVectorProperty, vtkSIIntVectorProperty, vtkSIStringVectorProperty, and vtkSIVectorPropertyTemplate< T, force_idtype >.

◆ SafeDownCast()

static vtkSIVectorProperty* vtkSIVectorProperty::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSIProperty.

Reimplemented in vtkSIVectorPropertyTemplate< T, force_idtype >.

◆ GetNumberOfElementsPerCommand()

virtual int vtkSIVectorProperty::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
*

◆ GetUseIndex()

virtual bool vtkSIVectorProperty::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
*

◆ GetCleanCommand()

virtual char* vtkSIVectorProperty::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.

◆ GetSetNumberCommand()

virtual char* vtkSIVectorProperty::GetSetNumberCommand ( )

virtual

If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter.

◆ GetInitialString()

virtual char* vtkSIVectorProperty::GetInitialString ( )

virtual

◆ SetCleanCommand()

virtual void vtkSIVectorProperty::SetCleanCommand ( const char * )

protectedvirtual

◆ SetSetNumberCommand()

virtual void vtkSIVectorProperty::SetSetNumberCommand ( const char * )

protectedvirtual

◆ SetInitialString()

virtual void vtkSIVectorProperty::SetInitialString ( const char * )

protectedvirtual

◆ ReadXMLAttributes()

bool vtkSIVectorProperty::ReadXMLAttributes	(	vtkSIProxy *	proxyhelper,
		vtkPVXMLElement *	element
	)

overrideprotectedvirtual

Set the appropriate ivars from the xml element.

Reimplemented from vtkSIProperty.

Reimplemented in vtkSIVectorPropertyTemplate< T, force_idtype >.

Member Data Documentation

◆ SetNumberCommand

char* vtkSIVectorProperty::SetNumberCommand

protected

Definition at line 78 of file vtkSIVectorProperty.h.

◆ CleanCommand

char* vtkSIVectorProperty::CleanCommand

protected

Definition at line 81 of file vtkSIVectorProperty.h.

◆ UseIndex

bool vtkSIVectorProperty::UseIndex

protected

Definition at line 82 of file vtkSIVectorProperty.h.

◆ NumberOfElementsPerCommand

int vtkSIVectorProperty::NumberOfElementsPerCommand

protected

Definition at line 83 of file vtkSIVectorProperty.h.

◆ InitialString

char* vtkSIVectorProperty::InitialString

protected

Definition at line 84 of file vtkSIVectorProperty.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSIVectorProperty.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSIVectorProperty()

◆ ~vtkSIVectorProperty()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetNumberOfElementsPerCommand()

◆ GetUseIndex()

◆ GetCleanCommand()

◆ GetSetNumberCommand()

◆ GetInitialString()

◆ SetCleanCommand()

◆ SetSetNumberCommand()

◆ SetInitialString()

◆ ReadXMLAttributes()

Member Data Documentation

◆ SetNumberCommand

◆ CleanCommand

◆ UseIndex

◆ NumberOfElementsPerCommand

◆ InitialString