VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkGenericAttribute Class Referenceabstract

abstract class defined API for attribute data More...

#include <vtkGenericAttribute.h>

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

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkGenericAttributeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual const char * GetName ()=0
 Name of the attribute. More...
 
virtual int GetNumberOfComponents ()=0
 Dimension of the attribute. More...
 
virtual int GetCentering ()=0
 Is the attribute centered either on points, cells or boundaries? More...
 
virtual int GetType ()=0
 Type of the attribute: scalar, vector, normal, texture coordinate, tensor. More...
 
virtual int GetComponentType ()=0
 Type of the components of the attribute: int, float, double. More...
 
virtual vtkIdType GetSize ()=0
 Number of tuples. More...
 
virtual unsigned long GetActualMemorySize ()=0
 Size in kibibytes (1024 bytes) taken by the attribute. More...
 
virtual doubleGetRange (int component=0)=0
 Range of the attribute component ‘component’. More...
 
virtual void GetRange (int component, double range[2])=0
 Range of the attribute component ‘component’. More...
 
virtual double GetMaxNorm ()=0
 Return the maximum euclidean norm for the tuples. More...
 
virtual doubleGetTuple (vtkGenericAdaptorCell *c)=0
 Attribute at all points of cell ‘c’. More...
 
virtual void GetTuple (vtkGenericAdaptorCell *c, double *tuple)=0
 Put attribute at all points of cell ‘c’ in ‘tuple’. More...
 
virtual doubleGetTuple (vtkGenericCellIterator *c)=0
 Attribute at all points of cell ‘c’. More...
 
virtual void GetTuple (vtkGenericCellIterator *c, double *tuple)=0
 Put attribute at all points of cell ‘c’ in ‘tuple’. More...
 
virtual doubleGetTuple (vtkGenericPointIterator *p)=0
 Value of the attribute at position ‘p’. More...
 
virtual void GetTuple (vtkGenericPointIterator *p, double *tuple)=0
 Put the value of the attribute at position ‘p’ into ‘tuple’. More...
 
virtual void GetComponent (int i, vtkGenericCellIterator *c, double *values)=0
 Put component ‘i’ of the attribute at all points of cell ‘c’ in ‘values’. More...
 
virtual double GetComponent (int i, vtkGenericPointIterator *p)=0
 Value of the component ‘i’ of the attribute at position ‘p’. More...
 
virtual void DeepCopy (vtkGenericAttribute *other)=0
 Recursive duplication of ‘other’ in ‘this’. More...
 
virtual void ShallowCopy (vtkGenericAttribute *other)=0
 Update ‘this’ using fields of ‘other’. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGenericAttributeSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGenericAttribute ()
 
 ~vtkGenericAttribute () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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
std::atomic< int32_t > 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 50 of file vtkGenericAttribute.h.

Member Typedef Documentation

◆ Superclass

Definition at line 53 of file vtkGenericAttribute.h.

Constructor & Destructor Documentation

◆ vtkGenericAttribute()

vtkGenericAttribute::vtkGenericAttribute ( )
protected

◆ ~vtkGenericAttribute()

vtkGenericAttribute::~vtkGenericAttribute ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGenericAttribute::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkGenericAttribute* vtkGenericAttribute::NewInstance ( ) const

◆ PrintSelf()

void vtkGenericAttribute::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ GetName()

virtual const char* vtkGenericAttribute::GetName ( )
pure virtual

Name of the attribute.

(e.g. "velocity")

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

◆ GetNumberOfComponents()

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

◆ GetCentering()

virtual int vtkGenericAttribute::GetCentering ( )
pure virtual

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

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

◆ GetType()

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)

◆ GetComponentType()

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)

◆ GetSize()

virtual vtkIdType vtkGenericAttribute::GetSize ( )
pure virtual

Number of tuples.

Postcondition
valid_result: result>=0

◆ GetActualMemorySize()

virtual unsigned long vtkGenericAttribute::GetActualMemorySize ( )
pure virtual

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

◆ GetRange() [1/2]

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

◆ GetRange() [2/2]

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

◆ GetMaxNorm()

virtual double vtkGenericAttribute::GetMaxNorm ( )
pure virtual

Return the maximum euclidean norm for the tuples.

Postcondition
positive_result: result>=0

◆ GetTuple() [1/6]

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

◆ GetTuple() [2/6]

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

◆ GetTuple() [3/6]

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

◆ GetTuple() [4/6]

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

◆ GetTuple() [5/6]

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

◆ GetTuple() [6/6]

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

◆ GetComponent() [1/2]

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

◆ GetComponent() [2/2]

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

◆ DeepCopy()

virtual void vtkGenericAttribute::DeepCopy ( vtkGenericAttribute other)
pure virtual

Recursive duplication of ‘other’ in ‘this’.

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

◆ ShallowCopy()

virtual void vtkGenericAttribute::ShallowCopy ( vtkGenericAttribute other)
pure virtual

Update ‘this’ using fields of ‘other’.

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

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