requires input has array of described type More...
#include <vtkSMInputArrayDomain.h>
Detailed Description
requires input has array of described type
vtkSMInputArrayDomain requires that the source proxy pointed by the property has an output with one or more arrays of specified type. Current restrictions include whether the array is part of point or cell data and whether it has a given number of components. The restriction can be overriden for point and cell properties if the global post filter conversion is turned on. These attributes are specified in the XML file. Valid XML attributes are:
* attribute_type - cell or point * number_of_components
The attribute type can also be (optionally) obtained from a required property FieldDataSelection which has a value of vtkDataSet::POINT_DATA_FIELD or vtkDataSet::CELL_DATA_FIELD.
- See also:
- vtkSMDomain
Definition at line 50 of file vtkSMInputArrayDomain.h.
Member Enumeration Documentation
Definition at line 103 of file vtkSMInputArrayDomain.h.
Constructor & Destructor Documentation
| vtkSMInputArrayDomain::vtkSMInputArrayDomain | ( | ) | [protected] |
| vtkSMInputArrayDomain::~vtkSMInputArrayDomain | ( | ) | [protected] |
Member Function Documentation
| static vtkSMInputArrayDomain* vtkSMInputArrayDomain::New | ( | ) | [static] |
Reimplemented from vtkSMSessionObject.
| virtual const char* vtkSMInputArrayDomain::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSMDomain.
| static int vtkSMInputArrayDomain::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkSMDomain.
| virtual int vtkSMInputArrayDomain::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkSMDomain.
| static vtkSMInputArrayDomain* vtkSMInputArrayDomain::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSMDomain.
| void vtkSMInputArrayDomain::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSMDomain.
| virtual int vtkSMInputArrayDomain::IsInDomain | ( | vtkSMProperty * | property | ) | [virtual] |
Returns true if the value of the propery is in the domain. The propery has to be a vtkSMProxyProperty which points to a vtkSMSourceProxy. The input has to have one or more arrays that match the requirements.
Implements vtkSMDomain.
| int vtkSMInputArrayDomain::IsInDomain | ( | vtkSMSourceProxy * | proxy, |
| int | outputport = 0 |
||
| ) |
Returns true if input has one or more arrays that match the requirements on the given output port.
| int vtkSMInputArrayDomain::IsFieldValid | ( | vtkSMSourceProxy * | proxy, |
| int | outputport, | ||
| vtkPVArrayInformation * | arrayInfo | ||
| ) |
Returns 1 if the array represented by the array information is a valid field. The attribute type (point or cell) as well as the number of components are checked for a match
| int vtkSMInputArrayDomain::IsFieldValid | ( | vtkSMSourceProxy * | proxy, |
| int | outputport, | ||
| vtkPVArrayInformation * | arrayInfo, | ||
| int | bypass | ||
| ) |
Returns 1 if the array represented by the array information is a valid field. The attribute type (point or cell) as well as the number of components are checked for a match
| virtual void vtkSMInputArrayDomain::SetAttributeType | ( | unsigned | char | ) | [virtual] |
Set/get the attribute type. Valid values are: POINT, CELL, ANY. Text representations are: point, cell, any.
| virtual unsigned char vtkSMInputArrayDomain::GetAttributeType | ( | ) | [virtual] |
Set/get the attribute type. Valid values are: POINT, CELL, ANY. Text representations are: point, cell, any.
| const char* vtkSMInputArrayDomain::GetAttributeTypeAsString | ( | ) |
Set/get the attribute type. Valid values are: POINT, CELL, ANY. Text representations are: point, cell, any.
| virtual void vtkSMInputArrayDomain::SetAttributeType | ( | const char * | type | ) | [virtual] |
Set/get the attribute type. Valid values are: POINT, CELL, ANY. Text representations are: point, cell, any.
| virtual void vtkSMInputArrayDomain::SetNumberOfComponents | ( | int | ) | [virtual] |
Set/get the required number of components. Set to 0 for no check.
| virtual int vtkSMInputArrayDomain::GetNumberOfComponents | ( | ) | [virtual] |
Set/get the required number of components. Set to 0 for no check.
| static void vtkSMInputArrayDomain::SetAutomaticPropertyConversion | ( | bool | ) | [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 bool vtkSMInputArrayDomain::GetAutomaticPropertyConversion | ( | ) | [static] |
Use this method to convert a vtkDataSet::FIELD_ASSOCIATION_* to AttributeTypes enum.
| virtual int vtkSMInputArrayDomain::ReadXMLAttributes | ( | vtkSMProperty * | prop, |
| vtkPVXMLElement * | element | ||
| ) | [protected, virtual] |
Set the appropriate ivars from the xml element. Should be overwritten by subclass if adding ivars.
Reimplemented from vtkSMDomain.
| virtual void vtkSMInputArrayDomain::ChildSaveState | ( | vtkPVXMLElement * | domainElement | ) | [protected, virtual] |
Reimplemented from vtkSMDomain.
| int vtkSMInputArrayDomain::AttributeInfoContainsArray | ( | vtkSMSourceProxy * | proxy, |
| int | outputport, | ||
| vtkPVDataSetAttributesInformation * | attrInfo | ||
| ) | [protected] |
| int vtkSMInputArrayDomain::CheckForArray | ( | vtkPVArrayInformation * | arrayInfo, |
| vtkPVDataSetAttributesInformation * | attrInfo | ||
| ) | [protected] |
Member Data Documentation
unsigned char vtkSMInputArrayDomain::AttributeType [protected] |
Definition at line 132 of file vtkSMInputArrayDomain.h.
int vtkSMInputArrayDomain::NumberOfComponents [protected] |
Definition at line 133 of file vtkSMInputArrayDomain.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMInputArrayDomain.h
