vtkOpenGLVertexBufferObjectGroup Class Reference

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

#include <vtkOpenGLVertexBufferObjectGroup.h>

Inheritance diagram for vtkOpenGLVertexBufferObjectGroup:

Collaboration diagram for vtkOpenGLVertexBufferObjectGroup:

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.
vtkOpenGLVertexBufferObjectGroup *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	GetNumberOfComponents (const char *attribute)
	Returns the number of components for this attribute zero if the attribute does not exist.
int	GetNumberOfTuples (const char *attribute)
	Returns the number of tuples for this attribute zero if the attribute does not exist.
void	ReleaseGraphicsResources (vtkWindow *)
	Release any graphics resources that are being consumed by this mapper.
vtkOpenGLVertexBufferObject *	GetVBO (const char *attribute)
	Returns the VBO for an attribute, NULL if it is not present.
void	AddAllAttributesToVAO (vtkShaderProgram *program, vtkOpenGLVertexArrayObject *vao)
	Attach all VBOs to their attributes.
void	RemoveAttribute (const char *attribute)
	used to remove a no longer needed attribute Calling CacheDataArray with a nullptr attribute will also work.
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.
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.
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.
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.
void	BuildAllVBOs (vtkViewport *)
void	ClearAllVBOs ()
	Force all the VBOs to be freed from this group.
void	ClearAllDataArrays ()
	Clear all the data arrays.
vtkMTimeType	GetMTime () override
	Get the mtime of this groups VBOs.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkOpenGLVertexBufferObjectGroup *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOpenGLVertexBufferObjectGroup *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	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, vtkIdType >	UsedDataArraySizes
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

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 66 of file vtkOpenGLVertexBufferObjectGroup.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkOpenGLVertexBufferObjectGroup::Superclass

Definition at line 70 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 165 of file vtkOpenGLVertexBufferObjectGroup.h.

UsedDataArrays

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

protected

Definition at line 166 of file vtkOpenGLVertexBufferObjectGroup.h.

UsedDataArrayMaps

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

protected

Definition at line 167 of file vtkOpenGLVertexBufferObjectGroup.h.

UsedDataArraySizes

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

protected

Definition at line 168 of file vtkOpenGLVertexBufferObjectGroup.h.

---

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

• Rendering/OpenGL2/vtkOpenGLVertexBufferObjectGroup.h