OgreOverlayProfileSessionListener.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/

#ifndef __OverlayProfileSessionListener_H__
#define __OverlayProfileSessionListener_H__

#include "OgreOverlayPrerequisites.h"
#include "OgreProfiler.h"
#include "OgreOverlay.h"

namespace Ogre  {

    class _OgreOverlayExport OverlayProfileSessionListener : public ProfileSessionListener
    {
    public:
        OverlayProfileSessionListener();
        virtual ~OverlayProfileSessionListener();

        virtual void initializeSession();

        virtual void finializeSession();

        virtual void displayResults(const ProfileInstance& instance, ulong maxTotalFrameTime);

        virtual void changeEnableState(bool enabled);

        void setOverlayDimensions(Real width, Real height);

        void setOverlayPosition(Real left, Real top);

        Real getOverlayWidth() const;
        Real getOverlayHeight() const;
        Real getOverlayLeft() const;
        Real getOverlayTop() const;

    private:
        typedef list<OverlayElement*>::type ProfileBarList;

        void displayResults(ProfileInstance* instance, ProfileBarList::const_iterator& bIter, Real& maxTimeMillisecs, Real& newGuiHeight, int& profileCount);

        OverlayContainer* createContainer();

        OverlayElement* createTextArea(const String& name, Real width, Real height, Real top, Real left, 
                                    uint fontSize, const String& caption, bool show = true);

        OverlayElement* createPanel(const String& name, Real width, Real height, Real top, Real left, 
                                const String& materialName, bool show = true);

        ProfileBarList mProfileBars;

        Overlay* mOverlay;

        OverlayContainer* mProfileGui;

        Real mBarHeight;

        Real mGuiHeight;

        Real mGuiWidth;

        Real mGuiLeft;

        Real mGuiTop;

        Real mBarIndent;

        Real mGuiBorderWidth;

        Real mBarLineWidth;

        Real mBarSpacing;

        uint mMaxDisplayProfiles;
    };
}
#endif