osgSim::ScalarBar Class Reference
List of all members.
Detailed Description
A ScalarBar is an osg::Geode to render a colored bar representing a range of scalars. The scalar/color ranges are specified by an instance of ScalarsToColors. There are a number of configurable properties on the ScalarBar, such as the orientation, the number of labels to be displayed across the range, the number of distinct colors to use when rendering the bar, text details etc.
In summary, the main configurables on the ScalarBar are:
- The range of scalars represented by the bar, and the colors corresponding to this range - these are specified by the ScalarsToColors object.
- The number of colors used when rendering the bar geometry - this may be thought of as the bar 'density'.
- The number of text labels to be used when displaying the bar.
The other configurables should be self-explanatory.
Member Enumeration Documentation
ScalarBar orientation specification.
- Enumerator:
HORIZONTAL |
a horizontally ascending scalar bar (x-axis)
|
VERTICAL |
a vertically ascending scalar bar (y-axis)
|
Constructor & Destructor Documentation
osgSim::ScalarBar::ScalarBar |
( |
|
) |
[inline] |
Construct a ScalarBar with the supplied parameters.
- 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. |
- See also:
- Orientation.
- Parameters:
-
| 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. |
- See also:
- ScalarPrinter
virtual osgSim::ScalarBar::~ScalarBar |
( |
|
) |
[protected, virtual] |
Member Function Documentation
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.
const osg::Vec3& osgSim::ScalarBar::getPosition |
( |
|
) |
const [inline] |
Get the position of scalar bar.
const ScalarPrinter* osgSim::ScalarBar::getScalarPrinter |
( |
|
) |
const |
std::string osgSim::ScalarBar::getTitle |
( |
|
) |
const |
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::setPosition |
( |
const osg::Vec3 & |
pos |
) |
|
Set the position of scalar bar's lower left corner.
void osgSim::ScalarBar::setTextProperties |
( |
const TextProperties & |
tp |
) |
|
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.
Member Data Documentation
The documentation for this class was generated from the following file: