#include <ViewerEventHandlers.h>

Inheritance diagram for osgViewer::StatsHandler:

Collaboration diagram for osgViewer::StatsHandler:

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)

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

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)

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)

virtual bool	handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object , osg::NodeVisitor )

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)

virtual void	operator() (osg::Node node, osg::NodeVisitor nv)

virtual void	event (osg::NodeVisitor nv, osg::Drawable drawable)

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)

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

	Object (bool threadSafeRefUnref)

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

virtual Object *	cloneType () const =0

virtual Object *	clone (const CopyOp &) const =0

virtual bool	isSameKindAs (const Object *) const

virtual const char *	libraryName () const =0

virtual const char *	className () const =0

std::string	getCompoundClassName () const

virtual Node *	asNode ()

virtual const Node *	asNode () 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	setThreadSafeRefUnref (bool threadSafe)

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)

virtual void	resizeGLObjectBuffers (unsigned int)

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

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

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

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

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)

static bool	getThreadSafeReferenceCounting ()

static void	setDeleteHandler (DeleteHandler *handler)

static DeleteHandler *	getDeleteHandler ()

Detailed Description

Event handler for adding on screen stats reporting to Viewers.

Definition at line 74 of file ViewerEventHandlers.h.

Member Typedef Documentation

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

protected

Definition at line 224 of file ViewerEventHandlers.h.

Member Enumeration Documentation

enum osgViewer::StatsHandler::StatsType

Enumerator
NO_STATS
FRAME_RATE
VIEWER_STATS
CAMERA_SCENE_STATS
VIEWER_SCENE_STATS
LAST

Definition at line 80 of file ViewerEventHandlers.h.

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

Definition at line 96 of file ViewerEventHandlers.h.

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

inline

Definition at line 100 of file ViewerEventHandlers.h.

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

inline

Definition at line 101 of file ViewerEventHandlers.h.

int osgViewer::StatsHandler::getKeyEventPrintsOutStats ( ) const

inline

Definition at line 94 of file ViewerEventHandlers.h.

int osgViewer::StatsHandler::getKeyEventTogglesOnScreenStats ( ) const

inline

Definition at line 91 of file ViewerEventHandlers.h.

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

Definition at line 93 of file ViewerEventHandlers.h.

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

inline

Definition at line 90 of file ViewerEventHandlers.h.

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

Definition at line 190 of file ViewerEventHandlers.h.

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

protected

Definition at line 176 of file ViewerEventHandlers.h.

unsigned int osgViewer::StatsHandler::_cameraSceneChildNum

protected

Definition at line 187 of file ViewerEventHandlers.h.

float osgViewer::StatsHandler::_characterSize

protected

Definition at line 198 of file ViewerEventHandlers.h.

std::string osgViewer::StatsHandler::_font

protected

Definition at line 195 of file ViewerEventHandlers.h.

unsigned int osgViewer::StatsHandler::_frameRateChildNum

protected

Definition at line 185 of file ViewerEventHandlers.h.

bool osgViewer::StatsHandler::_initialized

protected

Definition at line 175 of file ViewerEventHandlers.h.

int osgViewer::StatsHandler::_keyEventPrintsOutStats

protected

Definition at line 171 of file ViewerEventHandlers.h.

int osgViewer::StatsHandler::_keyEventTogglesOnScreenStats

protected

Definition at line 170 of file ViewerEventHandlers.h.

float osgViewer::StatsHandler::_leftPos

protected

Definition at line 197 of file ViewerEventHandlers.h.

float osgViewer::StatsHandler::_lineHeight

protected

Definition at line 199 of file ViewerEventHandlers.h.

unsigned int osgViewer::StatsHandler::_numBlocks

protected

Definition at line 189 of file ViewerEventHandlers.h.

float osgViewer::StatsHandler::_startBlocks

protected

Definition at line 196 of file ViewerEventHandlers.h.

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

protected

Definition at line 180 of file ViewerEventHandlers.h.

float osgViewer::StatsHandler::_statsHeight

protected

Definition at line 193 of file ViewerEventHandlers.h.

int osgViewer::StatsHandler::_statsType

protected

Definition at line 173 of file ViewerEventHandlers.h.

float osgViewer::StatsHandler::_statsWidth

protected

Definition at line 192 of file ViewerEventHandlers.h.

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

protected

Definition at line 178 of file ViewerEventHandlers.h.

ViewerBase::ThreadingModel osgViewer::StatsHandler::_threadingModel

protected

Definition at line 182 of file ViewerEventHandlers.h.

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

protected

Definition at line 183 of file ViewerEventHandlers.h.

UserStatsLines osgViewer::StatsHandler::_userStatsLines

protected

Definition at line 225 of file ViewerEventHandlers.h.

unsigned int osgViewer::StatsHandler::_viewerChildNum

protected

Definition at line 186 of file ViewerEventHandlers.h.

unsigned int osgViewer::StatsHandler::_viewerSceneChildNum

protected

Definition at line 188 of file ViewerEventHandlers.h.

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

osg_head/include/osgViewer/ViewerEventHandlers.h

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