Hud.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------------
//
// Pro-Vocation Light Engine (PVLE)
// Copyright (C) 2007-2009  Sukender, KinoX & Buzib
// For more information, contact us : sukender@free.fr
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// For any use that is not compatible with the terms of the GNU 
// General Public License, please contact the authors for alternative
// licensing options.
//
// This program 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
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
//-----------------------------------------------------------------------------------

#ifndef ENT_HUD_H
#define ENT_HUD_H

#include <osg/NodeCallback>
#include <osg/Projection>
#include <PVLE/Util/Util.h>
#include <PVLE/3D/Commons.h>

class Hud : public virtual osg::Group {
public:
    Hud(UINT left, UINT right, UINT bottom, UINT top) : left(left), right(right), bottom(bottom), top(top) {
        // Set the update callback
        osg::Group::setUpdateCallback(new HudCB(this));

        // ----- 2D -----
        // Create 2D projection and transform matrix
        std::pair<osg::Projection*, osg::MatrixTransform*> p = create2DProjection(osg::Matrix::ortho2D(left, right, bottom, top));
        pProjection = p.first;
        pRoot2D = p.second;
        addChild(pProjection);
        // Set no ligthing and Z test disabled
        setHudStatset(pProjection->getOrCreateStateSet());

        // ----- 3D -----
        // TODO ! How to render 3D objects in a 2D frame ?
        //pRoot3D = new osg::Group;
        //addChild(pRoot3D);

        //onProjectionChanged(left, right, bottom, top);
    }

    virtual void onProjectionChanged(UINT left, UINT right, UINT bottom, UINT top) {
        set2DProjection(left, right, bottom, top);
    }

    virtual void updateCB(osg::Node *node, osg::NodeVisitor *nv)=0;


    inline float fromLeft  (float x) const { return left+x; }
    inline float fromRight (float x) const { return right-x; }
    inline float fromBottom(float y) const { return bottom+y; }
    inline float fromTop   (float y) const { return top-y; }

    inline osg::Vec3 fromCornerLT(float x, float y) const { return osg::Vec3(fromLeft(x),  fromTop(y)   , 0); }
    inline osg::Vec3 fromCornerLB(float x, float y) const { return osg::Vec3(fromLeft(x),  fromBottom(y), 0); }
    inline osg::Vec3 fromCornerRT(float x, float y) const { return osg::Vec3(fromRight(x), fromTop(y)   , 0); }
    inline osg::Vec3 fromCornerRB(float x, float y) const { return osg::Vec3(fromRight(x), fromBottom(y), 0); }

    inline float relativeFromLeft  (float percent) const { return fromLeft  (widthRelative (percent)); }
    inline float relativeFromRight (float percent) const { return fromRight (widthRelative (percent)); }
    inline float relativeFromBottom(float percent) const { return fromBottom(heightRelative(percent)); }
    inline float relativeFromTop   (float percent) const { return fromTop   (heightRelative(percent)); }

    inline float widthRelative (float percent) const { return percent*(right-left); }
    inline float heightRelative(float percent) const { return percent*(top-bottom); }


protected:
    osg::Projection * pProjection;      
    osg::MatrixTransform * pRoot2D;     
    //osg::Group * pRoot3D;     ///< Node under which 3D elements of the HUD are added.

    // Dev note (Sukender) : I tried to derivate Hud from Group AND NodeCallback, but of course, setting the callback to "this" with ref_ptr's results in an error when deallocating.
    class HudCB : public osg::NodeCallback {
    public:
        HudCB(Hud * pHud) : pHud(pHud) {}
        virtual void operator()(osg::Node *node, osg::NodeVisitor *nv) { pHud->updateCB(node, nv); traverse(node, nv); }
    protected:
        Hud * pHud;
    };

    void set2DProjection(UINT left, UINT right, UINT bottom, UINT top) {
        this->left=left;  this->right=right;  this->bottom=bottom;  this->top=top;
        pProjection->setMatrix(osg::Matrix::ortho2D(left, right, bottom, top));
    }

private:
    UINT left, right, bottom, top;      
};


#endif  // ENT_HUD_H

---