ParaView
|
list of strings More...
#include <vtkSMStringListDomain.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 property is in the domain. More... | |
int | IsInDomain (const char *string, unsigned int &idx) |
Returns true if the string is in the domain. More... | |
const char * | GetString (unsigned int idx) |
Returns a string in the domain. More... | |
unsigned int | GetNumberOfStrings () |
Returns the number of strings in the domain. More... | |
virtual void | Update (vtkSMProperty *) |
Update self checking the "unchecked" values of all required properties. More... | |
virtual void | SetAnimationValue (vtkSMProperty *, int, double) |
Set the value of an element of a property from the animation editor. 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 vtkSMStringListDomain * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMStringListDomain * | 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... | |
virtual void | SetStrings (const std::vector< vtkStdString > &strings) |
Call to set the strings. More... | |
const std::vector< vtkStdString > & | GetStrings () |
Call to set the strings. 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 () | |
virtual int | SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) |
A vtkSMProperty is often defined with a default value in the XML itself. More... | |
vtkSMStringListDomain () | |
A vtkSMProperty is often defined with a default value in the XML itself. More... | |
~vtkSMStringListDomain () | |
A vtkSMProperty is often defined with a default value in the XML itself. More... | |
Additional Inherited Members | |
![]() | |
char * | XMLName |
bool | IsOptional |
vtkSMDomainInternals * | Internals |
![]() | |
vtkWeakPointer< vtkSMSession > | Session |
list of strings
vtkSMStringListDomain represents a domain consisting of a list of strings. It only works with vtkSMStringVectorProperty. Valid XML elements are:
* * <String value=""> *
Definition at line 39 of file vtkSMStringListDomain.h.
Definition at line 43 of file vtkSMStringListDomain.h.
|
protected |
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.
|
protected |
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.
|
static |
|
virtual |
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMArrayListDomain, vtkSMChartSeriesSelectionDomain, vtkSMChartSeriesListDomain, vtkSMSILDomain, vtkSMRepresentationTypeDomain, vtkSMArraySelectionDomain, vtkSMRepresentedArrayListDomain, vtkSMInputFileNameDomain, vtkSMBagChartSeriesListDomain, vtkSMFunctionalBagChartSeriesSelectionDomain, and vtkSMFileListDomain.
|
static |
|
virtual |
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMArrayListDomain, vtkSMChartSeriesSelectionDomain, vtkSMChartSeriesListDomain, vtkSMSILDomain, vtkSMRepresentationTypeDomain, vtkSMArraySelectionDomain, vtkSMRepresentedArrayListDomain, vtkSMInputFileNameDomain, vtkSMBagChartSeriesListDomain, vtkSMFunctionalBagChartSeriesSelectionDomain, and vtkSMFileListDomain.
|
static |
void vtkSMStringListDomain::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
virtual |
Returns true if the value of the property is in the domain.
The propery has to be a vtkSMStringVectorProperty. If all vector values are in the domain, it returns 1. It returns 0 otherwise.
Implements vtkSMDomain.
int vtkSMStringListDomain::IsInDomain | ( | const char * | string, |
unsigned int & | idx | ||
) |
Returns true if the string is in the domain.
const char* vtkSMStringListDomain::GetString | ( | unsigned int | idx | ) |
Returns a string in the domain.
The pointer may become invalid once the domain has been modified.
unsigned int vtkSMStringListDomain::GetNumberOfStrings | ( | ) |
Returns the number of strings in the domain.
|
virtual |
Update self checking the "unchecked" values of all required properties.
Overwritten by sub-classes.
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMArrayListDomain, vtkSMChartSeriesSelectionDomain, vtkSMChartSeriesListDomain, vtkSMRepresentedArrayListDomain, and vtkSMInputFileNameDomain.
|
virtual |
Set the value of an element of a property from the animation editor.
|
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 in vtkSMArrayListDomain, vtkSMChartSeriesSelectionDomain, vtkSMSILDomain, vtkSMChartSeriesListDomain, vtkSMInputFileNameDomain, vtkSMRepresentationTypeDomain, vtkSMArraySelectionDomain, and vtkSMBagChartSeriesListDomain.
|
protectedvirtual |
Set the appropriate ivars from the xml element.
Should be overwritten by subclass if adding ivars.
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMArrayListDomain, vtkSMChartSeriesSelectionDomain, vtkSMChartSeriesListDomain, vtkSMSILDomain, vtkSMRepresentedArrayListDomain, and vtkSMBagChartSeriesListDomain.
|
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.
|
protectedvirtual |
Call to set the strings.
Will fire DomainModifiedEvent if the domain values have indeed changed.
|
protected |
Call to set the strings.
Will fire DomainModifiedEvent if the domain values have indeed changed.