Event handler for adding on screen stats reporting to Viewers. More...

Inheritance diagram for osgViewer::StatsHandler:

[legend]

Classes
struct	UserStatsLine

Public Types
enum	StatsType { NO_STATS = 0, FRAME_RATE = 1, VIEWER_STATS = 2, CAMERA_SCENE_STATS = 3, VIEWER_SCENE_STATS = 4, LAST = 5 }

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

Public Member Functions
	StatsHandler ()

void	setKeyEventTogglesOnScreenStats (int key)

int	getKeyEventTogglesOnScreenStats () const

void	setKeyEventPrintsOutStats (int key)

int	getKeyEventPrintsOutStats () const

double	getBlockMultiplier () const

void	reset ()

osg::Camera *	getCamera ()

const osg::Camera *	getCamera () const

virtual bool	handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa)
	Deprecated, Handle events, return true if handled, false otherwise. More...

virtual void	getUsage (osg::ApplicationUsage &usage) const
	Get the keyboard and mouse usage of this manipulator. More...

void	addUserStatsLine (const std::string &label, const osg::Vec4 &textColor, const osg::Vec4 &barColor, const std::string &timeTakenName, float multiplier, bool average, bool averageInInverseSpace, const std::string &beginTimeName, const std::string &endTimeName, float maxValue)
	This allows the user to register additional stats lines that will be added to the graph. More...

void	removeUserStatsLine (const std::string &label)

Public Member Functions inherited from osgGA::GUIEventHandler
	GUIEventHandler ()

	GUIEventHandler (const GUIEventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)

	META_Object (osgGA, GUIEventHandler)

virtual bool	handle (osgGA::Event event, osg::Object object, osg::NodeVisitor *nv)
	Handle event. More...

virtual bool	handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object , osg::NodeVisitor )
	Handle events, return true if handled, false otherwise. More...

Public Member Functions inherited from osgGA::EventHandler
	EventHandler ()

	EventHandler (const EventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)

	META_Object (osgGA, EventHandler)

virtual bool	run (osg::Object object, osg::Object data)
	NodeCallback overrides the Callback::run() method to adapt it the old style NodeCallback::operator()(Node* node, NodeVisitor* nv) method. More...

virtual void	operator() (osg::Node node, osg::NodeVisitor nv)
	Event traversal node callback method. More...

virtual void	event (osg::NodeVisitor nv, osg::Drawable drawable)
	Event traversal drawable callback method. More...

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

	NodeCallback (const NodeCallback &nc, const CopyOp &copyop)

	META_Object (osg, NodeCallback)

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

	Callback (const Callback &cb, const CopyOp &copyop)

	META_Object (osg, Callback)

bool	traverse (osg::Object object, osg::Object data)
	traverse the nested callbacks or call NodeVisitor::traverse() if the object is Node, and data is NodeVisitor. More...

void	setNestedCallback (osg::Callback *cb)

osg::Callback *	getNestedCallback ()

const osg::Callback *	getNestedCallback () const

void	addNestedCallback (osg::Callback *nc)

void	removeNestedCallback (osg::Callback *nc)

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...

virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...

virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type. More...

virtual bool	isSameKindAs (const Object *) const

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

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

std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. 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 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	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. 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...

virtual void	resizeGLObjectBuffers (unsigned int)
	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...

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...

Public Member Functions inherited from osg::Drawable::EventCallback
	EventCallback ()

	EventCallback (const EventCallback &, const CopyOp &)

	META_Object (osg, EventCallback)

Protected Types
typedef std::vector< UserStatsLine >	UserStatsLines

Protected Member Functions
void	setUpHUDCamera (osgViewer::ViewerBase *viewer)

void	setWindowSize (int width, int height)

osg::Geometry *	createBackgroundRectangle (const osg::Vec3 &pos, const float width, const float height, osg::Vec4 &color)

osg::Geometry *	createGeometry (const osg::Vec3 &pos, float height, const osg::Vec4 &colour, unsigned int numBlocks)

osg::Geometry *	createFrameMarkers (const osg::Vec3 &pos, float height, const osg::Vec4 &colour, unsigned int numBlocks)

osg::Geometry *	createTick (const osg::Vec3 &pos, float height, const osg::Vec4 &colour, unsigned int numTicks)

void	createTimeStatsLine (const std::string &lineLabel, osg::Vec3 pos, const osg::Vec4 &textColor, const osg::Vec4 &barColor, osg::Stats viewerStats, osg::Stats stats, const std::string &timeTakenName, float multiplier, bool average, bool averageInInverseSpace, const std::string &beginTimeName, const std::string &endTimeName)

void	createCameraTimeStats (osg::Vec3 &pos, bool acquireGPUStats, osg::Stats viewerStats, osg::Camera camera)

void	setUpScene (osgViewer::ViewerBase *viewer)

void	updateThreadingModelText ()

Protected Member Functions inherited from osgGA::GUIEventHandler
virtual	~GUIEventHandler ()

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

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

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	_keyEventTogglesOnScreenStats

int	_keyEventPrintsOutStats

int	_statsType

bool	_initialized

osg::ref_ptr< osg::Camera >	_camera

osg::ref_ptr< osg::Switch >	_switch

osg::ref_ptr< osg::Geode >	_statsGeode

ViewerBase::ThreadingModel	_threadingModel

osg::ref_ptr< osgText::Text >	_threadingModelText

unsigned int	_frameRateChildNum

unsigned int	_viewerChildNum

unsigned int	_cameraSceneChildNum

unsigned int	_viewerSceneChildNum

unsigned int	_numBlocks

double	_blockMultiplier

float	_statsWidth

float	_statsHeight

std::string	_font

float	_startBlocks

float	_leftPos

float	_characterSize

float	_lineHeight

UserStatsLines	_userStatsLines

Protected Attributes inherited from osg::Callback
ref_ptr< Callback >	_nestedCallback

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

Event handler for adding on screen stats reporting to Viewers.

Member Typedef Documentation

typedef std::vector<UserStatsLine> osgViewer::StatsHandler::UserStatsLines

protected

Member Enumeration Documentation

enum osgViewer::StatsHandler::StatsType

Enumerator
NO_STATS
FRAME_RATE
VIEWER_STATS
CAMERA_SCENE_STATS
VIEWER_SCENE_STATS
LAST

Constructor & Destructor Documentation

osgViewer::StatsHandler::StatsHandler ( )

Member Function Documentation

void osgViewer::StatsHandler::addUserStatsLine	(	const std::string &	label,
		const osg::Vec4 &	textColor,
		const osg::Vec4 &	barColor,
		const std::string &	timeTakenName,
		float	multiplier,
		bool	average,
		bool	averageInInverseSpace,
		const std::string &	beginTimeName,
		const std::string &	endTimeName,
		float	maxValue
	)

This allows the user to register additional stats lines that will be added to the graph.

The stats for these will be gotten from the viewer (viewer->getViewerStats()). The stats can be displayed in either or all of the following ways:

A numeric time beside the stat name Requires that an elapsed time be recorded in the viewer's stats for the "timeTakenName".
A bar in the top bar graph Requires that two times (relative to the viewer's start tick) be recorded in the viewer's stats for the "beginTimeName" and "endTimeName".
A line in the bottom graph Requires that an elapsed time be recorded in the viewer's stats for the "timeTakenName" and that the value be used as an average.

If you don't want a numeric value and a line in the bottom line graph for your value, pass the empty string for timeTakenName. If you don't want a bar in the graph, pass the empty string for beginTimeName and endTimeName.

Parameters

label	The label to be displayed to identify the line in the stats.
textColor	Will be used for the text label, the numeric time and the bottom line graph.
barColor	Will be used for the bar in the top bar graph.
timeTakenName	The name to be queried in the viewer stats for the numeric value (also used for the bottom line graph).
multiplier	The multiplier to apply to the numeric value before displaying it in the stats.
average	Whether to use the average value of the numeric value.
averageInInverseSpace	Whether to average in inverse space (used for frame rate).
beginTimeName	The name to be queried in the viewer stats for the begin time for the top bar graph.
endTimeName	The name to be queried in the viewer stats for the end time for the top bar graph.
maxValue	The value to use as maximum in the bottom line graph. Stats will be clamped between 0 and that value, and it will be the highest visible value in the graph.

osg::Geometry* osgViewer::StatsHandler::createBackgroundRectangle	(	const osg::Vec3 &	pos,
		const float	width,
		const float	height,
		osg::Vec4 &	color
	)

protected

void osgViewer::StatsHandler::createCameraTimeStats	(	osg::Vec3 &	pos,
		bool	acquireGPUStats,
		osg::Stats *	viewerStats,
		osg::Camera *	camera
	)

protected

osg::Geometry* osgViewer::StatsHandler::createFrameMarkers	(	const osg::Vec3 &	pos,
		float	height,
		const osg::Vec4 &	colour,
		unsigned int	numBlocks
	)

protected

osg::Geometry* osgViewer::StatsHandler::createGeometry	(	const osg::Vec3 &	pos,
		float	height,
		const osg::Vec4 &	colour,
		unsigned int	numBlocks
	)

protected

osg::Geometry* osgViewer::StatsHandler::createTick	(	const osg::Vec3 &	pos,
		float	height,
		const osg::Vec4 &	colour,
		unsigned int	numTicks
	)

protected

void osgViewer::StatsHandler::createTimeStatsLine	(	const std::string &	lineLabel,
		osg::Vec3	pos,
		const osg::Vec4 &	textColor,
		const osg::Vec4 &	barColor,
		osg::Stats *	viewerStats,
		osg::Stats *	stats,
		const std::string &	timeTakenName,
		float	multiplier,
		bool	average,
		bool	averageInInverseSpace,
		const std::string &	beginTimeName,
		const std::string &	endTimeName
	)

protected

double osgViewer::StatsHandler::getBlockMultiplier ( ) const

inline

osg::Camera* osgViewer::StatsHandler::getCamera ( )

inline

const osg::Camera* osgViewer::StatsHandler::getCamera ( ) const

inline

int osgViewer::StatsHandler::getKeyEventPrintsOutStats ( ) const

inline

int osgViewer::StatsHandler::getKeyEventTogglesOnScreenStats ( ) const

inline

virtual void osgViewer::StatsHandler::getUsage ( osg::ApplicationUsage & usage ) const

virtual

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::EventHandler.

virtual bool osgViewer::StatsHandler::handle	(	const osgGA::GUIEventAdapter &	,
		osgGA::GUIActionAdapter &
	)

virtual

Deprecated, Handle events, return true if handled, false otherwise.

Reimplemented from osgGA::GUIEventHandler.

void osgViewer::StatsHandler::removeUserStatsLine ( const std::string & label )

void osgViewer::StatsHandler::reset ( )

void osgViewer::StatsHandler::setKeyEventPrintsOutStats ( int key )

inline

void osgViewer::StatsHandler::setKeyEventTogglesOnScreenStats ( int key )

inline

void osgViewer::StatsHandler::setUpHUDCamera ( osgViewer::ViewerBase * viewer )

protected

void osgViewer::StatsHandler::setUpScene ( osgViewer::ViewerBase * viewer )

protected

void osgViewer::StatsHandler::setWindowSize	(	int	width,
		int	height
	)

protected

void osgViewer::StatsHandler::updateThreadingModelText ( )

protected

Member Data Documentation

double osgViewer::StatsHandler::_blockMultiplier

protected

osg::ref_ptr<osg::Camera> osgViewer::StatsHandler::_camera

protected

unsigned int osgViewer::StatsHandler::_cameraSceneChildNum

protected

float osgViewer::StatsHandler::_characterSize

protected

std::string osgViewer::StatsHandler::_font

protected

unsigned int osgViewer::StatsHandler::_frameRateChildNum

protected

bool osgViewer::StatsHandler::_initialized

protected

int osgViewer::StatsHandler::_keyEventPrintsOutStats

protected

int osgViewer::StatsHandler::_keyEventTogglesOnScreenStats

protected

float osgViewer::StatsHandler::_leftPos

protected

float osgViewer::StatsHandler::_lineHeight

protected

unsigned int osgViewer::StatsHandler::_numBlocks

protected

float osgViewer::StatsHandler::_startBlocks

protected

osg::ref_ptr<osg::Geode> osgViewer::StatsHandler::_statsGeode

protected

float osgViewer::StatsHandler::_statsHeight

protected

int osgViewer::StatsHandler::_statsType

protected

float osgViewer::StatsHandler::_statsWidth

protected

osg::ref_ptr<osg::Switch> osgViewer::StatsHandler::_switch

protected

ViewerBase::ThreadingModel osgViewer::StatsHandler::_threadingModel

protected

osg::ref_ptr<osgText::Text> osgViewer::StatsHandler::_threadingModelText

protected

UserStatsLines osgViewer::StatsHandler::_userStatsLines

protected

unsigned int osgViewer::StatsHandler::_viewerChildNum

protected

unsigned int osgViewer::StatsHandler::_viewerSceneChildNum

protected

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

osgViewer/ViewerEventHandlers

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation