vtkSMDomain Class Reference

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

#include <vtkSMDomain.h>

Inheritance diagram for vtkSMDomain:

[legend]Collaboration diagram for vtkSMDomain:

[legend]List of all members.

[NOHEADER]
virtual void	SetIsOptional (int)
virtual int	GetIsOptional ()
int	IsOptional
Public Member Functions
	vtkTypeRevisionMacro (vtkSMDomain, vtkSMObject)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	IsInDomain (vtkSMProperty *property)=0
virtual void	Update (vtkSMProperty *)
virtual void	SetAnimationValue (vtkSMProperty *, int, double)
void	AddRequiredProperty (vtkSMProperty *prop, const char *function)
virtual char *	GetXMLName ()
Protected Member Functions
	vtkSMDomain ()
	~vtkSMDomain ()
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

---

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 40 of file vtkSMDomain.h.

---

Constructor & Destructor Documentation

vtkSMDomain::vtkSMDomain (   )  [protected]

vtkSMDomain::~vtkSMDomain (   )  [protected]

---

Member Function Documentation

vtkSMDomain::vtkTypeRevisionMacro (  vtkSMDomain  , vtkSMObject  )

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

Reimplemented from vtkSMObject. Reimplemented in vtkSMArrayListDomain, vtkSMArrayRangeDomain, vtkSMArraySelectionDomain, vtkSMBooleanDomain, vtkSMBoundsDomain, vtkSMDataTypeDomain, vtkSMDoubleRangeDomain, vtkSMEnumerationDomain, vtkSMExtentDomain, vtkSMFieldDataDomain, vtkSMFixedTypeDomain, vtkSMInputArrayDomain, vtkSMIntRangeDomain, vtkSMNumberOfGroupsDomain, vtkSMNumberOfPartsDomain, vtkSMProxyGroupDomain, vtkSMStringListDomain, vtkSMStringListRangeDomain, and vtkSMXDMFPropertyDomain.

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

Is the (unchecked) value of the property in the domain? Overwritten by sub-classes. Implemented in vtkSMBooleanDomain, vtkSMDataTypeDomain, vtkSMDoubleRangeDomain, vtkSMEnumerationDomain, vtkSMFixedTypeDomain, vtkSMInputArrayDomain, vtkSMIntRangeDomain, vtkSMNumberOfGroupsDomain, vtkSMNumberOfPartsDomain, vtkSMProxyGroupDomain, vtkSMStringListDomain, and vtkSMStringListRangeDomain.

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

Update self based on the "unchecked" values of all required properties. Overwritten by sub-classes. Reimplemented in vtkSMArrayListDomain, vtkSMArrayRangeDomain, vtkSMArraySelectionDomain, vtkSMBoundsDomain, vtkSMDoubleRangeDomain, vtkSMExtentDomain, vtkSMFieldDataDomain, vtkSMIntRangeDomain, vtkSMNumberOfGroupsDomain, vtkSMStringListDomain, and vtkSMXDMFPropertyDomain. Definition at line 52 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 vtkSMBooleanDomain, vtkSMDoubleRangeDomain, vtkSMExtentDomain, vtkSMIntRangeDomain, vtkSMStringListDomain, and vtkSMStringListRangeDomain. Definition at line 55 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.

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, vtkSMBoundsDomain, vtkSMDataTypeDomain, vtkSMDoubleRangeDomain, vtkSMEnumerationDomain, vtkSMInputArrayDomain, vtkSMIntRangeDomain, vtkSMNumberOfGroupsDomain, vtkSMNumberOfPartsDomain, vtkSMProxyGroupDomain, vtkSMStringListDomain, and vtkSMStringListRangeDomain.

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 int vtkSMDomain::GetIsOptional (   )  [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.

---

Friends And Related Function Documentation

friend class vtkSMProperty [friend]

Definition at line 71 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 92 of file vtkSMDomain.h.

char* vtkSMDomain::XMLName [protected]

Definition at line 95 of file vtkSMDomain.h.

vtkSMDomainInternals* vtkSMDomain::Internals [protected]

Definition at line 103 of file vtkSMDomain.h.

---

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

• Servers/ServerManager/vtkSMDomain.h

---