CEGUIRenderingWindow.h

/***********************************************************************
    filename:   CEGUIRenderingWindow.h
    created:    Mon Jan 12 2009
    author:     Paul D Turner
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
 *
 *   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 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 _CEGUIRenderingWindow_h_
#define _CEGUIRenderingWindow_h_

#include "CEGUIRenderingSurface.h"
#include "CEGUIVector.h"
#include "CEGUISize.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT RenderingWindow : public RenderingSurface
{
public:
    RenderingWindow(TextureTarget& target, RenderingSurface& owner);

    ~RenderingWindow();

    void setClippingRegion(const Rect& region);

    void setPosition(const Vector2& position);

    void setSize(const Size& size);

    void setRotation(const Vector3& rotation);

    void setPivot(const Vector3& pivot);

    const Vector2& getPosition() const;

    const Size& getSize() const;

    const Vector3& getRotation()const;

    const Vector3& getPivot() const;

    const TextureTarget& getTextureTarget() const;
    TextureTarget& getTextureTarget();

    void update(const float elapsed);

    void setRenderEffect(RenderEffect* effect);

    RenderEffect* getRenderEffect();

    void realiseGeometry();

    void invalidateGeometry();

    const RenderingSurface& getOwner() const;
    RenderingSurface& getOwner();

    void unprojectPoint(const Vector2& p_in, Vector2& p_out);

    // overrides from base
    void draw();
    void invalidate();
    bool isRenderingWindow() const;

protected:
    virtual void realiseGeometry_impl();

    void setOwner(RenderingSurface& owner);
    // friend is so that RenderingSurface can call setOwner to xfer ownership.
    friend void RenderingSurface::transferRenderingWindow(RenderingWindow&);

    Renderer& d_renderer;
    TextureTarget& d_textarget;
    RenderingSurface* d_owner;
    GeometryBuffer* d_geometry;
    bool d_geometryValid;
    Vector2 d_position;
    Size d_size;
    Vector3 d_rotation;
    Vector3 d_pivot;
};

} // End of  CEGUI namespace section

#endif  // end of guard _CEGUIRenderingWindow_h_