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

a collection of attributes More...

#include <vtkGenericAttributeCollection.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkGenericAttributeCollection * NewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
int GetNumberOfAttributes ()
 
int GetNumberOfComponents ()
 
int GetNumberOfPointCenteredComponents ()
 
int GetMaxNumberOfComponents ()
 
unsigned long GetActualMemorySize ()
 
int IsEmpty ()
 
vtkGenericAttribute * GetAttribute (int i)
 
int FindAttribute (const char *name)
 
int GetAttributeIndex (int i)
 
void InsertNextAttribute (vtkGenericAttribute *a)
 
void InsertAttribute (int i, vtkGenericAttribute *a)
 
void RemoveAttribute (int i)
 
void Reset ()
 
void DeepCopy (vtkGenericAttributeCollection *other)
 
void ShallowCopy (vtkGenericAttributeCollection *other)
 
virtual unsigned long int GetMTime ()
 
virtual int GetActiveAttribute ()
 
virtual int GetActiveComponent ()
 
void SetActiveAttribute (int attribute, int component=0)
 
virtual int GetNumberOfAttributesToInterpolate ()
 
int * GetAttributesToInterpolate ()
 
int HasAttribute (int size, int *attributes, int attribute)
 
void SetAttributesToInterpolate (int size, int *attributes)
 
void SetAttributesToInterpolateToAll ()
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
int GetReferenceCount ()
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkGenericAttributeCollection * New ()
 
static int IsTypeOf (const char *type)
 
static vtkGenericAttributeCollection * 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
 
 vtkGenericAttributeCollection ()
 
virtual ~vtkGenericAttributeCollection ()
 
void ComputeNumbers ()
 
- 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 &)
 

Protected Attributes

vtkGenericAttributeInternalVector * AttributeInternalVector
 
vtkIntInternalVector * AttributeIndices
 
int ActiveAttribute
 
int ActiveComponent
 
int NumberOfAttributesToInterpolate
 
int AttributesToInterpolate [10]
 
int NumberOfComponents
 
int NumberOfPointCenteredComponents
 
int MaxNumberOfComponents
 
unsigned long ActualMemorySize
 
vtkTimeStamp ComputeTime
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a collection of attributes

vtkGenericAttributeCollection is a class that collects attributes (represented by vtkGenericAttribute).

Tests:
vtkGenericAttributeCollection (Tests)

Definition at line 35 of file vtkGenericAttributeCollection.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkGenericAttributeCollection::Superclass

Standard type definition and print methods for a VTK class.

Definition at line 43 of file vtkGenericAttributeCollection.h.

Constructor & Destructor Documentation

◆ vtkGenericAttributeCollection()

vtkGenericAttributeCollection::vtkGenericAttributeCollection ( )
protected

Default constructor: empty collection.

◆ ~vtkGenericAttributeCollection()

virtual vtkGenericAttributeCollection::~vtkGenericAttributeCollection ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ New()

static vtkGenericAttributeCollection* vtkGenericAttributeCollection::New ( )
static

Create an empty collection.

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGenericAttributeCollection::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

◆ NewInstance()

vtkGenericAttributeCollection* vtkGenericAttributeCollection::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetNumberOfAttributes()

int vtkGenericAttributeCollection::GetNumberOfAttributes ( )

Return the number of attributes (e.g., instances of vtkGenericAttribute) in the collection.

Postcondition
positive_result: result>=0

◆ GetNumberOfComponents()

int vtkGenericAttributeCollection::GetNumberOfComponents ( )

Return the number of components. This is the sum of all components found in all attributes.

Postcondition
positive_result: result>=0

◆ GetNumberOfPointCenteredComponents()

int vtkGenericAttributeCollection::GetNumberOfPointCenteredComponents ( )

Return the number of components. This is the sum of all components found in all point centered attributes.

Postcondition
positive_result: result>=0

◆ GetMaxNumberOfComponents()

int vtkGenericAttributeCollection::GetMaxNumberOfComponents ( )

Maximum number of components encountered among all attributes.

Postcondition
positive_result: result>=0
valid_result: result<=GetNumberOfComponents()

◆ GetActualMemorySize()

unsigned long vtkGenericAttributeCollection::GetActualMemorySize ( )

Actual size of the data in kibibytes (1024 bytes); only valid after the pipeline has updated. It is guaranteed to be greater than or equal to the memory required to represent the data.

◆ IsEmpty()

int vtkGenericAttributeCollection::IsEmpty ( )

Indicate whether the collection contains any attributes.

Postcondition
definition: result==(GetNumberOfAttributes()==0)

◆ GetAttribute()

vtkGenericAttribute* vtkGenericAttributeCollection::GetAttribute ( int  i)

Return a pointer to the ith instance of vtkGenericAttribute.

Precondition
not_empty: !IsEmpty()
valid_i: i>=0 && i<GetNumberOfAttributes()
Postcondition
result_exists: result!=0

◆ FindAttribute()

int vtkGenericAttributeCollection::FindAttribute ( const char *  name)

Return the index of the attribute named ‘name’. Return the non-negative index if found. Return -1 otherwise.

Precondition
name_exists: name!=0
Postcondition
valid_result: (result==-1) || (result>=0) && (result<=GetNumberOfAttributes())

◆ GetAttributeIndex()

int vtkGenericAttributeCollection::GetAttributeIndex ( int  i)

Return the index of the first component of attribute ‘i’ in an array of format attrib0comp0 attrib0comp1 ... attrib4comp0 ...

Precondition
valid_i: i>=0 && i<GetNumberOfAttributes()
is_point_centered: GetAttribute(i)->GetCentering()==vtkPointCentered

◆ InsertNextAttribute()

void vtkGenericAttributeCollection::InsertNextAttribute ( vtkGenericAttribute *  a)

Add the attribute ‘a’ to the end of the collection.

Precondition
a_exists: a!=0
Postcondition
more_items: GetNumberOfAttributes()==old GetNumberOfAttributes()+1
a_is_set: GetAttribute(GetNumberOfAttributes()-1)==a

◆ InsertAttribute()

void vtkGenericAttributeCollection::InsertAttribute ( int  i,
vtkGenericAttribute *  a 
)

Replace the attribute at index ‘i’ by ‘a’.

Precondition
not_empty: !IsEmpty()
a_exists: a!=0
valid_i: i>=0 && i<GetNumberOfAttributes()
Postcondition
same_size: GetNumberOfAttributes()==old GetNumberOfAttributes()
item_is_set: GetAttribute(i)==a

◆ RemoveAttribute()

void vtkGenericAttributeCollection::RemoveAttribute ( int  i)

Remove the attribute at ‘i’.

Precondition
not_empty: !IsEmpty()
valid_i: i>=0 && i<GetNumberOfAttributes()
Postcondition
fewer_items: GetNumberOfAttributes()==old GetNumberOfAttributes()-1

◆ Reset()

void vtkGenericAttributeCollection::Reset ( )

Remove all attributes.

Postcondition
is_empty: GetNumberOfAttributes()==0

◆ DeepCopy()

void vtkGenericAttributeCollection::DeepCopy ( vtkGenericAttributeCollection *  other)

Copy, without reference counting, the other attribute array.

Precondition
other_exists: other!=0
not_self: other!=this
Postcondition
same_size: GetNumberOfAttributes()==other->GetNumberOfAttributes()

◆ ShallowCopy()

void vtkGenericAttributeCollection::ShallowCopy ( vtkGenericAttributeCollection *  other)

Copy, via reference counting, the other attribute array.

Precondition
other_exists: other!=0
not_self: other!=this
Postcondition
same_size: GetNumberOfAttributes()==other->GetNumberOfAttributes()

◆ GetMTime()

virtual unsigned long int vtkGenericAttributeCollection::GetMTime ( )
virtual

vtkAttributeCollection is a composite object and needs to check each member of its collection for modified time.

Reimplemented from vtkObject.

◆ GetActiveAttribute()

virtual int vtkGenericAttributeCollection::GetActiveAttribute ( )
virtual

Index of the attribute to be processed (not necessarily scalar).

Precondition
not_empty: !IsEmpty()
Postcondition
valid_result: result>=0 && result<GetNumberOfAttributes()

◆ GetActiveComponent()

virtual int vtkGenericAttributeCollection::GetActiveComponent ( )
virtual

Component of the active attribute to be processed. -1 means module.

Precondition
not_empty: GetNumberOfAttributes()>0
Postcondition
valid_result: result>=-1 && result<GetAttribute(GetActiveAttribute())->GetNumberOfComponents()

◆ SetActiveAttribute()

void vtkGenericAttributeCollection::SetActiveAttribute ( int  attribute,
int  component = 0 
)

Set the scalar attribute to be processed. -1 means module.

Precondition
not_empty: !IsEmpty()
valid_attribute: attribute>=0 && attribute<GetNumberOfAttributes()
valid_component: component>=-1 && component<GetAttribute(attribute)->GetNumberOfComponents()
Postcondition
is_set: GetActiveAttribute()==attribute && GetActiveComponent()==component

◆ GetNumberOfAttributesToInterpolate()

virtual int vtkGenericAttributeCollection::GetNumberOfAttributesToInterpolate ( )
virtual

Number of attributes to interpolate.

Precondition
not_empty: !IsEmpty()
Postcondition
positive_result: result>=0

◆ GetAttributesToInterpolate()

int* vtkGenericAttributeCollection::GetAttributesToInterpolate ( )

Indices of attributes to interpolate.

Precondition
not_empty: !IsEmpty()
Postcondition
valid_result: GetNumberOfAttributesToInterpolate()>0

◆ HasAttribute()

int vtkGenericAttributeCollection::HasAttribute ( int  size,
int *  attributes,
int  attribute 
)

Does the array ‘attributes’ of size ‘size’ have ‘attribute’?

Precondition
positive_size: size>=0
valid_attributes: size>0 implies attributes!=0

◆ SetAttributesToInterpolate()

void vtkGenericAttributeCollection::SetAttributesToInterpolate ( int  size,
int *  attributes 
)

Set the attributes to interpolate.

Precondition
not_empty: !IsEmpty()
positive_size: size>=0
valid_attributes: size>0 implies attributes!=0
valid_attributes_contents: attributes!=0 implies !HasAttributes(size,attributes,GetActiveAttribute())
Postcondition
is_set: (GetNumberOfAttributesToInterpolate()==size)&& (GetAttributesToInterpolate()==attributes)

◆ SetAttributesToInterpolateToAll()

void vtkGenericAttributeCollection::SetAttributesToInterpolateToAll ( )

◆ ComputeNumbers()

void vtkGenericAttributeCollection::ComputeNumbers ( )
protected

Compute number of components, max number of components and actual memory size.

Member Data Documentation

◆ AttributeInternalVector

vtkGenericAttributeInternalVector* vtkGenericAttributeCollection::AttributeInternalVector
protected

STL vector for storing attributes

Definition at line 191 of file vtkGenericAttributeCollection.h.

◆ AttributeIndices

vtkIntInternalVector* vtkGenericAttributeCollection::AttributeIndices
protected

STL vector for storing index of point centered attributes

Definition at line 193 of file vtkGenericAttributeCollection.h.

◆ ActiveAttribute

int vtkGenericAttributeCollection::ActiveAttribute
protected

Definition at line 195 of file vtkGenericAttributeCollection.h.

◆ ActiveComponent

int vtkGenericAttributeCollection::ActiveComponent
protected

Definition at line 196 of file vtkGenericAttributeCollection.h.

◆ NumberOfAttributesToInterpolate

int vtkGenericAttributeCollection::NumberOfAttributesToInterpolate
protected

Definition at line 197 of file vtkGenericAttributeCollection.h.

◆ AttributesToInterpolate

int vtkGenericAttributeCollection::AttributesToInterpolate[10]
protected

Definition at line 198 of file vtkGenericAttributeCollection.h.

◆ NumberOfComponents

int vtkGenericAttributeCollection::NumberOfComponents
protected

Definition at line 200 of file vtkGenericAttributeCollection.h.

◆ NumberOfPointCenteredComponents

int vtkGenericAttributeCollection::NumberOfPointCenteredComponents
protected

Definition at line 201 of file vtkGenericAttributeCollection.h.

◆ MaxNumberOfComponents

int vtkGenericAttributeCollection::MaxNumberOfComponents
protected

Definition at line 202 of file vtkGenericAttributeCollection.h.

◆ ActualMemorySize

unsigned long vtkGenericAttributeCollection::ActualMemorySize
protected

Definition at line 203 of file vtkGenericAttributeCollection.h.

◆ ComputeTime

vtkTimeStamp vtkGenericAttributeCollection::ComputeTime
protected

Definition at line 204 of file vtkGenericAttributeCollection.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.8.20