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

Go to the documentation of this file.

// Copyright 2006-2011 by Kat'Oun

#ifndef _OVERLAY_H_
#define _OVERLAY_H_

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

namespace render
{

enum MetricsMode
{
        MM_RELATIVE,                            // 'left', 'top', 'height' and 'width' are parametrics from 0.0 to 1.0
        MM_PIXELS,                                      // Positions & sizes are in absolute pixels
        MM_RELATIVE_ASPECT_ADJUSTED     // Positions & sizes are in virtual pixels
};

enum HorizontalAlignment
{
        HA_LEFT,
        HA_CENTER,
        HA_RIGHT
};

enum VerticalAlignment
{
        VA_TOP,
        VA_CENTER,
        VA_BOTTOM
};


class Material;
class VertexData;
class IndexData;

class ENGINE_PUBLIC_EXPORT Overlay: public Renderable
{
public:

        Overlay();
        Overlay(const std::string& name);

        virtual ~Overlay();

        void setPosition(f32 x, f32 y);

        void setDimension(f32 width, f32 height);

        f32 getWidth();
        f32 getHeight();

        virtual void setMetricsMode(MetricsMode mm);
        MetricsMode getMetricsMode() const;

        virtual Material* getMaterial() const;

        void getRenderOperation(RenderOperation& ro);

protected:

        // Incremented count for next Index
        static u32 msNextGeneratedOverlayIndex;

        void initProperties();

        Material* mMaterial;

        VertexData* mVertexData;

        IndexData* mIndexData;

        f32 mWidth;
        f32 mHeight;

        MetricsMode mMetricsMode;

        f32 mU1, mV1, mU2, mV2;

        void updateImpl(f32 elapsedTime);

        bool mGeometryInitialized;

        bool mGeomPositionsOutOfDate;
        bool mGeomUVsOutOfDate;

        virtual void updatePositionBinding() = 0;
        virtual void updateTextureBinding() = 0;

        bool mModifiedWorldTransform;

        void updateWorldTransform();
};

} //namespace render

#endif