A ScalarBar is an osg::Geode to render a colored bar representing a range of scalars. More...

Inheritance diagram for osgSim::ScalarBar:

[legend]

Classes
struct	ScalarPrinter
	Users may provide their own ScalarPrinter by deriving from this base class and overriding the printScalar() method. More...

struct	TextProperties
	TextProperties allows users to specify a number of properties for the text used to display the labels & title on the ScalarBar. More...

Public Types
enum	Orientation { HORIZONTAL, VERTICAL }
	ScalarBar orientation specification. More...

Public Types inherited from osg::Node
typedef std::vector< Group * >	ParentList
	A vector of osg::Group pointers which is used to store the parent(s) of node. More...

typedef unsigned int	NodeMask
	This is a set of bits (flags) that represent the Node. More...

typedef std::vector< std::string >	DescriptionList
	A vector of std::string's which are used to describe the object. More...

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

Public Member Functions
	ScalarBar ()
	Default constructor. More...

	ScalarBar (int numColors, int numLabels, ScalarsToColors stc, const std::string &title, Orientation orientation=HORIZONTAL, float aspectRatio=0.25, ScalarPrinter sp=new ScalarPrinter)
	Construct a ScalarBar with the supplied parameters. More...

	ScalarBar (const ScalarBar &rhs, const osg::CopyOp &co)
	Copy constructor. More...

	META_Node (osgSim, ScalarBar)

void	setNumColors (int numColors)
	Set the number of distinct colours on the ScalarBar. More...

int	getNumColors () const
	Get the number of distinct colours on the ScalarBar. More...

void	setNumLabels (int numLabels)
	Set the number of labels to display along the ScalarBar. More...

int	getNumLabels () const
	Get the number of labels displayed along the ScalarBar. More...

void	setScalarsToColors (ScalarsToColors *stc)
	Set the ScalarsToColors mapping object for the ScalarBar. More...

const ScalarsToColors *	getScalarsToColors () const
	Get the ScalarsToColors mapping object from the ScalarBar. More...

void	setTitle (const std::string &title)
	Set the title for the ScalarBar, set "" for no title. More...

const std::string &	getTitle () const
	Get the title for the ScalarBar. More...

void	setPosition (const osg::Vec3 &pos)
	Set the position of scalar bar's lower left corner. More...

const osg::Vec3 &	getPosition () const
	Get the position of scalar bar. More...

void	setWidth (float width)
	Set the width of the scalar bar. More...

float	getWidth () const
	Get the width of the scalar bar. More...

void	setAspectRatio (float aspectRatio)
	Set the aspect ration (y/x) for the displayed bar. More...

float	getAspectRatio () const
	Get the aspect ration (y/x) for the displayed bar. More...

void	setOrientation (ScalarBar::Orientation orientation)
	Set the orientation of the ScalarBar. More...

ScalarBar::Orientation	getOrientation () const
	Get the orientation of the ScalarBar. More...

void	setScalarPrinter (ScalarPrinter *sp)
	Set a ScalarPrinter object for the ScalarBar. More...

const ScalarPrinter *	getScalarPrinter () const
	Get the ScalarPrinter object. More...

void	setTextProperties (const TextProperties &tp)
	Set the TextProperties for the labels & title. More...

const TextProperties &	getTextProperties () const
	Get the TextProperties for the labels & title. More...

void	update ()
	force update the drawables used to render the scalar bar. More...

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

	Geode (const Geode &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

	META_Node (osg, Geode)

virtual Geode *	asGeode ()
	Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0. More...

virtual const Geode *	asGeode () const
	convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0. More...

virtual bool	addDrawable (Drawable *drawable)
	Add a `Drawable` to the `Geode`. More...

template<class T >
bool	addDrawable (const ref_ptr< T > &drawable)

virtual bool	removeDrawable (Drawable *drawable)
	Remove a `Drawable` from the `Geode`. More...

template<class T >
bool	removeDrawable (const ref_ptr< T > &drawable)

virtual bool	removeDrawables (unsigned int i, unsigned int numDrawablesToRemove=1)
	Remove `Drawable`(s) from the specified position in `Geode`'s drawable list. More...

virtual bool	replaceDrawable (Drawable origDraw, Drawable newDraw)
	Replace specified Drawable with another Drawable. More...

template<class T , class R >
bool	replaceDrawable (const ref_ptr< T > &origDraw, const ref_ptr< R > &newDraw)

virtual bool	setDrawable (unsigned int i, Drawable *drawable)
	Set `Drawable` at position `i`. More...

template<class T >
bool	setDrawable (unsigned int i, const ref_ptr< T > &drawable)

unsigned int	getNumDrawables () const
	Return the number of `Drawable`s currently attached to the `Geode`. More...

Drawable *	getDrawable (unsigned int i)
	Return the `Drawable` at position `i`. More...

const Drawable *	getDrawable (unsigned int i) const
	Return the `Drawable` at position `i`. More...

bool	containsDrawable (const Drawable *drawable) const
	Return `true` if a given `Drawable` is contained within `Geode`. More...

template<class T >
bool	containsDrawable (const ref_ptr< T > &drawable) const

unsigned int	getDrawableIndex (const Drawable *drawable) const
	Get the index number of `drawable`. More...

template<class T >
unsigned int	getDrawableIndex (const ref_ptr< T > &drawable) const

void	compileDrawables (RenderInfo &renderInfo)
	Compile OpenGL Display List for each drawable. More...

const BoundingBox &	getBoundingBox () const
	Return the Geode's bounding box, which is the union of all the bounding boxes of the geode's drawables. More...

virtual BoundingSphere	computeBound () const
	Compute the bounding sphere around Node's geometry or children. More...

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

	Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

	META_Node (osg, Group)

virtual Group *	asGroup ()
	convert 'this' into a Group pointer if Node is a Group, otherwise return 0. More...

virtual const Group *	asGroup () const
	convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0. More...

virtual void	traverse (NodeVisitor &nv)
	Traverse downwards : calls children's accept method with NodeVisitor. More...

virtual bool	addChild (Node *child)
	Add Node to Group. More...

template<class T >
bool	addChild (const ref_ptr< T > &child)

virtual bool	insertChild (unsigned int index, Node *child)
	Insert Node to Group at specific location. More...

template<class T >
bool	insertChild (unsigned int index, const ref_ptr< T > &child)

virtual bool	removeChild (Node *child)
	Remove Node from Group. More...

template<class T >
bool	removeChild (const ref_ptr< T > &child)

bool	removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
	Remove Node from Group. More...

virtual bool	removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
	Remove children from Group. More...

virtual bool	replaceChild (Node origChild, Node newChild)
	Replace specified child Node with another Node. More...

template<class T , class R >
bool	replaceChild (const ref_ptr< T > &origChild, const ref_ptr< R > &newChild)

virtual unsigned int	getNumChildren () const
	Return the number of children nodes. More...

virtual bool	setChild (unsigned int i, Node *node)
	Set child node at position i. More...

Node *	getChild (unsigned int i)
	Return child node at position i. More...

const Node *	getChild (unsigned int i) const
	Return child node at position i. More...

bool	containsNode (const Node *node) const
	Return true if node is contained within Group. More...

template<class T >
bool	conatainsNode (const ref_ptr< T > &node) const

unsigned int	getChildIndex (const Node *node) const
	Get the index number of child, return a value between 0 and _children.size()-1 if found, if not found then return _children.size(). More...

virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...

virtual void	resizeGLObjectBuffers (unsigned int maxSize)
	Resize any per context GLObject buffers to specified size. More...

virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...

Public Member Functions inherited from osg::Node
	Node ()
	Construct a node. More...

	Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

virtual Object *	cloneType () const
	clone an object of the same type as the node. More...

virtual Object *	clone (const CopyOp &copyop) const
	return a clone of a node, with Object* return type. More...

virtual bool	isSameKindAs (const Object *obj) const
	return true if this and obj are of the same kind of object. More...

virtual const char *	libraryName () const
	return the name of the node's library. More...

virtual const char *	className () const
	return the name of the node's class type. More...

virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...

virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...

virtual Drawable *	asDrawable ()
	convert 'this' into a Drawable pointer if Node is a Drawable, otherwise return 0. More...

virtual const Drawable *	asDrawable () const
	convert 'const this' into a const Drawable pointer if Node is a Drawable, otherwise return 0. More...

virtual Geometry *	asGeometry ()
	convert 'this' into a Geometry pointer if Node is a Geometry, otherwise return 0. More...

virtual const Geometry *	asGeometry () const
	convert 'const this' into a const Geometry pointer if Node is a Geometry, otherwise return 0. More...

virtual Transform *	asTransform ()
	Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. More...

virtual const Transform *	asTransform () const
	convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0. More...

virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...

virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...

virtual Switch *	asSwitch ()
	Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0. More...

virtual const Switch *	asSwitch () const
	convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0. More...

virtual osgTerrain::Terrain *	asTerrain ()
	Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0. More...

virtual const osgTerrain::Terrain *	asTerrain () const
	convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0. More...

virtual void	accept (NodeVisitor &nv)
	Visitor Pattern : calls the apply method of a NodeVisitor with this node's type. More...

virtual void	ascend (NodeVisitor &nv)
	Traverse upwards : calls parents' accept method with NodeVisitor. More...

const ParentList &	getParents () const
	Get the parent list of node. More...

ParentList	getParents ()
	Get the a copy of parent list of node. More...

Group *	getParent (unsigned int i)

const Group *	getParent (unsigned int i) const
	Get a single const parent of node. More...

unsigned int	getNumParents () const
	Get the number of parents of node. More...

NodePathList	getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
	Get the list of node paths parent paths. More...

MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
	Get the list of matrices that transform this node from local coordinates to world coordinates. More...

void	setUpdateCallback (Callback *nc)
	Set update node callback, called during update traversal. More...

template<class T >
void	setUpdateCallback (const ref_ptr< T > &nc)

Callback *	getUpdateCallback ()
	Get update node callback, called during update traversal. More...

const Callback *	getUpdateCallback () const
	Get const update node callback, called during update traversal. More...

void	addUpdateCallback (Callback *nc)
	Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one. More...

template<class T >
void	addUpdateCallback (const ref_ptr< T > &nc)

void	removeUpdateCallback (Callback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested. More...

template<class T >
void	removeUpdateCallback (const ref_ptr< T > &nc)

unsigned int	getNumChildrenRequiringUpdateTraversal () const
	Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children. More...

void	setEventCallback (Callback *nc)
	Set event node callback, called during event traversal. More...

template<class T >
void	setEventCallback (const ref_ptr< T > &nc)

Callback *	getEventCallback ()
	Get event node callback, called during event traversal. More...

const Callback *	getEventCallback () const
	Get const event node callback, called during event traversal. More...

void	addEventCallback (Callback *nc)
	Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one. More...

template<class T >
void	addEventCallback (const ref_ptr< T > &nc)

void	removeEventCallback (Callback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested. More...

template<class T >
void	removeEventCallback (const ref_ptr< T > &nc)

unsigned int	getNumChildrenRequiringEventTraversal () const
	Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children. More...

void	setCullCallback (Callback *nc)
	Set cull node callback, called during cull traversal. More...

template<class T >
void	setCullCallback (const ref_ptr< T > &nc)

Callback *	getCullCallback ()
	Get cull node callback, called during cull traversal. More...

const Callback *	getCullCallback () const
	Get const cull node callback, called during cull traversal. More...

void	addCullCallback (Callback *nc)
	Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one. More...

template<class T >
void	addCullCallback (const ref_ptr< T > &nc)

void	removeCullCallback (Callback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested. More...

template<class T >
void	removeCullCallback (const ref_ptr< T > &nc)

void	setCullingActive (bool active)
	Set the view frustum/small feature culling of this node to be active or inactive. More...

bool	getCullingActive () const
	Get the view frustum/small feature _cullingActive flag for this node. More...

unsigned int	getNumChildrenWithCullingDisabled () const
	Get the number of Children of this node which have culling disabled. More...

bool	isCullingActive () const
	Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal. More...

unsigned int	getNumChildrenWithOccluderNodes () const
	Get the number of Children of this node which are or have OccluderNode's. More...

bool	containsOccluderNodes () const
	return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes. More...

void	setNodeMask (NodeMask nm)
	Set the node mask. More...

NodeMask	getNodeMask () const
	Get the node Mask. More...

void	setStateSet (osg::StateSet *stateset)
	Set the node's StateSet. More...

template<class T >
void	setStateSet (const osg::ref_ptr< T > &stateset)

osg::StateSet *	getOrCreateStateSet ()
	return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet. More...

osg::StateSet *	getStateSet ()
	Return the node's StateSet. More...

const osg::StateSet *	getStateSet () const
	Return the node's const StateSet. More...

void	setDescriptions (const DescriptionList &descriptions)
	Set the list of string descriptions. More...

DescriptionList &	getDescriptions ()
	Get the description list of the node. More...

const DescriptionList &	getDescriptions () const
	Get the const description list of the const node. More...

const std::string &	getDescription (unsigned int i) const
	Get a single const description of the const node. More...

std::string &	getDescription (unsigned int i)
	Get a single description of the node. More...

unsigned int	getNumDescriptions () const
	Get the number of descriptions of the node. More...

void	addDescription (const std::string &desc)
	Add a description string to the node. More...

void	setInitialBound (const osg::BoundingSphere &bsphere)
	Set the initial bounding volume to use when computing the overall bounding volume. More...

const BoundingSphere &	getInitialBound () const
	Set the initial bounding volume to use when computing the overall bounding volume. More...

void	dirtyBound ()
	Mark this node's bounding sphere dirty. More...

const BoundingSphere &	getBound () const

void	setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
	Set the compute bound callback to override the default computeBound. More...

template<class T >
void	setComputeBoundingSphereCallback (const ref_ptr< T > &callback)

ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback ()
	Get the compute bound callback. More...

const ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback () const
	Get the const compute bound callback. More...

Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...

std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...

void	setName (const char *name)
	Set the name of object using a C style string. More...

const std::string &	getName () const
	Get the name of object. More...

void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...

DataVariance	getDataVariance () const
	Get the data variance of this object. More...

virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...

void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...

template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)

osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...

virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...

template<class T >
void	setUserData (const ref_ptr< T > &ud)

virtual Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () const
	Get const user data. More...

template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...

template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...

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

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

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...

OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...

int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	referenceCount () const
	Return the number of pointers currently referencing this object. More...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...

void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...

void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

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 ()
	Node destructor. More...

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 ()
	Object destructor. More...

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 ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...

static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

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

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.

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.

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.

Member Data Documentation

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

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

osgSim/ScalarBar

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