OpenSceneGraph  3.0.1
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osgViewer::StatsHandler Class Reference

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

Inheritance diagram for osgViewer::StatsHandler:
Inheritance graph
[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 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)
- Public Member Functions inherited from osgGA::GUIEventHandler
 GUIEventHandler ()
 GUIEventHandler (const GUIEventHandler &eh, const osg::CopyOp &copyop)
 META_Object (osgGA, GUIEventHandler)
virtual void operator() (osg::Node *node, osg::NodeVisitor *nv)
 Event traversal node callback method.
virtual void event (osg::NodeVisitor *nv, osg::Drawable *drawable)
 Event traversal drawable callback method.
virtual bool handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *, osg::NodeVisitor *)
 Handle events, return true if handled, false otherwise.
bool handleWithCheckAgainstIgnoreHandledEventsMask (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *object, osg::NodeVisitor *nv)
 Convenience method that only passes on to the handle(,,,) method events that either haven't been handled yet, or have been handled but haven't be set to be ignored by the IgnoreHandledEventsMask.
bool handleWithCheckAgainstIgnoreHandledEventsMask (const GUIEventAdapter &ea, GUIActionAdapter &aa)
 Convenience method that only passes on to the handle(,) method events that either haven't been handled yet, or have been handled but haven't be set to be ignored by the IgnoreHandledEventsMask.
void setIgnoreHandledEventsMask (unsigned int mask)
 Set a mask of osgGA::GUIEeventAdapter::Event to be ignored if marked as handled.
unsigned int getIgnoreHandledEventsMask () const
 Get the event mask of the osgGA::GUIEeventAdapter::Event to be ignored if marked as handled.
- Public Member Functions inherited from osg::NodeCallback
 NodeCallback ()
 NodeCallback (const NodeCallback &nc, const CopyOp &)
 META_Object (osg, NodeCallback)
void traverse (Node *node, NodeVisitor *nv)
 Call any nested callbacks and then traverse the scene graph.
void setNestedCallback (NodeCallback *nc)
NodeCallbackgetNestedCallback ()
const NodeCallbackgetNestedCallback () const
void addNestedCallback (NodeCallback *nc)
void removeNestedCallback (NodeCallback *nc)
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 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.
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type.
virtual bool isSameKindAs (const Object *) const
virtual const char * libraryName () const =0
 return the name of the object's library.
virtual const char * className () const =0
 return the name of the object's class type.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience 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.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.
- 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)
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
- Protected Attributes inherited from osgGA::GUIEventHandler
unsigned int _ignoreHandledEventsMask

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.
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting.
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.
- Public Attributes inherited from osg::NodeCallback
ref_ptr< NodeCallback_nestedCallback

Detailed Description

Event handler for adding on screen stats reporting to Viewers.

Member Typedef Documentation

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

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
int osgViewer::StatsHandler::_keyEventToggleVSync
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:

osg logo
Generated at Fri Sep 7 2012 02:21:34 for the OpenSceneGraph by doxygen 1.8.1.2.