OpenSceneGraph  3.0.1
Classes | Public Member Functions | Protected Member Functions | Protected Attributes
osg::BufferData Class Reference
Inheritance diagram for osg::BufferData:
Inheritance graph
[legend]

List of all members.

Classes

struct  ModifiedCallback

Public Member Functions

 BufferData ()
 BufferData (const BufferData &bd, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
 return the name of the object's library.
virtual const char * className () const
 return the name of the object's class type.
virtual const GLvoid * getDataPointer () const =0
virtual unsigned int getTotalDataSize () const =0
void setBufferObject (BufferObject *bufferObject)
BufferObjectgetBufferObject ()
const BufferObjectgetBufferObject () const
void setBufferIndex (unsigned int index)
unsigned int getBufferIndex () const
GLBufferObjectgetGLBufferObject (unsigned int contextID) const
GLBufferObjectgetOrCreateGLBufferObject (unsigned int contextID) const
void setModifiedCallback (ModifiedCallback *md)
ModifiedCallbackgetModifiedCallback ()
const ModifiedCallbackgetModifiedCallback () const
void dirty ()
 Dirty the primitive, which increments the modified count, to force buffer objects to update.
void setModifiedCount (unsigned int value)
 Set the modified count value.
unsigned int getModifiedCount () const
 Get modified count value.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
void releaseGLObjects (State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context.
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Protected Member Functions

virtual ~BufferData ()
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor.
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

unsigned int _modifiedCount
unsigned int _bufferIndex
osg::ref_ptr< BufferObject_bufferObject
osg::ref_ptr< ModifiedCallback_modifiedCallback
- Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Additional Inherited Members

- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Constructor & Destructor Documentation

osg::BufferData::BufferData ( )
inline
osg::BufferData::BufferData ( const BufferData bd,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
inline

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::BufferData::~BufferData ( )
protectedvirtual

Member Function Documentation

virtual const char* osg::BufferData::className ( ) const
inlinevirtual

return the name of the object's class type.

Must be defined by derived classes.

Implements osg::Object.

Reimplemented in osg::DrawElementsUInt, osg::DrawElementsUShort, osg::DrawElementsUByte, osg::DrawArrayLengths, osg::DrawArrays, osg::PrimitiveSet, osg::Image, osg::Array, osg::ImageSequence, and osg::ImageStream.

void osg::BufferData::dirty ( )
inline

Dirty the primitive, which increments the modified count, to force buffer objects to update.

If a ModifiedCallback is attached to this BufferData then the callback is called prior to the bufferObject's dirty is called.

References osg::BufferData::ModifiedCallback::modified().

unsigned int osg::BufferData::getBufferIndex ( ) const
inline
BufferObject* osg::BufferData::getBufferObject ( )
inline
const BufferObject* osg::BufferData::getBufferObject ( ) const
inline
virtual const GLvoid* osg::BufferData::getDataPointer ( ) const
pure virtual
GLBufferObject* osg::BufferData::getGLBufferObject ( unsigned int  contextID) const
inline
ModifiedCallback* osg::BufferData::getModifiedCallback ( )
inline
const ModifiedCallback* osg::BufferData::getModifiedCallback ( ) const
inline
unsigned int osg::BufferData::getModifiedCount ( ) const
inline

Get modified count value.

GLBufferObject* osg::BufferData::getOrCreateGLBufferObject ( unsigned int  contextID) const
inline
virtual unsigned int osg::BufferData::getTotalDataSize ( ) const
pure virtual
virtual bool osg::BufferData::isSameKindAs ( const Object obj) const
inlinevirtual
virtual const char* osg::BufferData::libraryName ( ) const
inlinevirtual

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Implements osg::Object.

Reimplemented in osg::DrawElementsUInt, osg::DrawElementsUShort, osg::DrawElementsUByte, osg::DrawArrayLengths, osg::DrawArrays, osg::PrimitiveSet, osg::Image, osg::Array, osg::ImageSequence, and osg::ImageStream.

void osg::BufferData::releaseGLObjects ( State state = 0) const
virtual

If State is non-zero, this function releases OpenGL objects for the specified graphics context.

Otherwise, releases OpenGL objects for all graphics contexts.

Reimplemented from osg::Object.

virtual void osg::BufferData::resizeGLObjectBuffers ( unsigned int  maxSize)
virtual

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Object.

void osg::BufferData::setBufferIndex ( unsigned int  index)
inline
void osg::BufferData::setBufferObject ( BufferObject bufferObject)
void osg::BufferData::setModifiedCallback ( ModifiedCallback md)
inline
void osg::BufferData::setModifiedCount ( unsigned int  value)
inline

Set the modified count value.


Member Data Documentation

unsigned int osg::BufferData::_bufferIndex
protected
osg::ref_ptr<BufferObject> osg::BufferData::_bufferObject
protected

Reimplemented in osg::Image.

Referenced by osg::DrawElements::getElementBufferObject().

osg::ref_ptr<ModifiedCallback> osg::BufferData::_modifiedCallback
protected
unsigned int osg::BufferData::_modifiedCount
protected

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

osg logo
Generated at Mon Oct 8 2012 23:49:51 for the OpenSceneGraph by doxygen 1.8.1.1.