VTK
|
Passes a subset of arrays to the output. More...
#include <vtkPassArrays.h>
Public Types | |
typedef vtkDataObjectAlgorithm | Superclass |
Public Member Functions | |
virtual int | IsA (const char *type) |
vtkPassArrays * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual void | AddArray (int fieldType, const char *name) |
virtual void | AddPointDataArray (const char *name) |
virtual void | AddCellDataArray (const char *name) |
virtual void | AddFieldDataArray (const char *name) |
virtual void | RemoveArray (int fieldType, const char *name) |
virtual void | RemovePointDataArray (const char *name) |
virtual void | RemoveCellDataArray (const char *name) |
virtual void | RemoveFieldDataArray (const char *name) |
virtual void | AddFieldType (int fieldType) |
virtual void | ClearFieldTypes () |
virtual void | ClearArrays () |
virtual void | ClearPointDataArrays () |
virtual void | ClearCellDataArrays () |
virtual void | ClearFieldDataArrays () |
virtual void | SetRemoveArrays (bool) |
virtual bool | GetRemoveArrays () |
virtual void | RemoveArraysOn () |
virtual void | RemoveArraysOff () |
virtual void | SetUseFieldTypes (bool) |
virtual bool | GetUseFieldTypes () |
virtual void | UseFieldTypesOn () |
virtual void | UseFieldTypesOff () |
virtual int | ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
Static Public Member Functions | |
static vtkPassArrays * | New () |
static int | IsTypeOf (const char *type) |
static vtkPassArrays * | SafeDownCast (vtkObjectBase *o) |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkPassArrays () | |
~vtkPassArrays () | |
int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
virtual int | RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
Protected Attributes | |
bool | RemoveArrays |
bool | UseFieldTypes |
Internals * | Implementation |
Passes a subset of arrays to the output.
This filter preserves all the topology of the input, but only a subset of arrays are passed to the output. Add an array to be passed to the output data object with AddArray(). If RemoveArrays is on, the specified arrays will be the ones that are removed instead of the ones that are kept.
Arrays with special attributes (scalars, pedigree ids, etc.) will retain those attributes in the output.
By default, only those field types with at least one array specified through AddArray will be processed. If instead UseFieldTypes is turned on, you explicitly set which field types to process with AddFieldType.
Example 1:
passArray->AddArray(vtkDataObject::POINT, "velocity");
The output will have only that one array "velocity" in the point data, but cell and field data will be untouched.
Example 2:
passArray->AddArray(vtkDataObject::POINT, "velocity"); passArray->UseFieldTypesOn(); passArray->AddFieldType(vtkDataObject::POINT); passArray->AddFieldType(vtkDataObject::CELL);
The point data would still contain the single array, but the cell data would be cleared since you did not specify any arrays to pass. Field data would still be untouched.
Definition at line 68 of file vtkPassArrays.h.
Reimplemented from vtkDataObjectAlgorithm.
Definition at line 72 of file vtkPassArrays.h.
vtkPassArrays::vtkPassArrays | ( | ) | [protected] |
vtkPassArrays::~vtkPassArrays | ( | ) | [protected] |
static vtkPassArrays* vtkPassArrays::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkDataObjectAlgorithm.
static int vtkPassArrays::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataObjectAlgorithm.
virtual int vtkPassArrays::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataObjectAlgorithm.
static vtkPassArrays* vtkPassArrays::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkDataObjectAlgorithm.
virtual vtkObjectBase* vtkPassArrays::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkDataObjectAlgorithm.
vtkPassArrays* vtkPassArrays::NewInstance | ( | ) | const |
Reimplemented from vtkDataObjectAlgorithm.
void vtkPassArrays::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkDataObjectAlgorithm.
virtual void vtkPassArrays::AddArray | ( | int | fieldType, |
const char * | name | ||
) | [virtual] |
Adds an array to pass through. fieldType where the array that should be passed (point data, cell data, etc.). It should be one of the constants defined in the vtkDataObject::AttributeTypes enumeration.
virtual void vtkPassArrays::AddPointDataArray | ( | const char * | name | ) | [virtual] |
virtual void vtkPassArrays::AddCellDataArray | ( | const char * | name | ) | [virtual] |
virtual void vtkPassArrays::AddFieldDataArray | ( | const char * | name | ) | [virtual] |
virtual void vtkPassArrays::RemoveArray | ( | int | fieldType, |
const char * | name | ||
) | [virtual] |
virtual void vtkPassArrays::RemovePointDataArray | ( | const char * | name | ) | [virtual] |
virtual void vtkPassArrays::RemoveCellDataArray | ( | const char * | name | ) | [virtual] |
virtual void vtkPassArrays::RemoveFieldDataArray | ( | const char * | name | ) | [virtual] |
virtual void vtkPassArrays::ClearArrays | ( | ) | [virtual] |
Clear all arrays to pass through.
virtual void vtkPassArrays::ClearPointDataArrays | ( | ) | [virtual] |
Clear all arrays to pass through.
virtual void vtkPassArrays::ClearCellDataArrays | ( | ) | [virtual] |
Clear all arrays to pass through.
virtual void vtkPassArrays::ClearFieldDataArrays | ( | ) | [virtual] |
Clear all arrays to pass through.
virtual void vtkPassArrays::SetRemoveArrays | ( | bool | ) | [virtual] |
Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.
virtual bool vtkPassArrays::GetRemoveArrays | ( | ) | [virtual] |
Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.
virtual void vtkPassArrays::RemoveArraysOn | ( | ) | [virtual] |
Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.
virtual void vtkPassArrays::RemoveArraysOff | ( | ) | [virtual] |
Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.
virtual void vtkPassArrays::SetUseFieldTypes | ( | bool | ) | [virtual] |
Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.
virtual bool vtkPassArrays::GetUseFieldTypes | ( | ) | [virtual] |
Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.
virtual void vtkPassArrays::UseFieldTypesOn | ( | ) | [virtual] |
Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.
virtual void vtkPassArrays::UseFieldTypesOff | ( | ) | [virtual] |
Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.
virtual void vtkPassArrays::AddFieldType | ( | int | fieldType | ) | [virtual] |
Add a field type to process. fieldType where the array that should be passed (point data, cell data, etc.). It should be one of the constants defined in the vtkDataObject::AttributeTypes enumeration. NOTE: These are only used if UseFieldType is turned on.
virtual void vtkPassArrays::ClearFieldTypes | ( | ) | [virtual] |
Clear all field types to process.
virtual int vtkPassArrays::ProcessRequest | ( | vtkInformation * | request, |
vtkInformationVector ** | inputVector, | ||
vtkInformationVector * | outputVector | ||
) | [virtual] |
This is required to capture REQUEST_DATA_OBJECT requests.
Reimplemented from vtkDataObjectAlgorithm.
virtual int vtkPassArrays::RequestDataObject | ( | vtkInformation * | request, |
vtkInformationVector ** | inputVector, | ||
vtkInformationVector * | outputVector | ||
) | [protected, virtual] |
Creates the same output type as the input type.
Reimplemented from vtkDataObjectAlgorithm.
int vtkPassArrays::RequestData | ( | vtkInformation * | , |
vtkInformationVector ** | , | ||
vtkInformationVector * | |||
) | [protected, virtual] |
Reimplemented from vtkDataObjectAlgorithm.
bool vtkPassArrays::RemoveArrays [protected] |
Definition at line 147 of file vtkPassArrays.h.
bool vtkPassArrays::UseFieldTypes [protected] |
Definition at line 148 of file vtkPassArrays.h.
Internals* vtkPassArrays::Implementation [protected] |
Definition at line 151 of file vtkPassArrays.h.