represents the possible values a property can have More...

#include <vtkSMDomain.h>

Inheritance diagram for vtkSMDomain:

Collaboration diagram for vtkSMDomain:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	IsInDomain (vtkSMProperty *property)=0
virtual void	Update (vtkSMProperty *)
virtual void	SetAnimationValue (vtkSMProperty *, int, double)
virtual int	SetDefaultValues (vtkSMProperty *)
void	AddRequiredProperty (vtkSMProperty prop, const char function)

virtual char *	GetXMLName ()

virtual int	GetIsOptional ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkSMDomain *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMDomain ()
	~vtkSMDomain ()
virtual void	SaveState (vtkPVXMLElement parent, const char uid)
virtual void	ChildSaveState (vtkPVXMLElement *propertyElement)
virtual int	LoadState (vtkPVXMLElement vtkNotUsed(domainElement), vtkSMProxyLocator vtkNotUsed(loader))
vtkSMProperty *	GetRequiredProperty (const char *function)
void	RemoveRequiredProperty (vtkSMProperty *prop)
virtual int	ReadXMLAttributes (vtkSMProperty prop, vtkPVXMLElement elem)
void	InvokeModified ()

virtual void	SetXMLName (const char *)
Protected Attributes
char *	XMLName
vtkSMDomainInternals *	Internals
Friends
class	vtkSMProperty
int	IsOptional
virtual void	SetIsOptional (int)
unsigned int	GetNumberOfRequiredProperties ()

Detailed Description

represents the possible values a property can have

vtkSMDomain is an abstract class that describes the "domain" of a a widget. A domain is a collection of possible values a property can have. Each domain can depend on one or more properties to compute it's values. This are called "required" properties and can be set in the XML configuration file.

See also:: vtkSMProxyGroupDomain

Definition at line 41 of file vtkSMDomain.h.

Constructor & Destructor Documentation

vtkSMDomain::vtkSMDomain ( ) [protected]

vtkSMDomain::~vtkSMDomain ( ) [protected]

Member Function Documentation

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

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

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

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

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

virtual int vtkSMDomain::IsInDomain ( vtkSMProperty * property ) [pure virtual]

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

Implemented in vtkSMDoubleRangeDomain, vtkSMInputArrayDomain, vtkSMIntRangeDomain, vtkSMProxyListDomain, vtkSMDataTypeDomain, vtkSMProxyGroupDomain, vtkSMStringListRangeDomain, vtkSMEnumerationDomain, vtkSMNumberOfGroupsDomain, vtkSMStringListDomain, vtkSMFixedTypeDomain, and vtkSMBooleanDomain.

virtual void vtkSMDomain::Update ( vtkSMProperty * ) [inline, virtual]

Update self based on the "unchecked" values of all required properties. Overwritten by sub-classes.

Reimplemented in vtkSMIntRangeDomain, vtkSMDoubleRangeDomain, vtkSMEnumerationDomain, vtkSMArrayListDomain, vtkSMStringListDomain, vtkSMFieldDataDomain, vtkSMNumberOfGroupsDomain, vtkSMCompositeTreeDomain, vtkSMArrayRangeDomain, vtkSMNumberOfComponentsDomain, vtkSMDimensionsDomain, vtkSMBoundsDomain, vtkSMArraySelectionDomain, and vtkSMExtentDomain.

Definition at line 53 of file vtkSMDomain.h.

virtual void vtkSMDomain::SetAnimationValue	(	vtkSMProperty *	,
		int	,
		double
	)		`[inline, virtual]`

Set the value of an element of a property from the animation editor.

Reimplemented in vtkSMIntRangeDomain, vtkSMDoubleRangeDomain, vtkSMStringListRangeDomain, vtkSMStringListDomain, vtkSMExtentDomain, and vtkSMBooleanDomain.

Definition at line 56 of file vtkSMDomain.h.

virtual int vtkSMDomain::SetDefaultValues ( vtkSMProperty * ) [inline, 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. Default implementation does nothing.

Reimplemented in vtkSMIntRangeDomain, vtkSMArrayListDomain, vtkSMCompositeTreeDomain, vtkSMEnumerationDomain, vtkSMStringListDomain, vtkSMProxyListDomain, vtkSMFieldDataDomain, vtkSMExtentDomain, vtkSMArrayRangeDomain, vtkSMArraySelectionDomain, vtkSMBoundsDomain, and vtkSMFileListDomain.

Definition at line 65 of file vtkSMDomain.h.

virtual char* vtkSMDomain::GetXMLName ( ) [virtual]

Assigned by the XML parser. The name assigned in the XML configuration. Can be used to figure out the origin of the domain.

void vtkSMDomain::AddRequiredProperty	(	vtkSMProperty *	prop,
		const char *	function
	)

Add a new required property to this domain.

virtual int vtkSMDomain::GetIsOptional ( ) [virtual]

When the IsOptional flag is set, IsInDomain() always returns true. This is used by properties that use domains to provide information (a suggestion to the gui for example) as opposed to restrict their values.

virtual void vtkSMDomain::SaveState	(	vtkPVXMLElement *	parent,
		const char *	uid
	)		`[protected, virtual]`

virtual void vtkSMDomain::ChildSaveState ( vtkPVXMLElement * propertyElement ) [protected, virtual]

Reimplemented in vtkSMStringListRangeDomain, vtkSMInputArrayDomain, vtkSMEnumerationDomain, vtkSMProxyListDomain, vtkSMStringListDomain, and vtkSMNumberOfGroupsDomain.

virtual int vtkSMDomain::LoadState	(	vtkPVXMLElement *	vtkNotUseddomainElement,
		vtkSMProxyLocator *	vtkNotUsedloader
	)		`[inline, protected, virtual]`

Definition at line 92 of file vtkSMDomain.h.

vtkSMProperty* vtkSMDomain::GetRequiredProperty ( const char * function ) [protected]

Returns a given required property of the given function. Function is a string associated with the require property in the XML file.

void vtkSMDomain::RemoveRequiredProperty ( vtkSMProperty * prop ) [protected]

Remove the given property from the required properties list.

virtual int vtkSMDomain::ReadXMLAttributes	(	vtkSMProperty *	prop,
		vtkPVXMLElement *	elem
	)		`[protected, virtual]`

Set the appropriate ivars from the xml element. Should be overwritten by subclass if adding ivars.

Reimplemented in vtkSMArrayListDomain, vtkSMIntRangeDomain, vtkSMDoubleRangeDomain, vtkSMStringListRangeDomain, vtkSMInputArrayDomain, vtkSMCompositeTreeDomain, vtkSMEnumerationDomain, vtkSMBoundsDomain, vtkSMStringListDomain, vtkSMProxyListDomain, vtkSMProxyGroupDomain, vtkSMNumberOfGroupsDomain, vtkSMFieldDataDomain, vtkSMDataTypeDomain, and vtkSMSILDomain.

virtual void vtkSMDomain::SetIsOptional ( int ) [protected, virtual]

When the IsOptional flag is set, IsInDomain() always returns true. This is used by properties that use domains to provide information (a suggestion to the gui for example) as opposed to restrict their values.

virtual void vtkSMDomain::SetXMLName ( const char * ) [protected, virtual]

Assigned by the XML parser. The name assigned in the XML configuration. Can be used to figure out the origin of the domain.

void vtkSMDomain::InvokeModified ( ) [protected]

Invoked DomainModifiedEvent.

unsigned int vtkSMDomain::GetNumberOfRequiredProperties ( ) [protected]

Gets the number of required properties added.

Friends And Related Function Documentation

friend class vtkSMProperty [friend]

Definition at line 96 of file vtkSMDomain.h.

Member Data Documentation

int vtkSMDomain::IsOptional [protected]

When the IsOptional flag is set, IsInDomain() always returns true. This is used by properties that use domains to provide information (a suggestion to the gui for example) as opposed to restrict their values.

Definition at line 115 of file vtkSMDomain.h.

char* vtkSMDomain::XMLName [protected]

Definition at line 119 of file vtkSMDomain.h.

vtkSMDomainInternals* vtkSMDomain::Internals [protected]

Definition at line 124 of file vtkSMDomain.h.

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

dox/ParaViewCore/ServerManager/vtkSMDomain.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation