osgSim::ScalarBar Class Reference

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

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

enum osgSim::ScalarBar::Orientation

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]

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.

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

osgSim::ScalarBar::ScalarBar	(	const ScalarBar &	rhs,
		const osg::CopyOp &	co
	)			`[inline]`

Copy constructor

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.

ScalarBar::Orientation osgSim::ScalarBar::getOrientation ( ) const

Get the orientation of the ScalarBar.

See also:: Orientation

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.

See also:: TextProperties

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.

See also:: Orientation

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.