class SG_EXPORT osg::Billboard

Billboard - a Geode which orientates its child osg::Drawable's to face the eye point.

Inheritance:

Public Methods

Billboard()

META_Node(Billboard)

inline void setAxis(const Vec3& axis)

Set the axis about which all the billboard's drawable rotate.

inline const Vec3& getAxis() const

Get the axis about which all the billboard's drawable rotate.

inline void setMode(const Mode mode)

Set the billboard rotation mode.

inline const Mode getMode() const

Get the billboard rotation mode.

inline void setPos(int i, const Vec3& pos)

Set the position of specified drawable.

inline const Vec3& getPos(int i) const

Get the position of specified drawable.

inline PositionList& getPositionList()

Get the PostionList from the billboard

inline const PositionList& getPositionList() const

Get a const PostionList from the billboard

virtual const bool addDrawable( Drawable* gset )

Add Drawable to Billboard with default position(0,0,0); If gset not NULL and is not contained in Billboard then increment its reference count, and dirty the bounding box to cause it to recompute on next getBound() and return true for success.

virtual const bool addDrawable(Drawable* gset, const Vec3& pos)

Add Drawable to Geode at position pos.

virtual const bool removeDrawable( Drawable* gset )

Remove Drawable and associated position from Billboard.

void calcRotation(const Vec3& eye_local, const Vec3& pos_local, Matrix& mat) const

void calcTransform(const Vec3& eye_local, const Vec3& pos_local, Matrix& mat) const

Public Members

enum Mode

typedef std::vector<Vec3> PositionList

PositionList represents a list of pivot points for each drawable

Protected Fields

Mode _mode

Vec3 _axis

PositionList _positionList

Protected Methods

virtual ~Billboard()

virtual const bool computeBound() const

Inherited from Geode:

Public Methods

virtual const bool replaceDrawable( Drawable* origDraw, Drawable* newDraw )

inline const int getNumDrawables() const

inline Drawable* getDrawable( const int i )

inline const Drawable* getDrawable( const int i ) const

inline const bool containsDrawable(const Drawable* gset) const

inline DrawableList::iterator findDrawable(const Drawable* gset)

inline DrawableList::const_iterator findDrawable(const Drawable* gset) const

void compileDrawables(State& state)

Protected Fields

DrawableList _drawables

Inherited from Node:

Public Methods

virtual Object* clone() const

virtual bool isSameKindAs(const Object* obj) const

virtual const char* className() const

virtual void accept(NodeVisitor& nv)

virtual void ascend(NodeVisitor& nv)

virtual void traverse(NodeVisitor& )

inline void setName( const std::string& name )

inline void setName( const char* name )

inline const std::string& getName() const

inline const ParentList& getParents() const

inline Group* getParent(const int i)

inline const Group* getParent(const int i) const

inline const int getNumParents() const

void setAppCallback(NodeCallback* nc)

inline NodeCallback* getAppCallback()

inline const NodeCallback* getAppCallback() const

inline const int getNumChildrenRequiringAppTraversal() const

inline void setUserData(void* data, MemoryAdapter* ma=0L)

inline void* getUserData()

inline const void* getUserData() const

inline MemoryAdapter* getMemoryAdapter()

inline const MemoryAdapter* getMemoryAdapter() const

inline void setNodeMask(const NodeMask nm)

inline const NodeMask getNodeMask() const

inline const DescriptionList& getDescriptions() const

inline DescriptionList& getDescriptions()

inline const std::string& getDescription(const int i) const

inline std::string& getDescription(const int i)

inline const int getNumDescriptions() const

void addDescription(const std::string& desc)

inline void setStateSet(osg::StateSet* dstate)

inline osg::StateSet* getStateSet()

inline const osg::StateSet* getStateSet() const

inline const BoundingSphere& getBound() const

void dirtyBound()

Public Members

typedef std::vector<Group*> ParentList

typedef std::vector<std::string> DescriptionList

Protected Fields

mutable BoundingSphere _bsphere

mutable bool _bsphere_computed

std::string _name

ParentList _parents

ref_ptr<NodeCallback> _appCallback

int _numChildrenRequiringAppTraversal

void* _userData

ref_ptr<MemoryAdapter> _memoryAdapter

NodeMask _nodeMask

DescriptionList _descriptions

ref_ptr<StateSet> _dstate

Protected Methods

void setNumChildrenRequiringAppTraversal(const int num)

Inherited from Object:

Inherited from Referenced:

Public Methods

inline Referenced& operator = (Referenced&)

inline void ref() const

inline void unref() const

inline const int referenceCount() const

Protected Fields

mutable int _refCount

Documentation

Billboard - a Geode which orientates its child osg::Drawable's to face the eye point. Typical uses are for trees, or particle explosions.

enum Mode

AXIAL_ROT

POINT_ROT_EYE

POINT_ROT_WORLD

Billboard()

META_Node(Billboard)

inline void setAxis(const Vec3& axis)

Set the axis about which all the billboard's drawable rotate.

inline const Vec3& getAxis() const

Get the axis about which all the billboard's drawable rotate.

inline void setMode(const Mode mode)

Set the billboard rotation mode.

inline const Mode getMode() const

Get the billboard rotation mode.

inline void setPos(int i, const Vec3& pos)

Set the position of specified drawable.

inline const Vec3& getPos(int i) const

Get the position of specified drawable.

typedef std::vector<Vec3> PositionList

PositionList represents a list of pivot points for each drawable

inline PositionList& getPositionList()

Get the PostionList from the billboard

inline const PositionList& getPositionList() const

Get a const PostionList from the billboard

virtual const bool addDrawable( Drawable* gset )

Add Drawable to Billboard with default position(0,0,0); If gset not NULL and is not contained in Billboard then increment its reference count, and dirty the bounding box to cause it to recompute on next getBound() and return true for success. Otherwise return false.

virtual const bool addDrawable(Drawable* gset, const Vec3& pos)

Add Drawable to Geode at position pos. If gset not NULL and is not contained in Billboard then increment its reference count, and dirty the bounding box to cause it to recompute on next getBound() and return true for success. Otherwise return false.

virtual const bool removeDrawable( Drawable* gset )

Remove Drawable and associated position from Billboard. If gset is contained in Billboard then remove it from the geoset list and decrement its reference count, and dirty the bounding box to cause it to recompute on next getBound() and return true for success. If gset is not found then return false and do not the reference count of gset is left unchanged.

void calcRotation(const Vec3& eye_local, const Vec3& pos_local, Matrix& mat) const

void calcTransform(const Vec3& eye_local, const Vec3& pos_local, Matrix& mat) const

virtual ~Billboard()

virtual const bool computeBound() const

Mode _mode

Vec3 _axis

PositionList _positionList

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java