OpenSceneGraph  3.0.1
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
osg::Billboard Class Reference

Billboard is a derived form of Geode that orients its osg::Drawable children to face the eye point. More...

Inheritance diagram for osg::Billboard:
Inheritance graph
[legend]

List of all members.

Public Types

enum  Mode { POINT_ROT_EYE, POINT_ROT_WORLD, AXIAL_ROT }
typedef std::vector< Vec3PositionList
 Type definition for pivot point position list.
- Public Types inherited from osg::Geode
typedef std::vector< ref_ptr
< Drawable > > 
DrawableList
- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
 A vector of osg::Group pointers which is used to store the parent(s) of node.
typedef unsigned int NodeMask
 This is a set of bits (flags) that represent the Node.
typedef std::vector< std::string > DescriptionList
 A vector of std::string's which are used to describe the object.
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions

 Billboard ()
 Billboard (const Billboard &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
 META_Node (osg, Billboard)
void setMode (Mode mode)
 Set the billboard rotation mode.
Mode getMode () const
 Get the billboard rotation mode.
void setAxis (const Vec3 &axis)
 Set the rotation axis for the billboard's child Drawables.
const Vec3getAxis () const
 Get the rotation axis.
void setNormal (const Vec3 &normal)
 This normal defines child Drawables' front face direction when unrotated.
const Vec3getNormal () const
 Get the front face direction normal.
void setPosition (unsigned int i, const Vec3 &pos)
 Set the specified child Drawable's position.
const Vec3getPosition (unsigned int i) const
 Get the specified child Drawable's position.
void setPositionList (PositionList &pl)
 Set the list of pivot point positions.
PositionListgetPositionList ()
 Get the list of pivot point positions.
const PositionListgetPositionList () const
 Get a const list of pivot point positions.
virtual bool addDrawable (Drawable *gset)
 Add a Drawable with a default position of Vec3(0,0,0).
virtual bool addDrawable (Drawable *gset, const Vec3 &pos)
 Add a Drawable with a specified position.
virtual bool removeDrawable (Drawable *gset)
 Remove a Drawable and its associated position.
bool computeMatrix (Matrix &modelview, const Vec3 &eye_local, const Vec3 &pos_local) const
virtual BoundingSphere computeBound () const
 Compute the bounding sphere around Node's geometry or children.
- Public Member Functions inherited from osg::Geode
 Geode ()
 Geode (const Geode &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
 META_Node (osg, Geode)
virtual GeodeasGeode ()
 Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0.
virtual const GeodeasGeode () const
 convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0.
virtual bool removeDrawables (unsigned int i, unsigned int numDrawablesToRemove=1)
 Remove Drawable(s) from the specified position in Geode's drawable list.
virtual bool replaceDrawable (Drawable *origDraw, Drawable *newDraw)
 Replace specified Drawable with another Drawable.
virtual bool setDrawable (unsigned int i, Drawable *drawable)
 Set Drawable at position i.
unsigned int getNumDrawables () const
 Return the number of Drawables currently attached to the Geode.
DrawablegetDrawable (unsigned int i)
 Return the Drawable at position i.
const DrawablegetDrawable (unsigned int i) const
 Return the Drawable at position i.
bool containsDrawable (const Drawable *gset) const
 Return true if a given Drawable is contained within Geode.
unsigned int getDrawableIndex (const Drawable *drawable) const
 Get the index number of drawable.
const DrawableListgetDrawableList () const
 Get the list of drawables.
void compileDrawables (RenderInfo &renderInfo)
 Compile OpenGL Display List for each drawable.
const BoundingBoxgetBoundingBox () const
 Return the Geode's bounding box, which is the union of all the bounding boxes of the geode's drawables.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
- Public Member Functions inherited from osg::Node
 Node ()
 Construct a node.
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual ObjectcloneType () const
 clone an object of the same type as the node.
virtual Objectclone (const CopyOp &copyop) const
 return a clone of a node, with Object* return type.
virtual bool isSameKindAs (const Object *obj) const
 return true if this and obj are of the same kind of object.
virtual const char * libraryName () const
 return the name of the node's library.
virtual const char * className () const
 return the name of the node's class type.
virtual GroupasGroup ()
 convert 'this' into a Group pointer if Node is a Group, otherwise return 0.
virtual const GroupasGroup () const
 convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0.
virtual TransformasTransform ()
 Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0.
virtual const TransformasTransform () const
 convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0.
virtual SwitchasSwitch ()
 Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0.
virtual const SwitchasSwitch () const
 convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0.
virtual osgTerrain::TerrainasTerrain ()
 Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0.
virtual const osgTerrain::TerrainasTerrain () const
 convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0.
virtual void accept (NodeVisitor &nv)
 Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.
virtual void ascend (NodeVisitor &nv)
 Traverse upwards : calls parents' accept method with NodeVisitor.
virtual void traverse (NodeVisitor &)
 Traverse downwards : calls children's accept method with NodeVisitor.
const ParentListgetParents () const
 Get the parent list of node.
ParentList getParents ()
 Get the a copy of parent list of node.
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
 Get a single const parent of node.
unsigned int getNumParents () const
 Get the number of parents of node.
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 Get the list of node paths parent paths.
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates.
void setUpdateCallback (NodeCallback *nc)
 Set update node callback, called during update traversal.
NodeCallbackgetUpdateCallback ()
 Get update node callback, called during update traversal.
const NodeCallbackgetUpdateCallback () const
 Get const update node callback, called during update traversal.
void addUpdateCallback (NodeCallback *nc)
 Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one.
void removeUpdateCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
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 (NodeCallback *nc)
 Set event node callback, called during event traversal.
NodeCallbackgetEventCallback ()
 Get event node callback, called during event traversal.
const NodeCallbackgetEventCallback () const
 Get const event node callback, called during event traversal.
void addEventCallback (NodeCallback *nc)
 Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one.
void removeEventCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
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 (NodeCallback *nc)
 Set cull node callback, called during cull traversal.
NodeCallbackgetCullCallback ()
 Get cull node callback, called during cull traversal.
const NodeCallbackgetCullCallback () const
 Get const cull node callback, called during cull traversal.
void addCullCallback (NodeCallback *nc)
 Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one.
void removeCullCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
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.
osg::StateSetgetOrCreateStateSet ()
 return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet.
osg::StateSetgetStateSet ()
 Return the node's StateSet.
const osg::StateSetgetStateSet () const
 Return the node's const StateSet.
void setDescriptions (const DescriptionList &descriptions)
 Set the list of string descriptions.
DescriptionListgetDescriptions ()
 Get the description list of the node.
const DescriptionListgetDescriptions () const
 Get the const description list of the const node.
const std::string & getDescription (unsigned int i) const
 Get a single const description of the const node.
std::string & getDescription (unsigned int i)
 Get a single description of the node.
unsigned int getNumDescriptions () const
 Get the number of descriptions of the node.
void addDescription (const std::string &desc)
 Add a description string to the node.
void setInitialBound (const osg::BoundingSphere &bsphere)
 Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingSpheregetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume.
void dirtyBound ()
 Mark this node's bounding sphere dirty.
const BoundingSpheregetBound () const
 Get the bounding sphere of node.
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 Set the compute bound callback to override the default computeBound.
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 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.
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.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience 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.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience 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)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Protected Types

enum  AxisAligned {
  AXIAL_ROT_X_AXIS = AXIAL_ROT+1, AXIAL_ROT_Y_AXIS, AXIAL_ROT_Z_AXIS, POINT_ROT_WORLD_Z_AXIS,
  CACHE_DIRTY
}

Protected Member Functions

virtual ~Billboard ()
void updateCache ()
- Protected Member Functions inherited from osg::Geode
virtual ~Geode ()
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 Node destructor.
void addParent (osg::Group *node)
void removeParent (osg::Group *node)
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

Mode _mode
Vec3 _axis
Vec3 _normal
Matrix _rotateNormalToZAxis
PositionList _positionList
int _cachedMode
Vec3 _side
- Protected Attributes inherited from osg::Geode
osg::BoundingBox _bbox
DrawableList _drawables
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
ref_ptr
< ComputeBoundingSphereCallback
_computeBoundCallback
BoundingSphere _boundingSphere
bool _boundingSphereComputed
ParentList _parents
ref_ptr< NodeCallback_updateCallback
unsigned int _numChildrenRequiringUpdateTraversal
ref_ptr< NodeCallback_eventCallback
unsigned int _numChildrenRequiringEventTraversal
ref_ptr< NodeCallback_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

Detailed Description

Billboard is a derived form of Geode that orients its osg::Drawable children to face the eye point.

Typical uses include trees and particle explosions,


Member Typedef Documentation

typedef std::vector<Vec3> osg::Billboard::PositionList

Type definition for pivot point position list.


Member Enumeration Documentation

Enumerator:
AXIAL_ROT_X_AXIS 
AXIAL_ROT_Y_AXIS 
AXIAL_ROT_Z_AXIS 
POINT_ROT_WORLD_Z_AXIS 
CACHE_DIRTY 
Enumerator:
POINT_ROT_EYE 
POINT_ROT_WORLD 
AXIAL_ROT 

Constructor & Destructor Documentation

osg::Billboard::Billboard ( )
osg::Billboard::Billboard ( const Billboard ,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Billboard::~Billboard ( )
protectedvirtual

Member Function Documentation

virtual bool osg::Billboard::addDrawable ( Drawable gset)
virtual

Add a Drawable with a default position of Vec3(0,0,0).

Call the base-class Geode::addDrawble() to add the given Drawable gset as a child. If Geode::addDrawable() returns true, add the default position to the pivot point position list and return true. Otherwise, return false.

Reimplemented from osg::Geode.

virtual bool osg::Billboard::addDrawable ( Drawable gset,
const Vec3 pos 
)
virtual

Add a Drawable with a specified position.

Call the base-class Geode::addDrawble() to add the given Drawable gset as a child. If Geode::addDrawable() returns true, add the given position pos to the pivot point position list and return true. Otherwise, return false.

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

Compute the bounding sphere around Node's geometry or children.

This method is automatically called by getBound() when the bounding sphere has been marked dirty via dirtyBound().

Reimplemented from osg::Geode.

bool osg::Billboard::computeMatrix ( Matrix modelview,
const Vec3 eye_local,
const Vec3 pos_local 
) const
const Vec3& osg::Billboard::getAxis ( ) const
inline

Get the rotation axis.

Mode osg::Billboard::getMode ( ) const
inline

Get the billboard rotation mode.

const Vec3& osg::Billboard::getNormal ( ) const
inline

Get the front face direction normal.

const Vec3& osg::Billboard::getPosition ( unsigned int  i) const
inline

Get the specified child Drawable's position.

PositionList& osg::Billboard::getPositionList ( )
inline

Get the list of pivot point positions.

const PositionList& osg::Billboard::getPositionList ( ) const
inline

Get a const list of pivot point positions.

osg::Billboard::META_Node ( osg  ,
Billboard   
)
virtual bool osg::Billboard::removeDrawable ( Drawable gset)
virtual

Remove a Drawable and its associated position.

If gset is a child, remove it, decrement its reference count, remove its pivot point position. and return true. Otherwise, return false.

Reimplemented from osg::Geode.

void osg::Billboard::setAxis ( const Vec3 axis)

Set the rotation axis for the billboard's child Drawables.

Only utilized when mode==AXIAL_ROT.

void osg::Billboard::setMode ( Mode  mode)

Set the billboard rotation mode.

void osg::Billboard::setNormal ( const Vec3 normal)

This normal defines child Drawables' front face direction when unrotated.

void osg::Billboard::setPosition ( unsigned int  i,
const Vec3 pos 
)
inline

Set the specified child Drawable's position.

void osg::Billboard::setPositionList ( PositionList pl)
inline

Set the list of pivot point positions.

void osg::Billboard::updateCache ( )
protected

Member Data Documentation

Vec3 osg::Billboard::_axis
protected
int osg::Billboard::_cachedMode
protected
Mode osg::Billboard::_mode
protected
Vec3 osg::Billboard::_normal
protected
PositionList osg::Billboard::_positionList
protected
Matrix osg::Billboard::_rotateNormalToZAxis
protected
Vec3 osg::Billboard::_side
protected

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

osg logo
Generated at Mon Oct 8 2012 23:49:49 for the OpenSceneGraph by doxygen 1.8.1.1.