Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkDataSetAttributes Class Reference

represent and manipulate attribute data in a dataset. More...

#include <vtkDataSetAttributes.h>

Inheritance diagram for vtkDataSetAttributes:

Inheritance graph
Collaboration diagram for vtkDataSetAttributes:

Collaboration graph
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void Initialize ()
virtual void Update ()
void PassData (vtkDataSetAttributes *pd)
void PassNoReplaceData (vtkDataSetAttributes *pd)
void CopyAllocate (vtkDataSetAttributes *pd, int sze=0, int ext=1000)
void CopyData (vtkDataSetAttributes *fromPd, int fromId, int toId)
void InterpolateAllocate (vtkDataSetAttributes *pd, int sze=0, int ext=1000)
void InterpolatePoint (vtkDataSetAttributes *fromPd, int toId, vtkIdList *ids, float *weights)
void InterpolateEdge (vtkDataSetAttributes *fromPd, int toId, int p1, int p2, float t)
void InterpolateTime (vtkDataSetAttributes *from1, vtkDataSetAttributes *from2, int id, float t)
void DeepCopy (vtkDataSetAttributes *pd)
void ShallowCopy (vtkDataSetAttributes *pd)
void Squeeze ()
unsigned long int GetMTime ()
virtual void SetScalars (vtkScalars *)
virtual vtkScalarsGetScalars ()
virtual void SetVectors (vtkVectors *)
virtual vtkVectorsGetVectors ()
virtual void SetNormals (vtkNormals *)
virtual vtkNormalsGetNormals ()
virtual void SetGhostLevels (vtkGhostLevels *)
virtual vtkGhostLevelsGetGhostLevels ()
virtual void SetTCoords (vtkTCoords *)
virtual vtkTCoordsGetTCoords ()
virtual void SetTensors (vtkTensors *)
virtual vtkTensorsGetTensors ()
virtual void SetFieldData (vtkFieldData *)
virtual vtkFieldDataGetFieldData ()
virtual void SetCopyScalars (int)
virtual int GetCopyScalars ()
virtual void CopyScalarsOn ()
virtual void CopyScalarsOff ()
virtual void SetCopyVectors (int)
virtual int GetCopyVectors ()
virtual void CopyVectorsOn ()
virtual void CopyVectorsOff ()
virtual void SetCopyGhostLevels (int)
virtual int GetCopyGhostLevels ()
virtual void CopyGhostLevelsOn ()
virtual void CopyGhostLevelsOff ()
virtual void SetCopyNormals (int)
virtual int GetCopyNormals ()
virtual void CopyNormalsOn ()
virtual void CopyNormalsOff ()
virtual void SetCopyTCoords (int)
virtual int GetCopyTCoords ()
virtual void CopyTCoordsOn ()
virtual void CopyTCoordsOff ()
virtual void SetCopyTensors (int)
virtual int GetCopyTensors ()
virtual void CopyTensorsOn ()
virtual void CopyTensorsOff ()
virtual void SetCopyFieldData (int)
virtual int GetCopyFieldData ()
virtual void CopyFieldDataOn ()
virtual void CopyFieldDataOff ()
int GetAnyEnabled ()
void CopyAllOn ()
void CopyAllOff ()
void CopyTuple (vtkDataArray *fromData, vtkDataArray *toData, int fromId, int toId)
unsigned long GetActualMemorySize ()
void DeepCopy (vtkDataSetAttributes &pd)
void ShallowCopy (vtkDataSetAttributes &pd)

Static Public Methods

vtkDataSetAttributes * New ()
int IsTypeOf (const char *type)
vtkDataSetAttributes * SafeDownCast (vtkObject *o)

Protected Methods

 vtkDataSetAttributes ()
 ~vtkDataSetAttributes ()
 vtkDataSetAttributes (const vtkDataSetAttributes &)
void operator= (const vtkDataSetAttributes &)
void InterpolateTuple (vtkDataArray *fromData, vtkDataArray *toData, int toId, vtkIdList *ptIds, float *weights)
void InterpolateTuple (vtkDataArray *fromData, vtkDataArray *toData, int toId, int id1, int id2, float t)
void InterpolateTuple (vtkDataArray *fromData1, vtkDataArray *fromData2, vtkDataArray *toData, int id, float t)

Protected Attributes

int CopyScalars
int CopyVectors
int CopyNormals
int CopyTCoords
int CopyTensors
int CopyFieldData
int CopyGhostLevels
int AnyEnabled
int CopyScalarsEnabled
int CopyVectorsEnabled
int CopyNormalsEnabled
int CopyTCoordsEnabled
int CopyTensorsEnabled
int CopyFieldDataEnabled
int CopyGhostLevelsEnabled
float Null3Tuple [3]
float Null4Tuple [4]
float * NullTuple
int TupleSize
float * Tuple

Detailed Description

represent and manipulate attribute data in a dataset.

2000/12/10 20:08:08

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.

Definition at line 66 of file vtkDataSetAttributes.h.

Constructor & Destructor Documentation

vtkDataSetAttributes::vtkDataSetAttributes   [protected]

vtkDataSetAttributes::~vtkDataSetAttributes   [protected]

vtkDataSetAttributes::vtkDataSetAttributes const vtkDataSetAttributes &    [inline, protected]

Definition at line 240 of file vtkDataSetAttributes.h.

Member Function Documentation

vtkDataSetAttributes* vtkDataSetAttributes::New   [static]

Construct object with copying turned on for all data.

Reimplemented from vtkObject.

Reimplemented in vtkCellData, and vtkPointData.

virtual const char* vtkDataSetAttributes::GetClassName   [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkCellData, and vtkPointData.

int vtkDataSetAttributes::IsTypeOf const char *    type [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 vtkObject.

Reimplemented in vtkCellData, and vtkPointData.

virtual int vtkDataSetAttributes::IsA const char *    type [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 vtkObject.

Reimplemented in vtkCellData, and vtkPointData.

vtkDataSetAttributes* vtkDataSetAttributes::SafeDownCast vtkObject   o [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkCellData, and vtkPointData.

void vtkDataSetAttributes::PrintSelf ostream &    os,
vtkIndent    indent

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 vtkObject.

Reimplemented in vtkCellData, and vtkPointData.

void vtkDataSetAttributes::Initialize  

Initialize all of the object's data to NULL

virtual void vtkDataSetAttributes::Update   [inline, virtual]

Attributes have a chance to bring themselves up to date; right now this is ignored.

Definition at line 80 of file vtkDataSetAttributes.h.

void vtkDataSetAttributes::PassData vtkDataSetAttributes *    pd

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

void vtkDataSetAttributes::PassNoReplaceData vtkDataSetAttributes *    pd

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 vtkDataSetAttributes::CopyAllocate vtkDataSetAttributes *    pd,
int    sze = 0,
int    ext = 1000

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 vtkDataSetAttributes::CopyData vtkDataSetAttributes *    fromPd,
int    fromId,
int    toId

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

void vtkDataSetAttributes::InterpolateAllocate vtkDataSetAttributes *    pd,
int    sze = 0,
int    ext = 1000

Initialize point interpolation method.

void vtkDataSetAttributes::InterpolatePoint vtkDataSetAttributes *    fromPd,
int    toId,
vtkIdList   ids,
float *    weights

Interpolate data set attributes from other data set attributes given cell or point ids and associated interpolation weights.

void vtkDataSetAttributes::InterpolateEdge vtkDataSetAttributes *    fromPd,
int    toId,
int    p1,
int    p2,
float    t

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 vtkDataSetAttributes::InterpolateTime vtkDataSetAttributes *    from1,
vtkDataSetAttributes *    from2,
int    id,
float    t

Interpolate data from the same id (point or cell) at different points in time (parameter t). Two input data set attributes objects are input. The parameter t lies between (0<=t<=1). IMPORTANT: it is assumed that the number of attributes and number of components is the same for both from1 and from2, and the type of data for from1 and from2 are the same. Make sure that the method InterpolateAllocate() has been invoked before using this method.

void vtkDataSetAttributes::DeepCopy vtkDataSetAttributes *    pd

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

void vtkDataSetAttributes::ShallowCopy vtkDataSetAttributes *    pd

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

void vtkDataSetAttributes::Squeeze  

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

unsigned long int vtkDataSetAttributes::GetMTime   [virtual]

Check object's components for modified times.

Reimplemented from vtkObject.

virtual void vtkDataSetAttributes::SetScalars vtkScalars   [virtual]

Set/Get the scalar data.

virtual vtkScalars* vtkDataSetAttributes::GetScalars   [virtual]

virtual void vtkDataSetAttributes::SetVectors vtkVectors   [virtual]

Set/Get the vector data.

virtual vtkVectors* vtkDataSetAttributes::GetVectors   [virtual]

virtual void vtkDataSetAttributes::SetNormals vtkNormals   [virtual]

Set/get the normal data.

virtual vtkNormals* vtkDataSetAttributes::GetNormals   [virtual]

virtual void vtkDataSetAttributes::SetGhostLevels vtkGhostLevels   [virtual]

Set/Get the ghost level data.

virtual vtkGhostLevels* vtkDataSetAttributes::GetGhostLevels   [virtual]

virtual void vtkDataSetAttributes::SetTCoords vtkTCoords   [virtual]

Set/Get the texture coordinate data.

virtual vtkTCoords* vtkDataSetAttributes::GetTCoords   [virtual]

virtual void vtkDataSetAttributes::SetTensors vtkTensors   [virtual]

Set/Get the tensor data.

virtual vtkTensors* vtkDataSetAttributes::GetTensors   [virtual]

virtual void vtkDataSetAttributes::SetFieldData vtkFieldData   [virtual]

Set/Get the field data.

virtual vtkFieldData* vtkDataSetAttributes::GetFieldData   [virtual]

virtual void vtkDataSetAttributes::SetCopyScalars int    [virtual]

Turn on/off the copying of scalar data.

virtual int vtkDataSetAttributes::GetCopyScalars   [virtual]

virtual void vtkDataSetAttributes::CopyScalarsOn   [virtual]

virtual void vtkDataSetAttributes::CopyScalarsOff   [virtual]

virtual void vtkDataSetAttributes::SetCopyVectors int    [virtual]

Turn on/off the copying of vector data.

virtual int vtkDataSetAttributes::GetCopyVectors   [virtual]

virtual void vtkDataSetAttributes::CopyVectorsOn   [virtual]

virtual void vtkDataSetAttributes::CopyVectorsOff   [virtual]

virtual void vtkDataSetAttributes::SetCopyGhostLevels int    [virtual]

Turn on/off the copying of ghost level data.

virtual int vtkDataSetAttributes::GetCopyGhostLevels   [virtual]

virtual void vtkDataSetAttributes::CopyGhostLevelsOn   [virtual]

virtual void vtkDataSetAttributes::CopyGhostLevelsOff   [virtual]

virtual void vtkDataSetAttributes::SetCopyNormals int    [virtual]

Turn on/off the copying of normals data.

virtual int vtkDataSetAttributes::GetCopyNormals   [virtual]

virtual void vtkDataSetAttributes::CopyNormalsOn   [virtual]

virtual void vtkDataSetAttributes::CopyNormalsOff   [virtual]

virtual void vtkDataSetAttributes::SetCopyTCoords int    [virtual]

Turn on/off the copying of texture coordinates data.

virtual int vtkDataSetAttributes::GetCopyTCoords   [virtual]

virtual void vtkDataSetAttributes::CopyTCoordsOn   [virtual]

virtual void vtkDataSetAttributes::CopyTCoordsOff   [virtual]

virtual void vtkDataSetAttributes::SetCopyTensors int    [virtual]

Turn on/off the copying of tensor data.

virtual int vtkDataSetAttributes::GetCopyTensors   [virtual]

virtual void vtkDataSetAttributes::CopyTensorsOn   [virtual]

virtual void vtkDataSetAttributes::CopyTensorsOff   [virtual]

virtual void vtkDataSetAttributes::SetCopyFieldData int    [virtual]

Turn on/off the copying of field data.

virtual int vtkDataSetAttributes::GetCopyFieldData   [virtual]

virtual void vtkDataSetAttributes::CopyFieldDataOn   [virtual]

virtual void vtkDataSetAttributes::CopyFieldDataOff   [virtual]

int vtkDataSetAttributes::GetAnyEnabled   [inline]

Flag indicates whether any data is to be copied or interpolated. This flag can be used to improve performance by avoiding extra CopyData() or Interpolate() calls. This method returns valid results only after CopyAllocate() or InterpolateAllocate() has been invoked.

Definition at line 206 of file vtkDataSetAttributes.h.

void vtkDataSetAttributes::CopyAllOn  

Turn on copying of all data.

void vtkDataSetAttributes::CopyAllOff  

Turn off copying of all data.

void vtkDataSetAttributes::CopyTuple vtkDataArray   fromData,
vtkDataArray   toData,
int    fromId,
int    toId

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().

unsigned long vtkDataSetAttributes::GetActualMemorySize  

Return the memory in kilobytes consumed by this attribute data. Used to support streaming and reading/writing data. The value returned is guaranteed to be greater than or equal to the memory required to actually represent the data represented by this object. The information returned is valid only after the pipeline has been updated.

void vtkDataSetAttributes::DeepCopy vtkDataSetAttributes &    pd [inline]

For legacy compatibility. Do not use.

Definition at line 231 of file vtkDataSetAttributes.h.

void vtkDataSetAttributes::ShallowCopy vtkDataSetAttributes &    pd [inline]

Definition at line 233 of file vtkDataSetAttributes.h.

void vtkDataSetAttributes::operator= const vtkDataSetAttributes &    [inline, protected]

Definition at line 241 of file vtkDataSetAttributes.h.

void vtkDataSetAttributes::InterpolateTuple vtkDataArray   fromData,
vtkDataArray   toData,
int    toId,
vtkIdList   ptIds,
float *    weights

void vtkDataSetAttributes::InterpolateTuple vtkDataArray   fromData,
vtkDataArray   toData,
int    toId,
int    id1,
int    id2,
float    t

void vtkDataSetAttributes::InterpolateTuple vtkDataArray   fromData1,
vtkDataArray   fromData2,
vtkDataArray   toData,
int    id,
float    t

Member Data Documentation

vtkScalars* vtkDataSetAttributes::Scalars [protected]

Definition at line 252 of file vtkDataSetAttributes.h.

vtkVectors* vtkDataSetAttributes::Vectors [protected]

Definition at line 253 of file vtkDataSetAttributes.h.

vtkNormals* vtkDataSetAttributes::Normals [protected]

Definition at line 254 of file vtkDataSetAttributes.h.

vtkTCoords* vtkDataSetAttributes::TCoords [protected]

Definition at line 255 of file vtkDataSetAttributes.h.

vtkTensors* vtkDataSetAttributes::Tensors [protected]

Definition at line 256 of file vtkDataSetAttributes.h.

vtkFieldData* vtkDataSetAttributes::FieldData [protected]

Definition at line 257 of file vtkDataSetAttributes.h.

vtkGhostLevels* vtkDataSetAttributes::GhostLevels [protected]

Definition at line 258 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyScalars [protected]

Definition at line 261 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyVectors [protected]

Definition at line 262 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyNormals [protected]

Definition at line 263 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyTCoords [protected]

Definition at line 264 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyTensors [protected]

Definition at line 265 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyFieldData [protected]

Definition at line 266 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyGhostLevels [protected]

Definition at line 267 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::AnyEnabled [protected]

Definition at line 270 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyScalarsEnabled [protected]

Definition at line 271 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyVectorsEnabled [protected]

Definition at line 272 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyNormalsEnabled [protected]

Definition at line 273 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyTCoordsEnabled [protected]

Definition at line 274 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyTensorsEnabled [protected]

Definition at line 275 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyFieldDataEnabled [protected]

Definition at line 276 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyGhostLevelsEnabled [protected]

Definition at line 277 of file vtkDataSetAttributes.h.

float vtkDataSetAttributes::Null3Tuple[3] [protected]

Definition at line 280 of file vtkDataSetAttributes.h.

float vtkDataSetAttributes::Null4Tuple[4] [protected]

Definition at line 281 of file vtkDataSetAttributes.h.

vtkTensor* vtkDataSetAttributes::NullTensor [protected]

Definition at line 282 of file vtkDataSetAttributes.h.

float* vtkDataSetAttributes::NullTuple [protected]

Definition at line 283 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::TupleSize [protected]

Definition at line 284 of file vtkDataSetAttributes.h.

float* vtkDataSetAttributes::Tuple [protected]

Definition at line 285 of file vtkDataSetAttributes.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:47:20 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001