Inheritance diagram for osgSim::ScalarBar:
Public Types | |
HORIZONTAL | |
a horizontally ascending scalar bar (x-axis) | |
VERTICAL | |
a vertically ascending scalar bar (y-axis) | |
enum | Orientation { HORIZONTAL, VERTICAL } |
Public Member Functions | |
ScalarBar () | |
ScalarBar (int numColors, int numLabels, ScalarsToColors *stc, const std::string &title, Orientation orientation=HORIZONTAL, float aspectRatio=0.25, ScalarPrinter *sp=new ScalarPrinter) | |
ScalarBar (const ScalarBar &rhs, const osg::CopyOp &co) | |
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) |
std::string | getTitle () const |
void | setPosition (const osg::Vec3 &pos) |
const osg::Vec3 & | getPosition () const |
void | setWidth (float width) |
float | getWidth () |
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 () |
Protected Member Functions | |
virtual | ~ScalarBar () |
void | createDrawables () |
Protected Attributes | |
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 |
Classes | |
struct | ScalarPrinter |
struct | TextProperties |
In summary, the main configurables on the ScalarBar are:
The other configurables should be self-explanatory.
ScalarBar orientation specification.
osgSim::ScalarBar::ScalarBar | ( | ) | [inline] |
Default constructor.
osgSim::ScalarBar::ScalarBar | ( | int | numColors, | |
int | numLabels, | |||
ScalarsToColors * | stc, | |||
const std::string & | title, | |||
Orientation | orientation = HORIZONTAL , |
|||
float | aspectRatio = 0.25 , |
|||
ScalarPrinter * | sp = new ScalarPrinter | |||
) | [inline] |
Construct a ScalarBar with the supplied parameters.
numColors | Specify the number of colors in the scalar bar. Color interpolation occurs where necessary. | |
numLabels | Specify the number of labels in the scalar bar. | |
stc | The ScalarsToColors defining the range of scalars and the colors they map to. | |
title | The title to be used when displaying the ScalarBar. Specify "" for no title. | |
orientation | The orientation of the ScalarBar. |
aspectRatio | The aspect ration (y/x) for the displayed bar. Bear in mind you may want to change this if you change the orientation. | |
sp | A ScalarPrinter object for the ScalarBar. For every displayed ScalarBar label, the scalar value will be passed to the ScalarPrinter object to turn it into a string. Users may override the default ScalarPrinter object to map scalars to whatever strings they wish. |
osgSim::ScalarBar::ScalarBar | ( | const ScalarBar & | rhs, | |
const osg::CopyOp & | co | |||
) | [inline] |
Copy constructor
virtual osgSim::ScalarBar::~ScalarBar | ( | ) | [protected, virtual] |
void osgSim::ScalarBar::createDrawables | ( | ) | [protected] |
float osgSim::ScalarBar::getAspectRatio | ( | ) | const |
Get the aspect ration (y/x) for the displayed bar.
int osgSim::ScalarBar::getNumColors | ( | ) | const |
Get the number of distinct colours on the ScalarBar.
int osgSim::ScalarBar::getNumLabels | ( | ) | const |
Get the number of labels displayed along the ScalarBar.
ScalarBar::Orientation osgSim::ScalarBar::getOrientation | ( | ) | const |
Get the orientation of the ScalarBar.
const osg::Vec3& osgSim::ScalarBar::getPosition | ( | ) | const [inline] |
Get the position of scalar bar.
const ScalarPrinter* osgSim::ScalarBar::getScalarPrinter | ( | ) | const |
Get the ScalarPrinter object
const ScalarsToColors* osgSim::ScalarBar::getScalarsToColors | ( | ) | const |
Get the ScalarsToColors mapping object from the ScalarBar.
const TextProperties& osgSim::ScalarBar::getTextProperties | ( | ) | const |
Get the TextProperties for the labels & title.
std::string osgSim::ScalarBar::getTitle | ( | ) | const |
Get the title for the ScalarBar.
float osgSim::ScalarBar::getWidth | ( | ) | [inline] |
Get the width of the scalar bar.
osgSim::ScalarBar::META_Node | ( | osgSim | , | |
ScalarBar | ||||
) |
void osgSim::ScalarBar::setAspectRatio | ( | float | aspectRatio | ) |
Set the aspect ration (y/x) for the displayed bar. Bear in mind you may want to change this if you change the orientation.
void osgSim::ScalarBar::setNumColors | ( | int | numColors | ) |
Set the number of distinct colours on the ScalarBar.
void osgSim::ScalarBar::setNumLabels | ( | int | numLabels | ) |
Set the number of labels to display along the ScalarBar. There will be one label at each end point, and evenly distributed labels in between.
void osgSim::ScalarBar::setOrientation | ( | ScalarBar::Orientation | orientation | ) |
Set the orientation of the ScalarBar.
void osgSim::ScalarBar::setPosition | ( | const osg::Vec3 & | pos | ) |
Set the position of scalar bar's lower left corner.
void osgSim::ScalarBar::setScalarPrinter | ( | ScalarPrinter * | sp | ) |
Set a ScalarPrinter object for the ScalarBar. For every displayed ScalarBar label, the scalar value will be passed to the ScalarPrinter object to turn it into a string. Users may override the default ScalarPrinter object to map scalars to whatever strings they wish.
void osgSim::ScalarBar::setScalarsToColors | ( | ScalarsToColors * | stc | ) |
Set the ScalarsToColors mapping object for the ScalarBar.
void osgSim::ScalarBar::setTextProperties | ( | const TextProperties & | tp | ) |
Set the TextProperties for the labels & title.
void osgSim::ScalarBar::setTitle | ( | const std::string & | title | ) |
Set the title for the ScalarBar, set "" for no title.
void osgSim::ScalarBar::setWidth | ( | float | width | ) |
Set the width of the scalar bar.
void osgSim::ScalarBar::update | ( | ) | [inline] |
force update the drawables used to render the scalar bar.
float osgSim::ScalarBar::_aspectRatio [protected] |
int osgSim::ScalarBar::_numColors [protected] |
int osgSim::ScalarBar::_numLabels [protected] |
Orientation osgSim::ScalarBar::_orientation [protected] |
osg::Vec3 osgSim::ScalarBar::_position [protected] |
osg::ref_ptr<ScalarPrinter> osgSim::ScalarBar::_sp [protected] |
osg::ref_ptr<ScalarsToColors> osgSim::ScalarBar::_stc [protected] |
TextProperties osgSim::ScalarBar::_textProperties [protected] |
std::string osgSim::ScalarBar::_title [protected] |
float osgSim::ScalarBar::_width [protected] |