statistics.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::Statistics class.  Tracks and displays runtime performance.
 
  \par Copyright Information
 
  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>
 
  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.
 
  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
 
  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).
 
  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.
 
*/
#ifndef STATISTICS_H
#define STATISTICS_H
 
#include "display_frame.h"
#include "glpolygon.h"
#include "group.h"
#include "timer.h"
#ifdef GLES
#    include "gls_quad_storage.h"
#endif
 
namespace disti
{
/** Provides basic runtime performance statistics.
  * Functionality is built into glsDisplayFrame
  */
class Statistics : public Group
{
private:
    typedef struct
    {
        unsigned long startTime;     /** Absolute (from start of program) uS */
        unsigned long drawTime;      /** Relative (from start of draw) uS  */
        unsigned long preDrawTime;   /** Relative (from start of predraw) uS */
        unsigned long calculateTime; /** Relative (from start of calculate) uS */
    } frameDataType;
    frameDataType* historyArray;
    Vertex*        drawLineVerts;
    Vertex*        preDrawLineVerts;
    Vertex*        calculateLineVerts;
    Vertex*        hzLineVerts;
    unsigned int   numFrames;
    unsigned long  _frameInterval;
    int            historyState;
    int            drawState;
    Timer          longTimer;
    Timer          shortTimer;
    DisplayFrame*  parentDisplay;
    unsigned int   currentIndex;
    unsigned int   NextIndex( int index );
    unsigned int   PrevIndex( int index );
    float          _initialWidth;
    float          _initialHeight;
    bool           _textVisible;
 
#ifdef GLES
    GlsQuadListVCT_2D _textQuadStorage;
    GlsQuadListVC_3D  _graphQuadStorage;
#endif
 
public:
    /** The current average frame rate in updates per second */
    float averageHz;
 
    Group*     statsGraphGroup;         ///< The group containing the statistics graph.
    GLPolygon* statsGraphLine;          ///< The draw timeline object.
    GLPolygon* statsPreDrawGraphLine;   ///< The predraw timeline object.
    GLPolygon* statsCalculateGraphLine; ///< The calculate timeline object.
    GLPolygon* statsHzLine;             ///< The framerate timeline object.
    GLPolygon* statsBox;                ///< Bounding box for the statistics objects.
    GLPolygon* statsTargetLine;         ///< The target framerate line object.
 
    /// Constructor
    /// \param display The display frame to associate with.
    /// \param numFrames The number of frames to store in history.
    /// \param frameInterval The frame interval for the application.
    GLS_EXPORT Statistics( DisplayFrame* display, unsigned int numFrames, unsigned long frameInterval );
 
    virtual GLS_EXPORT ~Statistics();
 
    /// Marks the time at draw start.
    /// Call right before Draw().
    virtual GLS_EXPORT void RecordDrawStart();
 
    /// Marks the time at draw end.
    /// Call right after Draw().
    virtual GLS_EXPORT void RecordDrawEnd();
 
    /// Marks the time at predraw start.
    /// Call right before PreDraw().
    virtual GLS_EXPORT void RecordPreDrawStart();
 
    /// Marks the time at predraw end.
    /// Call right after PreDraw().
    virtual GLS_EXPORT void RecordPreDrawEnd();
 
    /// Marks the time at calculate start.
    /// Call right before Calculate().
    virtual GLS_EXPORT void RecordCalculateStart();
 
    /// Marks the time at calculate end.
    /// Call right after Calculate().
    virtual GLS_EXPORT void RecordCalculateEnd();
 
    virtual GLS_EXPORT void PreDraw( const OpenGLMatrices& current, Culler& culler ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void Draw() DISTI_METHOD_OVERRIDE;
 
    /// Helper method to draw the statistics themselves.
    virtual GLS_EXPORT void DrawStats();
 
    /// Toggle the statistics displays between its various states.
    /// 0: Off
    /// 1: Text and graph
    /// 2: Graph only
    /// 3: Text only
    virtual GLS_EXPORT void ToggleDisplay();
 
    /// Set the number of frames to store in statistics history.
    /// \param frames The new number of frames to store.
    virtual GLS_EXPORT void Samples( int frames );
 
    /// \return The number of frames to store in statistics history.
    virtual GLS_EXPORT int Samples();
 
    /// Set the application frame interval.
    /// \param microseconds The frame interval to set in microseconds.
    virtual GLS_EXPORT void FrameInterval( unsigned long microseconds );
};
 
} // namespace disti
 
#endif