Documentation for vtkAttributeData

vtkAttributeData - abstract class defines API for attribute data

Description:

vtkAttributeData is an abstract class that defines an API and methods to support attribute data such as scalars, vectors, tensors, etc. The class works by managing an underlying data array. This data array can be explicitly set or alternatively, created by the object. You can control the type of the underlying data, if necessary.

See Also:

vtkPoints vtkScalars vtkVectors vtkNormals vtkTCoords vtkTensors vtkFieldData

Methods:

	void vtkAttributeData (int )
	void vtkAttributeData ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	int Allocate (const int ,const int )
	void Initialize ()
	vtkAttributeData *MakeObject ()
	void SetData (vtkDataArray *)
	vtkDataArray *GetData ()
	int GetDataType ()
	void SetDataType (int )
	void SetDataTypeToBit ()
	void SetDataTypeToChar ()
	void SetDataTypeToUnsignedChar ()
	void SetDataTypeToShort ()
	void SetDataTypeToUnsignedShort ()
	void SetDataTypeToInt ()
	void SetDataTypeToUnsignedInt ()
	void SetDataTypeToLong ()
	void SetDataTypeToUnsignedLong ()
	void SetDataTypeToFloat ()
	void SetDataTypeToDouble ()
	void *GetVoidPointer (const int )
	void Squeeze ()
	void Reset ()
	void DeepCopy (vtkAttributeData *)
	void ShallowCopy (vtkAttributeData *)
	void DeepCopy (vtkAttributeData &)
	void ShallowCopy (vtkAttributeData &)

Detailed Method Descriptions:

Construct object with an initial data array of type dataType (by default dataType is VTK_FLOAT.

void vtkAttributeData (int )

Virtual constructor creates object of same type as this object.

vtkAttributeData *MakeObject ()

Set/Get the underlying data array. This function must be implemented in a concrete subclass to check for consistency. (The tuple size must match the type of data. For example, 3-tuple data array can be assigned to a vector, normal, or points object, but not a tensor object, which has a tuple dimension of 9. Scalars, on the other hand, can have tuple dimension from 1-4, depending on the type of scalar.)

	void SetData (vtkDataArray *)
	vtkDataArray *GetData ()

Return the underlying data type. An integer indicating data type is returned as specified in vtkSetGet.h.

int GetDataType ()

Specify the underlying data type of the object.

	void SetDataType (int )
	void SetDataTypeToBit ()
	void SetDataTypeToChar ()
	void SetDataTypeToUnsignedChar ()
	void SetDataTypeToShort ()
	void SetDataTypeToUnsignedShort ()
	void SetDataTypeToInt ()
	void SetDataTypeToUnsignedInt ()
	void SetDataTypeToLong ()
	void SetDataTypeToUnsignedLong ()
	void SetDataTypeToFloat ()
	void SetDataTypeToDouble ()

Return a void pointer. For image pipeline interface and other special pointer manipulation.

void *GetVoidPointer (const int )

Reclaim any extra memory.

void Squeeze ()

Make object look empty but do not delete memory.

void Reset ()

Different ways to copy data. Shallow copy does reference count (i.e., assigns pointers and updates reference count); deep copy runs through entire data array assigning values.

	void DeepCopy (vtkAttributeData *)
	void ShallowCopy (vtkAttributeData *)

For legacy compatibility. Do not use.

void DeepCopy (vtkAttributeData &)