osgSim::ColorRange Class Reference

ColorRange is a ScalarsToColors object to define a color spectrum for a scalar range. More...

Inheritance diagram for osgSim::ColorRange:

Public Member Functions
	ColorRange (float min, float max)
	Constructor for a ColorRange with a default list of colors set to Red-Yellow-Green-Blue-Cyan. More...
	ColorRange (float min, float max, const std::vector< osg::Vec4 > &colors)
	Constructor for a ColorRange. More...
void	setColors (const std::vector< osg::Vec4 > &colors)
	Set the range of colors. More...
const std::vector< osg::Vec4 > &	getColors () const
	Get the range of colors. More...
osg::Vec4	getColor (float scalar) const
	Get the color for a given scalar value. More...
Public Member Functions inherited from osgSim::ScalarsToColors
	ScalarsToColors (float scalarMin, float scalarMax)
virtual	~ScalarsToColors ()
float	getMin () const
	Get the minimum scalar value. More...
float	getMax () const
	Get the maximum scalar value. More...
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
virtual void	setThreadSafeRefUnref (bool)
	Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called. More...
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...

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	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...
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet
OpenThreads::Atomic	_refCount

Detailed Description

ColorRange is a ScalarsToColors object to define a color spectrum for a scalar range.

An optional vector of colors may be passed in at construction time. The range of colors will be mapped to the scalar range, and interpolation between the colors will be performed as necessary. By default, the color range will run Red-Yellow-Green-Cyan-Blue.

Constructor & Destructor Documentation

ColorRange() [1/2]

osgSim::ColorRange::ColorRange	(	float	min,
		float	max
	)

Constructor for a ColorRange with a default list of colors set to Red-Yellow-Green-Blue-Cyan.

Parameters

min	minimum scalar value
max	maximum scalar value

ColorRange() [2/2]

osgSim::ColorRange::ColorRange	(	float	min,
		float	max,
		const std::vector< osg::Vec4 > &	colors
	)

Constructor for a ColorRange.

Parameters

min	minimum scalar value
max	maximum scalar value
colors	optional range of colors,

Member Function Documentation

getColor()

osg::Vec4 osgSim::ColorRange::getColor ( float  scalar ) const

virtual

Get the color for a given scalar value.

Reimplemented from osgSim::ScalarsToColors.

getColors()

const std::vector<osg::Vec4>& osgSim::ColorRange::getColors ( ) const

inline

Get the range of colors.

setColors()

void osgSim::ColorRange::setColors

(

const std::vector< osg::Vec4 > &

colors

)

Set the range of colors.

---

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

• osgSim/ColorRange