OpenSceneGraph  3.2.0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
osg::Drawable Class Referenceabstract

Pure virtual base class for drawable geometry. More...

Inheritance diagram for osg::Drawable:
Inheritance graph
[legend]

Classes

class  AttributeFunctor
 
struct  ComputeBoundingBoxCallback
 Callback to allow users to override the default computation of bounding volume. More...
 
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...
 
struct  EventCallback
 
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...
 
struct  UpdateCallback
 

Public Types

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
}
 
typedef std::vector< Node * > ParentList
 A vector of osg::Node pointers which is used to store the parent(s) of drawable. More...
 
typedef unsigned int AttributeType
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Drawable ()
 
 Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 return the name of the object's library. More...
 
virtual const char * className () const
 return the name of the object's class type. More...
 
virtual GeometryasGeometry ()
 Convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0. More...
 
virtual const GeometryasGeometry () const
 Convert 'const this' into a const Geometry pointer if Drawable is a Geometry, otherwise return 0. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
const ParentListgetParents () const
 Get the parent list of drawable. More...
 
ParentList getParents ()
 Get the a copy of parent list of node. More...
 
NodegetParent (unsigned int i)
 Get a single parent of Drawable. More...
 
const NodegetParent (unsigned int i) const
 Get a single const parent of Drawable. More...
 
unsigned int getNumParents () const
 Get the number of parents of node. More...
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates. More...
 
void setStateSet (StateSet *stateset)
 Set the StateSet attached to the Drawable. More...
 
StateSetgetStateSet ()
 Get the attached StateSet. More...
 
const StateSetgetStateSet () const
 Get the attached const StateSet. More...
 
StateSetgetOrCreateStateSet ()
 Get the attached const StateSet, if one is not already attached create one, attach it to the drawable and return a pointer to it. More...
 
void setInitialBound (const osg::BoundingBox &bbox)
 Set the initial bounding volume to use when computing the overall bounding volume. More...
 
const BoundingBoxgetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume. More...
 
void dirtyBound ()
 Dirty the bounding box, forcing a computeBound() on the next call to getBound(). More...
 
const BoundingBoxgetBound () const
 Get BoundingBox of Drawable. More...
 
virtual BoundingBox computeBound () const
 Compute the bounding box around Drawables's geometry. More...
 
void setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
 Set the compute bound callback to override the default computeBound. More...
 
ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback ()
 Get the compute bound callback. More...
 
const ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback () const
 Get the const compute bound callback. More...
 
void setShape (Shape *shape)
 Set the Shape of the Drawable. More...
 
ShapegetShape ()
 Get the Shape of the Drawable. More...
 
const ShapegetShape () const
 Get the const Shape of the const Drawable. More...
 
void setSupportsDisplayList (bool flag)
 Set the drawable so that it can or cannot be used in conjunction with OpenGL display lists. More...
 
bool getSupportsDisplayList () const
 Get whether display lists are supported for this drawable instance. More...
 
void setUseDisplayList (bool flag)
 When set to true, force the draw method to use OpenGL Display List for rendering. More...
 
bool getUseDisplayList () const
 Return whether OpenGL display lists are being used for rendering. More...
 
GLuint & getDisplayList (unsigned int contextID) const
 Return OpenGL display list for specified contextID. More...
 
virtual 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. More...
 
bool getUseVertexBufferObjects () const
 Return whether OpenGL vertex buffer objects should be used when supported by OpenGL driver. More...
 
virtual void dirtyDisplayList ()
 Force a recompile on next draw() of any OpenGL display list associated with this geoset. More...
 
virtual unsigned int getGLObjectSizeHint () const
 Return the estimated size of GLObjects (display lists/vertex buffer objects) that are associated with this drawable. More...
 
void draw (RenderInfo &renderInfo) const
 Draw OpenGL primitives. More...
 
virtual void compileGLObjects (RenderInfo &renderInfo) const
 Immediately compile this Drawable into an OpenGL Display List/VertexBufferObjects. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context. More...
 
virtual void setUpdateCallback (UpdateCallback *ac)
 Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal. More...
 
UpdateCallbackgetUpdateCallback ()
 Get the non const UpdateCallback. More...
 
const UpdateCallbackgetUpdateCallback () const
 Get the const UpdateCallback. More...
 
bool requiresUpdateTraversal () const
 Return whether this Drawable has update callbacks associated with it, and therefore must be traversed. More...
 
virtual void setEventCallback (EventCallback *ac)
 Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal. More...
 
EventCallbackgetEventCallback ()
 Get the non const EventCallback. More...
 
const EventCallbackgetEventCallback () const
 Get the const EventCallback. More...
 
bool requiresEventTraversal () const
 Return whether this Drawable has event callbacks associated with it, and therefore must be traversed. More...
 
virtual void setCullCallback (CullCallback *cc)
 Set the CullCallback which allows users to customize the culling of Drawable during the cull traversal. More...
 
CullCallbackgetCullCallback ()
 Get the non const CullCallback. More...
 
const CullCallbackgetCullCallback () const
 Get the const CullCallback. More...
 
virtual void setDrawCallback (DrawCallback *dc)
 Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object. More...
 
DrawCallbackgetDrawCallback ()
 Get the non const DrawCallback. More...
 
const DrawCallbackgetDrawCallback () const
 Get the const DrawCallback. More...
 
virtual void drawImplementation (RenderInfo &renderInfo) const =0
 drawImplementation(RenderInfo&) 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. More...
 
virtual bool supports (const AttributeFunctor &) const
 Return true if the Drawable subclass supports accept(AttributeFunctor&). More...
 
virtual void accept (AttributeFunctor &)
 accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has. More...
 
virtual bool supports (const ConstAttributeFunctor &) const
 Return true if the Drawable subclass supports accept(ConstAttributeFunctor&). More...
 
virtual void accept (ConstAttributeFunctor &) const
 Accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has. More...
 
virtual bool supports (const PrimitiveFunctor &) const
 Return true if the Drawable subclass supports accept(PrimitiveFunctor&). More...
 
virtual void accept (PrimitiveFunctor &) const
 Accept a PrimitiveFunctor and call its methods to tell it about the internal primitives that this Drawable has. More...
 
virtual bool supports (const PrimitiveIndexFunctor &) const
 Return true if the Drawable subclass supports accept(PrimitiveIndexFunctor&). More...
 
virtual void accept (PrimitiveIndexFunctor &) const
 Accept a PrimitiveIndexFunctor and call its methods to tell it about the internal primitives that this Drawable has. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 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. More...
 
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
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. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
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. More...
 
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. More...
 
template<typename T >
BoolValueObject
UCharValueObject
UShortValueObject
UIntValueObject
DoubleValueObject
Vec3fValueObject
Vec2dValueObject
Vec4dValueObject
PlaneValueObject
MatrixdValueObject bool 
getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- 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. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

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. More...
 
static void setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum)
 Set the minimum number of display lists to retain in the deleted display list cache. More...
 
static unsigned int getMinimumNumberOfDisplayListsToRetainInCache ()
 Get the minimum number of display lists to retain in the deleted display list cache. More...
 
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. More...
 
static void flushAllDeletedDisplayLists (unsigned int contextID)
 Flush all the cached display list which need to be deleted in the OpenGL context related to contextID. More...
 
static void discardAllDeletedDisplayLists (unsigned int contextID)
 Flush all the cached display list which need to be deleted in the OpenGL context related to contextID. More...
 
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. More...
 
static ExtensionsgetExtensions (unsigned int contextID, bool createIfNotInitalized)
 Function to call to get the extension of a specified context. More...
 
static void setExtensions (unsigned int contextID, Extensions *extensions)
 setExtensions allows users to override the extensions across graphics contexts. More...
 

Static Public Attributes

static unsigned int s_numberDrawablesReusedLastInLastFrame
 
static unsigned int s_numberNewDrawablesInLastFrame
 
static unsigned int s_numberDeletedDrawablesInLastFrame
 

Protected Types

typedef osg::buffered_value
< GLuint > 
GLObjectList
 

Protected Member Functions

Drawableoperator= (const Drawable &)
 
virtual ~Drawable ()
 
void setBound (const BoundingBox &bb) const
 set the bounding box . More...
 
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 Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () 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
 
ref_ptr< UpdateCallback_updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< EventCallback_eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< CullCallback_cullCallback
 
ref_ptr< DrawCallback_drawCallback
 
- 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
 

Friends

class Node
 
class Geode
 
class StateSet
 

Detailed Description

Pure virtual base class for drawable geometry.

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, 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.

Member Typedef Documentation

typedef unsigned int osg::Drawable::AttributeType
typedef std::vector<Node*> osg::Drawable::ParentList

A vector of osg::Node pointers which is used to store the parent(s) of drawable.

Member Enumeration Documentation

Enumerator
VERTICES 
WEIGHTS 
NORMALS 
COLORS 
SECONDARY_COLORS 
FOG_COORDS 
ATTRIBUTE_6 
ATTRIBUTE_7 
TEXTURE_COORDS 
TEXTURE_COORDS_0 
TEXTURE_COORDS_1 
TEXTURE_COORDS_2 
TEXTURE_COORDS_3 
TEXTURE_COORDS_4 
TEXTURE_COORDS_5 
TEXTURE_COORDS_6 
TEXTURE_COORDS_7 

Constructor & Destructor Documentation

osg::Drawable::Drawable ( )
osg::Drawable::Drawable ( const Drawable drawable,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Drawable::~Drawable ( )
protectedvirtual

Member Function Documentation

virtual void osg::Drawable::accept ( AttributeFunctor )
inlinevirtual

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.

virtual void osg::Drawable::accept ( ConstAttributeFunctor ) const
inlinevirtual

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, osg::Geometry, osg::ShapeDrawable, and osgText::Text3D.

virtual void osg::Drawable::accept ( PrimitiveFunctor ) const
inlinevirtual

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 osgText::Text, osg::Geometry, osg::ShapeDrawable, osgSim::ImpostorSprite, osgParticle::PrecipitationEffect::PrecipitationDrawable, and osgText::Text3D.

virtual void osg::Drawable::accept ( PrimitiveIndexFunctor ) const
inlinevirtual

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.

void osg::Drawable::addParent ( osg::Node node)
protected
virtual Geometry* osg::Drawable::asGeometry ( )
inlinevirtual

Convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0.

Equivalent to dynamic_cast<Geometry*>(this).

Reimplemented in osg::Geometry.

Referenced by osgUtil::Simplifier::apply().

virtual const Geometry* osg::Drawable::asGeometry ( ) const
inlinevirtual

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 const char* osg::Drawable::className ( ) const
inlinevirtual

return the name of the object's class type.

Must be defined by derived classes.

Implements osg::Object.

Reimplemented in osgShadow::ShadowVolumeGeometry, osg::ShapeDrawable, osgAnimation::MorphGeometry, osgSim::ImpostorSprite, osgShadow::OccluderGeometry, osg::Geometry, osg::DrawPixels, osgText::Text, and osgText::TextBase.

virtual void osg::Drawable::compileGLObjects ( RenderInfo renderInfo) const
virtual

Immediately compile this Drawable into an OpenGL Display List/VertexBufferObjects.

Note
Operation is ignored if _useDisplayList is false or VertexBufferObjects are not used.

Reimplemented in osg::Geometry.

virtual BoundingBox osg::Drawable::computeBound ( ) const
virtual
virtual void osg::Drawable::computeDataVariance ( )
virtual

Compute the DataVariance based on an assessment of callback etc.

Reimplemented from osg::Object.

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.

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.

virtual void osg::Drawable::dirtyDisplayList ( )
virtual

Force a recompile on next draw() of any OpenGL display list associated with this geoset.

Reimplemented in osg::Geometry.

static void osg::Drawable::discardAllDeletedDisplayLists ( unsigned int  contextID)
static

Flush all the cached display list which need to be deleted in the OpenGL context related to contextID.

Note, unlike flush no OpenGL calls are made, instead the handles are all removed. this call is useful for when an OpenGL context has been destroyed.

void osg::Drawable::draw ( RenderInfo renderInfo) 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().

Note
This method should not be overridden in subclasses, as it manages the optional display list (notice this is not even virtual). Subclasses should override drawImplementation() instead.

References _drawCallback, _globjList, _supportsVertexBufferObjects, _useDisplayList, _useVertexBufferObjects, drawImplementation(), generateDisplayList(), osg::RenderInfo::getContextID(), getGLObjectSizeHint(), osg::RenderInfo::getState(), and osg::State::isVertexBufferObjectSupported().

virtual void osg::Drawable::drawImplementation ( RenderInfo renderInfo) const
pure virtual

drawImplementation(RenderInfo&) 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(RenderInfo&) is called from the draw(RenderInfo&) method, with the draw method handling management of OpenGL display lists, and drawImplementation(RenderInfo&) handling the actual drawing itself.

Parameters
renderInfoThe osg::RenderInfo object that encapsulates the current rendering information including the osg::State OpenGL state for the current graphics context.

Implemented in osgText::Text, osgParticle::ParticleSystem, osgShadow::ShadowVolumeGeometry, osg::Geometry, osg::ShapeDrawable, osgSim::ImpostorSprite, osgParticle::PrecipitationEffect::PrecipitationDrawable, osgText::Text3D, osg::QueryGeometry, osgShadow::OccluderGeometry, osgAnimation::RigGeometry, osg::DrawPixels, osgParticle::ConnectedParticleSystem, and osgText::FadeText.

Referenced by draw().

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 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.

Referenced by draw().

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().

References osg::BoundingBoxImpl< VT >::expandBy().

ComputeBoundingBoxCallback* osg::Drawable::getComputeBoundingBoxCallback ( )
inline

Get the compute bound callback.

const ComputeBoundingBoxCallback* osg::Drawable::getComputeBoundingBoxCallback ( ) const
inline

Get the const compute bound callback.

CullCallback* osg::Drawable::getCullCallback ( )
inline
const CullCallback* osg::Drawable::getCullCallback ( ) const
inline

Get the const CullCallback.

GLuint& osg::Drawable::getDisplayList ( unsigned int  contextID) const
inline

Return OpenGL display list for specified contextID.

DrawCallback* osg::Drawable::getDrawCallback ( )
inline

Get the non const DrawCallback.

const DrawCallback* osg::Drawable::getDrawCallback ( ) const
inline

Get the const DrawCallback.

EventCallback* osg::Drawable::getEventCallback ( )
inline
const EventCallback* osg::Drawable::getEventCallback ( ) const
inline

Get the 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
inlinevirtual

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.

Referenced by draw().

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
inlineprotected
unsigned int osg::Drawable::getNumChildrenRequiringUpdateTraversal ( ) const
inlineprotected
unsigned int osg::Drawable::getNumParents ( ) const
inline

Get the number of parents of node.

Returns
the number of parents of this 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.

Node* osg::Drawable::getParent ( unsigned int  i)
inline

Get a single parent of Drawable.

Parameters
iindex of the parent to get.
Returns
the parent i.
const Node* osg::Drawable::getParent ( unsigned int  i) const
inline

Get a single const parent of Drawable.

Parameters
iindex of the parent to get.
Returns
the parent i.
const ParentList& osg::Drawable::getParents ( ) const
inline

Get the parent list of drawable.

Referenced by osgAnimation::RigGeometry::UpdateVertex::update().

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.

Shape* osg::Drawable::getShape ( )
inline

Get the Shape of the Drawable.

const Shape* osg::Drawable::getShape ( ) const
inline

Get the const Shape of the const Drawable.

StateSet* osg::Drawable::getStateSet ( )
inline

Get the attached StateSet.

const StateSet* osg::Drawable::getStateSet ( ) const
inline

Get the attached const StateSet.

bool osg::Drawable::getSupportsDisplayList ( ) const
inline

Get whether display lists are supported for this drawable instance.

UpdateCallback* osg::Drawable::getUpdateCallback ( )
inline
const UpdateCallback* osg::Drawable::getUpdateCallback ( ) const
inline

Get the 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.

MatrixList osg::Drawable::getWorldMatrices ( const osg::Node haltTraversalAtNode = 0) const

Get the list of matrices that transform this node from local coordinates to world coordinates.

The optional Node* haltTraversalAtNode allows the user to prevent traversal beyond a specifed node.

virtual bool osg::Drawable::isSameKindAs ( const Object obj) const
inlinevirtual
virtual const char* osg::Drawable::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 osgShadow::ShadowVolumeGeometry, osg::ShapeDrawable, osgAnimation::MorphGeometry, osgSim::ImpostorSprite, osgShadow::OccluderGeometry, osg::Geometry, osg::DrawPixels, osgText::Text, and osgText::TextBase.

Drawable& osg::Drawable::operator= ( const Drawable )
inlineprotected
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 objects for all graphics contexts.

Reimplemented from osg::Object.

Reimplemented in osgText::Text, osgText::TextBase, osg::Geometry, osgText::Text3D, and osg::QueryGeometry.

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.

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

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Object.

Reimplemented in osgText::Text, osgText::TextBase, osg::Geometry, and osgText::Text3D.

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)
inlinevirtual

Set the CullCallback which allows users to customize the culling of Drawable during the cull traversal.

virtual void osg::Drawable::setDrawCallback ( DrawCallback dc)
inlinevirtual

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.

See Also
osg::Shape.
void osg::Drawable::setStateSet ( StateSet stateset)

Set the StateSet attached to the Drawable.

Previously attached StateSet are automatically unreferenced on assignment of a new drawstate.

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::setThreadSafeRefUnref ( bool  threadSafe)
virtual

Set whether to use a mutex to ensure ref() and unref() are thread safe.

Reimplemented from osg::Object.

Reimplemented in osgText::Text, osgText::TextBase, and osgText::Text3D.

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.

virtual void osg::Drawable::setUseVertexBufferObjects ( bool  flag)
virtual

When set to true, ignore the setUseDisplayList() settings, and hints to the drawImplementation method to use OpenGL vertex buffer objects for rendering.

Reimplemented in osg::Geometry.

virtual bool osg::Drawable::supports ( const AttributeFunctor ) const
inlinevirtual

Return true if the Drawable subclass supports accept(AttributeFunctor&).

Reimplemented in osgText::Text, osg::Geometry, osg::ShapeDrawable, and osgText::Text3D.

virtual bool osg::Drawable::supports ( const ConstAttributeFunctor ) const
inlinevirtual

Return true if the Drawable subclass supports accept(ConstAttributeFunctor&).

Reimplemented in osgText::Text, osg::Geometry, osg::ShapeDrawable, and osgText::Text3D.

virtual bool osg::Drawable::supports ( const PrimitiveFunctor ) const
inlinevirtual

Return true if the Drawable subclass supports accept(PrimitiveFunctor&).

Reimplemented in osgText::Text, osg::Geometry, osg::ShapeDrawable, osgSim::ImpostorSprite, osgParticle::PrecipitationEffect::PrecipitationDrawable, and osgText::Text3D.

virtual bool osg::Drawable::supports ( const PrimitiveIndexFunctor ) const
inlinevirtual

Return true if the Drawable subclass supports accept(PrimitiveIndexFunctor&).

Reimplemented in osg::Geometry, and osgParticle::PrecipitationEffect::PrecipitationDrawable.

Friends And Related Function Documentation

friend class Geode
friend
friend class Node
friend
friend class StateSet
friend

Member Data Documentation

BoundingBox osg::Drawable::_boundingBox
mutableprotected
bool osg::Drawable::_boundingBoxComputed
mutableprotected
ref_ptr<ComputeBoundingBoxCallback> osg::Drawable::_computeBoundCallback
protected
ref_ptr<CullCallback> osg::Drawable::_cullCallback
protected
ref_ptr<DrawCallback> osg::Drawable::_drawCallback
protected

Referenced by draw().

ref_ptr<EventCallback> osg::Drawable::_eventCallback
protected
GLObjectList osg::Drawable::_globjList
mutableprotected

Referenced by draw().

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

Referenced by draw().

ref_ptr<UpdateCallback> osg::Drawable::_updateCallback
protected
bool osg::Drawable::_useDisplayList
protected

Referenced by draw().

bool osg::Drawable::_useVertexBufferObjects
protected

Referenced by draw().

unsigned int osg::Drawable::s_numberDeletedDrawablesInLastFrame
static
unsigned int osg::Drawable::s_numberDrawablesReusedLastInLastFrame
static
unsigned int osg::Drawable::s_numberNewDrawablesInLastFrame
static

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

osg logo
Generated at Mon Sep 9 2013 06:14:58 for the OpenSceneGraph by doxygen 1.8.4.