ParaView
|
represents the possible values a property can have More...
#include <vtkSMDomain.h>
Public Types | |
typedef vtkSMSessionObject | Superclass |
![]() | |
typedef vtkSMObject | Superclass |
![]() | |
typedef vtkObject | Superclass |
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 |
Is the (unchecked) value of the property in the domain? Overwritten by sub-classes. More... | |
virtual void | Update (vtkSMProperty *requestingProperty) |
Update self based on the "unchecked" values of all required properties. More... | |
virtual void | SetAnimationValue (vtkSMProperty *, int vtkNotUsed(index), double vtkNotUsed(value)) |
Set the value of an element of a property from the animation editor. More... | |
virtual int | SetDefaultValues (vtkSMProperty *, bool vtkNotUsed(use_unchecked_values)) |
A vtkSMProperty is often defined with a default value in the XML itself. More... | |
vtkSMProperty * | GetProperty () |
Provides access to the vtkSMProperty on which this domain is hooked up. More... | |
virtual char * | GetXMLName () |
Assigned by the XML parser. More... | |
virtual bool | GetIsOptional () |
When the IsOptional flag is set, IsInDomain() always returns true. More... | |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual vtkSMSessionProxyManager * | GetSessionProxyManager () |
Return the corresponding ProxyManager if any. More... | |
virtual void | SetSession (vtkSMSession *) |
Get/Set the session on wihch this object exists. More... | |
virtual vtkSMSession * | GetSession () |
Get/Set the session on wihch this object exists. More... | |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkSMDomain * | SafeDownCast (vtkObject *o) |
![]() | |
static vtkSMSessionObject * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMSessionObject * | SafeDownCast (vtkObject *o) |
![]() | |
static vtkSMObject * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMObject * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
vtkSMDomain () | |
~vtkSMDomain () | |
virtual int | LoadState (vtkPVXMLElement *vtkNotUsed(domainElement), vtkSMProxyLocator *vtkNotUsed(loader)) |
Load the state of the domain from the XML. More... | |
virtual int | ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *elem) |
Set the appropriate ivars from the xml element. More... | |
vtkSMProperty * | GetRequiredProperty (const char *function) |
Returns a given required property of the given function. More... | |
void | RemoveRequiredProperty (vtkSMProperty *prop) |
Remove the given property from the required properties list. More... | |
void | AddRequiredProperty (vtkSMProperty *prop, const char *function) |
Add a new required property to this domain. More... | |
virtual vtkPVDataInformation * | GetInputDataInformation (const char *function, int index=0) |
Helper method to get vtkPVDataInformation from input proxy connected to the required property with the given function. More... | |
void | DomainModified () |
Invokes DomainModifiedEvent. More... | |
void | InvokeModified () |
unsigned int | GetNumberOfRequiredProperties () |
Gets the number of required properties added. More... | |
void | SetProperty (vtkSMProperty *) |
Set the domain's property. More... | |
void | SaveState (vtkPVXMLElement *parent, const char *uid) |
Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More... | |
virtual void | ChildSaveState (vtkPVXMLElement *domainElement) |
Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More... | |
virtual void | SetIsOptional (bool) |
When the IsOptional flag is set, IsInDomain() always returns true. More... | |
virtual void | SetXMLName (const char *) |
Assigned by the XML parser. More... | |
![]() | |
vtkSMSessionObject () | |
~vtkSMSessionObject () | |
![]() | |
vtkSMObject () | |
~vtkSMObject () | |
Protected Attributes | |
char * | XMLName |
bool | IsOptional |
vtkSMDomainInternals * | Internals |
![]() | |
vtkWeakPointer< vtkSMSession > | Session |
Friends | |
class | vtkSMProperty |
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.
Every time a domain changes it must fire a vtkCommand::DomainModifiedEvent. Applications may decide to update the UI every-time the domain changes. As a result, domains ideally should only fire that event when their values change for real not just potentially changed.
Definition at line 48 of file vtkSMDomain.h.
Definition at line 51 of file vtkSMDomain.h.
|
protected |
|
protected |
|
virtual |
Reimplemented from vtkSMSessionObject.
Reimplemented in vtkSMArrayListDomain, vtkSMInputArrayDomain, vtkSMBoundsDomain, vtkSMCompositeTreeDomain, vtkSMFieldDataDomain, vtkSMChartSeriesSelectionDomain, vtkSMProxyListDomain, vtkSMChartSeriesListDomain, vtkSMDoubleRangeDomain, vtkSMDataTypeDomain, vtkSMDimensionsDomain, vtkSMIntRangeDomain, vtkSMProxyGroupDomain, vtkSMSILDomain, vtkSMRepresentationTypeDomain, vtkSMArraySelectionDomain, vtkSMStringListDomain, vtkSMChartUseIndexForAxisDomain, vtkSMNumberOfComponentsDomain, vtkSMRepresentedArrayListDomain, vtkSMEnumerationDomain, vtkSMFixedTypeDomain, vtkSMArrayRangeDomain, vtkSMExtentDomain, vtkSMInputFileNameDomain, vtkSMTimeStepIndexDomain, vtkSMBooleanDomain, vtkSMBagChartSeriesListDomain, vtkSMFunctionalBagChartSeriesSelectionDomain, vtkSMIndexSelectionDomain, and vtkSMFileListDomain.
|
static |
|
virtual |
Reimplemented from vtkSMSessionObject.
Reimplemented in vtkSMArrayListDomain, vtkSMInputArrayDomain, vtkSMBoundsDomain, vtkSMCompositeTreeDomain, vtkSMFieldDataDomain, vtkSMChartSeriesSelectionDomain, vtkSMProxyListDomain, vtkSMChartSeriesListDomain, vtkSMDoubleRangeDomain, vtkSMDataTypeDomain, vtkSMDimensionsDomain, vtkSMIntRangeDomain, vtkSMProxyGroupDomain, vtkSMSILDomain, vtkSMRepresentationTypeDomain, vtkSMArraySelectionDomain, vtkSMStringListDomain, vtkSMChartUseIndexForAxisDomain, vtkSMNumberOfComponentsDomain, vtkSMRepresentedArrayListDomain, vtkSMEnumerationDomain, vtkSMFixedTypeDomain, vtkSMArrayRangeDomain, vtkSMExtentDomain, vtkSMInputFileNameDomain, vtkSMTimeStepIndexDomain, vtkSMBooleanDomain, vtkSMBagChartSeriesListDomain, vtkSMFunctionalBagChartSeriesSelectionDomain, vtkSMIndexSelectionDomain, and vtkSMFileListDomain.
|
static |
void vtkSMDomain::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
pure virtual |
Is the (unchecked) value of the property in the domain? Overwritten by sub-classes.
Implemented in vtkSMInputArrayDomain, vtkSMProxyListDomain, vtkSMRangeDomainTemplate< T >, vtkSMProxyGroupDomain, vtkSMDataTypeDomain, vtkSMStringListDomain, vtkSMFixedTypeDomain, vtkSMEnumerationDomain, vtkSMBooleanDomain, and vtkSMIndexSelectionDomain.
|
inlinevirtual |
Update self based on the "unchecked" values of all required properties.
Subclasses must override this method to update the domain based on the requestingProperty (and/or other required properties).
Reimplemented in vtkSMRangeDomainTemplate< T >, vtkSMEnumerationDomain, vtkSMArrayListDomain, vtkSMBoundsDomain, vtkSMCompositeTreeDomain, vtkSMStringListDomain, vtkSMFieldDataDomain, vtkSMChartSeriesSelectionDomain, vtkSMChartUseIndexForAxisDomain, vtkSMChartSeriesListDomain, vtkSMDimensionsDomain, vtkSMNumberOfComponentsDomain, vtkSMArrayRangeDomain, vtkSMRepresentedArrayListDomain, vtkSMExtentDomain, vtkSMTimeStepIndexDomain, and vtkSMInputFileNameDomain.
Definition at line 65 of file vtkSMDomain.h.
|
inlinevirtual |
Set the value of an element of a property from the animation editor.
Definition at line 70 of file vtkSMDomain.h.
|
inlinevirtual |
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. If use_unchecked_values
is true, the property's unchecked values will be changed by this method. Returns 1 if the domain updated the property. Default implementation does nothing.
Definition at line 85 of file vtkSMDomain.h.
|
virtual |
Assigned by the XML parser.
The name assigned in the XML configuration. Can be used to figure out the origin of the domain.
|
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.
vtkSMProperty* vtkSMDomain::GetProperty | ( | ) |
Provides access to the vtkSMProperty on which this domain is hooked up.
|
protected |
Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes.
The newly created element will also be added to the parent element as a child node. Subclasses can override ChildSaveState() method to fill it up with subclass specific values.
|
protectedvirtual |
Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes.
The newly created element will also be added to the parent element as a child node. Subclasses can override ChildSaveState() method to fill it up with subclass specific values.
Reimplemented in vtkSMProxyListDomain, vtkSMEnumerationDomain, and vtkSMStringListDomain.
|
inlineprotectedvirtual |
Load the state of the domain from the XML.
Subclasses generally have no need to load XML state. In fact, serialization of state for domains, in general, is unnecessary for two reasons:
Definition at line 139 of file vtkSMDomain.h.
|
protectedvirtual |
Set the appropriate ivars from the xml element.
Should be overwritten by subclass if adding ivars.
Reimplemented in vtkSMArrayListDomain, vtkSMInputArrayDomain, vtkSMRangeDomainTemplate< T >, vtkSMCompositeTreeDomain, vtkSMProxyListDomain, vtkSMEnumerationDomain, vtkSMBoundsDomain, vtkSMChartSeriesSelectionDomain, vtkSMProxyGroupDomain, vtkSMStringListDomain, vtkSMDataTypeDomain, vtkSMChartSeriesListDomain, vtkSMFieldDataDomain, vtkSMSILDomain, vtkSMRepresentedArrayListDomain, and vtkSMBagChartSeriesListDomain.
|
protected |
Returns a given required property of the given function.
Function is a string associated with the require property in the XML file.
|
protected |
Remove the given property from the required properties list.
|
protected |
Add a new required property to this domain.
Whenever the prop
fires vtkCommand::UncheckedPropertyModifiedEvent, vtkSMDomain::Update(prop) is called. Also whenever a vtkSMInputProperty is added as a required property, vtkSMDomain::Update(prop) will also be called the vtkCommand::UpdateDataEvent is fired by the proxies contained in that required property.
|
protectedvirtual |
Helper method to get vtkPVDataInformation from input proxy connected to the required property with the given function.
|
protectedvirtual |
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.
|
protectedvirtual |
Assigned by the XML parser.
The name assigned in the XML configuration. Can be used to figure out the origin of the domain.
|
protected |
Invokes DomainModifiedEvent.
Note that this event must be fired after the domain has changed (ideally, if and only if the domain has changed).
|
inlineprotected |
Definition at line 205 of file vtkSMDomain.h.
|
protected |
Gets the number of required properties added.
|
protected |
Set the domain's property.
This is called by vtkSMProperty when the domain is created.
|
friend |
Definition at line 151 of file vtkSMDomain.h.
|
protected |
Definition at line 218 of file vtkSMDomain.h.
|
protected |
Definition at line 219 of file vtkSMDomain.h.
|
protected |
Definition at line 220 of file vtkSMDomain.h.