domain used to restrict an vtkSMIntVectorProperty values to valid flat-index for a vtkCompositeDataSet. More...

#include <vtkSMCompositeTreeDomain.h>

Inheritance diagram for vtkSMCompositeTreeDomain:

Collaboration diagram for vtkSMCompositeTreeDomain:

Public Types
enum	{ ALL = 0, LEAVES = 1, NON_LEAVES = 2, NONE = 3 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Update (vtkSMProperty *input)
vtkSMSourceProxy *	GetSource ()
virtual int	IsInDomain (vtkSMProperty *vtkNotUsed(property))
virtual int	SetDefaultValues (vtkSMProperty *)

virtual vtkPVDataInformation *	GetInformation ()

virtual int	GetSourcePort ()

virtual int	GetMode ()
virtual void	SetMode (int)
Static Public Member Functions
static vtkSMCompositeTreeDomain *	New ()
static int	IsTypeOf (const char *type)
static vtkSMCompositeTreeDomain *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMCompositeTreeDomain ()
	~vtkSMCompositeTreeDomain ()
virtual int	ReadXMLAttributes (vtkSMProperty prop, vtkPVXMLElement element)
void	Update (vtkSMInputProperty *iproperty)
void	InvokeModifiedIfChanged ()
void	SetInformation (vtkPVDataInformation *)
Protected Attributes
vtkPVDataInformation *	Information
vtkTimeStamp	UpdateTime
vtkPVDataInformation *	LastInformation
vtkWeakPointer< vtkSMSourceProxy >	Source
int	Mode
int	SourcePort

Detailed Description

domain used to restrict an vtkSMIntVectorProperty values to valid flat-index for a vtkCompositeDataSet.

vtkSMCompositeTreeDomain can be added to a vtkSMIntVectorProperty. This domain requires a vtkSMInputProperty which is used to provide the input to the filter. This domain obtains data information from the input selected on the required input property and then decides the range for the flat-index. A flat index for a tree is obtained by performing a pre-order traversal of the tree eg. A ( B ( D, E), C (F, G)) becomes: [A,B,D,E,C,F,G], so flat-index of A is 0, while flat-index of C is 4.

Definition at line 40 of file vtkSMCompositeTreeDomain.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

ALL
LEAVES
NON_LEAVES
NONE

Definition at line 83 of file vtkSMCompositeTreeDomain.h.

Constructor & Destructor Documentation

vtkSMCompositeTreeDomain::vtkSMCompositeTreeDomain ( ) [protected]

vtkSMCompositeTreeDomain::~vtkSMCompositeTreeDomain ( ) [protected]

Member Function Documentation

static vtkSMCompositeTreeDomain* vtkSMCompositeTreeDomain::New ( ) [static]

Reimplemented from vtkSMSessionObject.

virtual const char* vtkSMCompositeTreeDomain::GetClassName ( ) [virtual]

Reimplemented from vtkSMDomain.

static int vtkSMCompositeTreeDomain::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkSMDomain.

virtual int vtkSMCompositeTreeDomain::IsA ( const char * type ) [virtual]

Reimplemented from vtkSMDomain.

static vtkSMCompositeTreeDomain* vtkSMCompositeTreeDomain::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkSMDomain.

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

Reimplemented from vtkSMDomain.

virtual void vtkSMCompositeTreeDomain::Update ( vtkSMProperty * input ) [virtual]

Called when the 'required-property' is modified. The property must be a vtkSMInputProperty. This will obtain the composite data information for the input source and then determine the valid range for the flat-index.

Reimplemented from vtkSMDomain.

virtual vtkPVDataInformation* vtkSMCompositeTreeDomain::GetInformation ( ) [virtual]

Get the vtkPVDataInformation which provides the tree structure for the composite dataset.

vtkSMSourceProxy* vtkSMCompositeTreeDomain::GetSource ( )

Returns the source proxy whose data information is returned by GetInformation().

virtual int vtkSMCompositeTreeDomain::GetSourcePort ( ) [virtual]

Returns the port for the source proxy from which the data information is obtained by GetInformation().

virtual int vtkSMCompositeTreeDomain::IsInDomain ( vtkSMProperty * vtkNotUsedproperty ) [inline, virtual]

Is the (unchecked) value of the property in the domain? Overwritten by sub-classes.

Definition at line 71 of file vtkSMCompositeTreeDomain.h.

virtual int vtkSMCompositeTreeDomain::GetMode ( ) [virtual]

Mode indicates if the property is interested in all nodes, leaves only or non-leaves only. Can be configured in XML using the "mode" attribute. Values can be "all", "leaves", "non-leaves". Default is all nodes.

virtual void vtkSMCompositeTreeDomain::SetMode ( int ) [virtual]

Mode indicates if the property is interested in all nodes, leaves only or non-leaves only. Can be configured in XML using the "mode" attribute. Values can be "all", "leaves", "non-leaves". Default is all nodes.

virtual int vtkSMCompositeTreeDomain::SetDefaultValues ( vtkSMProperty * ) [virtual]

A vtkSMProperty is often defined with a default value in the XML itself. However, many times, the default value must be determined at run time. To facilitate this, domains can override this method to compute and set the default value for the property. Note that unlike the compile-time default values, the application must explicitly call this method to initialize the property. Returns 1 if the domain updated the property.

Reimplemented from vtkSMDomain.