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

The VertexArrayObject class uses, or emulates, vertex array objects. More...

#include <vtkOpenGLVertexArrayObject.h>

Inheritance diagram for vtkOpenGLVertexArrayObject:
[legend]
Collaboration diagram for vtkOpenGLVertexArrayObject:
[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...
 
vtkOpenGLVertexArrayObjectNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Bind ()
 
void Release ()
 
void ReleaseGraphicsResources ()
 
void ShaderProgramChanged ()
 
bool AddAttributeArray (vtkShaderProgram *program, vtkOpenGLBufferObject *buffer, const std::string &name, int offset, size_t stride, int elementType, int elementTupleSize, bool normalize)
 
bool AddAttributeArray (vtkShaderProgram *program, vtkOpenGLVertexBufferObject *buffer, const std::string &name, int offset, bool normalize)
 
bool AddAttributeArrayWithDivisor (vtkShaderProgram *program, vtkOpenGLBufferObject *buffer, const std::string &name, int offset, size_t stride, int elementType, int elementTupleSize, bool normalize, int divisor, bool isMatrix)
 
bool AddAttributeMatrixWithDivisor (vtkShaderProgram *program, vtkOpenGLBufferObject *buffer, const std::string &name, int offset, size_t stride, int elementType, int elementTupleSize, bool normalize, int divisor, int tupleOffset)
 
bool RemoveAttributeArray (const std::string &name)
 
void SetForceEmulation (bool val)
 
- 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)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 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...
 
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...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkOpenGLVertexArrayObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLVertexArrayObjectSafeDownCast (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 ()
 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenGLVertexArrayObject ()
 
 ~vtkOpenGLVertexArrayObject () 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- 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
 

Detailed Description

The VertexArrayObject class uses, or emulates, vertex array objects.

These are extremely useful for setup/tear down of vertex attributes, and can offer significant performance benefits when the hardware supports them.

It should be noted that this object is very lightweight, and it assumes the objects being used are correctly set up. Even without support for VAOs this class caches the array locations, types, etc and avoids repeated look ups. It it bound to a single ShaderProgram object.

Definition at line 37 of file vtkOpenGLVertexArrayObject.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkOpenGLVertexArrayObject.h.

Constructor & Destructor Documentation

◆ vtkOpenGLVertexArrayObject()

vtkOpenGLVertexArrayObject::vtkOpenGLVertexArrayObject ( )
protected

◆ ~vtkOpenGLVertexArrayObject()

vtkOpenGLVertexArrayObject::~vtkOpenGLVertexArrayObject ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkOpenGLVertexArrayObject* vtkOpenGLVertexArrayObject::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenGLVertexArrayObject::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkOpenGLVertexArrayObject* vtkOpenGLVertexArrayObject::NewInstance ( ) const

◆ PrintSelf()

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

◆ Bind()

void vtkOpenGLVertexArrayObject::Bind ( )

◆ Release()

void vtkOpenGLVertexArrayObject::Release ( )

◆ ReleaseGraphicsResources()

void vtkOpenGLVertexArrayObject::ReleaseGraphicsResources ( )

◆ ShaderProgramChanged()

void vtkOpenGLVertexArrayObject::ShaderProgramChanged ( )

◆ AddAttributeArray() [1/2]

bool vtkOpenGLVertexArrayObject::AddAttributeArray ( vtkShaderProgram program,
vtkOpenGLBufferObject buffer,
const std::string &  name,
int  offset,
size_t  stride,
int  elementType,
int  elementTupleSize,
bool  normalize 
)
inline

Definition at line 52 of file vtkOpenGLVertexArrayObject.h.

◆ AddAttributeArray() [2/2]

bool vtkOpenGLVertexArrayObject::AddAttributeArray ( vtkShaderProgram program,
vtkOpenGLVertexBufferObject buffer,
const std::string &  name,
int  offset,
bool  normalize 
)

◆ AddAttributeArrayWithDivisor()

bool vtkOpenGLVertexArrayObject::AddAttributeArrayWithDivisor ( vtkShaderProgram program,
vtkOpenGLBufferObject buffer,
const std::string &  name,
int  offset,
size_t  stride,
int  elementType,
int  elementTupleSize,
bool  normalize,
int  divisor,
bool  isMatrix 
)

◆ AddAttributeMatrixWithDivisor()

bool vtkOpenGLVertexArrayObject::AddAttributeMatrixWithDivisor ( vtkShaderProgram program,
vtkOpenGLBufferObject buffer,
const std::string &  name,
int  offset,
size_t  stride,
int  elementType,
int  elementTupleSize,
bool  normalize,
int  divisor,
int  tupleOffset 
)

◆ RemoveAttributeArray()

bool vtkOpenGLVertexArrayObject::RemoveAttributeArray ( const std::string &  name)

◆ SetForceEmulation()

void vtkOpenGLVertexArrayObject::SetForceEmulation ( bool  val)

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