Documentation for vtkDataSetAttributes

vtkDataSetAttributes - represent and manipulate attribute data in a dataset

Super Class: vtkObject

Description:

vtkDataSetAttributes is a class that is used to represent and manipulate attribute data (e.g., scalars, vectors, normals, texture coordinates, tensors, and field data) Special methods are provided to work with filter objects, such as passing data through filter, copying data from one attribute set to another, and interpolating data given cell interpolation weights.

 

Methods:

void vtkDataSetAttributes ()
void Initialize ()
void vtkDataSetAttributes ()
static vtkDataSetAttributes *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
void Update ()
void PassData (vtkDataSetAttributes *)
void PassNoReplaceData (vtkDataSetAttributes *)
void CopyAllocate (vtkDataSetAttributes * ,int ,int )
void CopyData (vtkDataSetAttributes * ,int ,int )
void InterpolateAllocate (vtkDataSetAttributes * ,int ,int )
void InterpolatePoint (vtkDataSetAttributes * ,int ,vtkIdList * ,float *)
void InterpolateEdge (vtkDataSetAttributes * ,int ,int ,int ,float )
void DeepCopy (vtkDataSetAttributes *)
void ShallowCopy (vtkDataSetAttributes *)
void Squeeze ()
unsigned long GetMTime ()
void SetScalars (vtkScalars *)
vtkScalars *GetScalars ()
void SetVectors (vtkVectors *)
vtkVectors *GetVectors ()
void SetNormals (vtkNormals *)
vtkNormals *GetNormals ()
void SetTCoords (vtkTCoords *)
vtkTCoords *GetTCoords ()
void SetTensors (vtkTensors *)
vtkTensors *GetTensors ()
void SetFieldData (vtkFieldData *)
vtkFieldData *GetFieldData ()
void SetCopyScalars (int )
int GetCopyScalars ()
void CopyScalarsOn ()
void CopyScalarsOff ()
void SetCopyVectors (int )
int GetCopyVectors ()
void CopyVectorsOn ()
void CopyVectorsOff ()
void SetCopyNormals (int )
int GetCopyNormals ()
void CopyNormalsOn ()
void CopyNormalsOff ()
void SetCopyTCoords (int )
int GetCopyTCoords ()
void CopyTCoordsOn ()
void CopyTCoordsOff ()
void SetCopyTensors (int )
int GetCopyTensors ()
void CopyTensorsOn ()
void CopyTensorsOff ()
void SetCopyFieldData (int )
int GetCopyFieldData ()
void CopyFieldDataOn ()
void CopyFieldDataOff ()
int GetAnyEnabled ()
void CopyAllOn ()
void CopyAllOff ()
void CopyTuple (vtkDataArray * ,vtkDataArray * ,int ,int )
void DeepCopy (vtkDataSetAttributes &)
void ShallowCopy (vtkDataSetAttributes &)
void InterpolateTuple (vtkDataArray * ,vtkDataArray * ,int ,vtkIdList * ,float *)
void InterpolateTuple (vtkDataArray * ,vtkDataArray * ,int ,int ,int ,float )

 

Detailed Method Descriptions:

Construct object with copying turned on for all data.

void vtkDataSetAttributes ()

Initialize all of the object's data to NULL

void Initialize ()

Destructor for the vtkDataSetAttributes objects.

void vtkDataSetAttributes ()

Pass entire arrays of input data through to output. Obey the "copy" flags.

void PassData (vtkDataSetAttributes *)

Pass entire arrays of input data through to output. Obey the "copy" flags. Only passes the data if the output attribute is NULL (i.e., not set).

void PassNoReplaceData (vtkDataSetAttributes *)

Allocates point data for point-by-point (or cell-by-cell) copy operation. If sze=0, then use the input DataSetAttributes to create (i.e., find initial size of) new objects; otherwise use the sze variable.

void CopyAllocate (vtkDataSetAttributes * ,int ,int )

Copy the attribute data from one id to another. Make sure CopyAllocate() has been invoked before using this method.

void CopyData (vtkDataSetAttributes * ,int ,int )

Initialize point interpolation method.

void InterpolateAllocate (vtkDataSetAttributes * ,int ,int )

Interpolate a points attributes from other points.

void InterpolatePoint (vtkDataSetAttributes * ,int ,vtkIdList * ,float *)

Interpolate data from the two points p1,p2 (forming an edge) and an interpolation factor, t, along the edge. The weight ranges from (0,1), with t=0 located at p1. Make sure that the method InterpolateAllocate() has been invoked before using this method.

void InterpolateEdge (vtkDataSetAttributes * ,int ,int ,int ,float )

Deep copy of data (i.e., create new data arrays and copy from input data).

void DeepCopy (vtkDataSetAttributes *)

Shallow copy of data (i.e., use reference counting).

void ShallowCopy (vtkDataSetAttributes *)

Resize object to just fit data requirements. Reclaims extra memory.

void Squeeze ()

Check object's components for modified times.

unsigned long GetMTime ()

Set/Get the scalar data.

void SetScalars (vtkScalars *)
vtkScalars *GetScalars ()

Set/Get the vector data.

void SetVectors (vtkVectors *)
vtkVectors *GetVectors ()

Set/get the normal data.

void SetNormals (vtkNormals *)
vtkNormals *GetNormals ()

Set/Get the texture coordinate data.

void SetTCoords (vtkTCoords *)
vtkTCoords *GetTCoords ()

Set/Get the tensor data.

void SetTensors (vtkTensors *)
vtkTensors *GetTensors ()

Set/Get the field data.

void SetFieldData (vtkFieldData *)
vtkFieldData *GetFieldData ()

Turn on/off the copying of scalar data.

void SetCopyScalars (int )
int GetCopyScalars ()
void CopyScalarsOn ()
void CopyScalarsOff ()

Turn on/off the copying of vector data.

void SetCopyVectors (int )
int GetCopyVectors ()
void CopyVectorsOn ()
void CopyVectorsOff ()

Turn on/off the copying of normals data.

void SetCopyNormals (int )
int GetCopyNormals ()
void CopyNormalsOn ()
void CopyNormalsOff ()

Turn on/off the copying of texture coordinates data.

void SetCopyTCoords (int )
int GetCopyTCoords ()
void CopyTCoordsOn ()
void CopyTCoordsOff ()

Turn on/off the copying of tensor data.

void SetCopyTensors (int )
int GetCopyTensors ()
void CopyTensorsOn ()
void CopyTensorsOff ()

Turn on/off the copying of field data.

void SetCopyFieldData (int )
int GetCopyFieldData ()
void CopyFieldDataOn ()
void CopyFieldDataOff ()

Turn on copying of all data.

int GetAnyEnabled ()
void CopyAllOn ()

Turn off copying of all data.

void CopyAllOff ()

Copy a tuple of data from one data array to another. This method (and following ones) assume that the fromData and toData objects are of the same type, and have the same number of components. This is true if you invoke CopyAllocate() or InterpolateAllocate().

void CopyTuple (vtkDataArray * ,vtkDataArray * ,int ,int )

For legacy compatibility. Do not use.

void DeepCopy (vtkDataSetAttributes &)