VTK
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 Member Functions

int GetNumberOfAttributes ()
 Return the number of attributes (e.g., instances of vtkGenericAttribute) in the collection. More...
 
int GetNumberOfComponents ()
 Return the number of components. More...
 
int GetNumberOfPointCenteredComponents ()
 Return the number of components. More...
 
int GetMaxNumberOfComponents ()
 Maximum number of components encountered among all attributes. More...
 
unsigned long GetActualMemorySize ()
 Actual size of the data in kibibytes (1024 bytes); only valid after the pipeline has updated. More...
 
int IsEmpty ()
 Indicate whether the collection contains any attributes. More...
 
vtkGenericAttributeGetAttribute (int i)
 Return a pointer to the ith instance of vtkGenericAttribute. More...
 
int FindAttribute (const char *name)
 Return the index of the attribute named `name'. More...
 
int GetAttributeIndex (int i)
 Return the index of the first component of attribute `i' in an array of format attrib0comp0 attrib0comp1 ... More...
 
void InsertNextAttribute (vtkGenericAttribute *a)
 Add the attribute `a' to the end of the collection. More...
 
void InsertAttribute (int i, vtkGenericAttribute *a)
 Replace the attribute at index `i' by `a'. More...
 
void RemoveAttribute (int i)
 Remove the attribute at `i'. More...
 
void Reset ()
 Remove all attributes. More...
 
void DeepCopy (vtkGenericAttributeCollection *other)
 Copy, without reference counting, the other attribute array. More...
 
void ShallowCopy (vtkGenericAttributeCollection *other)
 Copy, via reference counting, the other attribute array. More...
 
vtkMTimeType GetMTime () override
 vtkAttributeCollection is a composite object and needs to check each member of its collection for modified time. More...
 
void SetActiveAttribute (int attribute, int component=0)
 Set the scalar attribute to be processed. More...
 
intGetAttributesToInterpolate ()
 Indices of attributes to interpolate. More...
 
int HasAttribute (int size, int *attributes, int attribute)
 Does the array `attributes' of size `size' have `attribute'? More...
 
virtual int GetActiveAttribute ()
 Index of the attribute to be processed (not necessarily scalar). More...
 
virtual int GetActiveComponent ()
 Component of the active attribute to be processed. More...
 
virtual int GetNumberOfAttributesToInterpolate ()
 Number of attributes to interpolate. More...
 
void SetAttributesToInterpolate (int size, int *attributes)
 Set the attributes to interpolate. More...
 
void SetAttributesToInterpolateToAll ()
 Set the attributes to interpolate. 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkGenericAttributeCollectionNew ()
 Create an empty collection. More...
 
- 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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

 vtkGenericAttributeCollection ()
 Default constructor: empty collection. More...
 
 ~vtkGenericAttributeCollection () override
 Destructor. More...
 
void ComputeNumbers ()
 Compute number of components, max number of components and actual memory size. More...
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- 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
 STL vector for storing attributes. More...
 
vtkIntInternalVector * AttributeIndices
 STL vector for storing index of point centered attributes. More...
 
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
 
typedef vtkObject Superclass
 Standard type definition and print methods for a VTK class. More...
 
static int IsTypeOf (const char *type)
 Standard type definition and print methods for a VTK class. More...
 
static vtkGenericAttributeCollectionSafeDownCast (vtkObjectBase *o)
 Standard type definition and print methods for a VTK class. More...
 
virtual int IsA (const char *type)
 Standard type definition and print methods for a VTK class. More...
 
vtkGenericAttributeCollectionNewInstance () const
 Standard type definition and print methods for a VTK class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard type definition and print methods for a VTK class. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard type definition and print methods for a VTK class. More...
 

Detailed Description

a collection of attributes

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

Tests:
vtkGenericAttributeCollection (Tests)

Definition at line 36 of file vtkGenericAttributeCollection.h.

Member Typedef Documentation

Standard type definition and print methods for a VTK class.

Definition at line 48 of file vtkGenericAttributeCollection.h.

Constructor & Destructor Documentation

vtkGenericAttributeCollection::vtkGenericAttributeCollection ( )
protected

Default constructor: empty collection.

vtkGenericAttributeCollection::~vtkGenericAttributeCollection ( )
overrideprotected

Destructor.

Member Function Documentation

static vtkGenericAttributeCollection* vtkGenericAttributeCollection::New ( )
static

Create an empty collection.

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

Standard type definition and print methods for a VTK class.

virtual int vtkGenericAttributeCollection::IsA ( const char *  type)
virtual

Standard type definition and print methods for a VTK class.

Reimplemented from vtkObjectBase.

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

Standard type definition and print methods for a VTK class.

virtual vtkObjectBase* vtkGenericAttributeCollection::NewInstanceInternal ( ) const
protectedvirtual

Standard type definition and print methods for a VTK class.

vtkGenericAttributeCollection* vtkGenericAttributeCollection::NewInstance ( ) const

Standard type definition and print methods for a VTK class.

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

Standard type definition and print methods for a VTK class.

Reimplemented from vtkObject.

int vtkGenericAttributeCollection::GetNumberOfAttributes ( )

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

Postcondition
positive_result: result>=0
int vtkGenericAttributeCollection::GetNumberOfComponents ( )

Return the number of components.

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

Postcondition
positive_result: result>=0
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
int vtkGenericAttributeCollection::GetMaxNumberOfComponents ( )

Maximum number of components encountered among all attributes.

Postcondition
positive_result: result>=0
valid_result: result<=GetNumberOfComponents()
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.

int vtkGenericAttributeCollection::IsEmpty ( )

Indicate whether the collection contains any attributes.

Postcondition
definition: result==(GetNumberOfAttributes()==0)
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
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())
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
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
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
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
void vtkGenericAttributeCollection::Reset ( )

Remove all attributes.

Postcondition
is_empty: GetNumberOfAttributes()==0
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()
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()
vtkMTimeType vtkGenericAttributeCollection::GetMTime ( )
overridevirtual

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

Reimplemented from vtkObject.

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()
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()
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
virtual int vtkGenericAttributeCollection::GetNumberOfAttributesToInterpolate ( )
virtual

Number of attributes to interpolate.

Precondition
not_empty: !IsEmpty()
Postcondition
positive_result: result>=0
int* vtkGenericAttributeCollection::GetAttributesToInterpolate ( )

Indices of attributes to interpolate.

Precondition
not_empty: !IsEmpty()
Postcondition
valid_result: GetNumberOfAttributesToInterpolate()>0
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
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)
void vtkGenericAttributeCollection::SetAttributesToInterpolateToAll ( )

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)
void vtkGenericAttributeCollection::ComputeNumbers ( )
protected

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

Member Data Documentation

vtkGenericAttributeInternalVector* vtkGenericAttributeCollection::AttributeInternalVector
protected

STL vector for storing attributes.

Definition at line 257 of file vtkGenericAttributeCollection.h.

vtkIntInternalVector* vtkGenericAttributeCollection::AttributeIndices
protected

STL vector for storing index of point centered attributes.

Definition at line 261 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::ActiveAttribute
protected

Definition at line 263 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::ActiveComponent
protected

Definition at line 264 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::NumberOfAttributesToInterpolate
protected

Definition at line 265 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::AttributesToInterpolate[10]
protected

Definition at line 266 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::NumberOfComponents
protected

Definition at line 268 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::NumberOfPointCenteredComponents
protected

Definition at line 269 of file vtkGenericAttributeCollection.h.

int vtkGenericAttributeCollection::MaxNumberOfComponents
protected

Definition at line 270 of file vtkGenericAttributeCollection.h.

unsigned long vtkGenericAttributeCollection::ActualMemorySize
protected

Definition at line 271 of file vtkGenericAttributeCollection.h.

vtkTimeStamp vtkGenericAttributeCollection::ComputeTime
protected

Definition at line 272 of file vtkGenericAttributeCollection.h.


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