|
virtual const char * | GetClassName () |
|
virtual int | IsA (const char *type) |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
|
void | Update (vtkSMProperty *prop) override |
| Updates the string list based on the available arrays. More...
|
|
int | IsArrayPartial (unsigned int idx) |
| Returns true if the array with the given idx is partial false otherwise. More...
|
|
int | GetFieldAssociation (unsigned int idx) |
| Get field association for the array. More...
|
|
int | GetDomainAssociation (unsigned int idx) |
| Get the true field association for the array. More...
|
|
int | SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override |
| A vtkSMProperty is often defined with a default value in the XML itself. More...
|
|
unsigned int | RemoveInformationKey (const char *location, const char *name) |
| Removes an InformationKey from this domain. More...
|
|
unsigned int | GetNumberOfInformationKeys () |
| Returns the number of InformationKeys in this domain. More...
|
|
void | RemoveAllInformationKeys () |
| Removes all InformationKeys from this domain. More...
|
|
|
virtual int | GetAttributeType () |
| Return the attribute type. More...
|
|
|
virtual char * | GetNoneString () |
| Return the string that is used as "none_string" in XML configuration. More...
|
|
|
virtual unsigned int | AddInformationKey (const char *location, const char *name, int strategy) |
| Adds a new InformationKey to the domain. More...
|
|
virtual unsigned int | AddInformationKey (const char *location, const char *name) |
| Adds a new InformationKey to the domain. More...
|
|
|
const char * | GetInformationKeyLocation (unsigned int) |
| Returns the location/name/strategy of a given InformationKey. More...
|
|
const char * | GetInformationKeyName (unsigned int) |
| Returns the location/name/strategy of a given InformationKey. More...
|
|
int | GetInformationKeyStrategy (unsigned int) |
| Returns the location/name/strategy of a given InformationKey. More...
|
|
Public Member Functions inherited from vtkSMStringListDomain |
void | PrintSelf (ostream &os, vtkIndent indent) override |
|
int | IsInDomain (vtkSMProperty *property) override |
| 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...
|
|
void | Update (vtkSMProperty *) override |
| Update self checking the "unchecked" values of all required properties. More...
|
|
void | SetAnimationValue (vtkSMProperty *, int, double) override |
| Set the value of an element of a property from the animation editor. More...
|
|
int | SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override |
| A vtkSMProperty is often defined with a default value in the XML itself. More...
|
|
Public Member Functions inherited from vtkSMDomain |
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 vtkPVDataInformation * | GetInputDataInformation (const char *function, unsigned int index=0) |
| Helper method to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...
|
|
virtual unsigned int | GetNumberOfInputConnections (const char *function) |
| Helper method to get the number of input connections hence the number of available vtkPVDataInformation from input proxy connected to the required property with the given function. More...
|
|
virtual char * | GetXMLName () |
| Assigned by the XML parser. More...
|
|
virtual bool | GetIsOptional () |
| When the IsOptional flag is set, IsInDomain() always returns true. More...
|
|
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...
|
|
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
|
virtual void | DebugOn () |
|
virtual void | DebugOff () |
|
bool | GetDebug () |
|
void | SetDebug (bool debugFlag) |
|
virtual void | Modified () |
|
virtual vtkMTimeType | GetMTime () |
|
void | RemoveObserver (unsigned long tag) |
|
void | RemoveObservers (unsigned long event) |
|
void | RemoveObservers (const char *event) |
|
void | RemoveAllObservers () |
|
int | HasObserver (unsigned long event) |
|
int | HasObserver (const char *event) |
|
int | InvokeEvent (unsigned long event) |
|
int | InvokeEvent (const char *event) |
|
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
|
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
|
vtkCommand * | GetCommand (unsigned long tag) |
|
void | RemoveObserver (vtkCommand *) |
|
void | RemoveObservers (unsigned long event, vtkCommand *) |
|
void | RemoveObservers (const char *event, vtkCommand *) |
|
int | HasObserver (unsigned long event, vtkCommand *) |
|
int | HasObserver (const char *event, vtkCommand *) |
|
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
|
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
|
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
|
int | InvokeEvent (unsigned long event, void *callData) |
|
int | InvokeEvent (const char *event, void *callData) |
|
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
|
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
|
vtkCommand * | GetCommand (unsigned long tag) |
|
void | RemoveObserver (vtkCommand *) |
|
void | RemoveObservers (unsigned long event, vtkCommand *) |
|
void | RemoveObservers (const char *event, vtkCommand *) |
|
int | HasObserver (unsigned long event, vtkCommand *) |
|
int | HasObserver (const char *event, vtkCommand *) |
|
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
|
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
|
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
|
int | InvokeEvent (unsigned long event, void *callData) |
|
int | InvokeEvent (const char *event, void *callData) |
|
const char * | GetClassName () const |
|
virtual void | Delete () |
|
virtual void | FastDelete () |
|
void | Print (ostream &os) |
|
virtual void | Register (vtkObjectBase *o) |
|
virtual void | UnRegister (vtkObjectBase *o) |
|
void | SetReferenceCount (int) |
|
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
|
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
|
int | GetReferenceCount () |
|
void | PrintRevisions (ostream &) |
|
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
|
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
|
int | GetReferenceCount () |
|
void | PrintRevisions (ostream &) |
|
|
| vtkSMArrayListDomain () |
|
| ~vtkSMArrayListDomain () override |
|
int | ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) override |
| Set the appropriate ivars from the xml element. More...
|
|
virtual vtkPVDataInformation * | GetExtraDataInformation () |
| HACK: Provides a temporary mechanism for subclasses to provide an "additional" vtkPVDataInformation instance to get available arrays list from. More...
|
|
virtual bool | IsFilteredArray (vtkPVDataInformation *info, int association, const char *arrayName) |
| Returns true if an array should be filtered out. More...
|
|
virtual void | SetNoneString (const char *) |
|
|
virtual char * | GetInputDomainName () |
| InputDomainName refers to a input property domain that describes the type of array is needed by this property. More...
|
|
virtual void | SetInputDomainName (const char *) |
| InputDomainName refers to a input property domain that describes the type of array is needed by this property. More...
|
|
Protected Member Functions inherited from vtkSMStringListDomain |
int | ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) override |
| Set the appropriate ivars from the xml element. More...
|
|
void | ChildSaveState (vtkPVXMLElement *domainElement) override |
| 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...
|
|
| vtkSMStringListDomain () |
| A vtkSMProperty is often defined with a default value in the XML itself. More...
|
|
| ~vtkSMStringListDomain () override |
| A vtkSMProperty is often defined with a default value in the XML itself. More...
|
|
Protected Member Functions inherited from vtkSMDomain |
| vtkSMDomain () |
|
| ~vtkSMDomain () override |
|
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...
|
|
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 () override |
|
| vtkSMObject () |
|
| ~vtkSMObject () override |
|
| vtkObject () |
|
virtual | ~vtkObject () |
|
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE |
|
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE |
|
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
|
void | InternalReleaseFocus () |
|
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
|
void | InternalReleaseFocus () |
|
| vtkObjectBase () |
|
virtual | ~vtkObjectBase () |
|
virtual void | CollectRevisions (ostream &) |
|
virtual void | ReportReferences (vtkGarbageCollector *) |
|
| vtkObjectBase (const vtkObjectBase &) |
|
void | operator= (const vtkObjectBase &) |
|
list of arrays obtained from input
vtkSMArrayListDomain is used on vtkSMStringVectorProperty when the values on the property correspond to data arrays in the input.
Supported Required Property Functions:
Input
: (required) this point to a vtkSMInputProperty on the parent proxy. The value of this property provides the source that provides the data information to determine the available arrays.
FieldDataSelection
: (optional) this points a vtkSMIntVectorProperty that provide the array association for accepted arrays as defined by vtkDataObject::FieldAssociations. If FieldDataSelection is missing, then the array association is determined using the vtkSMInputArrayDomain on the vtkSMInputProperty pointed by the required function Input
. If the input property has multiple vtkSMInputArrayDomain types, you can identify the domain to use by using the
- input_domain_name XML attribute. If neither the FieldDataSelection is specified and no vtkSMInputArrayDomain is found, then this domain assumes that all array associations are valid.
Supported XML attributes:
attribute_type
: (optional) when specified, this is used to pick the default value in SetDefaultValues. This specifies the array-attribute type to pick as the default, if available e.g. if value is "Scalars", then by default the active scalar array will be picked, if available. Not to be confused with vtkDataObject::AttributeTypes, this corresponds to vtkDataSetAttributes::AttributeTypes. Accepted values are "Scalars", "Vectors", etc., as defined by vtkDataSetAttributes::AttributeNames.
data_type:
(optional) when specified qualifies the acceptable arrays list to the types specified. Value can be one or more of VTK_BIT, VTK_CHAR, VTK_INT, VTK_FLOAT, VTK_DOUBLE,... etc. or the equivalent integers from vtkType.h. VTK_VOID, and 0 are equivalent to not specifying, meaning any data type. VTK_DATA_ARRAY can be used to limit to vtkDataArray subclasses.
none_string:
(optional) when specified, this string appears as the first entry in the domain the list and can be used to show "None", or "Not available" etc.
key_location
/ key_name
/ key_strategy:
(optional) those tree attributes are related to InformationKey of the array. key_location/key_name are the location and name of the given InformationKey key_strategy specifies if this specific key is needed to be in the domain or if this key is rejected. One of need_key or reject_key. if nothing is specified, the default is to add a vtkAbstractArray::GUI_HIDE key, with the reject_key strategy, so that arrays that have this InformationKey are not visible in the user interface.
Definition at line 85 of file vtkSMArrayListDomain.h.