ScalarBar

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 OSGSIM_SCALARBAR
#define OSGSIM_SCALARBAR 1
 
#include <osgSim/Export>
#include <osgSim/ColorRange>    // The default ScalarsToColors is a ColorRange
#include <osg/Geode>
#include <string>
 
namespace osgSim
{
class OSGSIM_EXPORT ScalarBar: public osg::Geode
{
 
public:

    enum Orientation{
        HORIZONTAL, 
        VERTICAL    
    };

    struct OSGSIM_EXPORT ScalarPrinter: public osg::Referenced
    {
        virtual std::string printScalar(float scalar);
    };

    struct TextProperties
    {
        std::string         _fontFile;
        std::pair<int,int>  _fontResolution;
        float               _characterSize;
        osg::Vec4           _color;
 
        TextProperties():
            _fontFile("fonts/arial.ttf"),
            _fontResolution(40,40),
            _characterSize(0.0f),
            _color(1.0f,1.0f,1.0f,1.0f)
        {
        }
    };

    ScalarBar(): osg::Geode(),
        _numColors(256),
        _numLabels(11),
        _stc(new ColorRange(0.0f,1.0f)),
        _title("Scalar Bar"),
        _position(0.0f,0.0f,0.0f),
        _width(1.0f),
        _aspectRatio(0.03),
        _orientation(HORIZONTAL),
        _sp(new ScalarPrinter)
    {
        createDrawables();
    }

    ScalarBar(int numColors, int numLabels, ScalarsToColors* stc,
                const std::string& title,
                Orientation orientation = HORIZONTAL,
                float aspectRatio=0.25,
                ScalarPrinter* sp=new ScalarPrinter):
        osg::Geode(),
        _numColors(numColors),
        _numLabels(numLabels),
        _stc(stc),
        _title(title),
        _position(0.0f,0.0f,0.0f),
        _width(1.0f),
        _aspectRatio(aspectRatio),
        _orientation(orientation),
        _sp(sp)
    {
        createDrawables();
    }

    ScalarBar(const ScalarBar& rhs, const osg::CopyOp& co): osg::Geode(rhs,co),
        _numColors(rhs._numColors),
        _numLabels(rhs._numLabels),
        _stc(rhs._stc),                     // Consider clone for deep copy?
        _title(rhs._title),
        _position(rhs._position),
        _width(rhs._width),
        _aspectRatio(rhs._aspectRatio),
        _orientation(rhs._orientation),
        _sp(rhs._sp),                        // Consider clone for deep copy?
        _textProperties(rhs._textProperties)
    {
    }
 
 
    META_Node(osgSim, ScalarBar);

    void setNumColors(int numColors);

    int getNumColors() const;

    void setNumLabels(int numLabels);

    int getNumLabels() const;

    void setScalarsToColors(ScalarsToColors* stc);

    const ScalarsToColors* getScalarsToColors() const;

    void setTitle(const std::string& title);

    const std::string& getTitle() const;
 

    void setPosition(const osg::Vec3& pos);

    const osg::Vec3& getPosition() const { return _position; }

    void setWidth(float width);

    float getWidth() const { return _width; }

    void setAspectRatio(float aspectRatio);

    float getAspectRatio() const;
 

    void setOrientation(ScalarBar::Orientation orientation);

    ScalarBar::Orientation getOrientation() const;
 

    void setScalarPrinter(ScalarPrinter* sp);

    const ScalarPrinter* getScalarPrinter() const;

    void setTextProperties(const TextProperties& tp);

    const TextProperties& getTextProperties() const;

    void update() { createDrawables(); }
 
protected:
    virtual ~ScalarBar();
 
    int _numColors;
    int _numLabels;
    osg::ref_ptr<ScalarsToColors> _stc;
    std::string _title;
    osg::Vec3 _position;
    float _width;
    float _aspectRatio;
    Orientation _orientation;
    osg::ref_ptr<ScalarPrinter> _sp;
    TextProperties  _textProperties;
 
    void createDrawables();
 
};
 
}
 
#endif