vtkGenericAttribute Class Reference

abstract class defined API for attribute data More...

#include <vtkGenericAttribute.h>

Inheritance diagram for vtkGenericAttribute:

Collaboration diagram for vtkGenericAttribute:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkGenericAttribute *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual const char *	GetName ()=0
virtual int	GetNumberOfComponents ()=0
virtual int	GetCentering ()=0
virtual int	GetType ()=0
virtual int	GetComponentType ()=0
virtual vtkIdType	GetSize ()=0
virtual unsigned long	GetActualMemorySize ()=0
virtual double *	GetRange (int component=0)=0
virtual double	GetMaxNorm ()=0
virtual double *	GetTuple (vtkGenericAdaptorCell *c)=0
virtual void	GetTuple (vtkGenericAdaptorCell *c, double *tuple)=0
virtual double *	GetTuple (vtkGenericCellIterator *c)=0
virtual void	GetTuple (vtkGenericCellIterator *c, double *tuple)=0
virtual double *	GetTuple (vtkGenericPointIterator *p)=0
virtual void	GetTuple (vtkGenericPointIterator *p, double *tuple)=0
virtual void	GetComponent (int i, vtkGenericCellIterator *c, double *values)=0
virtual double	GetComponent (int i, vtkGenericPointIterator *p)=0
virtual void	DeepCopy (vtkGenericAttribute *other)=0
virtual void	ShallowCopy (vtkGenericAttribute *other)=0
virtual void	GetRange (int component, double range[2])=0
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkGenericAttribute *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGenericAttribute ()
	~vtkGenericAttribute ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

abstract class defined API for attribute data

vtkGenericAttribute is an abstract class that defines an API for attribute data. Attribute data is data associated with the topology or geometry of a dataset (i.e., points, cells, etc.). vtkGenericAttribute is part of the adaptor framework (see GenericFiltering/README.html).

vtkGenericAttribute provides a more general interface to attribute data than its counterpart vtkDataArray (which assumes a linear, contiguous array). It adopts an iterator interface, and allows attributes to be associated with points, edges, faces, or edges.

Tests:

vtkGenericAttribute (Tests)

Definition at line 49 of file vtkGenericAttribute.h.

Member Typedef Documentation

typedef vtkObject vtkGenericAttribute::Superclass

Definition at line 52 of file vtkGenericAttribute.h.

Constructor & Destructor Documentation

vtkGenericAttribute::vtkGenericAttribute ( )

protected

vtkGenericAttribute::~vtkGenericAttribute ( )

protected

Member Function Documentation

static int vtkGenericAttribute::IsTypeOf ( const char *  type )

static

virtual int vtkGenericAttribute::IsA ( const char *  name )

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

static vtkGenericAttribute* vtkGenericAttribute::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkGenericAttribute::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkBridgeAttribute.

vtkGenericAttribute* vtkGenericAttribute::NewInstance

(

)

const

virtual void vtkGenericAttribute::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 vtkBridgeAttribute.

virtual const char* vtkGenericAttribute::GetName ( )

pure virtual

Name of the attribute. (e.g. "velocity")

Postcondition

result_may_not_exist: result!=0 || result==0

Implemented in vtkBridgeAttribute.

virtual int vtkGenericAttribute::GetNumberOfComponents ( )

pure virtual

Dimension of the attribute. (1 for scalar, 3 for velocity)

Postcondition

positive_result: result>=0

GetType()==VTK_SCALARS implies result==1

(GetType()==VTK_VECTORS||(GetType()==VTK_NORMALS)||(GetType()==VTK_TCOORDS) implies result==3

GetType()==VTK_TENSORS implies result==6

Implemented in vtkBridgeAttribute.

virtual int vtkGenericAttribute::GetCentering ( )

pure virtual

Is the attribute centered either on points, cells or boundaries?

Postcondition

valid_result: (result==vtkPointCentered)||(result==vtkCellCentered)

Implemented in vtkBridgeAttribute.

virtual int vtkGenericAttribute::GetType ( )

pure virtual

Type of the attribute: scalar, vector, normal, texture coordinate, tensor

Postcondition

valid_result: (result==vtkDataSetAttributes::SCALARS) ||(result==vtkDataSetAttributes::VECTORS) ||(result==vtkDataSetAttributes::NORMALS) ||(result==vtkDataSetAttributes::TCOORDS) ||(result==vtkDataSetAttributes::TENSORS)

Implemented in vtkBridgeAttribute.

virtual int vtkGenericAttribute::GetComponentType ( )

pure virtual

Type of the components of the attribute: int, float, double

Postcondition

valid_result: (result==VTK_BIT) ||(result==VTK_CHAR) ||(result==VTK_UNSIGNED_CHAR) ||(result==VTK_SHORT) ||(result==VTK_UNSIGNED_SHORT)||(result==VTK_INT) ||(result==VTK_UNSIGNED_INT) ||(result==VTK_LONG) ||(result==VTK_UNSIGNED_LONG) ||(result==VTK_FLOAT) ||(result==VTK_DOUBLE) ||(result==VTK_ID_TYPE)

Implemented in vtkBridgeAttribute.

virtual vtkIdType vtkGenericAttribute::GetSize ( )

pure virtual

Number of tuples.

Postcondition

valid_result: result>=0

Implemented in vtkBridgeAttribute.

virtual unsigned long vtkGenericAttribute::GetActualMemorySize ( )

pure virtual

Size in kibibytes (1024 bytes) taken by the attribute.

Implemented in vtkBridgeAttribute.

virtual double* vtkGenericAttribute::GetRange ( int  component = 0 )

pure virtual

Range of the attribute component `component'. If `component'==-1, it returns the range of the magnitude (euclidean norm). It returns double, even if GetType()==VTK_INT. NOT THREAD SAFE

Precondition

valid_component: (component>=-1)&&(component<GetNumberOfComponents())

Postcondition

result_exists: result!=0

Implemented in vtkBridgeAttribute.

virtual void vtkGenericAttribute::GetRange ( int  component, double  range[2]  )

pure virtual

Range of the attribute component `component'. If `component'==-1, it returns the range of the magnitude (euclidean norm). THREAD SAFE

Precondition

valid_component: (component>=-1)&&(component<GetNumberOfComponents())

Implemented in vtkBridgeAttribute.

virtual double vtkGenericAttribute::GetMaxNorm ( )

pure virtual

Return the maximum euclidean norm for the tuples.

Postcondition

positive_result: result>=0

Implemented in vtkBridgeAttribute.

virtual double* vtkGenericAttribute::GetTuple ( vtkGenericAdaptorCell *  c )

pure virtual

Attribute at all points of cell `c'.

Precondition

c_exists: c!=0

c_valid: !c->IsAtEnd()

Postcondition

result_exists: result!=0

valid_result: sizeof(result)==GetNumberOfComponents()*c->GetCell()->GetNumberOfPoints()

Implemented in vtkBridgeAttribute.

virtual void vtkGenericAttribute::GetTuple ( vtkGenericAdaptorCell *  c, double *  tuple  )

pure virtual

Put attribute at all points of cell `c' in `tuple'.

Precondition

c_exists: c!=0

c_valid: !c->IsAtEnd()

tuple_exists: tuple!=0

valid_tuple: sizeof(tuple)>=GetNumberOfComponents()*c->GetCell()->GetNumberOfPoints()

Implemented in vtkBridgeAttribute.

virtual double* vtkGenericAttribute::GetTuple ( vtkGenericCellIterator *  c )

pure virtual

Attribute at all points of cell `c'.

Precondition

c_exists: c!=0

c_valid: !c->IsAtEnd()

Postcondition

result_exists: result!=0

valid_result: sizeof(result)==GetNumberOfComponents()*c->GetCell()->GetNumberOfPoints()

Implemented in vtkBridgeAttribute.

virtual void vtkGenericAttribute::GetTuple ( vtkGenericCellIterator *  c, double *  tuple  )

pure virtual

Put attribute at all points of cell `c' in `tuple'.

Precondition

c_exists: c!=0

c_valid: !c->IsAtEnd()

tuple_exists: tuple!=0

valid_tuple: sizeof(tuple)>=GetNumberOfComponents()*c->GetCell()->GetNumberOfPoints()

Implemented in vtkBridgeAttribute.

virtual double* vtkGenericAttribute::GetTuple ( vtkGenericPointIterator *  p )

pure virtual

Value of the attribute at position `p'.

Precondition

p_exists: p!=0

p_valid: !p->IsAtEnd()

Postcondition

result_exists: result!=0

valid_result_size: sizeof(result)==GetNumberOfComponents()

Implemented in vtkBridgeAttribute.

virtual void vtkGenericAttribute::GetTuple ( vtkGenericPointIterator *  p, double *  tuple  )

pure virtual

Put the value of the attribute at position `p' into `tuple'.

Precondition

p_exists: p!=0

p_valid: !p->IsAtEnd()

tuple_exists: tuple!=0

valid_tuple_size: sizeof(tuple)>=GetNumberOfComponents()

Implemented in vtkBridgeAttribute.

virtual void vtkGenericAttribute::GetComponent ( int  i, vtkGenericCellIterator *  c, double *  values  )

pure virtual

Put component `i' of the attribute at all points of cell `c' in `values'.

Precondition

valid_component: (i>=0) && (i<GetNumberOfComponents())

c_exists: c!=0

c_valid: !c->IsAtEnd()

values_exist: values!=0

valid_values: sizeof(values)>=c->GetCell()->GetNumberOfPoints()

Implemented in vtkBridgeAttribute.

virtual double vtkGenericAttribute::GetComponent ( int  i, vtkGenericPointIterator *  p  )

pure virtual

Value of the component `i' of the attribute at position `p'.

Precondition

valid_component: (i>=0) && (i<GetNumberOfComponents())

p_exists: p!=0

p_valid: !p->IsAtEnd()

Implemented in vtkBridgeAttribute.

virtual void vtkGenericAttribute::DeepCopy ( vtkGenericAttribute *  other )

pure virtual

Recursive duplication of `other' in `this'.

Precondition

other_exists: other!=0

not_self: other!=this

Implemented in vtkBridgeAttribute.

virtual void vtkGenericAttribute::ShallowCopy ( vtkGenericAttribute *  other )

pure virtual

Update `this' using fields of `other'.

Precondition

other_exists: other!=0

not_self: other!=this

Implemented in vtkBridgeAttribute.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkGenericAttribute.h