|
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 (vtkSMSourceProxy *proxy, unsigned int outputport=0) |
| Returns true if input has one or more arrays that match the requirements on the given output port. More...
|
|
int | GetNumberOfComponents () |
| Return the first acceptable number of components or 0 if any number of components are acceptable. More...
|
|
std::vector< int > | GetAcceptableNumbersOfComponents () const |
| Get the AcceptableNumberOfComponents vector Empty or containing a zero means no check. More...
|
|
int | IsArrayAcceptable (vtkPVArrayInformation *arrayInfo) |
| This method will check if the arrayInfo contain info about an acceptable array, by checking its number of components against this domain acceptable numbers of components. More...
|
|
|
virtual int | GetAttributeType () |
| Get the attribute type. More...
|
|
const char * | GetAttributeTypeAsString () |
| Get the attribute type. More...
|
|
Public Member Functions inherited from vtkSMDomain |
void | PrintSelf (ostream &os, vtkIndent indent) |
|
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) |
|
|
| vtkSMInputArrayDomain () |
|
| ~vtkSMInputArrayDomain () |
|
void | SetNumberOfComponents (int) |
| Set the first acceptable number of components This method is deprecated. More...
|
|
virtual void | SetAttributeType (int) |
|
void | SetAttributeType (const char *type) |
|
virtual int | ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) |
| Set the appropriate ivars from the xml element. More...
|
|
bool | IsAttributeTypeAcceptable (int attributeType) |
| Returns true if based on this->AttributeType, the specified attributeType is acceptable to this domain. More...
|
|
bool | HasAcceptableArray (vtkPVDataSetAttributesInformation *attrInfo) |
| Returns true if based on this->AutomaticPropertyConversion and this->NumberOfComponents, an acceptable array can be found in the attrInfo. More...
|
|
Protected Member Functions inherited from vtkSMDomain |
| 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 | 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 () |
|
domain to ensure that input has required types of arrays.
vtkSMInputArrayDomain is a domain that can be used on a vtkSMInputProperty to check if the pipeline input provides attribute arrays of the required types e.g. if a filter can only work if the input data set has cell data arrays, then one can use this domain.
vtkSMInputArrayDomain also provides a mechanism to check if the attribute arrays have a certain number of components.
When enabled, ParaView supports automatic array conversion i.e. extracting components or converting cell data to point data and vice-versa is done implicitly. In that case, vtkSMInputArrayDomain's behavior also changes as appropriate.
Supported XML attributes:
attribute_type
: (optional) value can be 'point', 'cell', 'field', 'vertex', 'edge', 'row', 'none', 'any-except-field', 'any'. If not specified, 'any-except-field' is assumed. This indicates the attribute type for acceptable arrays.
number_of_components
: (optional) Indicates the number of components required in arrays that are considered acceptable. 0 (default) indicates any number of components is acceptable. A comma-separated list (e.g., "1" or "1,3,4") of component counts limits acceptable arrays to those with a number of components that appear in the list.
This domain doesn't support any required properties (to help clean old code, we print a warning if any required properties are specified).
- Attention
- Prior to ParaView 5.0, attribute_type="any" meant all attributes excepting field data. For being consistent with general understanding of "any", this has been changed to include field data arrays since 5.0. Use "any-except-field" for cases where the intention is to match any attribute arrays except field data arrays.
Definition at line 74 of file vtkSMInputArrayDomain.h.
static bool vtkSMInputArrayDomain::IsAttributeTypeAcceptable |
( |
int |
required_type, |
|
|
int |
attribute_type, |
|
|
int * |
acceptable_as_type = NULL |
|
) |
| |
|
static |
Method to check if a particular attribute-type (attribute_type
) will be accepted by this domain with a required attribute type (required_type
).
This takes into consideration the state of AutomaticePropertyConversion flag. If a particular attribute_type is acceptable only because AutomaticPropertyConversion is true, acceptable_as_type
value will be set to the attribute type that the particular attribute was automatically converted to. e.g. is required_type = POINT and attribute_type is CELL and AutomaticPropertyConversion is true, this method will return true and acceptable_as_type will be set to POINT. In other cases, acceptable_as_type is simply set to attribute_type.