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, ATTIBUTE_6 = 6, ATTIBUTE_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 *state) |
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 | dirtyBound () |
Dirty the bounding box, forcing a computeBound() on the next call to getBound(). | |
const BoundingBox & | getBound () const |
get bounding box of geoset. | |
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. | |
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 osg::State object is supplied: release any OpenGL display lists associated with graphics context specified or if state pointer is NULL: release all display lists for all graphics contexts | |
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. | |
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 |
draw directly ignoring an OpenGL display list which could be attached. | |
virtual bool | supports (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 (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 (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 (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 | |
static GLuint | generateDisplayList (unsigned int contextID, unsigned int sizeHint=0) |
Return a OpenGL display list handle a newly generated or reused from display list cache. | |
static void | setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum) |
Set the minimum number of display lists to retain in the deleted display list cache. | |
static unsigned int | getMinimumNumberOfDisplayListsToRetainInCache () |
Get the minimum number of display lists to retain in the deleted display list cache. | |
static 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. | |
static void | flushAllDeletedDisplayLists (unsigned int contextID) |
flush all the cached display list which need to be deleted in the OpenGL context related to contextID. | |
static void | flushDeletedDisplayLists (unsigned int contextID, double &availableTime) |
flush the cached display list which need to be deleted in the OpenGL context related to contextID. | |
static void | deleteVertexBufferObject (unsigned int contextID, GLuint globj) |
use deleteVertexBufferObject instead of glDeleteList 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. | |
static 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. | |
static Extensions * | getExtensions (unsigned int contextID, bool createIfNotInitalized) |
Function to call to get the extension of a specified context. | |
static void | setExtensions (unsigned int contextID, Extensions *extensions) |
setExtensions allows users to override the extensions across graphics contexts. | |
Static Public Attributes | |
static unsigned int | s_numberDrawablesReusedLastInLastFrame = 0 |
static unsigned int | s_numberNewDrawablesInLastFrame = 0 |
static unsigned int | s_numberDeletedDrawablesInLastFrame = 0 |
Protected Types | |
typedef osg::buffered_value< GLuint > | GLObjectList |
Protected Member Functions | |
Drawable & | operator= (const Drawable &) |
virtual | ~Drawable () |
virtual bool | computeBound () const |
compute the bounding box of the drawable. | |
void | setBound (const BoundingBox &bb) const |
set the bounding box . | |
void | addParent (osg::Node *node) |
void | removeParent (osg::Node *node) |
Protected Attributes | |
ParentList | _parents |
ref_ptr< StateSet > | _stateset |
BoundingBox | _bbox |
bool | _bbox_computed |
ref_ptr< Shape > | _shape |
bool | _supportsDisplayList |
bool | _useDisplayList |
bool | _supportsVertexBufferObjects |
bool | _useVertexBufferObjects |
GLObjectList | _globjList |
GLObjectList | _vboList |
ref_ptr< UpdateCallback > | _updateCallback |
ref_ptr< CullCallback > | _cullCallback |
ref_ptr< DrawCallback > | _drawCallback |
Friends | |
class | Node |
class | Geode |
Classes | |
class | AttributeFunctor |
class | ConstAttributeFunctor |
struct | CullCallback |
struct | DrawCallback |
Callback attached to an Drawable which allows the users to customize the drawing of an exist Drawable object. More... | |
class | Extensions |
Extensions class which encapsulates the querying of extensions and associated function pointers, and provide convenience wrappers to check for the extensions or use the associated functions. More... | |
class | PrimitiveFunctor |
class | PrimitiveIndexFunctor |
struct | UpdateCallback |
Contains no drawing primitives directly, these are provided by subclasses such as osg::Geometry. State attributes for a Drawable are maintained in StateSet which the Drawable maintains a referenced counted pointer to. Both Drawable's and StateSet's can be shared for optimal memory usage and graphics performance.
|
|
|
|
|
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::ImpostorSprite, and osg::ShapeDrawable. |
|
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::ImpostorSprite, and osg::ShapeDrawable. |
|
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 osg::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::ImpostorSprite, osg::ShapeDrawable, and osgText::Text. |
|
Immediately compile this drawable into an OpenGL Display List. Note I, operation is ignored if _useDisplayList to false. Note II, compile is not intended to be overridden in subclasses. |
|
compute the bounding box of the drawable. Method must be implemented by subclasses. Reimplemented in osg::DrawPixels, osg::ImpostorSprite, osg::ShapeDrawable, osgParticle::ParticleSystem, 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 glDeleteList 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 drawable has _useDisplayList set to true then use an OpenGL display list, automatically compiling one if required. Otherwise call drawImplementation(). Note, draw method should *not* be overridden in subclasses as it manages the optional display list. |
|
draw directly ignoring an OpenGL display list which could be attached. This is the internal draw method which does the drawing itself, and is the method to override when deriving from Drawable. Implemented in osg::DrawPixels, osg::Geometry, osg::ImpostorSprite, and osg::ShapeDrawable. |
|
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 CullCallback.
|
|
Get the non const CullCallback.
|
|
Get the const DrawCallback.
|
|
Get the non const DrawCallback.
|
|
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. |
|
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, osg::ImpostorSprite, 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::ImpostorSprite, osg::ShapeDrawable, and osgText::Text. |
|
|
|
if osg::State object is supplied: release any OpenGL display lists associated with graphics context specified or if state pointer is NULL: release all display lists for all graphics contexts
|
|
|
|
set the bounding box .
|
|
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.
|
|
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 minimum number of display lists to retain in the deleted display list cache.
|
|
Set the Shape of the drawable. The shape can be used to speed up collision detection or as a guide for procedural geometry generation - see osg::Shape. |
|
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, osg::ImpostorSprite, and osg::ShapeDrawable. |
|
return true if the Drawable subclass supports accept(ConstAttributeFunctor&).
Reimplemented in osg::Geometry, osg::ImpostorSprite, and osg::ShapeDrawable. |
|
return true if the Drawable subclass supports accept(AttributeFunctor&).
Reimplemented in osg::Geometry, osg::ImpostorSprite, and osg::ShapeDrawable. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|