OpenSceneGraph  3.0.1
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
osgViewer::StatsHandler Class Reference

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

Inheritance diagram for osgViewer::StatsHandler:
Inheritance graph
[legend]

List of all members.

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::CameragetCamera ()
const osg::CameragetCamera () const
virtual bool handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa)
 Deprecated, Handle events, return true if handled, false otherwise.
virtual void getUsage (osg::ApplicationUsage &usage) const
 Get the keyboard and mouse usage of this manipulator.
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.
void removeUserStatsLine (const std::string &label)

Protected Types

typedef std::vector
< UserStatsLine
UserStatsLines

Protected Member Functions

void setUpHUDCamera (osgViewer::ViewerBase *viewer)
osg::GeometrycreateBackgroundRectangle (const osg::Vec3 &pos, const float width, const float height, osg::Vec4 &color)
osg::GeometrycreateGeometry (const osg::Vec3 &pos, float height, const osg::Vec4 &colour, unsigned int numBlocks)
osg::GeometrycreateFrameMarkers (const osg::Vec3 &pos, float height, const osg::Vec4 &colour, unsigned int numBlocks)
osg::GeometrycreateTick (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

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:
labelThe label to be displayed to identify the line in the stats.
textColorWill be used for the text label, the numeric time and the bottom line graph.
barColorWill be used for the bar in the top bar graph.
timeTakenNameThe name to be queried in the viewer stats for the numeric value (also used for the bottom line graph).
multiplierThe multiplier to apply to the numeric value before displaying it in the stats.
averageWhether to use the average value of the numeric value.
averageInInverseSpaceWhether to average in inverse space (used for frame rate).
beginTimeNameThe name to be queried in the viewer stats for the begin time for the top bar graph.
endTimeNameThe name to be queried in the viewer stats for the end time for the top bar graph.
maxValueThe 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]
int osgViewer::StatsHandler::getKeyEventToggleVSync ( ) const [inline]
virtual void osgViewer::StatsHandler::getUsage ( osg::ApplicationUsage usage) const [virtual]

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::GUIEventHandler.

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::setKeyEventToggleVSync ( int  key) [inline]
void osgViewer::StatsHandler::setUpHUDCamera ( osgViewer::ViewerBase viewer) [protected]
void osgViewer::StatsHandler::setUpScene ( osgViewer::ViewerBase viewer) [protected]
void osgViewer::StatsHandler::updateThreadingModelText ( ) [protected]

Member Data Documentation

std::string osgViewer::StatsHandler::_font [protected]
unsigned int osgViewer::StatsHandler::_numBlocks [protected]
unsigned int osgViewer::StatsHandler::_viewerChildNum [protected]

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

osg logo
Generated at Mon Oct 3 2011 12:39:51 for the OpenSceneGraph by doxygen 1.7.5.