Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

osg::Drawable Class Reference

Inheritance diagram for osg::Drawable:

osg::Object osg::Referenced osg::DrawPixels osg::Geometry osg::ImpostorSprite osg::ShapeDrawable osgParticle::ParticleSystem osgText::Text List of all members.

Public Types

typedef std::vector< Node * > ParentList
typedef unsigned int AttributeType
enum  AttributeTypes {
  VERTICES = 0, WEIGHTS = 1, NORMALS = 2, COLORS = 3,
  SECONDARY_COLORS = 4, FOG_COORDS = 5, ATTIBUTE_6 = 6, ATTIBUTE_7 = 7,
  TEXTURE_COORDS = 8, TEXTURE_COORDS_0 = TEXTURE_COORDS, TEXTURE_COORDS_1 = TEXTURE_COORDS_0+1, TEXTURE_COORDS_2 = TEXTURE_COORDS_0+2,
  TEXTURE_COORDS_3 = TEXTURE_COORDS_0+3, TEXTURE_COORDS_4 = TEXTURE_COORDS_0+4, TEXTURE_COORDS_5 = TEXTURE_COORDS_0+5, TEXTURE_COORDS_6 = TEXTURE_COORDS_0+6,
  TEXTURE_COORDS_7 = TEXTURE_COORDS_0+7
}

Public Member Functions

 Drawable ()
 Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual GeometryasGeometry ()
virtual const GeometryasGeometry () const
const ParentListgetParents () const
ParentList getParents ()
NodegetParent (unsigned int i)
const NodegetParent (unsigned int i) const
unsigned int getNumParents () const
void setStateSet (StateSet *state)
StateSetgetStateSet ()
const StateSetgetStateSet () const
StateSetgetOrCreateStateSet ()
void dirtyBound ()
const BoundingBoxgetBound () const
void setShape (Shape *shape)
ShapegetShape ()
const ShapegetShape () const
void setSupportsDisplayList (bool flag)
bool getSupportsDisplayList () const
void setUseDisplayList (bool flag)
bool getUseDisplayList () const
void setUseVertexBufferObjects (bool flag)
bool getUseVertexBufferObjects () const
void dirtyDisplayList ()
virtual unsigned int getGLObjectSizeHint () const
void draw (State &state) const
virtual void compileGLObjects (State &state) const
virtual void releaseGLObjects (State *state=0) const
virtual void setUpdateCallback (UpdateCallback *ac)
UpdateCallbackgetUpdateCallback ()
const UpdateCallbackgetUpdateCallback () const
virtual void setCullCallback (CullCallback *cc)
CullCallbackgetCullCallback ()
const CullCallbackgetCullCallback () const
virtual void setDrawCallback (DrawCallback *dc)
DrawCallbackgetDrawCallback ()
const DrawCallbackgetDrawCallback () const
virtual void drawImplementation (State &state) const =0
virtual bool supports (AttributeFunctor &) const
virtual void accept (AttributeFunctor &)
virtual bool supports (ConstAttributeFunctor &) const
virtual void accept (ConstAttributeFunctor &) const
virtual bool supports (PrimitiveFunctor &) const
virtual void accept (PrimitiveFunctor &) const
virtual bool supports (PrimitiveIndexFunctor &) const
virtual void accept (PrimitiveIndexFunctor &) const

Static Public Member Functions

static GLuint generateDisplayList (unsigned int contextID, unsigned int sizeHint=0)
static void setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum)
static unsigned int getMinimumNumberOfDisplayListsToRetainInCache ()
static void deleteDisplayList (unsigned int contextID, GLuint globj, unsigned int sizeHint=0)
static void flushAllDeletedDisplayLists (unsigned int contextID)
static void flushDeletedDisplayLists (unsigned int contextID, double &availableTime)
static void deleteVertexBufferObject (unsigned int contextID, GLuint globj)
static void flushDeletedVertexBufferObjects (unsigned int contextID, double currentTime, double &availableTime)
static ExtensionsgetExtensions (unsigned int contextID, bool createIfNotInitalized)
static void setExtensions (unsigned int contextID, Extensions *extensions)

Static Public Attributes

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

Protected Types

typedef osg::buffered_value<
GLuint > 
GLObjectList

Protected Member Functions

Drawableoperator= (const Drawable &)
virtual ~Drawable ()
virtual bool computeBound () const
void setBound (const BoundingBox &bb) const
void addParent (osg::Node *node)
void removeParent (osg::Node *node)

Protected Attributes

ParentList _parents
ref_ptr< StateSet_stateset
BoundingBox _bbox
bool _bbox_computed
ref_ptr< Shape_shape
bool _supportsDisplayList
bool _useDisplayList
bool _supportsVertexBufferObjects
bool _useVertexBufferObjects
GLObjectList _globjList
GLObjectList _vboList
ref_ptr< UpdateCallback_updateCallback
ref_ptr< CullCallback_cullCallback
ref_ptr< DrawCallback_drawCallback

Friends

class Node
class Geode

Classes

class  AttributeFunctor
class  ConstAttributeFunctor
struct  CullCallback
struct  DrawCallback
class  Extensions
class  PrimitiveFunctor
class  PrimitiveIndexFunctor
struct  UpdateCallback

Detailed Description

Pure virtual base class for drawable Geometry. Contains no drawing primitives directly, these are provided by subclasses such as osg::Geometry. State attributes for a Drawable are maintained in StateSet which the Drawable maintains a referenced counted pointer to. Both Drawable's and StateSet's can be shared for optimal memory usage and graphics performance.


Member Typedef Documentation

typedef unsigned int osg::Drawable::AttributeType
 

typedef osg::buffered_value<GLuint> osg::Drawable::GLObjectList [protected]
 

typedef std::vector<Node*> osg::Drawable::ParentList
 

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


Member Enumeration Documentation

enum osg::Drawable::AttributeTypes
 

Enumeration values:
VERTICES 
WEIGHTS 
NORMALS 
COLORS 
SECONDARY_COLORS 
FOG_COORDS 
ATTIBUTE_6 
ATTIBUTE_7 
TEXTURE_COORDS 
TEXTURE_COORDS_0 
TEXTURE_COORDS_1 
TEXTURE_COORDS_2 
TEXTURE_COORDS_3 
TEXTURE_COORDS_4 
TEXTURE_COORDS_5 
TEXTURE_COORDS_6 
TEXTURE_COORDS_7 


Constructor & Destructor Documentation

osg::Drawable::Drawable  ) 
 

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

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Drawable::~Drawable  )  [protected, virtual]
 


Member Function Documentation

virtual void osg::Drawable::accept PrimitiveIndexFunctor  )  const [inline, virtual]
 

accept a PrimitiveIndexFunctor and call its methods to tell it about the internal primitives that this Drawable has. return true if functor handled by drawable, return false on failure of drawable to generate functor calls. Note, PrimtiveIndexFunctor only provide const access of the primitives, as primitives may be procedurally generated so one cannot modify it.

Reimplemented in osg::Geometry.

virtual void osg::Drawable::accept PrimitiveFunctor  )  const [inline, virtual]
 

accept a PrimitiveFunctor and call its methods to tell it about the internal primitives that this Drawable has. return true if functor handled by drawable, return false on failure of drawable to generate functor calls. Note, PrimtiveFunctor only provides const access of the primitives, as primitives may be procedurally generated so one cannot modify it.

Reimplemented in osg::Geometry, osg::ImpostorSprite, and osg::ShapeDrawable.

virtual void osg::Drawable::accept ConstAttributeFunctor  )  const [inline, virtual]
 

accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has. return true if functor handled by drawable, return false on failure of drawable to generate functor calls.

Reimplemented in osg::Geometry, osg::ImpostorSprite, and osg::ShapeDrawable.

virtual void osg::Drawable::accept AttributeFunctor  )  [inline, virtual]
 

accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has. return true if functor handled by drawable, return false on failure of drawable to generate functor calls.

Reimplemented in osg::Geometry, and osg::ImpostorSprite.

void osg::Drawable::addParent osg::Node node  )  [protected]
 

virtual const Geometry* osg::Drawable::asGeometry  )  const [inline, virtual]
 

convert 'const this' into a const Geometry pointer if Drawable is a Geometry, otherwise return 0. Equivalent to dynamic_cast<const Geometry*>(this).

Reimplemented in osg::Geometry.

virtual Geometry* osg::Drawable::asGeometry  )  [inline, virtual]
 

convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0. Equivalent to dynamic_cast<Geometry*>(this).

Reimplemented in osg::Geometry.

virtual const char* osg::Drawable::className  )  const [inline, virtual]
 

return the name of the object's class type. Must be defined by derived classes.

Implements osg::Object.

Reimplemented in osg::DrawPixels, osg::Geometry, osg::ImpostorSprite, osg::ShapeDrawable, and osgText::Text.

virtual void osg::Drawable::compileGLObjects State state  )  const [virtual]
 

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.

virtual bool osg::Drawable::computeBound  )  const [protected, virtual]
 

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

Reimplemented in osg::DrawPixels, osg::ImpostorSprite, osg::ShapeDrawable, osgParticle::ParticleSystem, and osgText::Text.

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.

static void osg::Drawable::deleteVertexBufferObject unsigned int  contextID,
GLuint  globj
[static]
 

use deleteVertexBufferObject instead of glDeleteList to allow OpenGL buffer objects to be cached until they can be deleted by the OpenGL context in which they were created, specified by contextID.

void osg::Drawable::dirtyBound  ) 
 

Dirty the bounding box, forcing a computeBound() on the next call to getBound(). Should be called in the internal geometry of the Drawable is modified.

void osg::Drawable::dirtyDisplayList  ) 
 

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

void osg::Drawable::draw State state  )  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, draw method should *not* be overridden in subclasses as it manages the optional display list.

virtual void osg::Drawable::drawImplementation State state  )  const [pure virtual]
 

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

Implemented in osg::DrawPixels, osg::Geometry, osg::ImpostorSprite, and osg::ShapeDrawable.

static void osg::Drawable::flushAllDeletedDisplayLists unsigned int  contextID  )  [static]
 

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

static void osg::Drawable::flushDeletedDisplayLists unsigned int  contextID,
double &  availableTime
[static]
 

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

static void osg::Drawable::flushDeletedVertexBufferObjects unsigned int  contextID,
double  currentTime,
double &  availableTime
[static]
 

flush all the cached vertex buffer objects which need to be deleted in the OpenGL context related to contextID.

static GLuint osg::Drawable::generateDisplayList unsigned int  contextID,
unsigned int  sizeHint = 0
[static]
 

Return a OpenGL display list handle a newly generated or reused from display list cache.

const BoundingBox& osg::Drawable::getBound  )  const [inline]
 

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

const CullCallback* osg::Drawable::getCullCallback  )  const [inline]
 

Get the const CullCallback.

CullCallback* osg::Drawable::getCullCallback  )  [inline]
 

Get the non const CullCallback.

const DrawCallback* osg::Drawable::getDrawCallback  )  const [inline]
 

Get the const DrawCallback.

DrawCallback* osg::Drawable::getDrawCallback  )  [inline]
 

Get the non const DrawCallback.

static Extensions* osg::Drawable::getExtensions unsigned int  contextID,
bool  createIfNotInitalized
[static]
 

Function to call to get the extension of a specified context. If the Exentsion object for that context has not yet been created and the 'createIfNotInitalized' flag been set to false then returns NULL. If 'createIfNotInitalized' is true then the Extensions object is automatically created. However, in this case the extension object is only created with the graphics context associated with ContextID..

virtual unsigned int osg::Drawable::getGLObjectSizeHint  )  const [inline, virtual]
 

Return the estimated size of GLObjects (display lists/vertex buffer objects) that are associated with this drawable. This size is used a hint for reuse of deleteed display lists/vertex buffer objects.

Reimplemented in osg::Geometry.

static unsigned int osg::Drawable::getMinimumNumberOfDisplayListsToRetainInCache  )  [static]
 

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

unsigned int osg::Drawable::getNumParents  )  const [inline]
 

Get the number of parents of node.

Returns:
the number of parents of this node.

StateSet* osg::Drawable::getOrCreateStateSet  ) 
 

Get the attached const StateSet, if one is not already attached create one, attach it to the drawable and return a pointer to it.

const Node* osg::Drawable::getParent unsigned int  i  )  const [inline]
 

Get a single const parent of Drawable.

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

Node* osg::Drawable::getParent unsigned int  i  )  [inline]
 

Get a single parent of Drawable.

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

ParentList osg::Drawable::getParents  )  [inline]
 

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

const ParentList& osg::Drawable::getParents  )  const [inline]
 

Get the parent list of drawable.

const Shape* osg::Drawable::getShape  )  const [inline]
 

Get the const Shape of the const Drawable.

Shape* osg::Drawable::getShape  )  [inline]
 

Get the Shape of the Drawable.

const StateSet* osg::Drawable::getStateSet  )  const [inline]
 

Get the attached const StateSet.

StateSet* osg::Drawable::getStateSet  )  [inline]
 

Get the attached StateSet.

bool osg::Drawable::getSupportsDisplayList  )  const [inline]
 

Get whether display lists are supported for this drawable instance.

const UpdateCallback* osg::Drawable::getUpdateCallback  )  const [inline]
 

Get the const UpdateCallback.

UpdateCallback* osg::Drawable::getUpdateCallback  )  [inline]
 

Get the non const UpdateCallback.

bool osg::Drawable::getUseDisplayList  )  const [inline]
 

Return whether OpenGL display lists are being used for rendering.

bool osg::Drawable::getUseVertexBufferObjects  )  const [inline]
 

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

virtual bool osg::Drawable::isSameKindAs const Object obj  )  const [inline, virtual]
 

Reimplemented from osg::Object.

Reimplemented in osg::DrawPixels, osg::Geometry, osg::ImpostorSprite, and osg::ShapeDrawable.

virtual const char* osg::Drawable::libraryName  )  const [inline, virtual]
 

return the name of the object's library. Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Implements osg::Object.

Reimplemented in osg::DrawPixels, osg::Geometry, osg::ImpostorSprite, osg::ShapeDrawable, and osgText::Text.

Drawable& osg::Drawable::operator= const Drawable  )  [inline, protected]
 

virtual void osg::Drawable::releaseGLObjects State state = 0  )  const [virtual]
 

if osg::State object is supplied: release any OpenGL display lists associated with graphics context specified or if state pointer is NULL: release all display lists for all graphics contexts

void osg::Drawable::removeParent osg::Node node  )  [protected]
 

void osg::Drawable::setBound const BoundingBox bb  )  const [protected]
 

set the bounding box .

virtual void osg::Drawable::setCullCallback CullCallback cc  )  [inline, virtual]
 

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

virtual void osg::Drawable::setDrawCallback DrawCallback dc  )  [inline, virtual]
 

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

static void osg::Drawable::setExtensions unsigned int  contextID,
Extensions extensions
[static]
 

setExtensions allows users to override the extensions across graphics contexts. typically used when you have different extensions supported across graphics pipes but need to ensure that they all use the same low common denominator extensions.

static void osg::Drawable::setMinimumNumberOfDisplayListsToRetainInCache unsigned int  minimum  )  [static]
 

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

void osg::Drawable::setShape Shape shape  )  [inline]
 

Set the Shape of the drawable. The shape can be used to speed up collision detection or as a guide for procedural geometry generation - see osg::Shape.

void osg::Drawable::setStateSet StateSet state  )  [inline]
 

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

void osg::Drawable::setSupportsDisplayList bool  flag  ) 
 

Set the drawable so that it can or cannot be used in conjunction with OpenGL display lists. When set to true, calls to Drawable::setUseDisplayList, whereas when set to false, no display lists can be created and calls to setUseDisplayList are ignored, and a warning is produced. The latter is typically used to guard against the switching on of display lists on objects with dynamic internal data such as continuous Level of Detail algorithms.

virtual void osg::Drawable::setUpdateCallback UpdateCallback ac  )  [virtual]
 

Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.

void osg::Drawable::setUseDisplayList bool  flag  ) 
 

When set to true, force the draw method to use OpenGL Display List for rendering. If false, rendering directly. If the display list has not been compiled already, the next call to draw will automatically create the display list.

void osg::Drawable::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.

virtual bool osg::Drawable::supports PrimitiveIndexFunctor  )  const [inline, virtual]
 

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

Reimplemented in osg::Geometry.

virtual bool osg::Drawable::supports PrimitiveFunctor  )  const [inline, virtual]
 

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

Reimplemented in osg::Geometry, osg::ImpostorSprite, and osg::ShapeDrawable.

virtual bool osg::Drawable::supports ConstAttributeFunctor  )  const [inline, virtual]
 

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

Reimplemented in osg::Geometry, osg::ImpostorSprite, and osg::ShapeDrawable.

virtual bool osg::Drawable::supports AttributeFunctor  )  const [inline, virtual]
 

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

Reimplemented in osg::Geometry, osg::ImpostorSprite, and osg::ShapeDrawable.


Friends And Related Function Documentation

friend class Geode [friend]
 

friend class Node [friend]
 


Member Data Documentation

BoundingBox osg::Drawable::_bbox [mutable, protected]
 

bool osg::Drawable::_bbox_computed [mutable, protected]
 

ref_ptr<CullCallback> osg::Drawable::_cullCallback [protected]
 

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

GLObjectList osg::Drawable::_globjList [mutable, protected]
 

ParentList osg::Drawable::_parents [protected]
 

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

ref_ptr<StateSet> osg::Drawable::_stateset [protected]
 

bool osg::Drawable::_supportsDisplayList [protected]
 

bool osg::Drawable::_supportsVertexBufferObjects [protected]
 

ref_ptr<UpdateCallback> osg::Drawable::_updateCallback [protected]
 

bool osg::Drawable::_useDisplayList [protected]
 

bool osg::Drawable::_useVertexBufferObjects [protected]
 

GLObjectList osg::Drawable::_vboList [mutable, protected]
 

unsigned int osg::Drawable::s_numberDeletedDrawablesInLastFrame [static]
 

unsigned int osg::Drawable::s_numberDrawablesReusedLastInLastFrame [static]
 

unsigned int osg::Drawable::s_numberNewDrawablesInLastFrame [static]
 


The documentation for this class was generated from the following file:
Generated on Fri May 13 15:15:47 2005 for openscenegraph by  doxygen 1.4.2