domain to ensure that input has required types of arrays. More...
#include <vtkSMInputArrayDomain.h>
Public Types | |
enum | AttributeTypes { POINT = vtkDataObject::POINT, CELL = vtkDataObject::CELL, FIELD = vtkDataObject::FIELD, ANY_EXCEPT_FIELD = vtkDataObject::POINT_THEN_CELL, VERTEX = vtkDataObject::VERTEX, EDGE = vtkDataObject::EDGE, ROW = vtkDataObject::ROW, ANY = vtkDataObject::NUMBER_OF_ATTRIBUTE_TYPES, NUMBER_OF_ATTRIBUTE_TYPES = ANY + 1 } |
typedef vtkSMDomain | Superclass |
![]() | |
enum | IsInDomainReturnCodes { NOT_APPLICABLE = -1, NOT_IN_DOMAIN = 0, IN_DOMAIN = 1 } |
Return values for IsInDomain calls. More... | |
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) override |
int | IsInDomain (vtkSMProperty *property) override |
Returns true if the value of the property 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... | |
std::vector< int > | GetAcceptableNumbersOfComponents () const |
Get the AcceptableNumberOfComponents vector Empty or containing a zero means no check. More... | |
bool | GetAutoConvertProperties () |
Get the auto convert property for this specific domain. 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... | |
![]() | |
virtual int | IsInDomain (vtkSMProperty *vtkNotUsed(property)) |
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 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... | |
vtkSMProperty * | GetRequiredProperty (const char *function) |
Returns a given required property of 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 vtkPVDataInformation * | GetInputDataInformation (const char *function, unsigned int index=0) |
Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More... | |
virtual vtkPVDataInformation * | GetInputSubsetDataInformation (unsigned int compositeIndex, const char *function, unsigned int index=0) |
Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More... | |
virtual vtkPVDataInformation * | GetInputSubsetDataInformation (const char *selector, const char *assemblyName, const char *function, unsigned int index=0) |
Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More... | |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
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 &) |
Static Public Member Functions | |
static vtkSMInputArrayDomain * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMInputArrayDomain * | SafeDownCast (vtkObject *o) |
static vtkSMInputArrayDomain * | FindApplicableDomain (vtkSMProperty *property) |
Helper method find the first vtkSMInputArrayDomain on the property that is acceptable based on the value of the property. More... | |
static void | SetAutomaticPropertyConversion (bool) |
Get/Set the application wide setting for automatic conversion of properties. More... | |
static bool | GetAutomaticPropertyConversion () |
Get/Set the application wide setting for automatic conversion of properties. More... | |
static bool | IsAttributeTypeAcceptable (int required_type, int attribute_type, int *acceptable_as_type=nullptr) |
Method to check if a particular attribute-type (attribute_type ) will be accepted by this domain with a required attribute type (required_type ). More... | |
static bool | IsAttributeTypeAcceptable (int required_type, int attribute_type, int *acceptable_as_type, bool autoconvert) |
Method to check if a particular attribute-type (attribute_type ) will be accepted by this domain with a required attribute type (required_type ). More... | |
![]() | |
static vtkSMDomain * | New () |
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) |
static std::string | CreatePrettyLabel (const std::string &name) |
Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More... | |
![]() | |
static vtkObject * | New () |
static void | BreakOnError () |
static void | SetGlobalWarningDisplay (int val) |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
static void | SetGlobalWarningDisplay (int val) |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
static vtkTypeBool | IsTypeOf (const char *name) |
static vtkObjectBase * | New () |
static vtkObjectBase * | New () |
Protected Member Functions | |
vtkSMInputArrayDomain () | |
~vtkSMInputArrayDomain () override | |
virtual void | SetAttributeType (int) |
void | SetAttributeType (const char *type) |
int | ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) override |
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... | |
![]() | |
vtkSMDomain () | |
~vtkSMDomain () override | |
virtual int | LoadState (vtkPVXMLElement *vtkNotUsed(domainElement), vtkSMProxyLocator *vtkNotUsed(loader)) |
Load the state of the domain from the XML. 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 | 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 () 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 &) |
Protected Attributes | |
int | AttributeType |
std::vector< int > | AcceptableNumbersOfComponents |
std::string | DataType |
![]() | |
char * | XMLName |
bool | IsOptional |
vtkSMDomainInternals * | Internals |
![]() | |
vtkWeakPointer< vtkSMSession > | Session |
Identifies the session id to which this object is related. More... | |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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. data_type:
(optional) when specified must be the class name for data type that this domain is applicable to. This is useful when adding multiple input-array-domains a property with different requirements based on the type (see ("filters", "Contour")
filter, for example). auto_convert_association:
(optional) Indicates if an automatic attribute type conversion can be applied to the input arrays to match the attribute_type criteria.This domain doesn't support any required properties (to help clean old code, we print a warning if any required properties are specified).
Definition at line 70 of file vtkSMInputArrayDomain.h.
Definition at line 74 of file vtkSMInputArrayDomain.h.
Enumerator | |
---|---|
POINT | |
CELL | |
FIELD | |
ANY_EXCEPT_FIELD | |
VERTEX | |
EDGE | |
ROW | |
ANY | |
NUMBER_OF_ATTRIBUTE_TYPES |
Definition at line 122 of file vtkSMInputArrayDomain.h.
|
protected |
|
overrideprotected |
|
static |
|
virtual |
Reimplemented from vtkSMDomain.
Reimplemented from vtkSMDomain.
|
static |
|
overridevirtual |
Reimplemented from vtkSMDomain.
|
override |
Returns true if the value of the property is in the domain.
The property has to be a vtkSMProxyProperty which points to a vtkSMSourceProxy. The input has to have one or more arrays that match the requirements.
int vtkSMInputArrayDomain::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.
|
virtual |
Get the attribute type.
Valid values are defined in AttributeTypes which map to vtkDataObject::AttributeTypes.
const char* vtkSMInputArrayDomain::GetAttributeTypeAsString | ( | ) |
Get the attribute type.
Valid values are defined in AttributeTypes which map to vtkDataObject::AttributeTypes.
std::vector<int> vtkSMInputArrayDomain::GetAcceptableNumbersOfComponents | ( | ) | const |
Get the AcceptableNumberOfComponents vector Empty or containing a zero means no check.
|
static |
Get/Set the application wide setting for automatic conversion of properties.
Automatic conversion of properties allows conversion between cell and point based properties, and the extraction of vector components as scalar properties
|
static |
Get/Set the application wide setting for automatic conversion of properties.
Automatic conversion of properties allows conversion between cell and point based properties, and the extraction of vector components as scalar properties
bool vtkSMInputArrayDomain::GetAutoConvertProperties | ( | ) |
Get the auto convert property for this specific domain.
This returns true if either application settings or local value is true.
|
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.
|
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.
int vtkSMInputArrayDomain::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.
Note that it takes into account property conversion This method return the accepted number of components to use.
|
static |
Helper method find the first vtkSMInputArrayDomain
on the property
that is acceptable based on the value of the property.
The property is typically vtkSMInputProperty
. If none of the domains applicable, this will simply return the first vtkSMInputArrayDomain that is found.
|
protectedvirtual |
|
protected |
|
overrideprotectedvirtual |
Set the appropriate ivars from the xml element.
Should be overwritten by subclass if adding ivars.
Reimplemented from vtkSMDomain.
|
protected |
Returns true if based on this->AttributeType, the specified attributeType
is acceptable to this domain.
|
protected |
Returns true if based on this->AutomaticPropertyConversion and this->NumberOfComponents, an acceptable array can be found in the attrInfo.
|
protected |
Definition at line 196 of file vtkSMInputArrayDomain.h.
|
protected |
Definition at line 197 of file vtkSMInputArrayDomain.h.
|
protected |
Definition at line 198 of file vtkSMInputArrayDomain.h.