openscenegraph
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
osg::Drawable Class Reference

#include <Drawable>

Inheritance diagram for osg::Drawable:
osg::Node osg::Object osg::Referenced osg::DispatchCompute osg::DrawPixels osg::Geometry osgParticle::ParticleSystem osgParticle::PrecipitationEffect::PrecipitationDrawable osgTerrain::HeightFieldDrawable osgTerrain::SharedGeometry osgText::TextBase

Classes

class  AttributeFunctor
 
struct  ComputeBoundingBoxCallback
 
class  ConstAttributeFunctor
 
struct  CreateVertexArrayStateCallback
 
struct  DrawCallback
 

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
 
typedef unsigned int NodeMask
 
typedef std::vector< std::string > DescriptionList
 
- 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)
 
 META_Node (osg, Drawable)
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual void computeDataVariance ()
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 
void setInitialBound (const osg::BoundingBox &bbox)
 
const BoundingBoxgetInitialBound () const
 
const BoundingSpheregetBound () const
 
const BoundingBoxgetBoundingBox () const
 
virtual BoundingSphere computeBound () const
 
virtual BoundingBox computeBoundingBox () const
 
void setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
 
ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback ()
 
const ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback () const
 
virtual void setShape (Shape *shape)
 
template<class T >
void setShape (const ref_ptr< T > &shape)
 
ShapegetShape ()
 
const ShapegetShape () const
 
void setSupportsDisplayList (bool flag)
 
bool getSupportsDisplayList () const
 
void setUseDisplayList (bool flag)
 
bool getUseDisplayList () const
 
GLuint & getDisplayList (unsigned int contextID) const
 
virtual void setUseVertexBufferObjects (bool flag)
 
bool getUseVertexBufferObjects () const
 
void setUseVertexArrayObject (bool flag)
 
bool getUseVertexArrayObject () const
 
virtual void dirtyGLObjects ()
 
virtual unsigned int getGLObjectSizeHint () const
 
void draw (RenderInfo &renderInfo) const
 
void drawInner (RenderInfo &renderInfo) const
 
virtual void compileGLObjects (RenderInfo &renderInfo) const
 
void setCreateVertexArrayStateCallback (CreateVertexArrayStateCallback *cb)
 
CreateVertexArrayStateCallbackgetCreateVertexArrayStateCallback ()
 
const CreateVertexArrayStateCallbackgetCreateVertexArrayStateCallback () const
 
VertexArrayStatecreateVertexArrayState (RenderInfo &renderInfo) const
 
virtual VertexArrayStatecreateVertexArrayStateImplementation (RenderInfo &renderInfo) const
 
void setVertexArrayStateList (VertexArrayStateList &vasl)
 
VertexArrayStateListgetVertexArrayStateList ()
 
const VertexArrayStateListgetVertexArrayStateList () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
virtual void releaseGLObjects (State *state=0) const
 
virtual void setDrawCallback (DrawCallback *dc)
 
DrawCallbackgetDrawCallback ()
 
const DrawCallbackgetDrawCallback () const
 
virtual void drawImplementation (RenderInfo &) const
 
virtual bool supports (const AttributeFunctor &) const
 
virtual void accept (AttributeFunctor &)
 
virtual bool supports (const ConstAttributeFunctor &) const
 
virtual void accept (ConstAttributeFunctor &) const
 
virtual bool supports (const PrimitiveFunctor &) const
 
virtual void accept (PrimitiveFunctor &) const
 
virtual bool supports (const PrimitiveIndexFunctor &) const
 
virtual void accept (PrimitiveIndexFunctor &) const
 
- Public Member Functions inherited from osg::Node
 Node ()
 
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const
 
virtual Objectclone (const CopyOp &copyop) const
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual GeometryasGeometry ()
 
virtual const GeometryasGeometry () const
 
virtual GroupasGroup ()
 
virtual const GroupasGroup () const
 
virtual TransformasTransform ()
 
virtual const TransformasTransform () const
 
virtual SwitchasSwitch ()
 
virtual const SwitchasSwitch () const
 
virtual GeodeasGeode ()
 
virtual const GeodeasGeode () const
 
virtual osgTerrain::TerrainasTerrain ()
 
virtual const osgTerrain::TerrainasTerrain () const
 
virtual void accept (NodeVisitor &nv)
 
virtual void ascend (NodeVisitor &nv)
 
virtual void traverse (NodeVisitor &)
 
const ParentListgetParents () const
 
ParentList getParents ()
 
GroupgetParent (unsigned int i)
 
const GroupgetParent (unsigned int i) const
 
unsigned int getNumParents () const
 
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 
void setUpdateCallback (Callback *nc)
 
template<class T >
void setUpdateCallback (const ref_ptr< T > &nc)
 
CallbackgetUpdateCallback ()
 
const CallbackgetUpdateCallback () const
 
void addUpdateCallback (Callback *nc)
 
template<class T >
void addUpdateCallback (const ref_ptr< T > &nc)
 
void removeUpdateCallback (Callback *nc)
 
template<class T >
void removeUpdateCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (Callback *nc)
 
template<class T >
void setEventCallback (const ref_ptr< T > &nc)
 
CallbackgetEventCallback ()
 
const CallbackgetEventCallback () const
 
void addEventCallback (Callback *nc)
 
template<class T >
void addEventCallback (const ref_ptr< T > &nc)
 
void removeEventCallback (Callback *nc)
 
template<class T >
void removeEventCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (Callback *nc)
 
template<class T >
void setCullCallback (const ref_ptr< T > &nc)
 
CallbackgetCullCallback ()
 
const CallbackgetCullCallback () const
 
void addCullCallback (Callback *nc)
 
template<class T >
void addCullCallback (const ref_ptr< T > &nc)
 
void removeCullCallback (Callback *nc)
 
template<class T >
void removeCullCallback (const ref_ptr< T > &nc)
 
void setCullingActive (bool active)
 
bool getCullingActive () const
 
unsigned int getNumChildrenWithCullingDisabled () const
 
bool isCullingActive () const
 
unsigned int getNumChildrenWithOccluderNodes () const
 
bool containsOccluderNodes () const
 
void setNodeMask (NodeMask nm)
 
NodeMask getNodeMask () const
 
void setStateSet (osg::StateSet *stateset)
 
template<class T >
void setStateSet (const osg::ref_ptr< T > &stateset)
 
osg::StateSetgetOrCreateStateSet ()
 
osg::StateSetgetStateSet ()
 
const osg::StateSetgetStateSet () const
 
void setDescriptions (const DescriptionList &descriptions)
 
DescriptionListgetDescriptions ()
 
const DescriptionListgetDescriptions () const
 
const std::string & getDescription (unsigned int i) const
 
std::string & getDescription (unsigned int i)
 
unsigned int getNumDescriptions () const
 
void addDescription (const std::string &desc)
 
void setInitialBound (const osg::BoundingSphere &bsphere)
 
const BoundingSpheregetInitialBound () const
 
void dirtyBound ()
 
const BoundingSpheregetBound () const
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 
template<class T >
void setComputeBoundingSphereCallback (const ref_ptr< T > &callback)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Static Public Member Functions

static GLuint generateDisplayList (unsigned int contextID, unsigned int sizeHint=0)
 
static void deleteDisplayList (unsigned int contextID, GLuint globj, unsigned int sizeHint=0)
 
static void setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum)
 
static unsigned int getMinimumNumberOfDisplayListsToRetainInCache ()
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Protected Types

typedef osg::buffered_value< GLuint > GLObjectList
 

Protected Member Functions

Drawableoperator= (const Drawable &)
 
virtual ~Drawable ()
 
void setBound (const BoundingBox &bb) const
 
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 
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 ()
 
- 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]

osg::Drawable::Drawable ( )

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

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

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

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

◆ 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 osgParticle::PrecipitationEffect::PrecipitationDrawable, osgTerrain::SharedGeometry, osgTerrain::HeightFieldDrawable, and osg::Geometry.

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

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

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

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

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

◆ createVertexArrayStateImplementation()

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

Implementation of Create the VertexArrayState object.

Reimplemented in osgParticle::ParticleSystem, osgTerrain::SharedGeometry, osgText::TextBase, and osg::Geometry.

◆ deleteDisplayList()

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.

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

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

◆ 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::QueryGeometry, osgParticle::ConnectedParticleSystem, osgParticle::ParticleSystem, osgParticle::PrecipitationEffect::PrecipitationDrawable, osgTerrain::SharedGeometry, osgTerrain::HeightFieldDrawable, osgText::FadeText, osgText::Text, osgText::Text3D, osg::DispatchCompute, osg::DrawPixels, and osg::Geometry.

◆ drawInner()

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

◆ generateDisplayList()

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.

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

◆ getComputeBoundingBoxCallback() [1/2]

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

Get the compute bound callback.

◆ getComputeBoundingBoxCallback() [2/2]

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

Get the const compute bound callback.

◆ getCreateVertexArrayStateCallback() [1/2]

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

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

◆ getCreateVertexArrayStateCallback() [2/2]

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

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

◆ getDisplayList()

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

Return OpenGL display list for specified contextID.

◆ getDrawCallback() [1/2]

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

Get the non const DrawCallback.

◆ getDrawCallback() [2/2]

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

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

◆ getInitialBound()

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

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

◆ getMinimumNumberOfDisplayListsToRetainInCache()

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

◆ getShape() [2/2]

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

Get the const Shape of the const Drawable.

◆ getSupportsDisplayList()

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

Get whether display lists are supported for this drawable instance.

◆ getUseDisplayList()

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

Return whether OpenGL display lists are being used for rendering.

◆ getUseVertexArrayObject()

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

Return whether to use a local VertexArrayObject for this Drawable.

◆ getUseVertexBufferObjects()

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

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

◆ getVertexArrayStateList() [1/2]

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

◆ getVertexArrayStateList() [2/2]

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

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

◆ operator=()

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

◆ 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 osgParticle::PrecipitationEffect::PrecipitationDrawable, osgTerrain::SharedGeometry, osg::QueryGeometry, osgParticle::ParticleSystem, osgTerrain::HeightFieldDrawable, osgText::Text, osgText::Text3D, osgText::TextBase, and osg::Geometry.

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

◆ setCreateVertexArrayStateCallback()

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

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

◆ setDrawCallback()

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

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

◆ setInitialBound()

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

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

◆ setMinimumNumberOfDisplayListsToRetainInCache()

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

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

◆ setShape() [1/2]

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

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

◆ 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

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

◆ 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 osgParticle::PrecipitationEffect::PrecipitationDrawable, osgTerrain::SharedGeometry, osgTerrain::HeightFieldDrawable, and osg::Geometry.

Friends And Related Symbol Documentation

◆ Geode

friend class Geode
friend

◆ Node

friend class Node
friend

◆ StateSet

friend class StateSet
friend

Member Data Documentation

◆ _boundingBox

BoundingBox osg::Drawable::_boundingBox
mutableprotected

◆ _computeBoundingBoxCallback

ref_ptr<ComputeBoundingBoxCallback> osg::Drawable::_computeBoundingBoxCallback
protected

◆ _createVertexArrayStateCallback

ref_ptr<CreateVertexArrayStateCallback> osg::Drawable::_createVertexArrayStateCallback
protected

◆ _drawCallback

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

◆ _globjList

GLObjectList osg::Drawable::_globjList
mutableprotected

◆ _initialBoundingBox

BoundingBox osg::Drawable::_initialBoundingBox
protected

◆ _shape

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

◆ _supportsDisplayList

bool osg::Drawable::_supportsDisplayList
protected

◆ _supportsVertexBufferObjects

bool osg::Drawable::_supportsVertexBufferObjects
protected

◆ _useDisplayList

bool osg::Drawable::_useDisplayList
protected

◆ _useVertexArrayObject

bool osg::Drawable::_useVertexArrayObject
protected

◆ _useVertexBufferObjects

bool osg::Drawable::_useVertexBufferObjects
protected

◆ _vertexArrayStateList

VertexArrayStateList osg::Drawable::_vertexArrayStateList
mutableprotected

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