OpenSceneGraph 3.6.5
osg::Drawable Class Reference

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

#include <Drawable>

Inheritance diagram for osg::Drawable:

Classes

class  AttributeFunctor
struct  ComputeBoundingBoxCallback
 Callback to allow users to override the default computation of bounding volume. More...
class  ConstAttributeFunctor
struct  CreateVertexArrayStateCallback
 Callback class for overriding the default Drawable::createCreateVertexArrayStateImplementation(). More...
struct  DrawCallback
 Callback attached to an Drawable which allows the users to customize the drawing of an exist Drawable object. More...

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 DrawableUpdateCallback UpdateCallback
typedef DrawableEventCallback EventCallback
typedef DrawableCullCallback CullCallback
typedef unsigned int AttributeType
Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
 A vector of osg::Group pointers which is used to store the parent(s) of node.
typedef unsigned int NodeMask
 This is a set of bits (flags) that represent the Node.
typedef std::vector< std::string > DescriptionList
 A vector of std::string's which are used to describe the object.
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.
 META_Node (osg, Drawable)
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates.
void setInitialBound (const osg::BoundingBox &bbox)
 Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingBoxgetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingSpheregetBound () const
const BoundingBoxgetBoundingBox () const
 Get BoundingBox of Drawable.
virtual BoundingSphere computeBound () const
 Compute the bounding sphere around Drawables's geometry.
virtual BoundingBox computeBoundingBox () const
 Compute the bounding box around Drawables's geometry.
void setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
 Set the compute bound callback to override the default computeBound.
ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback ()
 Get the compute bound callback.
const ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback () const
 Get the const compute bound callback.
virtual void setShape (Shape *shape)
 Set the Shape of the Drawable.
template<class T>
void setShape (const ref_ptr< T > &shape)
ShapegetShape ()
 Get the Shape of the Drawable.
const ShapegetShape () 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.
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.
bool getUseVertexBufferObjects () const
 Return whether OpenGL vertex buffer objects should be used when supported by OpenGL driver.
void setUseVertexArrayObject (bool flag)
 Set whether to use a local VertexArrayObject for this Drawable.
bool getUseVertexArrayObject () const
 Return whether to use a local VertexArrayObject for this Drawable.
virtual void dirtyGLObjects ()
 Force a recompile on next draw() of any OpenGL objects 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 (RenderInfo &renderInfo) const
 Draw OpenGL primitives.
void drawInner (RenderInfo &renderInfo) const
virtual void compileGLObjects (RenderInfo &renderInfo) const
 Immediately compile this Drawable into an OpenGL Display List/VertexBufferObjects.
void setCreateVertexArrayStateCallback (CreateVertexArrayStateCallback *cb)
 Set the callback to override the default Drawable::createCreateVertexArrayStateImplementation().
CreateVertexArrayStateCallbackgetCreateVertexArrayStateCallback ()
 Get the callback that overrides the default Drawable::createCreateVertexArrayStateImplementation().
const CreateVertexArrayStateCallbackgetCreateVertexArrayStateCallback () const
 Get the const callback that overrides the default Drawable::createCreateVertexArrayStateImplementation().
VertexArrayStatecreateVertexArrayState (RenderInfo &renderInfo) const
 Create the VertexArrayState object used to track vertex array and vertex array object state.
virtual VertexArrayStatecreateVertexArrayStateImplementation (RenderInfo &renderInfo) const
 Implementation of Create the VertexArrayState object.
void setVertexArrayStateList (VertexArrayStateList &vasl)
VertexArrayStateListgetVertexArrayStateList ()
const VertexArrayStateListgetVertexArrayStateList () const
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context.
virtual void setDrawCallback (DrawCallback *dc)
 Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object.
DrawCallbackgetDrawCallback ()
 Get the non const DrawCallback.
const DrawCallbackgetDrawCallback () const
 Get the const DrawCallback.
virtual void drawImplementation (RenderInfo &) const
 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.
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.
Public Member Functions inherited from osg::Node
 Node ()
 Construct a node.
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual ObjectcloneType () const
 clone an object of the same type as the node.
virtual Objectclone (const CopyOp &copyop) const
 return a clone of a node, with Object* return type.
virtual bool isSameKindAs (const Object *obj) const
 return true if this and obj are of the same kind of object.
virtual const char * libraryName () const
 return the name of the node's library.
virtual const char * className () const
 return the name of the node's class type.
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual GeometryasGeometry ()
 convert 'this' into a Geometry pointer if Node is a Geometry, otherwise return 0.
virtual const GeometryasGeometry () const
 convert 'const this' into a const Geometry pointer if Node is a Geometry, otherwise return 0.
virtual GroupasGroup ()
 convert 'this' into a Group pointer if Node is a Group, otherwise return 0.
virtual const GroupasGroup () const
 convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0.
virtual TransformasTransform ()
 Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0.
virtual const TransformasTransform () const
 convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0.
virtual SwitchasSwitch ()
 Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0.
virtual const SwitchasSwitch () const
 convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0.
virtual GeodeasGeode ()
 Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0.
virtual const GeodeasGeode () const
 convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0.
virtual osgTerrain::TerrainasTerrain ()
 Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0.
virtual const osgTerrain::TerrainasTerrain () const
 convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0.
virtual void accept (NodeVisitor &nv)
 Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.
virtual void ascend (NodeVisitor &nv)
 Traverse upwards : calls parents' accept method with NodeVisitor.
virtual void traverse (NodeVisitor &)
 Traverse downwards : calls children's accept method with NodeVisitor.
const ParentListgetParents () const
 Get the parent list of node.
ParentList getParents ()
 Get the a copy of parent list of node.
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
 Get a single const parent of node.
unsigned int getNumParents () const
 Get the number of parents of node.
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 Get the list of node paths parent paths.
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates.
void setUpdateCallback (Callback *nc)
 Set update node callback, called during update traversal.
template<class T>
void setUpdateCallback (const ref_ptr< T > &nc)
CallbackgetUpdateCallback ()
 Get update node callback, called during update traversal.
const CallbackgetUpdateCallback () const
 Get const update node callback, called during update traversal.
void addUpdateCallback (Callback *nc)
 Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one.
template<class T>
void addUpdateCallback (const ref_ptr< T > &nc)
void removeUpdateCallback (Callback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
template<class T>
void removeUpdateCallback (const ref_ptr< T > &nc)
unsigned int getNumChildrenRequiringUpdateTraversal () const
 Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children.
void setEventCallback (Callback *nc)
 Set event node callback, called during event traversal.
template<class T>
void setEventCallback (const ref_ptr< T > &nc)
CallbackgetEventCallback ()
 Get event node callback, called during event traversal.
const CallbackgetEventCallback () const
 Get const event node callback, called during event traversal.
void addEventCallback (Callback *nc)
 Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one.
template<class T>
void addEventCallback (const ref_ptr< T > &nc)
void removeEventCallback (Callback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
template<class T>
void removeEventCallback (const ref_ptr< T > &nc)
unsigned int getNumChildrenRequiringEventTraversal () const
 Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children.
void setCullCallback (Callback *nc)
 Set cull node callback, called during cull traversal.
template<class T>
void setCullCallback (const ref_ptr< T > &nc)
CallbackgetCullCallback ()
 Get cull node callback, called during cull traversal.
const CallbackgetCullCallback () const
 Get const cull node callback, called during cull traversal.
void addCullCallback (Callback *nc)
 Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one.
template<class T>
void addCullCallback (const ref_ptr< T > &nc)
void removeCullCallback (Callback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
template<class T>
void removeCullCallback (const ref_ptr< T > &nc)
void setCullingActive (bool active)
 Set the view frustum/small feature culling of this node to be active or inactive.
bool getCullingActive () const
 Get the view frustum/small feature _cullingActive flag for this node.
unsigned int getNumChildrenWithCullingDisabled () const
 Get the number of Children of this node which have culling disabled.
bool isCullingActive () const
 Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal.
unsigned int getNumChildrenWithOccluderNodes () const
 Get the number of Children of this node which are or have OccluderNode's.
bool containsOccluderNodes () const
 return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes.
void setNodeMask (NodeMask nm)
 Set the node mask.
NodeMask getNodeMask () const
 Get the node Mask.
void setStateSet (osg::StateSet *stateset)
 Set the node's StateSet.
template<class T>
void setStateSet (const osg::ref_ptr< T > &stateset)
osg::StateSetgetOrCreateStateSet ()
 return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet.
osg::StateSetgetStateSet ()
 Return the node's StateSet.
const osg::StateSetgetStateSet () const
 Return the node's const StateSet.
void setDescriptions (const DescriptionList &descriptions)
 Set the list of string descriptions.
DescriptionListgetDescriptions ()
 Get the description list of the node.
const DescriptionListgetDescriptions () const
 Get the const description list of the const node.
const std::string & getDescription (unsigned int i) const
 Get a single const description of the const node.
std::string & getDescription (unsigned int i)
 Get a single description of the node.
unsigned int getNumDescriptions () const
 Get the number of descriptions of the node.
void addDescription (const std::string &desc)
 Add a description string to the node.
void setInitialBound (const osg::BoundingSphere &bsphere)
 Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingSpheregetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume.
void dirtyBound ()
 Mark this node's bounding sphere dirty.
const BoundingSpheregetBound () const
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 Set the compute bound callback to override the default computeBound.
template<class T>
void setComputeBoundingSphereCallback (const ref_ptr< T > &callback)
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 Get the compute bound callback.
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
 Get the const compute bound callback.
Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name.
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
template<class T>
void setUserData (const ref_ptr< T > &ud)
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T>
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T>
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
template<typename T>
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template
Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead.
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

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 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 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 Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.

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 .
Protected Member Functions inherited from osg::Node
virtual ~Node ()
 Node destructor.
void addParent (osg::Group *parent)
void removeParent (osg::Group *parent)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
void setNumChildrenRequiringEventTraversal (unsigned int num)
void setNumChildrenWithCullingDisabled (unsigned int num)
void setNumChildrenWithOccluderNodes (unsigned int num)
Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor.
Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

BoundingBox _initialBoundingBox
ref_ptr< ComputeBoundingBoxCallback_computeBoundingBoxCallback
BoundingBox _boundingBox
ref_ptr< Shape_shape
bool _supportsDisplayList
bool _useDisplayList
bool _supportsVertexBufferObjects
bool _useVertexBufferObjects
bool _useVertexArrayObject
GLObjectList _globjList
VertexArrayStateList _vertexArrayStateList
ref_ptr< DrawCallback_drawCallback
ref_ptr< CreateVertexArrayStateCallback_createVertexArrayStateCallback
Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
ref_ptr< ComputeBoundingSphereCallback_computeBoundCallback
BoundingSphere _boundingSphere
bool _boundingSphereComputed
ParentList _parents
ref_ptr< Callback_updateCallback
unsigned int _numChildrenRequiringUpdateTraversal
ref_ptr< Callback_eventCallback
unsigned int _numChildrenRequiringEventTraversal
ref_ptr< Callback_cullCallback
bool _cullingActive
unsigned int _numChildrenWithCullingDisabled
unsigned int _numChildrenWithOccluderNodes
NodeMask _nodeMask
ref_ptr< StateSet_stateset
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

◆ AttributeType

typedef unsigned int osg::Drawable::AttributeType

◆ CullCallback

◆ EventCallback

◆ GLObjectList

◆ UpdateCallback

Member Enumeration Documentation

◆ AttributeTypes

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

◆ Drawable() [1/2]

◆ Drawable() [2/2]

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

Copy constructor using CopyOp to manage deep vs shallow copy.

References Drawable(), and osg::CopyOp::SHALLOW_COPY.

◆ ~Drawable()

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

Member Function Documentation

◆ accept() [1/4]

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, osgTerrain::HeightFieldDrawable, and osgTerrain::SharedGeometry.

◆ accept() [2/4]

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 osg::Geometry, osgTerrain::HeightFieldDrawable, osgTerrain::SharedGeometry, osgText::Text3D, and osgText::Text.

◆ accept() [3/4]

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, PrimitiveFunctor only provides const access of the primitives, as primitives may be procedurally generated so one cannot modify it.

Reimplemented in osg::Geometry, osgParticle::PrecipitationEffect::PrecipitationDrawable, osgTerrain::HeightFieldDrawable, osgTerrain::SharedGeometry, osgText::Text3D, and osgText::Text.

◆ accept() [4/4]

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, PrimitiveIndexFunctor only provide const access of the primitives, as primitives may be procedurally generated so one cannot modify it.

Reimplemented in osg::Geometry, osgParticle::PrecipitationEffect::PrecipitationDrawable, osgTerrain::HeightFieldDrawable, and osgTerrain::SharedGeometry.

◆ asDrawable() [1/2]

virtual Drawable * osg::Drawable::asDrawable ( )
inlinevirtual

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

Equivalent to dynamic_cast<Drawable*>(this).

Reimplemented from osg::Node.

References Drawable().

◆ asDrawable() [2/2]

virtual const Drawable * osg::Drawable::asDrawable ( ) const
inlinevirtual

convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.

Equivalent to dynamic_cast<const Drawable*>(this).

Reimplemented from osg::Node.

References Drawable().

◆ compileGLObjects()

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::DispatchCompute, osg::Geometry, osgTerrain::HeightFieldDrawable, osgTerrain::SharedGeometry, and osgText::TextBase.

◆ computeBound()

virtual BoundingSphere osg::Drawable::computeBound ( ) const
virtual

Compute the bounding sphere around Drawables's geometry.

Reimplemented from osg::Node.

◆ computeBoundingBox()

virtual BoundingBox osg::Drawable::computeBoundingBox ( ) const
virtual

Compute the bounding box around Drawables's geometry.

Reimplemented in osg::DrawPixels, osgParticle::ParticleSystem, osgText::Text3D, and osgText::TextBase.

Referenced by getBoundingBox().

◆ computeDataVariance()

virtual void osg::Drawable::computeDataVariance ( )
virtual

Compute the DataVariance based on an assessment of callback etc.

Reimplemented from osg::Object.

◆ createVertexArrayState()

VertexArrayState * osg::Drawable::createVertexArrayState ( RenderInfo & renderInfo) const
inline

Create the VertexArrayState object used to track vertex array and vertex array object state.

This method will be called automatically during rendering setup so users should not call this themselves.

References _createVertexArrayStateCallback, and createVertexArrayStateImplementation().

Referenced by draw().

◆ createVertexArrayStateImplementation()

virtual VertexArrayState * osg::Drawable::createVertexArrayStateImplementation ( RenderInfo & renderInfo) const
virtual

◆ deleteDisplayList()

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.

◆ dirtyGLObjects()

virtual void osg::Drawable::dirtyGLObjects ( )
virtual

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

Reimplemented in osg::Geometry.

Referenced by setDrawCallback().

◆ draw()

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 _globjList, _supportsVertexBufferObjects, _useDisplayList, _useVertexArrayObject, _useVertexBufferObjects, _vertexArrayStateList, osg::State::bindVertexArrayObject(), createVertexArrayState(), drawInner(), osg::Object::DYNAMIC, generateDisplayList(), osg::RenderInfo::getContextID(), osg::State::getCurrentVertexArrayState(), osg::Object::getDataVariance(), getGLObjectSizeHint(), osg::RenderInfo::getState(), osg::VertexArrayState::setRequiresSetArrays(), osg::State::useVertexArrayObject(), and osg::State::useVertexBufferObject().

◆ drawImplementation()

virtual void osg::Drawable::drawImplementation ( RenderInfo & ) const
inlinevirtual

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. renderInfo : The osg::RenderInfo object that encapsulates the current rendering information including the osg::State OpenGL state for the current graphics context.

Reimplemented in osg::DispatchCompute, osg::DrawPixels, osg::Geometry, osg::QueryGeometry, osgParticle::ConnectedParticleSystem, osgParticle::ParticleSystem, osgParticle::PrecipitationEffect::PrecipitationDrawable, osgTerrain::HeightFieldDrawable, osgTerrain::SharedGeometry, osgText::FadeText, osgText::Text3D, and osgText::Text.

Referenced by drawInner().

◆ drawInner()

void osg::Drawable::drawInner ( RenderInfo & renderInfo) const
inline

References _drawCallback, and drawImplementation().

Referenced by draw().

◆ generateDisplayList()

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

◆ getBound()

const BoundingSphere & osg::Drawable::getBound ( ) const
inline

◆ getBoundingBox()

const BoundingBox & osg::Drawable::getBoundingBox ( ) const
inline

Get BoundingBox of Drawable.

If the BoundingBox is not up to date then its updated via an internal call to computeBond().

References _boundingBox, osg::Node::_boundingSphere, osg::Node::_boundingSphereComputed, _computeBoundingBoxCallback, _initialBoundingBox, and computeBoundingBox().

Referenced by getBound().

◆ getComputeBoundingBoxCallback() [1/2]

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

Get the compute bound callback.

References _computeBoundingBoxCallback.

◆ getComputeBoundingBoxCallback() [2/2]

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

Get the const compute bound callback.

References _computeBoundingBoxCallback.

◆ getCreateVertexArrayStateCallback() [1/2]

CreateVertexArrayStateCallback * osg::Drawable::getCreateVertexArrayStateCallback ( )
inline

Get the callback that overrides the default Drawable::createCreateVertexArrayStateImplementation().

References _createVertexArrayStateCallback.

◆ getCreateVertexArrayStateCallback() [2/2]

const CreateVertexArrayStateCallback * osg::Drawable::getCreateVertexArrayStateCallback ( ) const
inline

Get the const callback that overrides the default Drawable::createCreateVertexArrayStateImplementation().

References _createVertexArrayStateCallback.

◆ getDisplayList()

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

Return OpenGL display list for specified contextID.

References _globjList.

◆ getDrawCallback() [1/2]

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

Get the non const DrawCallback.

References _drawCallback.

◆ getDrawCallback() [2/2]

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

Get the const DrawCallback.

References _drawCallback.

◆ getGLObjectSizeHint()

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

◆ getInitialBound()

const BoundingBox & osg::Drawable::getInitialBound ( ) const
inline

Set the initial bounding volume to use when computing the overall bounding volume.

References _initialBoundingBox.

◆ getMinimumNumberOfDisplayListsToRetainInCache()

unsigned int osg::Drawable::getMinimumNumberOfDisplayListsToRetainInCache ( )
static

Get the minimum number of display lists to retain in the deleted display list cache.

◆ getShape() [1/2]

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

Get the Shape of the Drawable.

References _shape.

◆ getShape() [2/2]

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

Get the const Shape of the const Drawable.

References _shape.

◆ getSupportsDisplayList()

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

Get whether display lists are supported for this drawable instance.

References _supportsDisplayList.

◆ getUseDisplayList()

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

Return whether OpenGL display lists are being used for rendering.

References _useDisplayList.

◆ getUseVertexArrayObject()

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

Return whether to use a local VertexArrayObject for this Drawable.

References _useVertexArrayObject.

◆ getUseVertexBufferObjects()

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

Return whether OpenGL vertex buffer objects should be used when supported by OpenGL driver.

References _useVertexBufferObjects.

◆ getVertexArrayStateList() [1/2]

VertexArrayStateList & osg::Drawable::getVertexArrayStateList ( )
inline

References _vertexArrayStateList.

◆ getVertexArrayStateList() [2/2]

const VertexArrayStateList & osg::Drawable::getVertexArrayStateList ( ) const
inline

References _vertexArrayStateList.

◆ getWorldMatrices()

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

◆ META_Node()

osg::Drawable::META_Node ( osg ,
Drawable  )

References Drawable().

◆ operator=()

Drawable & osg::Drawable::operator= ( const Drawable & )
inlineprotected

References Drawable().

◆ releaseGLObjects()

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

Reimplemented in osg::Geometry, osg::QueryGeometry, osgParticle::ParticleSystem, osgParticle::PrecipitationEffect::PrecipitationDrawable, osgTerrain::HeightFieldDrawable, osgTerrain::SharedGeometry, osgText::Text3D, osgText::Text, and osgText::TextBase.

◆ resizeGLObjectBuffers()

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

◆ setBound()

void osg::Drawable::setBound ( const BoundingBox & bb) const
protected

set the bounding box .

◆ setComputeBoundingBoxCallback()

void osg::Drawable::setComputeBoundingBoxCallback ( ComputeBoundingBoxCallback * callback)
inline

Set the compute bound callback to override the default computeBound.

References _computeBoundingBoxCallback.

◆ setCreateVertexArrayStateCallback()

void osg::Drawable::setCreateVertexArrayStateCallback ( CreateVertexArrayStateCallback * cb)
inline

Set the callback to override the default Drawable::createCreateVertexArrayStateImplementation().

References _createVertexArrayStateCallback.

◆ setDrawCallback()

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

Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object.

References _drawCallback, and dirtyGLObjects().

◆ setInitialBound()

void osg::Drawable::setInitialBound ( const osg::BoundingBox & bbox)
inline

Set the initial bounding volume to use when computing the overall bounding volume.

References _initialBoundingBox, and osg::Node::dirtyBound().

◆ setMinimumNumberOfDisplayListsToRetainInCache()

void osg::Drawable::setMinimumNumberOfDisplayListsToRetainInCache ( unsigned int minimum)
static

Set the minimum number of display lists to retain in the deleted display list cache.

References osg::minimum().

◆ setShape() [1/2]

template<class T>
void osg::Drawable::setShape ( const ref_ptr< T > & shape)
inline

References osg::ref_ptr< T >::get(), and setShape().

Referenced by setShape().

◆ setShape() [2/2]

virtual void osg::Drawable::setShape ( Shape * shape)
inlinevirtual

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.

Reimplemented in osg::ShapeDrawable.

References _shape.

◆ setSupportsDisplayList()

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.

◆ setThreadSafeRefUnref()

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

◆ setUseDisplayList()

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.

◆ setUseVertexArrayObject()

void osg::Drawable::setUseVertexArrayObject ( bool flag)

Set whether to use a local VertexArrayObject for this Drawable.

◆ setUseVertexBufferObjects()

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.

◆ setVertexArrayStateList()

void osg::Drawable::setVertexArrayStateList ( VertexArrayStateList & vasl)
inline

References _vertexArrayStateList.

◆ supports() [1/4]

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

◆ supports() [2/4]

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

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

Reimplemented in osg::Geometry, osgTerrain::HeightFieldDrawable, osgTerrain::SharedGeometry, osgText::Text3D, and osgText::Text.

◆ supports() [3/4]

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

◆ supports() [4/4]

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

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

Reimplemented in osg::Geometry, osgParticle::PrecipitationEffect::PrecipitationDrawable, osgTerrain::HeightFieldDrawable, and osgTerrain::SharedGeometry.

◆ Geode

friend class Geode
friend

References Geode.

Referenced by Geode.

◆ Node

friend class Node
friend

References Node.

Referenced by Node.

◆ StateSet

friend class StateSet
friend

References StateSet.

Referenced by StateSet.

Member Data Documentation

◆ _boundingBox

BoundingBox osg::Drawable::_boundingBox
mutableprotected

Referenced by getBoundingBox().

◆ _computeBoundingBoxCallback

◆ _createVertexArrayStateCallback

◆ _drawCallback

ref_ptr<DrawCallback> osg::Drawable::_drawCallback
protected

◆ _globjList

GLObjectList osg::Drawable::_globjList
mutableprotected

Referenced by draw(), and getDisplayList().

◆ _initialBoundingBox

BoundingBox osg::Drawable::_initialBoundingBox
protected

◆ _shape

ref_ptr<Shape> osg::Drawable::_shape
protected

Referenced by getShape(), getShape(), and setShape().

◆ _supportsDisplayList

bool osg::Drawable::_supportsDisplayList
protected

Referenced by getSupportsDisplayList().

◆ _supportsVertexBufferObjects

bool osg::Drawable::_supportsVertexBufferObjects
protected

Referenced by draw().

◆ _useDisplayList

bool osg::Drawable::_useDisplayList
protected

Referenced by draw(), and getUseDisplayList().

◆ _useVertexArrayObject

bool osg::Drawable::_useVertexArrayObject
protected

Referenced by draw(), and getUseVertexArrayObject().

◆ _useVertexBufferObjects

bool osg::Drawable::_useVertexBufferObjects
protected

Referenced by draw(), and getUseVertexBufferObjects().

◆ _vertexArrayStateList

VertexArrayStateList osg::Drawable::_vertexArrayStateList
mutableprotected

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

osg logo
Generated at Sun Jul 27 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.