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

manage vertex buffer objects shared within a mapper More...

#include <vtkOpenGLVertexBufferObjectGroup.h>

Inheritance diagram for vtkOpenGLVertexBufferObjectGroup:
[legend]
Collaboration diagram for vtkOpenGLVertexBufferObjectGroup:
[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...
 
vtkOpenGLVertexBufferObjectGroupNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetNumberOfComponents (const char *attribute)
 Returns the number of components for this attribute zero if the attribute does not exist. More...
 
int GetNumberOfTuples (const char *attribute)
 Returns the number of tuples for this attribute zero if the attribute does not exist. More...
 
void ReleaseGraphicsResources (vtkWindow *)
 Release any graphics resources that are being consumed by this mapper. More...
 
vtkOpenGLVertexBufferObjectGetVBO (const char *attribute)
 Returns the VBO for an attribute, NULL if it is not present. More...
 
void AddAllAttributesToVAO (vtkShaderProgram *program, vtkOpenGLVertexArrayObject *vao)
 Attach all VBOs to their attributes. More...
 
void RemoveAttribute (const char *attribute)
 used to remove a no longer needed attribute Calling CacheDataArray with a nullptr attribute will also work. More...
 
void CacheDataArray (const char *attribute, vtkDataArray *da, vtkOpenGLVertexBufferObjectCache *cache, int destType)
 Set the data array for an attribute in the VBO Group registers the data array until build is called once this is called a valid VBO will exist. More...
 
void CacheDataArray (const char *attribute, vtkDataArray *da, vtkViewport *vp, int destType)
 
bool ArrayExists (const char *attribute, vtkDataArray *da, vtkIdType &offset, vtkIdType &totalOffset)
 Check if the array already exists. More...
 
void AppendDataArray (const char *attribute, vtkDataArray *da, int destType)
 Append a data array for an attribute in the VBO Group registers the data array until build is called. More...
 
void BuildAllVBOs (vtkOpenGLVertexBufferObjectCache *)
 using the data arrays in this group build all the VBOs, once this has been called the reference to the data arrays will be freed. More...
 
void BuildAllVBOs (vtkViewport *)
 
void ClearAllVBOs ()
 Force all the VBOs to be freed from this group. More...
 
void ClearAllDataArrays ()
 Clear all the data arrays. More...
 
vtkMTimeType GetMTime () override
 Get the mtime of this groups VBOs. 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...
 
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 vtkOpenGLVertexBufferObjectGroupNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLVertexBufferObjectGroupSafeDownCast (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
 
 vtkOpenGLVertexBufferObjectGroup ()
 
 ~vtkOpenGLVertexBufferObjectGroup () 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 &)
 

Protected Attributes

std::map< std::string, vtkOpenGLVertexBufferObject * > UsedVBOs
 
std::map< std::string, std::vector< vtkDataArray * > > UsedDataArrays
 
std::map< std::string, std::map< vtkDataArray *, vtkIdType > > UsedDataArrayMaps
 
std::map< std::string, vtkIdTypeUsedDataArraySizes
 
- 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

manage vertex buffer objects shared within a mapper

This class holds onto the VBOs that a mapper is using. The basic operation is that during the render process the mapper may cache a number of dataArrays as VBOs associated with attributes. This class keep track of freeing VBOs no longer used by the mapper and uploading new data as needed.

When using CacheCataArray the same array can be set each time and this class will not rebuild or upload unless needed.

When using the AppendDataArray API no caching is done and the VBOs will be rebuilt and uploaded each time. So when appending th emapper need to handle checking if the VBO should be updated.

Use case: make this an ivar of your mapper vbg->CacheDataArray("vertexMC", vtkDataArray); vbg->BuildAllVBOs(); if (vbg->GetMTime() > your VAO update time) { vbg->AddAllAttributesToVAO(...); }

Appended Use case: make this an ivar of your mapper if (you need to update your VBOs) { vbg->ClearAllVBOs(); vbg->AppendDataArray("vertexMC", vtkDataArray1); vbg->AppendDataArray("vertexMC", vtkDataArray2); vbg->AppendDataArray("vertexMC", vtkDataArray3); vbg->BuildAllVBOs(); vbg->AddAllAttributesToVAO(...); }

use VAO

Definition at line 77 of file vtkOpenGLVertexBufferObjectGroup.h.

Member Typedef Documentation

◆ Superclass

Definition at line 81 of file vtkOpenGLVertexBufferObjectGroup.h.

Constructor & Destructor Documentation

◆ vtkOpenGLVertexBufferObjectGroup()

vtkOpenGLVertexBufferObjectGroup::vtkOpenGLVertexBufferObjectGroup ( )
protected

◆ ~vtkOpenGLVertexBufferObjectGroup()

vtkOpenGLVertexBufferObjectGroup::~vtkOpenGLVertexBufferObjectGroup ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkOpenGLVertexBufferObjectGroup* vtkOpenGLVertexBufferObjectGroup::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenGLVertexBufferObjectGroup::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkOpenGLVertexBufferObjectGroup* vtkOpenGLVertexBufferObjectGroup::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetNumberOfComponents()

int vtkOpenGLVertexBufferObjectGroup::GetNumberOfComponents ( const char *  attribute)

Returns the number of components for this attribute zero if the attribute does not exist.

◆ GetNumberOfTuples()

int vtkOpenGLVertexBufferObjectGroup::GetNumberOfTuples ( const char *  attribute)

Returns the number of tuples for this attribute zero if the attribute does not exist.

◆ ReleaseGraphicsResources()

void vtkOpenGLVertexBufferObjectGroup::ReleaseGraphicsResources ( vtkWindow )

Release any graphics resources that are being consumed by this mapper.

The parameter window could be used to determine which graphic resources to release.

◆ GetVBO()

vtkOpenGLVertexBufferObject* vtkOpenGLVertexBufferObjectGroup::GetVBO ( const char *  attribute)

Returns the VBO for an attribute, NULL if it is not present.

◆ AddAllAttributesToVAO()

void vtkOpenGLVertexBufferObjectGroup::AddAllAttributesToVAO ( vtkShaderProgram program,
vtkOpenGLVertexArrayObject vao 
)

Attach all VBOs to their attributes.

◆ RemoveAttribute()

void vtkOpenGLVertexBufferObjectGroup::RemoveAttribute ( const char *  attribute)

used to remove a no longer needed attribute Calling CacheDataArray with a nullptr attribute will also work.

◆ CacheDataArray() [1/2]

void vtkOpenGLVertexBufferObjectGroup::CacheDataArray ( const char *  attribute,
vtkDataArray da,
vtkOpenGLVertexBufferObjectCache cache,
int  destType 
)

Set the data array for an attribute in the VBO Group registers the data array until build is called once this is called a valid VBO will exist.

◆ CacheDataArray() [2/2]

void vtkOpenGLVertexBufferObjectGroup::CacheDataArray ( const char *  attribute,
vtkDataArray da,
vtkViewport vp,
int  destType 
)

◆ ArrayExists()

bool vtkOpenGLVertexBufferObjectGroup::ArrayExists ( const char *  attribute,
vtkDataArray da,
vtkIdType offset,
vtkIdType totalOffset 
)

Check if the array already exists.

offset is the index of the first vertex of the array if it exists. totalOffset is the total number of vertices in the appended arrays. Note that if the array does not exist, offset is equal to totalOffset.

◆ AppendDataArray()

void vtkOpenGLVertexBufferObjectGroup::AppendDataArray ( const char *  attribute,
vtkDataArray da,
int  destType 
)

Append a data array for an attribute in the VBO Group registers the data array until build is called.

◆ BuildAllVBOs() [1/2]

void vtkOpenGLVertexBufferObjectGroup::BuildAllVBOs ( vtkOpenGLVertexBufferObjectCache )

using the data arrays in this group build all the VBOs, once this has been called the reference to the data arrays will be freed.

◆ BuildAllVBOs() [2/2]

void vtkOpenGLVertexBufferObjectGroup::BuildAllVBOs ( vtkViewport )

◆ ClearAllVBOs()

void vtkOpenGLVertexBufferObjectGroup::ClearAllVBOs ( )

Force all the VBOs to be freed from this group.

Call this prior to starting appending operations. Not needed for single array caching.

◆ ClearAllDataArrays()

void vtkOpenGLVertexBufferObjectGroup::ClearAllDataArrays ( )

Clear all the data arrays.

Typically an internal method. Automatically called at the end of BuildAllVBOs to prepare for the next set of attributes.

◆ GetMTime()

vtkMTimeType vtkOpenGLVertexBufferObjectGroup::GetMTime ( )
overridevirtual

Get the mtime of this groups VBOs.

Reimplemented from vtkObject.

Member Data Documentation

◆ UsedVBOs

std::map<std::string, vtkOpenGLVertexBufferObject*> vtkOpenGLVertexBufferObjectGroup::UsedVBOs
protected

Definition at line 176 of file vtkOpenGLVertexBufferObjectGroup.h.

◆ UsedDataArrays

std::map<std::string, std::vector<vtkDataArray*> > vtkOpenGLVertexBufferObjectGroup::UsedDataArrays
protected

Definition at line 177 of file vtkOpenGLVertexBufferObjectGroup.h.

◆ UsedDataArrayMaps

std::map<std::string, std::map<vtkDataArray*, vtkIdType> > vtkOpenGLVertexBufferObjectGroup::UsedDataArrayMaps
protected

Definition at line 178 of file vtkOpenGLVertexBufferObjectGroup.h.

◆ UsedDataArraySizes

std::map<std::string, vtkIdType> vtkOpenGLVertexBufferObjectGroup::UsedDataArraySizes
protected

Definition at line 179 of file vtkOpenGLVertexBufferObjectGroup.h.


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