openscenegraph
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgSim::ScalarBar Class Reference
Inheritance diagram for osgSim::ScalarBar:
osg::Geode osg::Node osg::Object osg::Referenced

Classes

struct  ScalarPrinter
struct  TextProperties

Public Types

enum  Orientation { HORIZONTAL, VERTICAL }
- Public Types inherited from osg::Geode
typedef std::vector< ref_ptr
< Drawable > > 
DrawableList
- 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 ScalarsToColorsgetScalarsToColors () const
void setTitle (const std::string &title)
const std::string & getTitle () const
void setPosition (const osg::Vec3 &pos)
const osg::Vec3getPosition () 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 ScalarPrintergetScalarPrinter () const
void setTextProperties (const TextProperties &tp)
const TextPropertiesgetTextProperties () 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 GeodeasGeode ()
virtual const GeodeasGeode () 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
DrawablegetDrawable (unsigned int i)
const DrawablegetDrawable (unsigned int i) const
bool containsDrawable (const Drawable *gset) const
unsigned int getDrawableIndex (const Drawable *drawable) const
const DrawableListgetDrawableList () const
void compileDrawables (RenderInfo &renderInfo)
const BoundingBoxgetBoundingBox () const
virtual BoundingSphere computeBound () 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 ObjectcloneType () const
virtual Objectclone (const CopyOp &copyop) const
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual TransformasTransform ()
virtual const TransformasTransform () const
virtual SwitchasSwitch ()
virtual const SwitchasSwitch () const
virtual osgTerrain::TerrainasTerrain ()
virtual const osgTerrain::TerrainasTerrain () const
virtual void accept (NodeVisitor &nv)
virtual void ascend (NodeVisitor &nv)
virtual void traverse (NodeVisitor &)
const ParentListgetParents () const
ParentList getParents ()
GroupgetParent (unsigned int i)
const GroupgetParent (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 (NodeCallback *nc)
NodeCallbackgetUpdateCallback ()
const NodeCallbackgetUpdateCallback () const
void addUpdateCallback (NodeCallback *nc)
void removeUpdateCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setEventCallback (NodeCallback *nc)
NodeCallbackgetEventCallback ()
const NodeCallbackgetEventCallback () const
void addEventCallback (NodeCallback *nc)
void removeEventCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringEventTraversal () const
void setCullCallback (NodeCallback *nc)
NodeCallbackgetCullCallback ()
const NodeCallbackgetCullCallback () const
void addCullCallback (NodeCallback *nc)
void removeCullCallback (NodeCallback *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::StateSetgetOrCreateStateSet ()
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
void setDescriptions (const DescriptionList &descriptions)
DescriptionListgetDescriptions ()
const DescriptionListgetDescriptions () 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 BoundingSpheregetInitialBound () const
void dirtyBound ()
const BoundingSpheregetBound () const
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
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::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () 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)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () 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::Node
virtual ~Node ()
void addParent (osg::Group *node)
void removeParent (osg::Group *node)
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
DrawableList _drawables
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
ref_ptr
< ComputeBoundingSphereCallback
_computeBoundCallback
BoundingSphere _boundingSphere
bool _boundingSphereComputed
ParentList _parents
ref_ptr< NodeCallback_updateCallback
unsigned int _numChildrenRequiringUpdateTraversal
ref_ptr< NodeCallback_eventCallback
unsigned int _numChildrenRequiringEventTraversal
ref_ptr< NodeCallback_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::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()

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:

  1. The range of scalars represented by the bar, and the colors corresponding to this range - these are specified by the ScalarsToColors object.
  2. The number of colors used when rendering the bar geometry - this may be thought of as the bar 'density'.
  3. 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

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
numColorsSpecify the number of colors in the scalar bar. Color interpolation occurs where necessary.
numLabelsSpecify the number of labels in the scalar bar.
stcThe ScalarsToColors defining the range of scalars and the colors they map to.
titleThe title to be used when displaying the ScalarBar. Specify "" for no title.
orientationThe orientation of the ScalarBar.
See Also
Orientation.
Parameters
aspectRatioThe aspect ration (y/x) for the displayed bar. Bear in mind you may want to change this if you change the orientation.
spA 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: