openscenegraph
osgAnimation::StatsHandler Class Reference

#include <StatsHandler>

Inheritance diagram for osgAnimation::StatsHandler:
osgGA::GUIEventHandler osgGA::EventHandler osg::NodeCallback osg::DrawableEventCallback osg::Callback osg::Callback osg::Object osg::Object osg::Referenced osg::Referenced

Public Types

enum  StatsType { NO_STATS = 0 , FRAME_RATE = 1 , LAST = 2 }
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::CameragetCamera ()
const osg::CameragetCamera () const
virtual bool handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa)
virtual void getUsage (osg::ApplicationUsage &usage) const
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 NodeCallbackasNodeCallback ()
virtual const NodeCallbackasNodeCallback () const
virtual DrawableEventCallbackasDrawableEventCallback ()
virtual const DrawableEventCallbackasDrawableEventCallback () const
virtual EventHandlerasEventHandler ()
virtual const EventHandlerasEventHandler () const
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)
virtual CallbackasCallback ()
virtual const CallbackasCallback () const
virtual CallbackObjectasCallbackObject ()
virtual const CallbackObjectasCallbackObject () const
virtual StateAttributeCallbackasStateAttributeCallback ()
virtual const StateAttributeCallbackasStateAttributeCallback () const
virtual UniformCallbackasUniformCallback ()
virtual const UniformCallbackasUniformCallback () const
virtual DrawableUpdateCallbackasDrawableUpdateCallback ()
virtual const DrawableUpdateCallbackasDrawableUpdateCallback () const
virtual DrawableCullCallbackasDrawableCullCallback ()
virtual const DrawableCullCallbackasDrawableCullCallback () const
bool traverse (osg::Object *object, osg::Object *data)
void setNestedCallback (osg::Callback *cb)
osg::CallbackgetNestedCallback ()
const osg::CallbackgetNestedCallback () 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 ObjectcloneType () const =0
virtual Objectclone (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 NodeasNode ()
virtual const NodeasNode () const
virtual NodeVisitorasNodeVisitor ()
virtual const NodeVisitorasNodeVisitor () const
virtual StateSetasStateSet ()
virtual const StateSetasStateSet () const
virtual StateAttributeasStateAttribute ()
virtual const StateAttributeasStateAttribute () const
virtual UniformasUniform ()
virtual const UniformasUniform () const
virtual CameraasCamera ()
virtual const CameraasCamera () const
virtual DrawableasDrawable ()
virtual const DrawableasDrawable () const
virtual UserDataContainerasUserDataContainer ()
virtual const UserDataContainerasUserDataContainer () const
virtual ValueObjectasValueObject ()
virtual const ValueObjectasValueObject () const
virtual ImageasImage ()
virtual const ImageasImage () 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)
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
template<class T>
void setUserData (const ref_ptr< T > &ud)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () 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 &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const
Public Member Functions inherited from osg::DrawableEventCallback
 DrawableEventCallback ()
 DrawableEventCallback (const DrawableEventCallback &org, const CopyOp &copyop)
 META_Object (osg, DrawableEventCallback)

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)
osg::NodecreateCameraTimeStats (const std::string &font, osg::Vec3 &pos, float startBlocks, bool acquireGPUStats, float characterSize, osg::Stats *viewerStats, osg::Camera *camera)
void setUpScene (osgViewer::Viewer *viewer)
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::Group_group
unsigned int _frameRateChildNum
unsigned int _numBlocks
double _blockMultiplier
float _statsWidth
float _statsHeight
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::MutexgetGlobalReferencedMutex ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()

Detailed Description

Event handler for adding on screen stats reporting to Viewers.

Member Enumeration Documentation

◆ StatsType

Enumerator
NO_STATS 
FRAME_RATE 
LAST 

Constructor & Destructor Documentation

◆ StatsHandler()

osgAnimation::StatsHandler::StatsHandler ( )

Member Function Documentation

◆ createBackgroundRectangle()

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

◆ createCameraTimeStats()

osg::Node * osgAnimation::StatsHandler::createCameraTimeStats ( const std::string & font,
osg::Vec3 & pos,
float startBlocks,
bool acquireGPUStats,
float characterSize,
osg::Stats * viewerStats,
osg::Camera * camera )
protected

◆ createFrameMarkers()

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

◆ createGeometry()

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

◆ createTick()

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

◆ getBlockMultiplier()

double osgAnimation::StatsHandler::getBlockMultiplier ( ) const
inline

References _blockMultiplier.

◆ getCamera() [1/2]

osg::Camera * osgAnimation::StatsHandler::getCamera ( )
inline

References _camera.

◆ getCamera() [2/2]

const osg::Camera * osgAnimation::StatsHandler::getCamera ( ) const
inline

References _camera.

◆ getKeyEventPrintsOutStats()

int osgAnimation::StatsHandler::getKeyEventPrintsOutStats ( ) const
inline

◆ getKeyEventTogglesOnScreenStats()

int osgAnimation::StatsHandler::getKeyEventTogglesOnScreenStats ( ) const
inline

◆ getUsage()

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

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::EventHandler.

◆ handle()

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

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

Reimplemented from osgGA::GUIEventHandler.

◆ reset()

void osgAnimation::StatsHandler::reset ( )

◆ setKeyEventPrintsOutStats()

void osgAnimation::StatsHandler::setKeyEventPrintsOutStats ( int key)
inline

◆ setKeyEventTogglesOnScreenStats()

void osgAnimation::StatsHandler::setKeyEventTogglesOnScreenStats ( int key)
inline

◆ setUpHUDCamera()

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

◆ setUpScene()

void osgAnimation::StatsHandler::setUpScene ( osgViewer::Viewer * viewer)
protected

Member Data Documentation

◆ _blockMultiplier

double osgAnimation::StatsHandler::_blockMultiplier
protected

Referenced by getBlockMultiplier().

◆ _camera

osg::ref_ptr<osg::Camera> osgAnimation::StatsHandler::_camera
protected

Referenced by getCamera(), and getCamera().

◆ _frameRateChildNum

unsigned int osgAnimation::StatsHandler::_frameRateChildNum
protected

◆ _group

osg::ref_ptr<osg::Group> osgAnimation::StatsHandler::_group
protected

◆ _initialized

bool osgAnimation::StatsHandler::_initialized
protected

◆ _keyEventPrintsOutStats

int osgAnimation::StatsHandler::_keyEventPrintsOutStats
protected

◆ _keyEventTogglesOnScreenStats

int osgAnimation::StatsHandler::_keyEventTogglesOnScreenStats
protected

◆ _numBlocks

unsigned int osgAnimation::StatsHandler::_numBlocks
protected

◆ _statsHeight

float osgAnimation::StatsHandler::_statsHeight
protected

◆ _statsType

int osgAnimation::StatsHandler::_statsType
protected

◆ _statsWidth

float osgAnimation::StatsHandler::_statsWidth
protected

◆ _switch

osg::ref_ptr<osg::Switch> osgAnimation::StatsHandler::_switch
protected

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