Inheritance diagram for osg::Drawable:
Public Types | |
typedef std::vector< Node * > | ParentList |
A vector of osg::Node pointers which is used to store the parent(s) of drawable. | |
typedef unsigned int | AttributeType |
enum | AttributeTypes { VERTICES = 0, WEIGHTS = 1, NORMALS = 2, COLORS = 3, SECONDARY_COLORS = 4, FOG_COORDS = 5, ATTRIBUTE_6 = 6, ATTRIBUTE_7 = 7, TEXTURE_COORDS = 8, TEXTURE_COORDS_0 = TEXTURE_COORDS, TEXTURE_COORDS_1 = TEXTURE_COORDS_0+1, TEXTURE_COORDS_2 = TEXTURE_COORDS_0+2, TEXTURE_COORDS_3 = TEXTURE_COORDS_0+3, TEXTURE_COORDS_4 = TEXTURE_COORDS_0+4, TEXTURE_COORDS_5 = TEXTURE_COORDS_0+5, TEXTURE_COORDS_6 = TEXTURE_COORDS_0+6, TEXTURE_COORDS_7 = TEXTURE_COORDS_0+7 } |
Public Member Functions | |
Drawable () | |
Drawable (const Drawable &drawable, const CopyOp ©op=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 Geometry * | asGeometry () |
Convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0. | |
virtual const Geometry * | asGeometry () const |
Convert 'const this' into a const Geometry pointer if Drawable is a Geometry, otherwise return 0. | |
const ParentList & | getParents () const |
Get the parent list of drawable. | |
ParentList | getParents () |
Get the a copy of parent list of node. | |
Node * | getParent (unsigned int i) |
Get a single parent of Drawable. | |
const Node * | getParent (unsigned int i) const |
Get a single const parent of Drawable. | |
unsigned int | getNumParents () const |
Get the number of parents of node. | |
void | setStateSet (StateSet *stateset) |
Set the StateSet attached to the Drawable. | |
StateSet * | getStateSet () |
Get the attached StateSet. | |
const StateSet * | getStateSet () const |
Get the attached const StateSet. | |
StateSet * | getOrCreateStateSet () |
Get the attached const StateSet, if one is not already attached create one, attach it to the drawable and return a pointer to it. | |
void | setInitialBound (const osg::BoundingBox &bbox) |
Set the intial bounding volume to use when computing the overall bounding volume. | |
const BoundingBox & | getInitialBound () const |
Set the intial bounding volume to use when computing the overall bounding volume. | |
void | dirtyBound () |
Dirty the bounding box, forcing a computeBound() on the next call to getBound(). | |
const BoundingBox & | getBound () const |
get bounding box of geoset. | |
virtual BoundingBox | computeBound () const |
Compute the bounding box around Drawables's geometry. | |
void | setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback) |
Set the compute bound callback to override the default computeBound. | |
ComputeBoundingBoxCallback * | getComputeBoundingBoxCallback () |
Get the compute bound callback. | |
const ComputeBoundingBoxCallback * | getComputeBoundingBoxCallback () const |
Get the const compute bound callback. | |
void | setShape (Shape *shape) |
Set the Shape of the Drawable . | |
Shape * | getShape () |
Get the Shape of the Drawable. | |
const Shape * | getShape () const |
Get the const Shape of the const Drawable. | |
void | setSupportsDisplayList (bool flag) |
Set the drawable so that it can or cannot be used in conjunction with OpenGL display lists. | |
bool | getSupportsDisplayList () const |
Get whether display lists are supported for this drawable instance. | |
void | setUseDisplayList (bool flag) |
When set to true, force the draw method to use OpenGL Display List for rendering. | |
bool | getUseDisplayList () const |
Return whether OpenGL display lists are being used for rendering. | |
GLuint & | getDisplayList (unsigned int contextID) const |
Return OpenGL display list for specified contextID. | |
void | setUseVertexBufferObjects (bool flag) |
When set to true, ignore the setUseDisplayList() settings, and hints to the drawImplementation method to use OpenGL vertex buffer objects for rendering. | |
bool | getUseVertexBufferObjects () const |
Return whether OpenGL vertex buffer objects should be used when supported by OpenGL driver. | |
void | dirtyDisplayList () |
Force a recompile on next draw() of any OpenGL display list associated with this geoset. | |
virtual unsigned int | getGLObjectSizeHint () const |
Return the estimated size of GLObjects (display lists/vertex buffer objects) that are associated with this drawable. | |
void | draw (State &state) const |
Draw OpenGL primitives. | |
virtual void | compileGLObjects (State &state) const |
Immediately compile this Drawable into an OpenGL Display List. | |
virtual void | releaseGLObjects (State *state=0) const |
If State is non-zero, this function releases OpenGL objects for the specified graphics context. | |
virtual void | setUpdateCallback (UpdateCallback *ac) |
Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal. | |
UpdateCallback * | getUpdateCallback () |
Get the non const UpdateCallback. | |
const UpdateCallback * | getUpdateCallback () const |
Get the const UpdateCallback. | |
bool | requiresUpdateTraversal () const |
Return whether this Drawable has update callbacks associated with it, and therefore must be traversed. | |
virtual void | setEventCallback (EventCallback *ac) |
Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal. | |
EventCallback * | getEventCallback () |
Get the non const EventCallback. | |
const EventCallback * | getEventCallback () const |
Get the const EventCallback. | |
bool | requiresEventTraversal () const |
Return whether this Drawable has event callbacks associated with it, and therefore must be traversed. | |
virtual void | setCullCallback (CullCallback *cc) |
Set the CullCallback which allows users to customize the culling of Drawable during the cull traversal. | |
CullCallback * | getCullCallback () |
Get the non const CullCallback. | |
const CullCallback * | getCullCallback () const |
Get the const CullCallback. | |
virtual void | setDrawCallback (DrawCallback *dc) |
Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object. | |
DrawCallback * | getDrawCallback () |
Get the non const DrawCallback. | |
const DrawCallback * | getDrawCallback () const |
Get the const DrawCallback. | |
virtual void | drawImplementation (State &state) const=0 |
drawImplementation(State&) is a pure virtaul method for the actual implementation of OpenGL drawing calls, such as vertex arrays and primitives, that must be implemented in concrete subclasses of the Drawable base class, examples include osg::Geometry and osg::ShapeDrawable. | |
virtual bool | supports (const AttributeFunctor &) const |
Return true if the Drawable subclass supports accept(AttributeFunctor&). | |
virtual void | accept (AttributeFunctor &) |
accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has. | |
virtual bool | supports (const ConstAttributeFunctor &) const |
Return true if the Drawable subclass supports accept(ConstAttributeFunctor&). | |
virtual void | accept (ConstAttributeFunctor &) const |
Accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has. | |
virtual bool | supports (const PrimitiveFunctor &) const |
Return true if the Drawable subclass supports accept(PrimitiveFunctor&). | |
virtual void | accept (PrimitiveFunctor &) const |
Accept a PrimitiveFunctor and call its methods to tell it about the internal primitives that this Drawable has. | |
virtual bool | supports (const PrimitiveIndexFunctor &) const |
Return true if the Drawable subclass supports accept(PrimitiveIndexFunctor&). | |
virtual void | accept (PrimitiveIndexFunctor &) const |
Accept a PrimitiveIndexFunctor and call its methods to tell it about the internal primitives that this Drawable has. | |
Static Public Member Functions | |
GLuint | generateDisplayList (unsigned int contextID, unsigned int sizeHint=0) |
Return a OpenGL display list handle a newly generated or reused from display list cache. | |
void | setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum) |
Set the minimum number of display lists to retain in the deleted display list cache. | |
unsigned int | getMinimumNumberOfDisplayListsToRetainInCache () |
Get the minimum number of display lists to retain in the deleted display list cache. | |
void | deleteDisplayList (unsigned int contextID, GLuint globj, unsigned int sizeHint=0) |
Use deleteDisplayList instead of glDeleteList to allow OpenGL display list to be cached until they can be deleted by the OpenGL context in which they were created, specified by contextID. | |
void | flushAllDeletedDisplayLists (unsigned int contextID) |
Flush all the cached display list which need to be deleted in the OpenGL context related to contextID. | |
void | flushDeletedDisplayLists (unsigned int contextID, double &availableTime) |
Flush the cached display list which need to be deleted in the OpenGL context related to contextID. | |
void | deleteVertexBufferObject (unsigned int contextID, GLuint globj) |
Use deleteVertexBufferObject instead of glDeleteBuffers to allow OpenGL buffer objects to be cached until they can be deleted by the OpenGL context in which they were created, specified by contextID. | |
void | flushDeletedVertexBufferObjects (unsigned int contextID, double currentTime, double &availableTime) |
Flush all the cached vertex buffer objects which need to be deleted in the OpenGL context related to contextID. | |
Extensions * | getExtensions (unsigned int contextID, bool createIfNotInitalized) |
Function to call to get the extension of a specified context. | |
void | setExtensions (unsigned int contextID, Extensions *extensions) |
setExtensions allows users to override the extensions across graphics contexts. | |
Static Public Attributes | |
unsigned int | s_numberDrawablesReusedLastInLastFrame |
unsigned int | s_numberNewDrawablesInLastFrame |
unsigned int | s_numberDeletedDrawablesInLastFrame |
Protected Types | |
typedef osg::buffered_value< GLuint > | GLObjectList |
Protected Member Functions | |
Drawable & | operator= (const Drawable &) |
virtual | ~Drawable () |
void | setBound (const BoundingBox &bb) const |
set the bounding box . | |
void | addParent (osg::Node *node) |
void | removeParent (osg::Node *node) |
void | setNumChildrenRequiringUpdateTraversal (unsigned int num) |
unsigned int | getNumChildrenRequiringUpdateTraversal () const |
void | setNumChildrenRequiringEventTraversal (unsigned int num) |
unsigned int | getNumChildrenRequiringEventTraversal () const |
Protected Attributes | |
ParentList | _parents |
ref_ptr< StateSet > | _stateset |
BoundingBox | _initialBound |
ref_ptr< ComputeBoundingBoxCallback > | _computeBoundCallback |
BoundingBox | _boundingBox |
bool | _boundingBoxComputed |
ref_ptr< Shape > | _shape |
bool | _supportsDisplayList |
bool | _useDisplayList |
bool | _supportsVertexBufferObjects |
bool | _useVertexBufferObjects |
GLObjectList | _globjList |
GLObjectList | _vboList |
ref_ptr< UpdateCallback > | _updateCallback |
unsigned int | _numChildrenRequiringUpdateTraversal |
ref_ptr< EventCallback > | _eventCallback |
unsigned int | _numChildrenRequiringEventTraversal |
ref_ptr< CullCallback > | _cullCallback |
ref_ptr< DrawCallback > | _drawCallback |
In OSG, everything that can be rendered is implemented as a class derived from Drawable
. The Drawable
class contains no drawing primitives, since these are provided by subclasses such as osg::Geometry
.
Notice that a Drawable
is not a Node
, and therefore it cannot be directly added to a scene graph. Instead, Drawable
s are attached to Geode
s, which are scene graph nodes.
The OpenGL state that must be used when rendering a Drawable
is represented by a StateSet
. Since a Drawable
has a reference (osg::ref_ptr
) to a StateSet
, StateSet
s can be shared between different Drawable
s. In fact, sharing StateSet
s is a good way to improve performance, since this allows OSG to reduce the number of expensive changes in the OpenGL state.
Finally, Drawable
s can also be shared between different Geode
s, so that the same geometry (loaded to memory just once) can be used in different parts of the scene graph.
|
|
|
|
|
A vector of osg::Node pointers which is used to store the parent(s) of drawable.
|
|
|
|
|
|
Copy constructor using CopyOp to manage deep vs shallow copy.
|
|
|
|
Accept a PrimitiveIndexFunctor and call its methods to tell it about the internal primitives that this Drawable has. return true if functor handled by drawable, return false on failure of drawable to generate functor calls. Note, PrimtiveIndexFunctor only provide const access of the primitives, as primitives may be procedurally generated so one cannot modify it. Reimplemented in osg::Geometry. |
|
Accept a PrimitiveFunctor and call its methods to tell it about the internal primitives that this Drawable has. return true if functor handled by drawable, return false on failure of drawable to generate functor calls. Note, PrimtiveFunctor only provides const access of the primitives, as primitives may be procedurally generated so one cannot modify it. Reimplemented in osg::Geometry, osg::ShapeDrawable, osgSim::ImpostorSprite, and osgText::Text. |
|
Accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has. return true if functor handled by drawable, return false on failure of drawable to generate functor calls. Reimplemented in osg::Geometry, osg::ShapeDrawable, and osgSim::ImpostorSprite. |
|
accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has. return true if functor handled by drawable, return false on failure of drawable to generate functor calls. Reimplemented in osg::Geometry, and osgSim::ImpostorSprite. |
|
|
|
Convert 'const this' into a const Geometry pointer if Drawable is a Geometry, otherwise return 0. Equivalent to dynamic_cast<const Geometry*>(this). Reimplemented in osg::Geometry. |
|
Convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0. Equivalent to dynamic_cast<Geometry*>(this). Reimplemented in osg::Geometry. |
|
return the name of the object's class type. Must be defined by derived classes. Implements osg::Object. Reimplemented in osg::DrawPixels, osg::Geometry, osg::ShapeDrawable, osgSim::ImpostorSprite, and osgText::Text. |
|
Immediately compile this
|
|
Compute the bounding box around Drawables's geometry.
Reimplemented in osg::DrawPixels, osg::ShapeDrawable, osgParticle::ParticleSystem, osgSim::ImpostorSprite, and osgText::Text. |
|
Use deleteDisplayList instead of glDeleteList to allow OpenGL display list to be cached until they can be deleted by the OpenGL context in which they were created, specified by contextID.
|
|
Use deleteVertexBufferObject instead of glDeleteBuffers to allow OpenGL buffer objects to be cached until they can be deleted by the OpenGL context in which they were created, specified by contextID.
|
|
Dirty the bounding box, forcing a computeBound() on the next call to getBound(). Should be called in the internal geometry of the Drawable is modified. |
|
Force a recompile on next draw() of any OpenGL display list associated with this geoset.
|
|
Draw OpenGL primitives.
If the
|
|
drawImplementation(State&) is a pure virtaul method for the actual implementation of OpenGL drawing calls, such as vertex arrays and primitives, that must be implemented in concrete subclasses of the Drawable base class, examples include osg::Geometry and osg::ShapeDrawable. drawImplementation(State&) is called from the draw(State&) method, with the draw method handling management of OpenGL display lists, and drawImplementation(State&) handling the actuall drawing itself.
Implemented in osg::DrawPixels, osg::Geometry, osg::ShapeDrawable, osgParticle::ConnectedParticleSystem, osgParticle::ParticleSystem, osgSim::ImpostorSprite, and osgText::Text. |
|
Flush all the cached display list which need to be deleted in the OpenGL context related to contextID.
|
|
Flush the cached display list which need to be deleted in the OpenGL context related to contextID.
|
|
Flush all the cached vertex buffer objects which need to be deleted in the OpenGL context related to contextID.
|
|
Return a OpenGL display list handle a newly generated or reused from display list cache.
|
|
get bounding box of geoset. Note, now made virtual to make it possible to implement user-drawn objects albeit somewhat crudely, to be improved later. |
|
Get the const compute bound callback.
|
|
Get the compute bound callback.
|
|
Get the const CullCallback.
|
|
Get the non const CullCallback.
|
|
Return OpenGL display list for specified contextID.
|
|
Get the const DrawCallback.
|
|
Get the non const DrawCallback.
|
|
Get the const EventCallback.
|
|
Get the non const EventCallback.
|
|
Function to call to get the extension of a specified context. If the Exentsion object for that context has not yet been created and the 'createIfNotInitalized' flag been set to false then returns NULL. If 'createIfNotInitalized' is true then the Extensions object is automatically created. However, in this case the extension object is only created with the graphics context associated with ContextID.. |
|
Return the estimated size of GLObjects (display lists/vertex buffer objects) that are associated with this drawable. This size is used a hint for reuse of deleteed display lists/vertex buffer objects. Reimplemented in osg::Geometry. |
|
Set the intial bounding volume to use when computing the overall bounding volume.
|
|
Get the minimum number of display lists to retain in the deleted display list cache.
|
|
|
|
|
|
Get the number of parents of node.
|
|
Get the attached const StateSet, if one is not already attached create one, attach it to the drawable and return a pointer to it.
|
|
Get a single const parent of Drawable.
|
|
Get a single parent of Drawable.
|
|
Get the a copy of parent list of node. A copy is returned to prevent modification of the parent list. |
|
Get the parent list of drawable.
|
|
Get the const Shape of the const Drawable.
|
|
Get the Shape of the Drawable.
|
|
Get the attached const StateSet.
|
|
Get the attached StateSet.
|
|
Get whether display lists are supported for this drawable instance.
|
|
Get the const UpdateCallback.
|
|
Get the non const UpdateCallback.
|
|
Return whether OpenGL display lists are being used for rendering.
|
|
Return whether OpenGL vertex buffer objects should be used when supported by OpenGL driver.
|
|
Reimplemented from osg::Object. Reimplemented in osg::DrawPixels, osg::Geometry, and osg::ShapeDrawable. |
|
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::DrawPixels, osg::Geometry, osg::ShapeDrawable, osgSim::ImpostorSprite, and osgText::Text. |
|
|
|
If State is non-zero, this function releases OpenGL objects for the specified graphics context. Otherwise, releases OpenGL objexts for all graphics contexts. Reimplemented from osg::Object. Reimplemented in osgText::Text. |
|
|
|
Return whether this Drawable has event callbacks associated with it, and therefore must be traversed.
|
|
Return whether this Drawable has update callbacks associated with it, and therefore must be traversed.
|
|
set the bounding box .
|
|
Set the compute bound callback to override the default computeBound.
|
|
Set the CullCallback which allows users to customize the culling of Drawable during the cull traversal.
|
|
Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object.
|
|
Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.
|
|
setExtensions allows users to override the extensions across graphics contexts. typically used when you have different extensions supported across graphics pipes but need to ensure that they all use the same low common denominator extensions. |
|
Set the intial bounding volume to use when computing the overall bounding volume.
|
|
Set the minimum number of display lists to retain in the deleted display list cache.
|
|
|
|
|
|
Set the Shape of the The shape can be used to speed up collision detection or as a guide for procedural geometry generation.
|
|
Set the StateSet attached to the Drawable. Previously attached StateSet are automatically unreferenced on assignment of a new drawstate. |
|
Set the drawable so that it can or cannot be used in conjunction with OpenGL display lists. When set to true, calls to Drawable::setUseDisplayList, whereas when set to false, no display lists can be created and calls to setUseDisplayList are ignored, and a warning is produced. The latter is typically used to guard against the switching on of display lists on objects with dynamic internal data such as continuous Level of Detail algorithms. |
|
Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.
|
|
When set to true, force the draw method to use OpenGL Display List for rendering. If false, rendering directly. If the display list has not been compiled already, the next call to draw will automatically create the display list. |
|
When set to true, ignore the setUseDisplayList() settings, and hints to the drawImplementation method to use OpenGL vertex buffer objects for rendering.
|
|
Return true if the Drawable subclass supports accept(PrimitiveIndexFunctor&).
Reimplemented in osg::Geometry. |
|
Return true if the Drawable subclass supports accept(PrimitiveFunctor&).
Reimplemented in osg::Geometry, and osg::ShapeDrawable. |
|
Return true if the Drawable subclass supports accept(ConstAttributeFunctor&).
Reimplemented in osg::Geometry, osg::ShapeDrawable, and osgSim::ImpostorSprite. |
|
Return true if the Drawable subclass supports accept(AttributeFunctor&).
Reimplemented in osg::Geometry, osg::ShapeDrawable, and osgSim::ImpostorSprite. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|