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

vtkAttributeData Class Reference

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

#include <vtkAttributeData.h>

Inheritance diagram for vtkAttributeData:

[legend]Collaboration diagram for vtkAttributeData:

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 *)
vtkDataArray *	GetData ()
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
vtkDataArray *	Data

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

Definition at line 60 of file vtkAttributeData.h.

Constructor & Destructor Documentation

vtkAttributeData::vtkAttributeData ( ) [protected]

vtkAttributeData::vtkAttributeData ( int dataType ) [protected]

vtkAttributeData::~vtkAttributeData ( ) [protected]

vtkAttributeData::vtkAttributeData ( const vtkAttributeData & ) [inline, protected]

Definition at line 140 of file vtkAttributeData.h.

Member Function Documentation

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, vtkNormals, vtkPoints, vtkScalars, vtkTCoords, vtkTensors, and vtkVectors.

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, vtkNormals, vtkPoints, vtkScalars, vtkTCoords, vtkTensors, and vtkVectors.

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, vtkNormals, vtkPoints, vtkScalars, vtkTCoords, vtkTensors, and vtkVectors.

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, vtkNormals, vtkPoints, vtkScalars, vtkTCoords, vtkTensors, and vtkVectors.

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, vtkNormals, vtkPoints, vtkScalars, vtkTCoords, vtkTensors, and vtkVectors.

virtual int vtkAttributeData::Allocate ( const int sz,

const int ext = 1000

) [virtual]

Allocate initial memory size.

virtual void vtkAttributeData::Initialize ( ) [virtual]

Return object to instantiated state.

virtual vtkAttributeData* vtkAttributeData::MakeObject ( ) [pure virtual]

Virtual constructor creates object of same type as this object.
Reimplemented in vtkGhostLevels, vtkNormals, vtkPoints, vtkScalars, vtkTCoords, vtkTensors, and vtkVectors.

virtual void vtkAttributeData::SetData ( vtkDataArray * data ) [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, vtkFloatPoints, vtkFloatScalars, vtkFloatTCoords, vtkFloatTensors, vtkFloatVectors, vtkScalars, and vtkTCoords.
Referenced by vtkFloatVectors::SetData(), vtkFloatTensors::SetData(), vtkFloatPoints::SetData(), and vtkFloatNormals::SetData().

vtkDataArray* vtkAttributeData::GetData ( ) [inline]

Definition at line 82 of file vtkAttributeData.h.
Referenced by vtkGhostLevels::GetGhostLevel(), vtkGhostLevels::InsertGhostLevel(), vtkGhostLevels::InsertNextGhostLevel(), and vtkGhostLevels::SetGhostLevel().

virtual int vtkAttributeData::GetDataType ( ) [virtual]

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

virtual void vtkAttributeData::SetDataType ( int type ) [virtual]

Specify the underlying data type of the object.
Reimplemented in vtkFloatNormals, vtkFloatPoints, vtkFloatScalars, vtkFloatTCoords, vtkFloatTensors, and vtkFloatVectors.
Referenced by vtkFloatVectors::SetDataType(), vtkFloatTensors::SetDataType(), vtkFloatTCoords::SetDataType(), vtkFloatScalars::SetDataType(), vtkFloatPoints::SetDataType(), and vtkFloatNormals::SetDataType().

void vtkAttributeData::SetDataTypeToBit ( ) [inline]

Definition at line 90 of file vtkAttributeData.h.

void vtkAttributeData::SetDataTypeToChar ( ) [inline]

Definition at line 91 of file vtkAttributeData.h.

void vtkAttributeData::SetDataTypeToUnsignedChar ( ) [inline]

Definition at line 92 of file vtkAttributeData.h.

void vtkAttributeData::SetDataTypeToShort ( ) [inline]

Definition at line 93 of file vtkAttributeData.h.

void vtkAttributeData::SetDataTypeToUnsignedShort ( ) [inline]

Definition at line 94 of file vtkAttributeData.h.

void vtkAttributeData::SetDataTypeToInt ( ) [inline]

Definition at line 95 of file vtkAttributeData.h.

void vtkAttributeData::SetDataTypeToUnsignedInt ( ) [inline]

Definition at line 96 of file vtkAttributeData.h.

void vtkAttributeData::SetDataTypeToLong ( ) [inline]

Definition at line 97 of file vtkAttributeData.h.

void vtkAttributeData::SetDataTypeToUnsignedLong ( ) [inline]

Definition at line 98 of file vtkAttributeData.h.

void vtkAttributeData::SetDataTypeToFloat ( ) [inline]

Definition at line 99 of file vtkAttributeData.h.

void vtkAttributeData::SetDataTypeToDouble ( ) [inline]

Definition at line 100 of file vtkAttributeData.h.

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

Return a void pointer. For image pipeline interface and other special pointer manipulation.
Definition at line 104 of file vtkAttributeData.h.

virtual void vtkAttributeData::Squeeze ( ) [inline, virtual]

Reclaim any extra memory.
Definition at line 107 of file vtkAttributeData.h.

virtual void vtkAttributeData::Reset ( ) [inline, virtual]

Make object look empty but do not delete memory.
Definition at line 110 of file vtkAttributeData.h.

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.

virtual void vtkAttributeData::ShallowCopy ( vtkAttributeData * ad ) [virtual]

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.

void vtkAttributeData::DeepCopy ( vtkAttributeData & ad ) [inline]

For legacy compatibility. Do not use.
Definition at line 128 of file vtkAttributeData.h.

void vtkAttributeData::ShallowCopy ( vtkAttributeData & ad ) [inline]

Definition at line 130 of file vtkAttributeData.h.

void vtkAttributeData::operator= ( const vtkAttributeData & ) [inline, protected]

Definition at line 141 of file vtkAttributeData.h.

Member Data Documentation

vtkDataArray* vtkAttributeData::Data [protected]

Definition at line 143 of file vtkAttributeData.h.

The documentation for this class was generated from the following file:

common/vtkAttributeData.h

Generated on Wed Nov 21 12:46:29 2001 for VTK by

vtkAttributeData Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation