#include <vtkOpenGLVertexBufferObject.h>

Inheritance diagram for vtkOpenGLVertexBufferObject:

Collaboration diagram for vtkOpenGLVertexBufferObject:

Public Types
enum	ShiftScaleMethod { DISABLE_SHIFT_SCALE, AUTO_SHIFT_SCALE, ALWAYS_AUTO_SHIFT_SCALE, MANUAL_SHIFT_SCALE }
	Methods for VBO coordinate shift+scale-computation. More...

typedef vtkOpenGLBufferObject	Superclass

Public Types inherited from vtkOpenGLBufferObject
enum	ObjectType { ArrayBuffer, ElementArrayBuffer, TextureBuffer }

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...

vtkOpenGLVertexBufferObject *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	UploadDataArray (vtkDataArray *array)

void	AppendDataArray (vtkDataArray *array)

virtual vtkTimeStamp	GetUploadTime ()

virtual bool	GetCoordShiftAndScaleEnabled ()

virtual ShiftScaleMethod	GetCoordShiftAndScaleMethod ()

virtual void	SetCoordShiftAndScaleMethod (ShiftScaleMethod meth)

virtual void	SetShift (const std::vector< double > &shift)

virtual void	SetScale (const std::vector< double > &scale)

virtual const std::vector< double > &	GetShift ()

virtual const std::vector< double > &	GetScale ()

void	SetDataType (int v)

virtual int	GetDataType ()

virtual unsigned int	GetDataTypeSize ()

virtual unsigned int	GetNumberOfTuples ()

virtual unsigned int	GetNumberOfComponents ()

virtual void	SetStride (unsigned int)

virtual unsigned int	GetStride ()

std::vector< float > &	GetPackedVBO ()

void	UploadVBO ()

void	SetCache (vtkOpenGLVertexBufferObjectCache *cache)

Public Member Functions inherited from vtkOpenGLBufferObject
vtkOpenGLBufferObject *	NewInstance () const

ObjectType	GetType () const
	Get the type of the buffer object. More...

void	SetType (ObjectType value)
	Set the type of the buffer object. More...

int	GetHandle () const
	Get the handle of the buffer object. More...

bool	IsReady () const
	Determine if the buffer object is ready to be used. More...

bool	GenerateBuffer (ObjectType type)
	Generate the opengl buffer for this Handle. More...

template<class T >
bool	Upload (const T &array, ObjectType type)
	Upload data to the buffer object. More...

template<class T >
bool	Upload (const T *array, size_t numElements, ObjectType type)

bool	Bind ()
	Bind the buffer object ready for rendering. More...

bool	Release ()
	Release the buffer. More...

void	ReleaseGraphicsResources ()

std::string	GetError () const
	Return a string describing errors. 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...

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)

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...

vtkCommand *	GetCommand (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...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	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 vtkOpenGLVertexBufferObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenGLVertexBufferObject *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkOpenGLBufferObject
static vtkOpenGLBufferObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenGLBufferObject *	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. 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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOpenGLVertexBufferObject ()

	~vtkOpenGLVertexBufferObject () override

Protected Member Functions inherited from vtkOpenGLBufferObject
	vtkOpenGLBufferObject ()

	~vtkOpenGLBufferObject () override

bool	UploadInternal (const void *buffer, size_t size, ObjectType objectType)

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
std::vector< float >	PackedVBO

vtkTimeStamp	UploadTime

unsigned int	Stride

unsigned int	NumberOfComponents

unsigned int	NumberOfTuples

int	DataType

unsigned int	DataTypeSize

ShiftScaleMethod	CoordShiftAndScaleMethod

bool	CoordShiftAndScaleEnabled

std::vector< double >	Shift

std::vector< double >	Scale

vtkOpenGLVertexBufferObjectCache *	Cache

Protected Attributes inherited from vtkOpenGLBufferObject
bool	Dirty

std::string	Error

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Definition at line 38 of file vtkOpenGLVertexBufferObject.h.

Member Typedef Documentation

typedef vtkOpenGLBufferObject vtkOpenGLVertexBufferObject::Superclass

Definition at line 43 of file vtkOpenGLVertexBufferObject.h.

Member Enumeration Documentation

enum vtkOpenGLVertexBufferObject::ShiftScaleMethod

Methods for VBO coordinate shift+scale-computation.

By default, shift and scale vectors are enabled whenever CreateVBO is called with points whose bounds are many bbox-lengths away from the origin.

Shifting and scaling may be completely disabled, or manually specified, or left at the default.

Manual specification is for the case when you will be calling AppendVBO instead of just CreateVBO and know better bounds than the what CreateVBO might produce.

The automatic method tells CreatVBO to compute shift and scale vectors that remap the points to the unit cube.

Enumerator
DISABLE_SHIFT_SCALE	Do not shift/scale point coordinates. Ever!
AUTO_SHIFT_SCALE	The default, automatic computation.
ALWAYS_AUTO_SHIFT_SCALE	Always shift scale using auto computed values.
MANUAL_SHIFT_SCALE	Manual shift/scale (for use with AppendVBO)

Definition at line 75 of file vtkOpenGLVertexBufferObject.h.

Constructor & Destructor Documentation

vtkOpenGLVertexBufferObject::vtkOpenGLVertexBufferObject ( )

protected

vtkOpenGLVertexBufferObject::~vtkOpenGLVertexBufferObject ( )

overrideprotected

Member Function Documentation

static vtkOpenGLVertexBufferObject* vtkOpenGLVertexBufferObject::New ( )

static

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

static

virtual vtkTypeBool vtkOpenGLVertexBufferObject::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 vtkOpenGLBufferObject.

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

static

virtual vtkObjectBase* vtkOpenGLVertexBufferObject::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkOpenGLBufferObject.

vtkOpenGLVertexBufferObject* vtkOpenGLVertexBufferObject::NewInstance ( ) const

void vtkOpenGLVertexBufferObject::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 vtkOpenGLBufferObject.

void vtkOpenGLVertexBufferObject::UploadDataArray ( vtkDataArray * array )

void vtkOpenGLVertexBufferObject::AppendDataArray ( vtkDataArray * array )

virtual vtkTimeStamp vtkOpenGLVertexBufferObject::GetUploadTime ( )

virtual

virtual bool vtkOpenGLVertexBufferObject::GetCoordShiftAndScaleEnabled ( )

virtual

virtual ShiftScaleMethod vtkOpenGLVertexBufferObject::GetCoordShiftAndScaleMethod ( )

virtual

virtual void vtkOpenGLVertexBufferObject::SetCoordShiftAndScaleMethod ( ShiftScaleMethod meth )

virtual

virtual void vtkOpenGLVertexBufferObject::SetShift ( const std::vector< double > & shift )

virtual

virtual void vtkOpenGLVertexBufferObject::SetScale ( const std::vector< double > & scale )

virtual

virtual const std::vector<double>& vtkOpenGLVertexBufferObject::GetShift ( )

virtual

virtual const std::vector<double>& vtkOpenGLVertexBufferObject::GetScale ( )

virtual

void vtkOpenGLVertexBufferObject::SetDataType ( int v )

virtual int vtkOpenGLVertexBufferObject::GetDataType ( )

virtual

virtual unsigned int vtkOpenGLVertexBufferObject::GetDataTypeSize ( )

virtual

virtual unsigned int vtkOpenGLVertexBufferObject::GetNumberOfTuples ( )

virtual

virtual unsigned int vtkOpenGLVertexBufferObject::GetNumberOfComponents ( )

virtual

virtual void vtkOpenGLVertexBufferObject::SetStride ( unsigned int )

virtual

virtual unsigned int vtkOpenGLVertexBufferObject::GetStride ( )

virtual

std::vector<float>& vtkOpenGLVertexBufferObject::GetPackedVBO ( )

inline

Definition at line 140 of file vtkOpenGLVertexBufferObject.h.

void vtkOpenGLVertexBufferObject::UploadVBO ( )

void vtkOpenGLVertexBufferObject::SetCache ( vtkOpenGLVertexBufferObjectCache * cache )

Member Data Documentation

std::vector<float> vtkOpenGLVertexBufferObject::PackedVBO

protected

Definition at line 154 of file vtkOpenGLVertexBufferObject.h.

vtkTimeStamp vtkOpenGLVertexBufferObject::UploadTime

protected

Definition at line 156 of file vtkOpenGLVertexBufferObject.h.

unsigned int vtkOpenGLVertexBufferObject::Stride

protected

Definition at line 158 of file vtkOpenGLVertexBufferObject.h.

unsigned int vtkOpenGLVertexBufferObject::NumberOfComponents

protected

Definition at line 159 of file vtkOpenGLVertexBufferObject.h.

unsigned int vtkOpenGLVertexBufferObject::NumberOfTuples

protected

Definition at line 160 of file vtkOpenGLVertexBufferObject.h.

int vtkOpenGLVertexBufferObject::DataType

protected

Definition at line 161 of file vtkOpenGLVertexBufferObject.h.

unsigned int vtkOpenGLVertexBufferObject::DataTypeSize

protected

Definition at line 162 of file vtkOpenGLVertexBufferObject.h.

ShiftScaleMethod vtkOpenGLVertexBufferObject::CoordShiftAndScaleMethod

protected

Definition at line 164 of file vtkOpenGLVertexBufferObject.h.

bool vtkOpenGLVertexBufferObject::CoordShiftAndScaleEnabled

protected

Definition at line 165 of file vtkOpenGLVertexBufferObject.h.

std::vector<double> vtkOpenGLVertexBufferObject::Shift

protected

Definition at line 166 of file vtkOpenGLVertexBufferObject.h.

std::vector<double> vtkOpenGLVertexBufferObject::Scale

protected

Definition at line 167 of file vtkOpenGLVertexBufferObject.h.

vtkOpenGLVertexBufferObjectCache* vtkOpenGLVertexBufferObject::Cache

protected

Definition at line 169 of file vtkOpenGLVertexBufferObject.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/OpenGL2/vtkOpenGLVertexBufferObject.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation