osg::ShapeDrawable Class Reference

Allow the use of Shapes as Drawables, so that they can be rendered with reduced effort. More...

#include <ShapeDrawable>

Inheritance diagram for osg::ShapeDrawable:

Public Member Functions
	ShapeDrawable ()
	ShapeDrawable (Shape *shape, TessellationHints *hints=0)
template<class T>
	ShapeDrawable (const ref_ptr< T > &shape, TessellationHints *hints=0)
	ShapeDrawable (const ShapeDrawable &pg, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy.
virtual Object *	cloneType () const
	clone an object of the same type as the node.
virtual Object *	clone (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 void	setShape (Shape *shape)
	Set the Shape of the Drawable.
void	setColor (const Vec4 &color)
	Set the color of the shape.
const Vec4 &	getColor () const
	Get the color of the shape.
void	setTessellationHints (TessellationHints *hints)
TessellationHints *	getTessellationHints ()
const TessellationHints *	getTessellationHints () const
void	build ()
	method to invoke to rebuild the geometry that renders the shape.
Public Member Functions inherited from osg::Geometry
	Geometry ()
	Geometry (const Geometry &geometry, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy.
	META_Node (osg, Geometry)
virtual Geometry *	asGeometry ()
	convert 'this' into a Geometry pointer if Node is a Geometry, otherwise return 0.
virtual const Geometry *	asGeometry () const
	convert 'const this' into a const Geometry pointer if Node is a Geometry, otherwise return 0.
bool	empty () const
void	setVertexArray (Array *array)
Array *	getVertexArray ()
const Array *	getVertexArray () const
void	setNormalArray (Array *array)
void	setNormalArray (Array *array, osg::Array::Binding binding)
Array *	getNormalArray ()
const Array *	getNormalArray () const
void	setColorArray (Array *array)
void	setColorArray (Array *array, osg::Array::Binding binding)
Array *	getColorArray ()
const Array *	getColorArray () const
void	setSecondaryColorArray (Array *array)
void	setSecondaryColorArray (Array *array, osg::Array::Binding binding)
Array *	getSecondaryColorArray ()
const Array *	getSecondaryColorArray () const
void	setFogCoordArray (Array *array)
void	setFogCoordArray (Array *array, osg::Array::Binding binding)
Array *	getFogCoordArray ()
const Array *	getFogCoordArray () const
void	setTexCoordArray (unsigned int unit, Array *array)
void	setTexCoordArray (unsigned int unit, Array *array, osg::Array::Binding binding)
Array *	getTexCoordArray (unsigned int unit)
const Array *	getTexCoordArray (unsigned int unit) const
unsigned int	getNumTexCoordArrays () const
void	setTexCoordArrayList (const ArrayList &arrrayList)
ArrayList &	getTexCoordArrayList ()
const ArrayList &	getTexCoordArrayList () const
void	setVertexAttribArray (unsigned int index, Array *array)
void	setVertexAttribArray (unsigned int index, Array *array, osg::Array::Binding binding)
Array *	getVertexAttribArray (unsigned int index)
const Array *	getVertexAttribArray (unsigned int index) const
unsigned int	getNumVertexAttribArrays () const
void	setVertexAttribArrayList (const ArrayList &arrayList)
ArrayList &	getVertexAttribArrayList ()
const ArrayList &	getVertexAttribArrayList () const
void	setPrimitiveSetList (const PrimitiveSetList &primitives)
PrimitiveSetList &	getPrimitiveSetList ()
const PrimitiveSetList &	getPrimitiveSetList () const
unsigned int	getNumPrimitiveSets () const
PrimitiveSet *	getPrimitiveSet (unsigned int pos)
const PrimitiveSet *	getPrimitiveSet (unsigned int pos) const
bool	addPrimitiveSet (PrimitiveSet *primitiveset)
	Add a primitive set to the geometry.
bool	setPrimitiveSet (unsigned int i, PrimitiveSet *primitiveset)
	Set a primitive set to the specified position in geometry's primitive set list.
bool	insertPrimitiveSet (unsigned int i, PrimitiveSet *primitiveset)
	Insert a primitive set to the specified position in geometry's primitive set list.
bool	removePrimitiveSet (unsigned int i, unsigned int numElementsToRemove=1)
	Remove primitive set(s) from the specified position in geometry's primitive set list.
unsigned int	getPrimitiveSetIndex (const PrimitiveSet *primitiveset) const
	Get the index number of a primitive set, return a value between 0 and getNumPrimitiveSet()-1 if found, if not found then return getNumPrimitiveSet().
void	configureBufferObjects ()
	Convenience method that checks all the vertex arrays to make sure that the buffer objects are all assigned appropriate.
bool	containsSharedArrays () const
	return true if any arrays are shared.
void	duplicateSharedArrays ()
	duplicate any shared arrays.
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.
virtual void	dirtyGLObjects ()
	Force a recompile on next draw() of any OpenGL objects associated with this geoset.
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.
bool	getArrayList (ArrayList &arrayList) const
bool	getDrawElementsList (DrawElementsList &drawElementsList) const
osg::VertexBufferObject *	getOrCreateVertexBufferObject ()
osg::ElementBufferObject *	getOrCreateElementBufferObject ()
virtual unsigned int	getGLObjectSizeHint () const
	Return the estimated size of GLObjects (display lists/vertex buffer objects) that are associated with this drawable.
virtual void	compileGLObjects (RenderInfo &renderInfo) const
	Immediately compile this Drawable into an OpenGL Display List/VertexBufferObjects.
virtual void	drawImplementation (RenderInfo &renderInfo) const
	Draw Geometry directly ignoring an OpenGL display list which could be attached.
void	drawVertexArraysImplementation (RenderInfo &renderInfo) const
	Set up the vertex arrays for the purpose of rendering, called by drawImplemtation() prior to it calling drawPrimitivesImplementation().
void	drawPrimitivesImplementation (RenderInfo &renderInfo) const
	dispatch the primitives to OpenGL, called by drawImplemtation() after calling drawVertexArraysImplementation().
virtual bool	supports (const Drawable::AttributeFunctor &) const
	Return true, osg::Geometry does support accept(Drawable::AttributeFunctor&).
virtual void	accept (Drawable::AttributeFunctor &af)
	Accept an Drawable::AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has.
virtual bool	supports (const Drawable::ConstAttributeFunctor &) const
	Return true, osg::Geometry does support accept(Drawable::ConstAttributeFunctor&).
virtual void	accept (Drawable::ConstAttributeFunctor &af) const
	Accept a Drawable::ConstAttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has.
virtual bool	supports (const PrimitiveFunctor &) const
	Return true, osg::Geometry does support accept(PrimitiveFunctor&).
virtual void	accept (PrimitiveFunctor &pf) 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, osg::Geometry does support accept(PrimitiveIndexFunctor&).
virtual void	accept (PrimitiveIndexFunctor &pf) const
	Accept a PrimitiveFunctor and call its methods to tell it about the internal primitives that this Drawable has.
bool	containsDeprecatedData () const
	Return true if the deprecated use array indices or BIND_PER_PRIMITIVE binding has been assigned to arrays.
bool	checkForDeprecatedData ()
	fallback for deprecated functionality.
void	fixDeprecatedData ()
	fallback for deprecated functionality.
void	setNormalBinding (AttributeBinding ab)
	deprecated, use array->set*Binding(..).
void	setColorBinding (AttributeBinding ab)
void	setSecondaryColorBinding (AttributeBinding ab)
void	setFogCoordBinding (AttributeBinding ab)
void	setVertexAttribBinding (unsigned int index, AttributeBinding ab)
AttributeBinding	getNormalBinding () const
	deprecated, use array->get*Binding(..).
AttributeBinding	getColorBinding () const
AttributeBinding	getSecondaryColorBinding () const
AttributeBinding	getFogCoordBinding () const
AttributeBinding	getVertexAttribBinding (unsigned int index) const
void	setVertexAttribNormalize (unsigned int index, GLboolean norm)
	deprecated, use array->set*Normalize(..).
GLboolean	getVertexAttribNormalize (unsigned int index) const
	deprecated, use array->get*Normalize(..).
Public Member Functions inherited from osg::Drawable
	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 Drawable *	asDrawable ()
	Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const Drawable *	asDrawable () 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 BoundingBox &	getInitialBound () const
	Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingSphere &	getBound () const
const BoundingBox &	getBoundingBox () 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.
ComputeBoundingBoxCallback *	getComputeBoundingBoxCallback ()
	Get the compute bound callback.
const ComputeBoundingBoxCallback *	getComputeBoundingBoxCallback () const
	Get the const compute bound callback.
template<class T>
void	setShape (const ref_ptr< T > &shape)
Shape *	getShape ()
	Get the Shape of the Drawable.
const Shape *	getShape () 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.
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.
void	draw (RenderInfo &renderInfo) const
	Draw OpenGL primitives.
void	drawInner (RenderInfo &renderInfo) const
void	setCreateVertexArrayStateCallback (CreateVertexArrayStateCallback *cb)
	Set the callback to override the default Drawable::createCreateVertexArrayStateImplementation().
CreateVertexArrayStateCallback *	getCreateVertexArrayStateCallback ()
	Get the callback that overrides the default Drawable::createCreateVertexArrayStateImplementation().
const CreateVertexArrayStateCallback *	getCreateVertexArrayStateCallback () const
	Get the const callback that overrides the default Drawable::createCreateVertexArrayStateImplementation().
VertexArrayState *	createVertexArrayState (RenderInfo &renderInfo) const
	Create the VertexArrayState object used to track vertex array and vertex array object state.
void	setVertexArrayStateList (VertexArrayStateList &vasl)
VertexArrayStateList &	getVertexArrayStateList ()
const VertexArrayStateList &	getVertexArrayStateList () const
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual 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.
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 Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual Group *	asGroup ()
	convert 'this' into a Group pointer if Node is a Group, otherwise return 0.
virtual const Group *	asGroup () const
	convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0.
virtual Transform *	asTransform ()
	Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0.
virtual const Transform *	asTransform () const
	convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0.
virtual Switch *	asSwitch ()
	Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0.
virtual const Switch *	asSwitch () const
	convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0.
virtual Geode *	asGeode ()
	Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0.
virtual const Geode *	asGeode () const
	convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0.
virtual osgTerrain::Terrain *	asTerrain ()
	Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0.
virtual const osgTerrain::Terrain *	asTerrain () 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 ParentList &	getParents () const
	Get the parent list of node.
ParentList	getParents ()
	Get the a copy of parent list of node.
Group *	getParent (unsigned int i)
const Group *	getParent (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)
Callback *	getUpdateCallback ()
	Get update node callback, called during update traversal.
const Callback *	getUpdateCallback () 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)
Callback *	getEventCallback ()
	Get event node callback, called during event traversal.
const Callback *	getEventCallback () 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)
Callback *	getCullCallback ()
	Get cull node callback, called during cull traversal.
const Callback *	getCullCallback () 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::StateSet *	getOrCreateStateSet ()
	return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet.
osg::StateSet *	getStateSet ()
	Return the node's StateSet.
const osg::StateSet *	getStateSet () const
	Return the node's const StateSet.
void	setDescriptions (const DescriptionList &descriptions)
	Set the list of string descriptions.
DescriptionList &	getDescriptions ()
	Get the description list of the node.
const DescriptionList &	getDescriptions () 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 BoundingSphere &	getInitialBound () const
	Set the initial bounding volume to use when computing the overall bounding volume.
void	dirtyBound ()
	Mark this node's bounding sphere dirty.
const BoundingSphere &	getBound () 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)
ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback ()
	Get the compute bound callback.
const ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback () 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 NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSet *	asStateSet ()
	Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSet *	asStateSet () const
	convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual Callback *	asCallback ()
	Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const Callback *	asCallback () const
	convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual CallbackObject *	asCallbackObject ()
	Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObject *	asCallbackObject () const
	convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual UserDataContainer *	asUserDataContainer ()
	Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainer *	asUserDataContainer () const
	convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObject *	asValueObject ()
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObject *	asValueObject () const
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual Image *	asImage ()
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const Image *	asImage () 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::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object.
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object.
osg::UserDataContainer *	getOrCreateUserDataContainer ()
	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 Referenced *	getUserData ()
	Get user data.
virtual const Referenced *	getUserData () 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 &)
Referenced &	operator= (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.
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSet *	getOrCreateObserverSet () 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.

Protected Member Functions
ShapeDrawable &	operator= (const ShapeDrawable &)
virtual	~ShapeDrawable ()
Protected Member Functions inherited from osg::Geometry
Geometry &	operator= (const Geometry &)
virtual	~Geometry ()
void	addVertexBufferObjectIfRequired (osg::Array *array)
void	addElementBufferObjectIfRequired (osg::PrimitiveSet *primitiveSet)
virtual VertexArrayState *	createVertexArrayStateImplementation (RenderInfo &renderInfo) const
	Implementation of Create the VertexArrayState object.
Protected Member Functions inherited from osg::Drawable
Drawable &	operator= (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
Vec4	_color
ref_ptr< TessellationHints >	_tessellationHints
Protected Attributes inherited from osg::Geometry
PrimitiveSetList	_primitives
osg::ref_ptr< Array >	_vertexArray
osg::ref_ptr< Array >	_normalArray
osg::ref_ptr< Array >	_colorArray
osg::ref_ptr< Array >	_secondaryColorArray
osg::ref_ptr< Array >	_fogCoordArray
ArrayList	_texCoordList
ArrayList	_vertexAttribList
bool	_containsDeprecatedData
Protected Attributes inherited from osg::Drawable
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

Additional Inherited Members
Public Types inherited from osg::Geometry
enum	AttributeBinding { BIND_OFF =0 , BIND_OVERALL =1 , BIND_PER_PRIMITIVE_SET =2 , BIND_PER_VERTEX =4 }
	deprecated, Same values as Array::Binding. More...
typedef std::vector< osg::ref_ptr< osg::Array > >	ArrayList
typedef std::vector< ref_ptr< PrimitiveSet > >	PrimitiveSetList
typedef std::vector< osg::DrawElements * >	DrawElementsList
Public Types inherited from osg::Drawable
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 }
Static Public Member Functions inherited from osg::Drawable
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 DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler.
Protected Types inherited from osg::Drawable
typedef osg::buffered_value< GLuint >	GLObjectList

Detailed Description

Allow the use of Shapes as Drawables, so that they can be rendered with reduced effort.

The implementation of ShapeDrawable is not geared to efficiency; it's better to think of it as a convenience to render Shapes easily (perhaps for test or debugging purposes) than as the right way to render basic shapes in some efficiency-critical section of code.

Constructor & Destructor Documentation

ShapeDrawable() [1/4]

osg::ShapeDrawable::ShapeDrawable

(

)

Referenced by clone(), cloneType(), isSameKindAs(), operator=(), and ShapeDrawable().

ShapeDrawable() [2/4]

osg::ShapeDrawable::ShapeDrawable	(	Shape *	shape,
		TessellationHints *	hints = 0 )

ShapeDrawable() [3/4]

template<class T>

osg::ShapeDrawable::ShapeDrawable ( const ref_ptr< T > & shape, TessellationHints * hints = 0 )

inline

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

ShapeDrawable() [4/4]

osg::ShapeDrawable::ShapeDrawable	(	const ShapeDrawable &	pg,
		const CopyOp &	copyop = CopyOp::SHALLOW_COPY )

Copy constructor using CopyOp to manage deep vs shallow copy.

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

~ShapeDrawable()

virtual osg::ShapeDrawable::~ShapeDrawable ( )

protectedvirtual

Member Function Documentation

build()

void osg::ShapeDrawable::build

(

)

method to invoke to rebuild the geometry that renders the shape.

className()

virtual const char * osg::ShapeDrawable::className ( ) const

inlinevirtual

return the name of the node's class type.

Reimplemented from osg::Node.

clone()

virtual Object * osg::ShapeDrawable::clone ( const CopyOp & copyop ) const

inlinevirtual

return a clone of a node, with Object* return type.

Reimplemented from osg::Node.

References ShapeDrawable().

cloneType()

virtual Object * osg::ShapeDrawable::cloneType ( ) const

inlinevirtual

clone an object of the same type as the node.

Reimplemented from osg::Node.

References ShapeDrawable().

getColor()

const Vec4 & osg::ShapeDrawable::getColor ( ) const

inline

Get the color of the shape.

References _color.

getTessellationHints() [1/2]

TessellationHints * osg::ShapeDrawable::getTessellationHints ( )

inline

References _tessellationHints.

getTessellationHints() [2/2]

const TessellationHints * osg::ShapeDrawable::getTessellationHints ( ) const

inline

References _tessellationHints.

isSameKindAs()

virtual bool osg::ShapeDrawable::isSameKindAs ( const Object * obj ) const

inlinevirtual

return true if this and obj are of the same kind of object.

Reimplemented from osg::Node.

References NULL, and ShapeDrawable().

libraryName()

virtual const char * osg::ShapeDrawable::libraryName ( ) const

inlinevirtual

return the name of the node's library.

Reimplemented from osg::Node.

operator=()

ShapeDrawable & osg::ShapeDrawable::operator= ( const ShapeDrawable & )

inlineprotected

References ShapeDrawable().

setColor()

void osg::ShapeDrawable::setColor

(

const Vec4 &

color

)

Set the color of the shape.

setShape()

virtual void osg::ShapeDrawable::setShape ( Shape * shape )

virtual

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

Referenced by ShapeDrawable().

setTessellationHints()

void osg::ShapeDrawable::setTessellationHints

(

TessellationHints *

hints

)

Member Data Documentation

_color

Vec4 osg::ShapeDrawable::_color

protected

Referenced by getColor().

_tessellationHints

ref_ptr<TessellationHints> osg::ShapeDrawable::_tessellationHints

protected

Referenced by getTessellationHints(), getTessellationHints(), and ShapeDrawable().

---

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

• osg/ShapeDrawable