Inheritance diagram for osg::Drawable:
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, Drawables are attached to Geodes, 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, StateSets can be shared between different Drawables. In fact, sharing StateSets is a good way to improve performance, since this allows OSG to reduce the number of expensive changes in the OpenGL state.
Finally, Drawables can also be shared between different Geodes, so that the same geometry (loaded to memory just once) can be used in different parts of the scene graph.
| typedef unsigned int osg::Drawable::AttributeType |
typedef osg::buffered_value<GLuint> osg::Drawable::GLObjectList [protected] |
| typedef std::vector<Node*> osg::Drawable::ParentList |
A vector of osg::Node pointers which is used to store the parent(s) of drawable.
| osg::Drawable::Drawable | ( | ) |
Copy constructor using CopyOp to manage deep vs shallow copy.
| virtual osg::Drawable::~Drawable | ( | ) | [protected, virtual] |
| virtual void osg::Drawable::accept | ( | PrimitiveIndexFunctor & | ) | const [inline, virtual] |
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, and osgParticle::PrecipitationEffect::PrecipitationDrawable.
| virtual void osg::Drawable::accept | ( | PrimitiveFunctor & | ) | const [inline, virtual] |
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, osgParticle::PrecipitationEffect::PrecipitationDrawable, osgSim::ImpostorSprite, and osgText::Text.
| virtual void osg::Drawable::accept | ( | ConstAttributeFunctor & | ) | const [inline, virtual] |
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 osgText::Text.
| virtual void osg::Drawable::accept | ( | AttributeFunctor & | ) | [inline, virtual] |
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.
| void osg::Drawable::addParent | ( | osg::Node * | node | ) | [protected] |
| virtual const Geometry* osg::Drawable::asGeometry | ( | ) | const [inline, virtual] |
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.
| virtual Geometry* osg::Drawable::asGeometry | ( | ) | [inline, virtual] |
Convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0. Equivalent to dynamic_cast<Geometry*>(this).
Reimplemented in osg::Geometry.
| virtual const char* osg::Drawable::className | ( | ) | const [inline, virtual] |
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.
| virtual void osg::Drawable::compileGLObjects | ( | State & | state | ) | const [virtual] |
Immediately compile this Drawable into an OpenGL Display List.
_useDisplayList is false. | virtual BoundingBox osg::Drawable::computeBound | ( | ) | const [virtual] |
Compute the bounding box around Drawables's geometry.
Reimplemented in osg::DrawPixels, osg::ShapeDrawable, osgParticle::ParticleSystem, osgSim::ImpostorSprite, and osgText::Text.
| static void osg::Drawable::deleteDisplayList | ( | unsigned int | contextID, | |
| GLuint | globj, | |||
| unsigned int | sizeHint = 0 | |||
| ) | [static] |
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.
| static void osg::Drawable::deleteVertexBufferObject | ( | unsigned int | contextID, | |
| GLuint | globj | |||
| ) | [static] |
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 osg::Drawable::dirtyBound | ( | ) |
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.
| void osg::Drawable::dirtyDisplayList | ( | ) |
Force a recompile on next draw() of any OpenGL display list associated with this geoset.
| void osg::Drawable::draw | ( | State & | state | ) | const [inline] |
Draw OpenGL primitives. If the Drawable has _useDisplayList set to true, then use an OpenGL display list, automatically compiling one if required. Otherwise, call drawImplementation().
virtual). Subclasses should override drawImplementation() instead. | virtual void osg::Drawable::drawImplementation | ( | State & | state | ) | const [pure virtual] |
drawImplementation(State&) is a pure virtual 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.
| state | The osg::State object that encapulates the current OpenGL state for the current graphics context. |
Implemented in osg::DrawPixels, osg::Geometry, osg::ShapeDrawable, osgParticle::ConnectedParticleSystem, osgParticle::ParticleSystem, osgParticle::PrecipitationEffect::PrecipitationDrawable, osgSim::ImpostorSprite, and osgText::Text.
| static void osg::Drawable::flushAllDeletedDisplayLists | ( | unsigned int | contextID | ) | [static] |
Flush all the cached display list which need to be deleted in the OpenGL context related to contextID.
| static void osg::Drawable::flushDeletedDisplayLists | ( | unsigned int | contextID, | |
| double & | availableTime | |||
| ) | [static] |
Flush the cached display list which need to be deleted in the OpenGL context related to contextID.
| static void osg::Drawable::flushDeletedVertexBufferObjects | ( | unsigned int | contextID, | |
| double | currentTime, | |||
| double & | availableTime | |||
| ) | [static] |
Flush all the cached vertex buffer objects which need to be deleted in the OpenGL context related to contextID.
| static GLuint osg::Drawable::generateDisplayList | ( | unsigned int | contextID, | |
| unsigned int | sizeHint = 0 | |||
| ) | [static] |
Return a OpenGL display list handle a newly generated or reused from display list cache.
| const BoundingBox& osg::Drawable::getBound | ( | ) | const [inline] |
Get BoundingBox of Drawable. If the BoundingBox is not up to date then its updated via an internal call to computeBond().
| const ComputeBoundingBoxCallback* osg::Drawable::getComputeBoundingBoxCallback | ( | ) | const [inline] |
Get the const compute bound callback.
| ComputeBoundingBoxCallback* osg::Drawable::getComputeBoundingBoxCallback | ( | ) | [inline] |
Get the compute bound callback.
| const CullCallback* osg::Drawable::getCullCallback | ( | ) | const [inline] |
Get the const CullCallback.
| CullCallback* osg::Drawable::getCullCallback | ( | ) | [inline] |
Get the non const CullCallback.
| GLuint& osg::Drawable::getDisplayList | ( | unsigned int | contextID | ) | const [inline] |
Return OpenGL display list for specified contextID.
| const DrawCallback* osg::Drawable::getDrawCallback | ( | ) | const [inline] |
Get the const DrawCallback.
| DrawCallback* osg::Drawable::getDrawCallback | ( | ) | [inline] |
Get the non const DrawCallback.
| const EventCallback* osg::Drawable::getEventCallback | ( | ) | const [inline] |
Get the const EventCallback.
| EventCallback* osg::Drawable::getEventCallback | ( | ) | [inline] |
Get the non const EventCallback.
| static Extensions* osg::Drawable::getExtensions | ( | unsigned int | contextID, | |
| bool | createIfNotInitalized | |||
| ) | [static] |
Function to call to get the extension of a specified context. If the Extension 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..
| virtual unsigned int osg::Drawable::getGLObjectSizeHint | ( | ) | const [inline, virtual] |
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 deleted display lists/vertex buffer objects.
Reimplemented in osg::Geometry.
| const BoundingBox& osg::Drawable::getInitialBound | ( | ) | const [inline] |
Set the initial bounding volume to use when computing the overall bounding volume.
| static unsigned int osg::Drawable::getMinimumNumberOfDisplayListsToRetainInCache | ( | ) | [static] |
Get the minimum number of display lists to retain in the deleted display list cache.
| unsigned int osg::Drawable::getNumChildrenRequiringEventTraversal | ( | ) | const [inline, protected] |
| unsigned int osg::Drawable::getNumChildrenRequiringUpdateTraversal | ( | ) | const [inline, protected] |
| unsigned int osg::Drawable::getNumParents | ( | ) | const [inline] |
Get the number of parents of node.
| StateSet* osg::Drawable::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.
| const Node* osg::Drawable::getParent | ( | unsigned int | i | ) | const [inline] |
Get a single const parent of Drawable.
| i | index of the parent to get. |
| Node* osg::Drawable::getParent | ( | unsigned int | i | ) | [inline] |
| ParentList osg::Drawable::getParents | ( | ) | [inline] |
Get the a copy of parent list of node. A copy is returned to prevent modification of the parent list.
| const ParentList& osg::Drawable::getParents | ( | ) | const [inline] |
Get the parent list of drawable.
| bool osg::Drawable::getSupportsDisplayList | ( | ) | const [inline] |
Get whether display lists are supported for this drawable instance.
| const UpdateCallback* osg::Drawable::getUpdateCallback | ( | ) | const [inline] |
Get the const UpdateCallback.
| UpdateCallback* osg::Drawable::getUpdateCallback | ( | ) | [inline] |
Get the non const UpdateCallback.
| bool osg::Drawable::getUseDisplayList | ( | ) | const [inline] |
Return whether OpenGL display lists are being used for rendering.
| bool osg::Drawable::getUseVertexBufferObjects | ( | ) | const [inline] |
Return whether OpenGL vertex buffer objects should be used when supported by OpenGL driver.
| virtual bool osg::Drawable::isSameKindAs | ( | const Object * | obj | ) | const [inline, virtual] |
Reimplemented from osg::Object.
Reimplemented in osg::DrawPixels, osg::Geometry, osg::ShapeDrawable, osgSim::ImpostorSprite, and osgText::Text.
| virtual const char* osg::Drawable::libraryName | ( | ) | const [inline, virtual] |
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.
| virtual void osg::Drawable::releaseGLObjects | ( | State * | state = 0 |
) | const [virtual] |
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.
| void osg::Drawable::removeParent | ( | osg::Node * | node | ) | [protected] |
| bool osg::Drawable::requiresEventTraversal | ( | ) | const [inline] |
Return whether this Drawable has event callbacks associated with it, and therefore must be traversed.
| bool osg::Drawable::requiresUpdateTraversal | ( | ) | const [inline] |
Return whether this Drawable has update callbacks associated with it, and therefore must be traversed.
| void osg::Drawable::setBound | ( | const BoundingBox & | bb | ) | const [protected] |
set the bounding box .
| void osg::Drawable::setComputeBoundingBoxCallback | ( | ComputeBoundingBoxCallback * | callback | ) | [inline] |
Set the compute bound callback to override the default computeBound.
| virtual void osg::Drawable::setCullCallback | ( | CullCallback * | cc | ) | [inline, virtual] |
Set the CullCallback which allows users to customize the culling of Drawable during the cull traversal.
| virtual void osg::Drawable::setDrawCallback | ( | DrawCallback * | dc | ) | [inline, virtual] |
Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object.
| virtual void osg::Drawable::setEventCallback | ( | EventCallback * | ac | ) | [virtual] |
Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.
| static void osg::Drawable::setExtensions | ( | unsigned int | contextID, | |
| Extensions * | extensions | |||
| ) | [static] |
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.
| void osg::Drawable::setInitialBound | ( | const osg::BoundingBox & | bbox | ) | [inline] |
Set the initial bounding volume to use when computing the overall bounding volume.
| static void osg::Drawable::setMinimumNumberOfDisplayListsToRetainInCache | ( | unsigned int | minimum | ) | [static] |
Set the minimum number of display lists to retain in the deleted display list cache.
| void osg::Drawable::setNumChildrenRequiringEventTraversal | ( | unsigned int | num | ) | [protected] |
| void osg::Drawable::setNumChildrenRequiringUpdateTraversal | ( | unsigned int | num | ) | [protected] |
| void osg::Drawable::setShape | ( | Shape * | shape | ) | [inline] |
Set the Shape of the Drawable. The shape can be used to speed up collision detection or as a guide for procedural geometry generation.
| void osg::Drawable::setStateSet | ( | StateSet * | stateset | ) |
| void osg::Drawable::setSupportsDisplayList | ( | bool | flag | ) |
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.
| virtual void osg::Drawable::setUpdateCallback | ( | UpdateCallback * | ac | ) | [virtual] |
Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.
| void osg::Drawable::setUseDisplayList | ( | bool | flag | ) |
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.
| void osg::Drawable::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.
| virtual bool osg::Drawable::supports | ( | const PrimitiveIndexFunctor & | ) | const [inline, virtual] |
Return true if the Drawable subclass supports accept(PrimitiveIndexFunctor&).
Reimplemented in osg::Geometry, and osgParticle::PrecipitationEffect::PrecipitationDrawable.
| virtual bool osg::Drawable::supports | ( | const PrimitiveFunctor & | ) | const [inline, virtual] |
Return true if the Drawable subclass supports accept(PrimitiveFunctor&).
Reimplemented in osg::Geometry, osg::ShapeDrawable, osgParticle::PrecipitationEffect::PrecipitationDrawable, osgSim::ImpostorSprite, and osgText::Text.
| virtual bool osg::Drawable::supports | ( | const ConstAttributeFunctor & | ) | const [inline, virtual] |
Return true if the Drawable subclass supports accept(ConstAttributeFunctor&).
Reimplemented in osgText::Text.
| virtual bool osg::Drawable::supports | ( | const AttributeFunctor & | ) | const [inline, virtual] |
Return true if the Drawable subclass supports accept(AttributeFunctor&).
Reimplemented in osgText::Text.
friend class Geode [friend] |
friend class Node [friend] |
friend class StateSet [friend] |
BoundingBox osg::Drawable::_boundingBox [mutable, protected] |
bool osg::Drawable::_boundingBoxComputed [mutable, protected] |
ref_ptr<CullCallback> osg::Drawable::_cullCallback [protected] |
ref_ptr<DrawCallback> osg::Drawable::_drawCallback [protected] |
ref_ptr<EventCallback> osg::Drawable::_eventCallback [protected] |
GLObjectList osg::Drawable::_globjList [mutable, protected] |
BoundingBox osg::Drawable::_initialBound [protected] |
unsigned int osg::Drawable::_numChildrenRequiringEventTraversal [protected] |
unsigned int osg::Drawable::_numChildrenRequiringUpdateTraversal [protected] |
ParentList osg::Drawable::_parents [protected] |
ref_ptr<Shape> osg::Drawable::_shape [protected] |
ref_ptr<StateSet> osg::Drawable::_stateset [protected] |
bool osg::Drawable::_supportsDisplayList [protected] |
bool osg::Drawable::_supportsVertexBufferObjects [protected] |
ref_ptr<UpdateCallback> osg::Drawable::_updateCallback [protected] |
bool osg::Drawable::_useDisplayList [protected] |
bool osg::Drawable::_useVertexBufferObjects [protected] |
GLObjectList osg::Drawable::_vboList [mutable, protected] |
unsigned int osg::Drawable::s_numberDeletedDrawablesInLastFrame [static] |
unsigned int osg::Drawable::s_numberDrawablesReusedLastInLastFrame [static] |
unsigned int osg::Drawable::s_numberNewDrawablesInLastFrame [static] |
1.4.7