Billboard.h

Go to the documentation of this file.

/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
 *
 * This library is open source and may be redistributed and/or modified under
 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
 * (at your option) any later version.  The full license is in LICENSE file
 * included with this distribution, and on the openscenegraph.org website.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * OpenSceneGraph Public License for more details.
*/

#ifndef OSG_BILLBOARD
#define OSG_BILLBOARD 1

#include <osg/Matrix>
#include <osg/Geode>

namespace osg {

class OSG_EXPORT Billboard : public Geode
{
    public:

        enum Mode {
            POINT_ROT_EYE,
            POINT_ROT_WORLD,
            AXIAL_ROT
        };

        Billboard();

        Billboard(const Billboard&,const CopyOp& copyop=CopyOp::SHALLOW_COPY);

        META_Node(osg, Billboard);

        void setMode(Mode mode);
        inline Mode getMode() const { return _mode; }

        void setAxis(const Vec3& axis);
        inline const Vec3& getAxis() const { return _axis; }

        void setNormal(const Vec3& normal);
        inline const Vec3& getNormal() const { return _normal; }


        inline void setPosition(unsigned int i,const Vec3& pos)      { _positionList[i] = pos; }
        inline const Vec3& getPosition(unsigned int i) const         { return _positionList[i]; }

        typedef std::vector<Vec3> PositionList;

        inline void setPositionList(PositionList& pl)       { _positionList=pl; }

        inline PositionList& getPositionList()              { return _positionList; }

        inline const PositionList& getPositionList() const  { return _positionList; }

        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;

    protected:

        virtual ~Billboard();

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


        Mode                                _mode;
        Vec3                                _axis;
        Vec3                                _normal;
        Matrix                              _rotateNormalToZAxis;
        PositionList                        _positionList;

        // used internally as cache of which what _axis is aligned to help
        // decide which method of rotation to use.
        int                                 _cachedMode;
        Vec3                                _side;
        void updateCache();

};

}

#endif