WMHud.h 4.17 KB
Newer Older
schurade's avatar
schurade committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------

#ifndef WMHUD_H
#define WMHUD_H

#include <string>

#include <osg/Group>
#include <osg/Geode>
#include <osg/Geometry>
#include <osg/Node>

#include "../../kernel/WModule.h"
36
#include "../../graphicsEngine/WGEGroupNode.h"
schurade's avatar
schurade committed
37 38 39

/**
 * This module implements several onscreen status displays
40
 * \ingroup modules
schurade's avatar
schurade committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
 */
class WMHud : public WModule, public osg::Referenced
{
public:
    /**
     * standard constructor
     */
    WMHud();

    /**
     * destructor
     */
    virtual ~WMHud();

    /**
     * \par Description
     * Gives back the name of this module.
     * \return the module's name.
     */
    virtual const std::string getName() const;

    /**
     * \par Description
     * Gives back a description of this module.
     * \return description to module.
     */
    virtual const std::string getDescription() const;

schurade's avatar
schurade committed
69
    /**
70
     * Sets pick text member vairable
schurade's avatar
schurade committed
71
     *
72
     * \param text the pick text
schurade's avatar
schurade committed
73 74 75
     */
    void updatePickText( std::string text );

schurade's avatar
schurade committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
protected:

    /**
     * \par Description
     * Entry point after loading the module. Runs in separate thread.
     */
    virtual void moduleMain();

    /**
     * Initialize the connectors this module is using.
     */
    virtual void connectors();

    /**
     * Initialize the properties for this module.
     */
    virtual void properties();

    /**
     * Due to the prototype design pattern used to build modules, this method returns a new instance of this method. NOTE: it
     * should never be initialized or modified in some other way. A simple new instance is required.
     *
     * \return the prototype used to create every module in OpenWalnut.
     */
    virtual boost::shared_ptr< WModule > factory() const;

private:
103 104 105 106


    boost::shared_mutex m_updateLock; //!< Lock to prevent concurrent threads trying to update the osg node

107 108 109
    /**
     * Projection node for defining view frustrum for HUD
     */
schurade's avatar
schurade committed
110 111
    osg::ref_ptr<osg::Projection> m_rootNode;

112 113 114
    /**
     * Geometry group for all hud related things
     */
115
    osg::ref_ptr< WGEGroupNode > m_HUDs;
schurade's avatar
schurade committed
116

117 118 119
    /**
     * Text instance that will show up in the HUD
     */
120
    osg::ref_ptr< osgText::Text > m_osgPickText;
schurade's avatar
schurade committed
121

122 123 124
    /**
     * string to store the pick result from the picking method
     */
schurade's avatar
schurade committed
125 126
    std::string m_pickText;

127 128 129
    /**
     * init method
     */
schurade's avatar
schurade committed
130 131
    void init();

132 133 134
    /**
     * update method
     */
schurade's avatar
schurade committed
135 136 137
    void update();

    /**
138 139
     * Gets signaled from the properties object when something was changed. Now, only m_active is used. This method therefore simply
     * activates/deactivates the HUD.
schurade's avatar
schurade committed
140
     */
141
    void activate();
schurade's avatar
schurade committed
142

143 144 145
    /**
     * Node callback to handle updates properly
     */
schurade's avatar
schurade committed
146 147 148
    class HUDNodeCallback : public osg::NodeCallback
    {
    public: // NOLINT
149 150 151 152 153 154
        /**
         * operator ()
         *
         * \param node the osg node
         * \param nv the node visitor
         */
schurade's avatar
schurade committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168
        virtual void operator()( osg::Node* node, osg::NodeVisitor* nv )
        {
            osg::ref_ptr< WMHud > module = static_cast< WMHud* > ( node->getUserData() );

            if ( module )
            {
                module->update();
            }
            traverse( node, nv );
        }
    };
};

#endif  // WMHUD_H