Labels a field as an attribute. More...

#include <vtkAssignAttribute.h>

Inheritance diagram for vtkAssignAttribute:

Collaboration diagram for vtkAssignAttribute:

Public Types
enum	AttributeLocation { POINT_DATA = 0, CELL_DATA = 1, VERTEX_DATA = 2, EDGE_DATA = 3, NUM_ATTRIBUTE_LOCS }
typedef vtkPassInputTypeAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkAssignAttribute *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	Assign (int inputAttributeType, int attributeType, int attributeLoc)
void	Assign (const char *fieldName, int attributeType, int attributeLoc)

void	Assign (const char name, const char attributeType, const char *attributeLoc)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkAssignAttribute *	SafeDownCast (vtkObjectBase *o)
static vtkAssignAttribute *	New ()
Protected Types
enum	FieldType { NAME, ATTRIBUTE }
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAssignAttribute ()
virtual	~vtkAssignAttribute ()
int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
int	FillInputPortInformation (int, vtkInformation *)
Protected Attributes
char *	FieldName
int	FieldTypeAssignment
int	AttributeType
int	InputAttributeType
int	AttributeLocationAssignment
Static Protected Attributes
static char	AttributeLocationNames [vtkAssignAttribute::NUM_ATTRIBUTE_LOCS][12]
static char	AttributeNames [vtkDataSetAttributes::NUM_ATTRIBUTES][20]

Detailed Description

Labels a field as an attribute.

vtkAssignAttribute is use to label a field (vtkDataArray) as an attribute. A field name or an attribute to labeled can be specified. For example:

 aa->Assign("foo", vtkDataSetAttributes::SCALARS,
            vtkAssignAttribute::POINT_DATA);

tells vtkAssignAttribute to make the array in the point data called "foo" the active scalars. On the other hand,

 aa->Assign(vtkDataSetAttributes::VECTORS, vtkDataSetAttributes::SCALARS,
            vtkAssignAttribute::POINT_DATA);

tells vtkAssignAttribute to make the active vectors also the active scalars. The same can be done more easily from Tcl by using the Assign() method which takes strings:

 aa Assign "foo" SCALARS POINT_DATA
 or
 aa Assign SCALARS VECTORS POINT_DATA

 AttributeTypes: SCALARS, VECTORS, NORMALS, TCOORDS, TENSORS
 Attribute locations: POINT_DATA, CELL_DATA

Warning:: When using Tcl, Java, Python or Visual Basic bindings, the array name can not be one of the AttributeTypes when calling Assign() which takes strings as arguments. The Tcl (Java etc.) command will always assume the string corresponds to an attribute type when the argument is one of the AttributeTypes. In this situation, use the Assign() which takes enums.

See also:: vtkFieldData vtkDataSet vtkDataObjectToDataSetFilter vtkDataSetAttributes vtkDataArray vtkRearrangeFields vtkSplitField vtkMergeFields

Examples:: vtkAssignAttribute (Examples)

Tests:: vtkAssignAttribute (Tests)

Definition at line 72 of file vtkAssignAttribute.h.

Member Typedef Documentation

typedef vtkPassInputTypeAlgorithm vtkAssignAttribute::Superclass

Reimplemented from vtkPassInputTypeAlgorithm.

Definition at line 75 of file vtkAssignAttribute.h.

Member Enumeration Documentation

enum vtkAssignAttribute::AttributeLocation

Enumerator:

POINT_DATA
CELL_DATA
VERTEX_DATA
EDGE_DATA
NUM_ATTRIBUTE_LOCS

Definition at line 97 of file vtkAssignAttribute.h.

enum vtkAssignAttribute::FieldType [protected]

Enumerator:

NAME
ATTRIBUTE

Definition at line 110 of file vtkAssignAttribute.h.

Constructor & Destructor Documentation

vtkAssignAttribute::vtkAssignAttribute ( ) [protected]

virtual vtkAssignAttribute::~vtkAssignAttribute ( ) [protected, virtual]

Member Function Documentation

static int vtkAssignAttribute::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 vtkPassInputTypeAlgorithm.

virtual int vtkAssignAttribute::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 vtkPassInputTypeAlgorithm.

static vtkAssignAttribute* vtkAssignAttribute::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkPassInputTypeAlgorithm.

virtual vtkObjectBase* vtkAssignAttribute::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkPassInputTypeAlgorithm.

vtkAssignAttribute* vtkAssignAttribute::NewInstance ( ) const

Reimplemented from vtkPassInputTypeAlgorithm.

void vtkAssignAttribute::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 vtkPassInputTypeAlgorithm.

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

Create a new vtkAssignAttribute.

Reimplemented from vtkPassInputTypeAlgorithm.

void vtkAssignAttribute::Assign	(	int	inputAttributeType,
		int	attributeType,
		int	attributeLoc
	)

Label an attribute as another attribute.

void vtkAssignAttribute::Assign	(	const char *	fieldName,
		int	attributeType,
		int	attributeLoc
	)

Label an array as an attribute.

void vtkAssignAttribute::Assign	(	const char *	name,
		const char *	attributeType,
		const char *	attributeLoc
	)

Helper method used by other language bindings. Allows the caller to specify arguments as strings instead of enums.

int vtkAssignAttribute::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)		`[protected, virtual]`

This is called within ProcessRequest when a request asks for Information. Typically an algorithm provides whatever lightweight information about its output that it can here without doing any lengthy computations. This happens in the first pass of the pipeline execution.

Reimplemented from vtkPassInputTypeAlgorithm.

int vtkAssignAttribute::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)		`[protected, virtual]`

This is called within ProcessRequest when a request asks the algorithm to do its work. This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.

Reimplemented from vtkPassInputTypeAlgorithm.

int vtkAssignAttribute::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)		`[protected, virtual]`

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPassInputTypeAlgorithm.