VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkBridgeAttribute Class Reference

Implementation of vtkGenericAttribute. More...

#include <vtkBridgeAttribute.h>

Inheritance diagram for vtkBridgeAttribute:
[legend]
Collaboration diagram for vtkBridgeAttribute:
[legend]

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
const char * GetName ()
int GetNumberOfComponents ()
int GetCentering ()
int GetType ()
int GetComponentType ()
vtkIdType GetSize ()
unsigned long GetActualMemorySize ()
double * GetRange (int component)
double GetMaxNorm ()
virtual double * GetTuple (vtkGenericAdaptorCell *c)
virtual void GetTuple (vtkGenericAdaptorCell *c, double *tuple)
double * GetTuple (vtkGenericCellIterator *c)
void GetTuple (vtkGenericCellIterator *c, double *tuple)
double * GetTuple (vtkGenericPointIterator *p)
void GetTuple (vtkGenericPointIterator *p, double *tuple)
void GetComponent (int i, vtkGenericCellIterator *c, double *values)
double GetComponent (int i, vtkGenericPointIterator *p)
void DeepCopy (vtkGenericAttribute *other)
void ShallowCopy (vtkGenericAttribute *other)
void GetRange (int component, double range[2])
void InitWithPointData (vtkPointData *d, int i)
void InitWithCellData (vtkCellData *d, int i)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkBridgeAttributeNew ()
static int IsTypeOf (const char *type)
static vtkBridgeAttributeSafeDownCast (vtkObject *o)

Protected Member Functions

void AllocateInternalTuple (int size)
 vtkBridgeAttribute ()
virtual ~vtkBridgeAttribute ()
- Protected Member Functions inherited from vtkGenericAttribute
 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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkPointDataPd
vtkCellDataCd
vtkDataSetAttributesData
int AttributeNumber
double * InternalTuple
int InternalTupleCapacity

Friends

class vtkBridgeCell

Detailed Description

Implementation of vtkGenericAttribute.

It is just an example that show how to implement the Generic. It is also used for testing and evaluating the Generic.

See Also
vtkGenericAttribute, vtkBridgeDataSet
Tests:
vtkBridgeAttribute (Tests)

Definition at line 37 of file vtkBridgeAttribute.h.

Member Typedef Documentation

Definition at line 41 of file vtkBridgeAttribute.h.

Constructor & Destructor Documentation

vtkBridgeAttribute::vtkBridgeAttribute ( )
protected

Default constructor: empty attribute, not valid

virtual vtkBridgeAttribute::~vtkBridgeAttribute ( )
protectedvirtual

Default constructor: empty attribute, not valid

Member Function Documentation

static vtkBridgeAttribute* vtkBridgeAttribute::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkBridgeAttribute::GetClassName ( )
virtual

Reimplemented from vtkGenericAttribute.

static int vtkBridgeAttribute::IsTypeOf ( const char *  name)
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 vtkGenericAttribute.

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

static vtkBridgeAttribute* vtkBridgeAttribute::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkGenericAttribute.

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

const char* vtkBridgeAttribute::GetName ( )
virtual

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

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

Implements vtkGenericAttribute.

int vtkBridgeAttribute::GetNumberOfComponents ( )
virtual

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

Postcondition
positive_result: result>=0

Implements vtkGenericAttribute.

int vtkBridgeAttribute::GetCentering ( )
virtual

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

Postcondition
valid_result: (result==vtkCenteringPoints) || (result==vtkCenteringCells) || (result==vtkCenteringBoundaries)

Implements vtkGenericAttribute.

int vtkBridgeAttribute::GetType ( )
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)

Implements vtkGenericAttribute.

int vtkBridgeAttribute::GetComponentType ( )
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)

Implements vtkGenericAttribute.

vtkIdType vtkBridgeAttribute::GetSize ( )
virtual

Number of tuples.

Postcondition
valid_result: result>=0

Implements vtkGenericAttribute.

unsigned long vtkBridgeAttribute::GetActualMemorySize ( )
virtual

Size in kilobytes taken by the attribute.

Implements vtkGenericAttribute.

double* vtkBridgeAttribute::GetRange ( int  component)
virtual

Range of the attribute component `component'. It returns double, even if GetType()==VTK_INT. NOT THREAD SAFE

Precondition
valid_component: (component>=0)&&(component<GetNumberOfComponents())
Postcondition
result_exists: result!=0

Implements vtkGenericAttribute.

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

Range of the attribute component `component'. THREAD SAFE

Precondition
valid_component: (component>=0)&&(component<GetNumberOfComponents())

Implements vtkGenericAttribute.

double vtkBridgeAttribute::GetMaxNorm ( )
virtual

Return the maximum euclidean norm for the tuples.

Postcondition
positive_result: result>=0

Implements vtkGenericAttribute.

virtual double* vtkBridgeAttribute::GetTuple ( vtkGenericAdaptorCell c)
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()->GetNumberOfPoin ts()

Implements vtkGenericAttribute.

virtual void vtkBridgeAttribute::GetTuple ( vtkGenericAdaptorCell c,
double *  tuple 
)
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()->GetNumberOfPoint s()

Implements vtkGenericAttribute.

double* vtkBridgeAttribute::GetTuple ( vtkGenericCellIterator c)
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()->GetNumberOfPoin ts()

Implements vtkGenericAttribute.

void vtkBridgeAttribute::GetTuple ( vtkGenericCellIterator c,
double *  tuple 
)
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()->GetNumberOfPoint s()

Implements vtkGenericAttribute.

double* vtkBridgeAttribute::GetTuple ( vtkGenericPointIterator p)
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()

Implements vtkGenericAttribute.

void vtkBridgeAttribute::GetTuple ( vtkGenericPointIterator p,
double *  tuple 
)
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()

Implements vtkGenericAttribute.

void vtkBridgeAttribute::GetComponent ( int  i,
vtkGenericCellIterator c,
double *  values 
)
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()

Implements vtkGenericAttribute.

double vtkBridgeAttribute::GetComponent ( int  i,
vtkGenericPointIterator p 
)
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()

Implements vtkGenericAttribute.

void vtkBridgeAttribute::DeepCopy ( vtkGenericAttribute other)
virtual

Recursive duplication of `other' in `this'.

Precondition
other_exists: other!=0
not_self: other!=this

Implements vtkGenericAttribute.

void vtkBridgeAttribute::ShallowCopy ( vtkGenericAttribute other)
virtual

Update `this' using fields of `other'.

Precondition
other_exists: other!=0
not_self: other!=this

Implements vtkGenericAttribute.

void vtkBridgeAttribute::InitWithPointData ( vtkPointData d,
int  i 
)

Set the current attribute to be centered on points with attribute `i' of `d'.

Precondition
d_exists: d!=0
valid_range: (i>=0) && (i<d->GetNumberOfArrays())
void vtkBridgeAttribute::InitWithCellData ( vtkCellData d,
int  i 
)

Set the current attribute to be centered on cells with attribute `i' of `d'.

Precondition
d_exists: d!=0
valid_range: (i>=0) && (i<d->GetNumberOfArrays())
void vtkBridgeAttribute::AllocateInternalTuple ( int  size)
protected

If size>InternalTupleCapacity, allocate enough memory.

Precondition
positive_size: size>0

Friends And Related Function Documentation

friend class vtkBridgeCell
friend

Definition at line 185 of file vtkBridgeAttribute.h.

Member Data Documentation

vtkPointData* vtkBridgeAttribute::Pd
protected

Definition at line 188 of file vtkBridgeAttribute.h.

vtkCellData* vtkBridgeAttribute::Cd
protected

Definition at line 189 of file vtkBridgeAttribute.h.

vtkDataSetAttributes* vtkBridgeAttribute::Data
protected

Definition at line 190 of file vtkBridgeAttribute.h.

int vtkBridgeAttribute::AttributeNumber
protected

Definition at line 191 of file vtkBridgeAttribute.h.

double* vtkBridgeAttribute::InternalTuple
protected

Definition at line 193 of file vtkBridgeAttribute.h.

int vtkBridgeAttribute::InternalTupleCapacity
protected

Definition at line 194 of file vtkBridgeAttribute.h.


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