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

vtkAttributeData Class Reference

abstract class defines API for attribute data. More...

#include <vtkAttributeData.h>

Inheritance diagram for vtkAttributeData:

Inheritance graph
[legend]
Collaboration diagram for vtkAttributeData:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int Allocate (const int sz, const int ext=1000)
virtual void Initialize ()
virtual vtkAttributeData * MakeObject ()=0
virtual void SetData (vtkDataArray *)
vtkDataArrayGetData ()
virtual int GetDataType ()
virtual void SetDataType (int dataType)
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 id)
virtual void Squeeze ()
virtual void Reset ()
virtual void DeepCopy (vtkAttributeData *ad)
virtual void ShallowCopy (vtkAttributeData *ad)
unsigned long GetActualMemorySize ()
void DeepCopy (vtkAttributeData &ad)
void ShallowCopy (vtkAttributeData &ad)

Static Public Methods

int IsTypeOf (const char *type)
vtkAttributeData * SafeDownCast (vtkObject *o)

Protected Methods

 vtkAttributeData ()
 vtkAttributeData (int dataType)
 ~vtkAttributeData ()
 vtkAttributeData (const vtkAttributeData &)
void operator= (const vtkAttributeData &)

Protected Attributes

vtkDataArrayData

Detailed Description

abstract class defines API for attribute data.

Date:
2000/12/10 20:08:06
Revision:
1.17

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


Member Function Documentation

virtual int vtkAttributeData::Allocate const int    sz,
const int    ext = 1000
[virtual]
 

Allocate initial memory size.

void vtkAttributeData::DeepCopy vtkAttributeData &    ad [inline]
 

For legacy compatibility. Do not use.

virtual void vtkAttributeData::DeepCopy vtkAttributeData *    ad [virtual]
 

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.

unsigned long vtkAttributeData::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.

virtual const char* vtkAttributeData::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 vtkGhostLevels.

virtual int vtkAttributeData::GetDataType   [virtual]
 

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

void* vtkAttributeData::GetVoidPointer const int    id [inline]
 

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

virtual void vtkAttributeData::Initialize   [virtual]
 

Return object to instantiated state.

virtual int vtkAttributeData::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 vtkGhostLevels.

int vtkAttributeData::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 vtkGhostLevels.

virtual vtkAttributeData* vtkAttributeData::MakeObject   [pure virtual]
 

Virtual constructor creates object of same type as this object.

Implemented in vtkGhostLevels.

void vtkAttributeData::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 vtkObject.

Reimplemented in vtkGhostLevels.

virtual void vtkAttributeData::Reset   [inline, virtual]
 

Make object look empty but do not delete memory.

vtkAttributeData* vtkAttributeData::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 vtkGhostLevels.

virtual void vtkAttributeData::SetData vtkDataArray   [virtual]
 

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

Reimplemented in vtkFloatNormals.

virtual void vtkAttributeData::SetDataType int    dataType [virtual]
 

Specify the underlying data type of the object.

Reimplemented in vtkFloatNormals.

virtual void vtkAttributeData::Squeeze   [inline, virtual]
 

Reclaim any extra memory.


The documentation for this class was generated from the following file:
Generated on Tue Mar 19 13:23:43 2002 for VTK by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002