#include <ScalarBar.h>

Inheritance diagram for osgSim::ScalarBar:

Collaboration diagram for osgSim::ScalarBar:

Classes
struct	ScalarPrinter

struct	TextProperties

Public Types
enum	Orientation { HORIZONTAL, VERTICAL }

Public Types inherited from osg::Node
typedef std::vector< Group * >	ParentList

typedef unsigned int	NodeMask

typedef std::vector< std::string >	DescriptionList

Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

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)

const std::string &	getTitle () const

void	setPosition (const osg::Vec3 &pos)

const osg::Vec3 &	getPosition () const

void	setWidth (float width)

float	getWidth () const

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 ()

Public Member Functions inherited from osg::Geode
	Geode ()

	Geode (const Geode &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

	META_Node (osg, Geode)

virtual Geode *	asGeode ()

virtual const Geode *	asGeode () const

virtual bool	addDrawable (Drawable *drawable)

virtual bool	removeDrawable (Drawable *drawable)

virtual bool	removeDrawables (unsigned int i, unsigned int numDrawablesToRemove=1)

virtual bool	replaceDrawable (Drawable origDraw, Drawable newDraw)

virtual bool	setDrawable (unsigned int i, Drawable *drawable)

unsigned int	getNumDrawables () const

Drawable *	getDrawable (unsigned int i)

const Drawable *	getDrawable (unsigned int i) const

bool	containsDrawable (const Drawable *drawable) const

unsigned int	getDrawableIndex (const Drawable *drawable) const

void	compileDrawables (RenderInfo &renderInfo)

const BoundingBox &	getBoundingBox () const

virtual BoundingSphere	computeBound () const

Public Member Functions inherited from osg::Group
	Group ()

	Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

	META_Node (osg, Group)

virtual Group *	asGroup ()

virtual const Group *	asGroup () const

virtual void	traverse (NodeVisitor &nv)

virtual bool	addChild (Node *child)

virtual bool	insertChild (unsigned int index, Node *child)

virtual bool	removeChild (Node *child)

bool	removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)

virtual bool	removeChildren (unsigned int pos, unsigned int numChildrenToRemove)

virtual bool	replaceChild (Node origChild, Node newChild)

virtual unsigned int	getNumChildren () const

virtual bool	setChild (unsigned int i, Node *node)

Node *	getChild (unsigned int i)

const Node *	getChild (unsigned int i) const

bool	containsNode (const Node *node) const

unsigned int	getChildIndex (const Node *node) const

virtual void	setThreadSafeRefUnref (bool threadSafe)

virtual void	resizeGLObjectBuffers (unsigned int maxSize)

virtual void	releaseGLObjects (osg::State *=0) const

Public Member Functions inherited from osg::Node
	Node ()

	Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

virtual Object *	cloneType () const

virtual Object *	clone (const CopyOp &copyop) const

virtual bool	isSameKindAs (const Object *obj) const

virtual const char *	libraryName () const

virtual const char *	className () const

virtual Node *	asNode ()

virtual const Node *	asNode () const

virtual Drawable *	asDrawable ()

virtual const Drawable *	asDrawable () const

virtual Geometry *	asGeometry ()

virtual const Geometry *	asGeometry () const

virtual Transform *	asTransform ()

virtual const Transform *	asTransform () const

virtual Camera *	asCamera ()

virtual const Camera *	asCamera () const

virtual Switch *	asSwitch ()

virtual const Switch *	asSwitch () const

virtual osgTerrain::Terrain *	asTerrain ()

virtual const osgTerrain::Terrain *	asTerrain () const

virtual void	accept (NodeVisitor &nv)

virtual void	ascend (NodeVisitor &nv)

const ParentList &	getParents () const

ParentList	getParents ()

Group *	getParent (unsigned int i)

const Group *	getParent (unsigned int i) const

unsigned int	getNumParents () const

NodePathList	getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const

MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const

void	setUpdateCallback (Callback *nc)

Callback *	getUpdateCallback ()

const Callback *	getUpdateCallback () const

void	addUpdateCallback (Callback *nc)

void	removeUpdateCallback (Callback *nc)

unsigned int	getNumChildrenRequiringUpdateTraversal () const

void	setEventCallback (Callback *nc)

Callback *	getEventCallback ()

const Callback *	getEventCallback () const

void	addEventCallback (Callback *nc)

void	removeEventCallback (Callback *nc)

unsigned int	getNumChildrenRequiringEventTraversal () const

void	setCullCallback (Callback *nc)

Callback *	getCullCallback ()

const Callback *	getCullCallback () const

void	addCullCallback (Callback *nc)

void	removeCullCallback (Callback *nc)

void	setCullingActive (bool active)

bool	getCullingActive () const

unsigned int	getNumChildrenWithCullingDisabled () const

bool	isCullingActive () const

unsigned int	getNumChildrenWithOccluderNodes () const

bool	containsOccluderNodes () const

void	setNodeMask (NodeMask nm)

NodeMask	getNodeMask () const

void	setStateSet (osg::StateSet *stateset)

osg::StateSet *	getOrCreateStateSet ()

osg::StateSet *	getStateSet ()

const osg::StateSet *	getStateSet () const

void	setDescriptions (const DescriptionList &descriptions)

DescriptionList &	getDescriptions ()

const DescriptionList &	getDescriptions () const

const std::string &	getDescription (unsigned int i) const

std::string &	getDescription (unsigned int i)

unsigned int	getNumDescriptions () const

void	addDescription (const std::string &desc)

void	setInitialBound (const osg::BoundingSphere &bsphere)

const BoundingSphere &	getInitialBound () const

void	dirtyBound ()

const BoundingSphere &	getBound () const

void	setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)

ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback ()

const ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback () const

Public Member Functions inherited from osg::Object
	Object ()

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

std::string	getCompoundClassName () const

virtual NodeVisitor *	asNodeVisitor ()

virtual const NodeVisitor *	asNodeVisitor () const

virtual StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () const

virtual void	setName (const std::string &name)

void	setName (const char *name)

const std::string &	getName () const

void	setDataVariance (DataVariance dv)

DataVariance	getDataVariance () const

virtual void	computeDataVariance ()

void	setUserDataContainer (osg::UserDataContainer *udc)

osg::UserDataContainer *	getUserDataContainer ()

const osg::UserDataContainer *	getUserDataContainer () const

osg::UserDataContainer *	getOrCreateUserDataContainer ()

virtual void	setUserData (Referenced *obj)

virtual Referenced *	getUserData ()

virtual const Referenced *	getUserData () const

template<typename T >
bool	getUserValue (const std::string &name, T &value) const

template<typename T >
void	setUserValue (const std::string &name, const T &value)

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const

Public Member Functions inherited from osg::Referenced
	Referenced ()

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const

OpenThreads::Mutex *	getRefMutex () const

int	ref () const

int	unref () const

int	unref_nodelete () const

int	referenceCount () const

ObserverSet *	getObserverSet () const

ObserverSet *	getOrCreateObserverSet () const

void	addObserver (Observer *observer) const

void	removeObserver (Observer *observer) const

Protected Member Functions
virtual	~ScalarBar ()

void	createDrawables ()

Protected Member Functions inherited from osg::Geode
virtual	~Geode ()

Protected Member Functions inherited from osg::Group
virtual	~Group ()

virtual void	childRemoved (unsigned int, unsigned int)

virtual void	childInserted (unsigned int)

Protected Member Functions inherited from osg::Node
virtual	~Node ()

void	addParent (osg::Group *parent)

void	removeParent (osg::Group *parent)

void	setNumChildrenRequiringUpdateTraversal (unsigned int num)

void	setNumChildrenRequiringEventTraversal (unsigned int num)

void	setNumChildrenWithCullingDisabled (unsigned int num)

void	setNumChildrenWithOccluderNodes (unsigned int num)

Protected Member Functions inherited from osg::Object
virtual	~Object ()

Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()

void	signalObserversAndDelete (bool signalDelete, bool doDelete) const

void	deleteUsingDeleteHandler () const

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

Protected Attributes inherited from osg::Geode
osg::BoundingBox	_bbox

Protected Attributes inherited from osg::Group
NodeList	_children

Protected Attributes inherited from osg::Node
BoundingSphere	_initialBound

ref_ptr < ComputeBoundingSphereCallback >	_computeBoundCallback

BoundingSphere	_boundingSphere

bool	_boundingSphereComputed

ParentList	_parents

ref_ptr< Callback >	_updateCallback

unsigned int	_numChildrenRequiringUpdateTraversal

ref_ptr< Callback >	_eventCallback

unsigned int	_numChildrenRequiringEventTraversal

ref_ptr< Callback >	_cullCallback

bool	_cullingActive

unsigned int	_numChildrenWithCullingDisabled

unsigned int	_numChildrenWithOccluderNodes

NodeMask	_nodeMask

ref_ptr< StateSet >	_stateset

Protected Attributes inherited from osg::Object
std::string	_name

DataVariance	_dataVariance

osg::UserDataContainer *	_userDataContainer

Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet

OpenThreads::Atomic	_refCount

Additional Inherited Members
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)

static bool	getThreadSafeReferenceCounting ()

static void	setDeleteHandler (DeleteHandler *handler)

static DeleteHandler *	getDeleteHandler ()

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.

Definition at line 43 of file ScalarBar.h.

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)

Definition at line 49 of file ScalarBar.h.

Constructor & Destructor Documentation

osgSim::ScalarBar::ScalarBar ( )

inline

Default constructor.

Definition at line 87 of file ScalarBar.h.

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

Definition at line 119 of file ScalarBar.h.

osgSim::ScalarBar::ScalarBar	(	const ScalarBar &	rhs,
		const osg::CopyOp &	co
	)

inline

Copy constructor

Definition at line 139 of file ScalarBar.h.

virtual osgSim::ScalarBar::~ScalarBar ( )

protectedvirtual

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.

Definition at line 187 of file ScalarBar.h.

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

const std::string& osgSim::ScalarBar::getTitle ( ) const

Get the title for the ScalarBar.

float osgSim::ScalarBar::getWidth ( ) const

inline

Get the width of the scalar bar.

Definition at line 193 of file ScalarBar.h.

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.

See also: ScalarPrinter

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.

See also: TextProperties

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.

Definition at line 226 of file ScalarBar.h.

Member Data Documentation

float osgSim::ScalarBar::_aspectRatio

protected

Definition at line 237 of file ScalarBar.h.

int osgSim::ScalarBar::_numColors

protected

Definition at line 231 of file ScalarBar.h.

int osgSim::ScalarBar::_numLabels

protected

Definition at line 232 of file ScalarBar.h.

Orientation osgSim::ScalarBar::_orientation

protected

Definition at line 238 of file ScalarBar.h.

osg::Vec3 osgSim::ScalarBar::_position

protected

Definition at line 235 of file ScalarBar.h.

osg::ref_ptr<ScalarPrinter> osgSim::ScalarBar::_sp

protected

Definition at line 239 of file ScalarBar.h.

osg::ref_ptr<ScalarsToColors> osgSim::ScalarBar::_stc

protected

Definition at line 233 of file ScalarBar.h.

TextProperties osgSim::ScalarBar::_textProperties

protected

Definition at line 240 of file ScalarBar.h.

std::string osgSim::ScalarBar::_title

protected

Definition at line 234 of file ScalarBar.h.

float osgSim::ScalarBar::_width

protected

Definition at line 236 of file ScalarBar.h.

The documentation for this class was generated from the following file:

osg_head/include/osgSim/ScalarBar.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation