E:/Programming/MyProject/K_Game_hg/GameEngine/include/render/Viewport.h

Go to the documentation of this file.

// Copyright 2006-2011 by Kat'Oun

#ifndef _VIEWPORT_H_
#define _VIEWPORT_H_

#include <EngineConfig.h>
#include <core/Types.h>
#include <render/Color.h>
#include <engine/Object.h>

namespace render
{

class Camera;
class RenderTarget;

class ENGINE_PUBLIC_EXPORT Viewport: public engine::Object
{
public:

        Viewport(Camera* camera, RenderTarget* target, f32 left, f32 top, f32 width, f32 height);
        Viewport(const std::string& name, Camera* camera, RenderTarget* target, f32 left, f32 top, f32 width, f32 height);
        ~Viewport();

        void updateDimensions();

        RenderTarget* getTarget();
        Camera* getCamera();
        f32 getLeft();
        f32 getTop();
        f32 getWidth();
        f32 getHeight();
        s32 getActualLeft();
        s32 getActualTop();
        s32 getActualWidth();
        s32 getActualHeight();
        

        void setDimensions(f32 left, f32 top, f32 width, f32 height);

        void setBackgroundColor(Color& color);
        Color getBackgroundColor();

        void setClearEveryFrame(bool clear);

        bool getClearEveryFrame();

        void getActualDimensions(s32& left, s32& top, s32& width, s32& height);

        bool isUpdated();

        void setVisible(bool enabled);
        bool isVisible();

        void notifyRenderedFaces(u32 numfaces);
        u32 getNumRenderedFaces() const;

        void setShowOverlays(bool enabled);
        bool getShowOverlays();

        void clearUpdatedFlag();

protected:

        // Incremented count for next index
        static u32 msNextGeneratedViewportIndex;

        void initProperties();

        void updateImpl(f32 elapsedTime);

        Camera* mCamera;
        RenderTarget* mTarget;

        // Relative dimensions, irrespective of target dimensions (0..1)
        f32 mRelLeft, mRelTop, mRelWidth, mRelHeight;
        // Actual dimensions, based on target dimensions
        s32 mActLeft, mActTop, mActWidth, mActHeight;
        
        // Stored number of visible faces in the last render
        u32 mRenderedFaces;

        // Background options
        Color mBackColor;
        bool mClearEveryFrame;

        bool mUpdated;

        bool mIsVisible;

        bool mShowOverlays;
};

} // end namespace render

#endif