openscenegraph
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::Billboard Class Reference
Inheritance diagram for osg::Billboard:
osg::Geode osg::Node osg::Object osg::Referenced

Public Types

enum  Mode { POINT_ROT_EYE, POINT_ROT_WORLD, AXIAL_ROT }
typedef std::vector< Vec3PositionList
- Public Types inherited from osg::Geode
typedef std::vector< ref_ptr
< Drawable > > 
DrawableList
- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
typedef unsigned int NodeMask
typedef std::vector< std::string > DescriptionList
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions

 Billboard ()
 Billboard (const Billboard &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Billboard)
void setMode (Mode mode)
Mode getMode () const
void setAxis (const Vec3 &axis)
const Vec3getAxis () const
void setNormal (const Vec3 &normal)
const Vec3getNormal () const
void setPosition (unsigned int i, const Vec3 &pos)
const Vec3getPosition (unsigned int i) const
void setPositionList (PositionList &pl)
PositionListgetPositionList ()
const PositionListgetPositionList () const
virtual bool addDrawable (Drawable *gset)
virtual bool addDrawable (Drawable *gset, const Vec3 &pos)
virtual bool removeDrawable (Drawable *gset)
bool computeMatrix (Matrix &modelview, const Vec3 &eye_local, const Vec3 &pos_local) const
virtual BoundingSphere computeBound () const
- Public Member Functions inherited from osg::Geode
 Geode ()
 Geode (const Geode &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Geode)
virtual GeodeasGeode ()
virtual const GeodeasGeode () const
virtual bool removeDrawables (unsigned int i, unsigned int numDrawablesToRemove=1)
virtual bool replaceDrawable (Drawable *origDraw, Drawable *newDraw)
virtual bool setDrawable (unsigned int i, Drawable *drawable)
unsigned int getNumDrawables () const
DrawablegetDrawable (unsigned int i)
const DrawablegetDrawable (unsigned int i) const
bool containsDrawable (const Drawable *gset) const
unsigned int getDrawableIndex (const Drawable *drawable) const
const DrawableListgetDrawableList () const
void compileDrawables (RenderInfo &renderInfo)
const BoundingBoxgetBoundingBox () const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void resizeGLObjectBuffers (unsigned int maxSize)
virtual void releaseGLObjects (osg::State *=0) const
- Public Member Functions inherited from osg::Node
 Node ()
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const
virtual Objectclone (const CopyOp &copyop) const
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual TransformasTransform ()
virtual const TransformasTransform () const
virtual SwitchasSwitch ()
virtual const SwitchasSwitch () const
virtual osgTerrain::TerrainasTerrain ()
virtual const osgTerrain::TerrainasTerrain () const
virtual void accept (NodeVisitor &nv)
virtual void ascend (NodeVisitor &nv)
virtual void traverse (NodeVisitor &)
const ParentListgetParents () const
ParentList getParents ()
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
unsigned int getNumParents () const
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void setUpdateCallback (NodeCallback *nc)
NodeCallbackgetUpdateCallback ()
const NodeCallbackgetUpdateCallback () const
void addUpdateCallback (NodeCallback *nc)
void removeUpdateCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setEventCallback (NodeCallback *nc)
NodeCallbackgetEventCallback ()
const NodeCallbackgetEventCallback () const
void addEventCallback (NodeCallback *nc)
void removeEventCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringEventTraversal () const
void setCullCallback (NodeCallback *nc)
NodeCallbackgetCullCallback ()
const NodeCallbackgetCullCallback () const
void addCullCallback (NodeCallback *nc)
void removeCullCallback (NodeCallback *nc)
void setCullingActive (bool active)
bool getCullingActive () const
unsigned int getNumChildrenWithCullingDisabled () const
bool isCullingActive () const
unsigned int getNumChildrenWithOccluderNodes () const
bool containsOccluderNodes () const
void setNodeMask (NodeMask nm)
NodeMask getNodeMask () const
void setStateSet (osg::StateSet *stateset)
osg::StateSetgetOrCreateStateSet ()
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
void setDescriptions (const DescriptionList &descriptions)
DescriptionListgetDescriptions ()
const DescriptionListgetDescriptions () const
const std::string & getDescription (unsigned int i) const
std::string & getDescription (unsigned int i)
unsigned int getNumDescriptions () const
void addDescription (const std::string &desc)
void setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSpheregetInitialBound () const
void dirtyBound ()
const BoundingSpheregetBound () const
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T >
bool getUserValue (const std::string &name, T &value) const
template<typename T >
void setUserValue (const std::string &name, const T &value)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

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

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()

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: