Inheritance 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 Member Functions
	StatsHandler ()
void	setKeyEventTogglesOnScreenStats (int key)
int	getKeyEventTogglesOnScreenStats () const
void	setKeyEventPrintsOutStats (int key)
int	getKeyEventPrintsOutStats () const
void	setKeyEventToggleVSync (int key)
int	getKeyEventToggleVSync () 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)
Protected Types
typedef std::vector < UserStatsLine >	UserStatsLines
Protected Member Functions
void	setUpHUDCamera (osgViewer::ViewerBase *viewer)
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 Attributes
int	_keyEventTogglesOnScreenStats
int	_keyEventPrintsOutStats
int	_keyEventToggleVSync
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

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]`