class SG_EXPORT osg::Drawable

Pure virtual base class for drawable Geometry.

Inheritance:

Public Methods
Drawable()
Drawable(const Drawable& drawable, const CopyOp& copyop=CopyOp::SHALLOW_COPY): Copy constructor using CopyOp to manage deep vs shallow copy
virtual bool isSameKindAs(const Object* obj) const
virtual const char* className() const
inline const ParentList& getParents() const: Get the parent list of drawable.
inline ParentList getParents(): Get the a copy of parent list of node.
inline Node* getParent(const unsigned int i): Get a single parent of Drawable.
inline const Node* getParent(const unsigned int i) const: Get a single const parent of Drawable.
inline const unsigned int getNumParents() const: Get the number of parents of node.
inline void setStateSet(StateSet* state): Set the StateSet attached to the Drawable.
inline StateSet* getStateSet(): Get the attached StateSet
inline const StateSet* getStateSet() const: Get the attached const StateSet
void setSupportsDisplayList(const bool flag): Set the drawable to it can or cannot be used in conjunction with OpenGL display lists.
inline const bool getSupportsDisplayList() const: Get whether display lists are supported for this drawable instance
void setUseDisplayList(const bool flag): When set to true, force the draw method to use OpenGL Display List for rendering.
inline const bool getUseDisplayList() const: Return whether OpenGL display lists are being used for rendering
void dirtyDisplayList(): Force a recompile on next draw() of any OpenGL display list associated with this geoset
void dirtyBound(): Dirty the bounding box, forcing a computeBound() on the next call to getBound().
inline const BoundingBox& getBound() const: get bounding box of geoset.
void compile(State& state): Immediately compile this drawable into an OpenGL Display List.
void setDrawCallback(DrawCallback* dc): Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object
DrawCallback* getDrawCallback(): Get the non const DrawCallback
const DrawCallback* getDrawCallback() const: Get the const DrawCallback
void setCullCallback(CullCallback* cc): Set the CullCallback which allows users to attach customize the drawing of existing Drawable object
CullCallback* getCullCallback(): Get the non const CullCallback
const CullCallback* getCullCallback() const: Get the const CullCallback
virtual void drawImmediateMode(State& state) = 0: draw directly ignoring an OpenGL display list which could be attached.
static void deleteDisplayList(uint contextID, uint globj): use deleteDisplayList instead of glDeleteList to allow OpenGL display list to cached until they can be deleted by the OpenGL context in which they were created, specified by contextID
static void flushDeletedDisplayLists(uint contextID): flush all the cached display list which need to be deleted in the OpenGL context related to contextID
virtual bool getStats(Statistics&): Collect Stistics count from Drawable
virtual AttributeBitMask suppportsAttributeOperation() const: return the attributes supported by applyAttrbuteOperation() as an AttributeBitMask
virtual AttributeBitMask applyAttributeOperation(AttributeFunctor&): return the attributes successully applied in applyAttributeUpdate
inline void draw(State& state): draw OpenGL primitives.

Public Members
typedef std::vector<Node*> ParentList: A vector of osg::Node pointers which is used to store the parent(s) of drawable
struct DrawCallback: public osg::Referenced: Callback attached to an Drawable which allows the users to customize the drawing of an exist Drawable object.
struct CullCallback: public osg::Referenced
typedef uint AttributeBitMaskenum AttributeBitMaskValues
class AttributeFunctor

Protected Fields
ParentList _parents
ref_ptr<StateSet> _dstate
bool _supportsDisplayList
bool _useDisplayList
mutable BoundingBox _bbox
mutable bool _bbox_computed
ref_ptr<DrawCallback> _drawCallback
ref_ptr<CullCallback> _cullCallback

Protected Methods
Drawable& operator = (const Drawable&)
virtual ~Drawable()
virtual const bool computeBound() const = 0: compute the bounding box of the drawable.
void addParent(osg::Node* node)
void removeParent(osg::Node* node)

Protected Members
typedef std::vector<uint> GLObjectList mutable GLObjectList _globjList
typedef std::map<uint,std::set<uint> >static DeletedDisplayListCache DeletedDisplayListCache s_deletedDisplayListCache

Inherited from Object:

Public Methods
virtual Object* cloneType() const
virtual Object* clone(const CopyOp&) const
inline void setDataVariance(const DataVariance dv)
inline const DataVariance getDataVariance() const

Public Members
enum DataVariance

Protected Fields
DataVariance _dataVariance

Inherited from Referenced:

Public Methods
inline void ref() const
inline void unref() const
inline void unref_nodelete() const
inline const int referenceCount() const

Protected Fields
mutable int _refCount

Documentation

Pure virtual base class for drawable Geometry. Contains no drawing primitives directly, these are provided by subclasses such as GeoSet. State attributes for a Drawable are maintained in StateSet which the Drawable maintains a referenced counted pointer to. Both Drawable's and StateSet's can be shared for optimal memory usage and graphics performance.
Subclasses should provide an instance of getStats(Statistics *st) if the subclass contains drawing primitives. This member function should add the primitives it draws into the Statistics class; for example add the number of quads, triangles etc created. For an example see GeoSet.cpp: getStats(osgUtil::Statistics *stat). Failure to implement this routine will only result in the stats displayed for your drawable being wrong. Another example is in the InfinitePlane class- this draws a normal geoset AND its own special set of quads, so this case of getPrims calls: the normal geoset stats gs->getStats(..), and then adds the number of quads rendered directly (it is rendered in a display list, but we do know how many quads are in the display list).

Drawable()

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

Copy constructor using CopyOp to manage deep vs shallow copy

virtual bool isSameKindAs(const Object* obj) const

virtual const char* className() const

typedef std::vector<Node*> ParentList

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

inline const ParentList& getParents() const

Get the parent list of drawable.

inline ParentList getParents()

Get the a copy of parent list of node. A copy is returned to prevent modification of the parent list.

inline Node* getParent(const unsigned int i)

Get a single parent of Drawable.


Parameters:: i - index of the parent to get.
Returns:: the parent i.

inline const Node* getParent(const unsigned int i) const

Get a single const parent of Drawable.


Parameters:: i - index of the parent to get.
Returns:: the parent i.

inline const unsigned int getNumParents() const

Get the number of parents of node.


Returns:: the number of parents of this node.

inline void setStateSet(StateSet* state)

Set the StateSet attached to the Drawable. Previously attached StateSet are automatically unreferenced on assignment of a new drawstate.

inline StateSet* getStateSet()

Get the attached StateSet

inline const StateSet* getStateSet() const

Get the attached const StateSet

void setSupportsDisplayList(const bool flag)

Set the drawable to it can or cannot be used in conjunction with OpenGL display lists. With 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 later 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.

inline const bool getSupportsDisplayList() const

Get whether display lists are supported for this drawable instance

void setUseDisplayList(const 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 already compile the next call to draw will automatically create the display list.

inline const bool getUseDisplayList() const

Return whether OpenGL display lists are being used for rendering

void dirtyDisplayList()

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

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

inline const BoundingBox& getBound() const

get bounding box of geoset. Note, now made virtual to make it possible to implement user-drawn objects albeit so what crudely, to be improved later.

void compile(State& state)

Immediately compile this drawable into an OpenGL Display List. Note I, operation is ignored if _useDisplayList to false. Note II, compile is not intended to be overridden in subclasses.

struct DrawCallback: public osg::Referenced

Callback attached to an Drawable which allows the users to customize the drawing of an exist Drawable object. The draw callback is implement as a replacement to the Drawable's own drawImmediateMode() method, if the the user intends to decorate the exist draw code then simple call the drawable->drawImmediateMode() from with the callbacks drawImmediateMode() method. This allows the users to do both pre and post callbacks without fuss and can even diable the inner draw in required.

virtual void drawImmediateMode(State& state, osg::Drawable* drawable) const = 0

do customized draw code

void setDrawCallback(DrawCallback* dc)

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

DrawCallback* getDrawCallback()

Get the non const DrawCallback

const DrawCallback* getDrawCallback() const

Get the const DrawCallback

struct CullCallback: public osg::Referenced virtual bool cull(osg::NodeVisitor* visitor, osg::Drawable* drawable) = 0 do customized cull code

void setCullCallback(CullCallback* cc)

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

CullCallback* getCullCallback()

Get the non const CullCallback

const CullCallback* getCullCallback() const

Get the const CullCallback

virtual void drawImmediateMode(State& state) = 0

draw directly ignoring an OpenGL display list which could be attached. This is the internal draw method which does the drawing itself, and is the method to override when deriving from Drawable.

static void deleteDisplayList(uint contextID, uint globj)

use deleteDisplayList instead of glDeleteList to allow OpenGL display list to cached until they can be deleted by the OpenGL context in which they were created, specified by contextID

static void flushDeletedDisplayLists(uint contextID)

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

virtual bool getStats(Statistics&)

Collect Stistics count from Drawable

typedef uint AttributeBitMaskenum AttributeBitMaskValues COORDS NORMALS COLORS TEXTURE_COORDS TEXTURE_COORDS_0 TEXTURE_COORDS_1 TEXTURE_COORDS_2 TEXTURE_COORDS_3

virtual AttributeBitMask suppportsAttributeOperation() const

return the attributes supported by applyAttrbuteOperation() as an AttributeBitMask

virtual AttributeBitMask applyAttributeOperation(AttributeFunctor&)

return the attributes successully applied in applyAttributeUpdate

Drawable& operator = (const Drawable&)

virtual ~Drawable()

virtual const bool computeBound() const = 0

compute the bounding box of the drawable. Method must be implemented by subclasses.

void addParent(osg::Node* node)

void removeParent(osg::Node* node)

ParentList _parents

ref_ptr<StateSet> _dstate

bool _supportsDisplayList

bool _useDisplayList

typedef std::vector<uint> GLObjectList mutable GLObjectList _globjList

mutable BoundingBox _bbox

mutable bool _bbox_computed

ref_ptr<DrawCallback> _drawCallback

ref_ptr<CullCallback> _cullCallback

typedef std::map<uint,std::set<uint> >static DeletedDisplayListCache DeletedDisplayListCache s_deletedDisplayListCache

inline void draw(State& state)

draw OpenGL primitives. If the drawable has _useDisplayList set to true then use an OpenGL display list, automatically compiling one if required. Otherwise call drawImmediateMode(). Note, draw method should *not* be overridden in subclasses as it manages the optional display list.