ParaView
|
list of integers with associated strings More...
#include <vtkSMEnumerationDomain.h>
Public Types | |
typedef vtkSMDomain | Superclass |
![]() | |
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) |
Returns true if the value of the propery is in the domain. More... | |
int | IsInDomain (int val, unsigned int &idx) |
Returns true if the int is in the domain. More... | |
unsigned int | GetNumberOfEntries () |
Returns the number of entries in the enumeration. More... | |
int | GetEntryValue (unsigned int idx) |
Returns the integer value of an enumeration entry. More... | |
const char * | GetEntryText (unsigned int idx) |
Returns the descriptive string of an enumeration entry. More... | |
const char * | GetEntryTextForValue (int value) |
Returns the text for an enumeration value. More... | |
int | HasEntryText (const char *text) |
Return 1 is the text is present in the enumeration, otherwise 0. More... | |
int | GetEntryValueForText (const char *text) |
Get the value for an enumeration text. More... | |
int | GetEntryValue (const char *text, int &valid) |
Given an entry text, return the integer value. More... | |
void | AddEntry (const char *text, int value) |
Add a new enumeration entry. More... | |
void | RemoveAllEntries () |
Clear all entries. More... | |
virtual void | Update (vtkSMProperty *property) |
Update self based on the "unchecked" values of all required properties. More... | |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
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 vtkSMEnumerationDomain * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMEnumerationDomain * | SafeDownCast (vtkObject *o) |
![]() | |
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 | |
virtual int | ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) |
Set the appropriate ivars from the xml element. 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... | |
![]() | |
vtkSMDomain () | |
~vtkSMDomain () | |
virtual int | LoadState (vtkPVXMLElement *vtkNotUsed(domainElement), vtkSMProxyLocator *vtkNotUsed(loader)) |
Load the state of the domain from the XML. 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 | 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 | |
vtkSMEnumerationDomainInternals * | EInternals |
![]() | |
char * | XMLName |
bool | IsOptional |
vtkSMDomainInternals * | Internals |
![]() | |
vtkWeakPointer< vtkSMSession > | Session |
virtual int | SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) |
Overridden to ensure that the property's default value is valid for the enumeration, if not it will be set to the first enumeration value. More... | |
vtkSMEnumerationDomain () | |
Overridden to ensure that the property's default value is valid for the enumeration, if not it will be set to the first enumeration value. More... | |
~vtkSMEnumerationDomain () | |
Overridden to ensure that the property's default value is valid for the enumeration, if not it will be set to the first enumeration value. More... | |
list of integers with associated strings
vtkSMEnumerationDomain represents an enumeration of integer values with associated descriptive strings. Valid XML elements are:
* * <Entry text="" value=""/> where text is the descriptive * string and value is the integer value. *
Definition at line 36 of file vtkSMEnumerationDomain.h.
Definition at line 40 of file vtkSMEnumerationDomain.h.
|
protected |
Overridden to ensure that the property's default value is valid for the enumeration, if not it will be set to the first enumeration value.
|
protected |
Overridden to ensure that the property's default value is valid for the enumeration, if not it will be set to the first enumeration value.
|
static |
|
virtual |
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMFieldDataDomain, and vtkSMNumberOfComponentsDomain.
|
static |
|
virtual |
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMFieldDataDomain, and vtkSMNumberOfComponentsDomain.
|
static |
void vtkSMEnumerationDomain::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
virtual |
Returns true if the value of the propery is in the domain.
The propery has to be a vtkSMIntVectorProperty. If all vector values are in the domain, it returns 1. It returns 0 otherwise.
Implements vtkSMDomain.
int vtkSMEnumerationDomain::IsInDomain | ( | int | val, |
unsigned int & | idx | ||
) |
Returns true if the int is in the domain.
If value is in domain, it's index is return in idx.
unsigned int vtkSMEnumerationDomain::GetNumberOfEntries | ( | ) |
Returns the number of entries in the enumeration.
int vtkSMEnumerationDomain::GetEntryValue | ( | unsigned int | idx | ) |
Returns the integer value of an enumeration entry.
const char* vtkSMEnumerationDomain::GetEntryText | ( | unsigned int | idx | ) |
Returns the descriptive string of an enumeration entry.
const char* vtkSMEnumerationDomain::GetEntryTextForValue | ( | int | value | ) |
Returns the text for an enumeration value.
int vtkSMEnumerationDomain::HasEntryText | ( | const char * | text | ) |
Return 1 is the text is present in the enumeration, otherwise 0.
int vtkSMEnumerationDomain::GetEntryValueForText | ( | const char * | text | ) |
Get the value for an enumeration text.
The return value is valid only is HasEntryText() returns 1.
int vtkSMEnumerationDomain::GetEntryValue | ( | const char * | text, |
int & | valid | ||
) |
Given an entry text, return the integer value.
Valid is set to 1 if text is defined, otherwise 0. If valid=0, return value is undefined.
void vtkSMEnumerationDomain::AddEntry | ( | const char * | text, |
int | value | ||
) |
Add a new enumeration entry.
text cannot be null.
void vtkSMEnumerationDomain::RemoveAllEntries | ( | ) |
Clear all entries.
|
virtual |
Update self based on the "unchecked" values of all required properties.
Overwritten by sub-classes.
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMFieldDataDomain, and vtkSMNumberOfComponentsDomain.
|
virtual |
Overridden to ensure that the property's default value is valid for the enumeration, if not it will be set to the first enumeration value.
Reimplemented in vtkSMFieldDataDomain.
|
protectedvirtual |
Set the appropriate ivars from the xml element.
Should be overwritten by subclass if adding ivars.
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMFieldDataDomain.
|
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 from vtkSMDomain.
|
protected |
Definition at line 131 of file vtkSMEnumerationDomain.h.