vtkPassArrays Class Reference

#include <vtkPassArrays.h>

Inheritance diagram for vtkPassArrays:

[legend]

Collaboration diagram for vtkPassArrays:

[legend]

List of all members.

Detailed Description

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.

Tests:: vtkPassArrays (Tests)

Definition at line 67 of file vtkPassArrays.h.


Public Types
typedef vtkDataObjectAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	AddArray (int fieldType, const char *name)
virtual void	ClearArrays ()
virtual void	AddFieldType (int fieldType)
virtual void	ClearFieldTypes ()

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 (vtkObject *o)
Protected Member Functions
	vtkPassArrays ()
	~vtkPassArrays ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
Protected Attributes
bool	RemoveArrays
bool	UseFieldTypes
Internals *	Implementation

Member Typedef Documentation

typedef vtkDataObjectAlgorithm vtkPassArrays::Superclass

Reimplemented from vtkDataObjectAlgorithm.

Definition at line 71 of file vtkPassArrays.h.

Constructor & Destructor Documentation

vtkPassArrays::vtkPassArrays ( ) [protected]

vtkPassArrays::~vtkPassArrays ( ) [protected]

Member Function Documentation

static vtkPassArrays* vtkPassArrays::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkDataObjectAlgorithm.

virtual const char* vtkPassArrays::GetClassName ( ) [virtual]

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 ( vtkObject * o ) [static]

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::ClearArrays ( ) [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]`