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

stores mapping for data arrays to generic vertex attributes. More...

#include <vtkGenericVertexAttributeMapping.h>

Inheritance diagram for vtkGenericVertexAttributeMapping:
[legend]
Collaboration diagram for vtkGenericVertexAttributeMapping:
[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...
 
vtkGenericVertexAttributeMappingNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void AddMapping (const char *attributeName, const char *arrayName, int fieldAssociation, int component)
 Select a data array from the point/cell data and map it to a generic vertex attribute. More...
 
void AddMapping (int unit, const char *arrayName, int fieldAssociation, int component)
 Select a data array and use it as multitexture texture coordinates. More...
 
bool RemoveMapping (const char *attributeName)
 Remove a vertex attribute mapping. More...
 
void RemoveAllMappings ()
 Remove all mappings. More...
 
unsigned int GetNumberOfMappings ()
 Get number of mappings. More...
 
const char * GetAttributeName (unsigned int index)
 Get the attribute name at the given index. More...
 
const char * GetArrayName (unsigned int index)
 Get the array name at the given index. More...
 
int GetFieldAssociation (unsigned int index)
 Get the field association at the given index. More...
 
int GetComponent (unsigned int index)
 Get the component no. More...
 
int GetTextureUnit (unsigned int index)
 Get the component no. 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 vtkGenericVertexAttributeMappingNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGenericVertexAttributeMappingSafeDownCast (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
 
 vtkGenericVertexAttributeMapping ()
 
 ~vtkGenericVertexAttributeMapping () 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

stores mapping for data arrays to generic vertex attributes.

vtkGenericVertexAttributeMapping stores mapping between data arrays and generic vertex attributes. It is used by vtkPainterPolyDataMapper to pass the mappings to the painter which rendering the attributes.

Thanks:
Support for generic vertex attributes in VTK was contributed in collaboration with Stephane Ploix at EDF.

Definition at line 34 of file vtkGenericVertexAttributeMapping.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 of file vtkGenericVertexAttributeMapping.h.

Constructor & Destructor Documentation

◆ vtkGenericVertexAttributeMapping()

vtkGenericVertexAttributeMapping::vtkGenericVertexAttributeMapping ( )
protected

◆ ~vtkGenericVertexAttributeMapping()

vtkGenericVertexAttributeMapping::~vtkGenericVertexAttributeMapping ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGenericVertexAttributeMapping* vtkGenericVertexAttributeMapping::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkGenericVertexAttributeMapping::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 vtkGenericVertexAttributeMapping* vtkGenericVertexAttributeMapping::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGenericVertexAttributeMapping::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkGenericVertexAttributeMapping* vtkGenericVertexAttributeMapping::NewInstance ( ) const

◆ PrintSelf()

void vtkGenericVertexAttributeMapping::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.

◆ AddMapping() [1/2]

void vtkGenericVertexAttributeMapping::AddMapping ( const char *  attributeName,
const char *  arrayName,
int  fieldAssociation,
int  component 
)

Select a data array from the point/cell data and map it to a generic vertex attribute.

Note that indices change when a mapping is added/removed.

◆ AddMapping() [2/2]

void vtkGenericVertexAttributeMapping::AddMapping ( int  unit,
const char *  arrayName,
int  fieldAssociation,
int  component 
)

Select a data array and use it as multitexture texture coordinates.

Note the texture unit parameter should correspond to the texture unit set on the texture.

◆ RemoveMapping()

bool vtkGenericVertexAttributeMapping::RemoveMapping ( const char *  attributeName)

Remove a vertex attribute mapping.

◆ RemoveAllMappings()

void vtkGenericVertexAttributeMapping::RemoveAllMappings ( )

Remove all mappings.

◆ GetNumberOfMappings()

unsigned int vtkGenericVertexAttributeMapping::GetNumberOfMappings ( )

Get number of mappings.

◆ GetAttributeName()

const char* vtkGenericVertexAttributeMapping::GetAttributeName ( unsigned int  index)

Get the attribute name at the given index.

◆ GetArrayName()

const char* vtkGenericVertexAttributeMapping::GetArrayName ( unsigned int  index)

Get the array name at the given index.

◆ GetFieldAssociation()

int vtkGenericVertexAttributeMapping::GetFieldAssociation ( unsigned int  index)

Get the field association at the given index.

◆ GetComponent()

int vtkGenericVertexAttributeMapping::GetComponent ( unsigned int  index)

Get the component no.

at the given index.

◆ GetTextureUnit()

int vtkGenericVertexAttributeMapping::GetTextureUnit ( unsigned int  index)

Get the component no.

at the given index.


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