/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     gfx_Viewport.h

  Copyright (C)2009-2010 Nintendo Co., Ltd./HAL Laboratory, Inc.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Revision: XXXXX $
 *---------------------------------------------------------------------------*/

#ifndef NW_GFX_VIEWPORT_H_
#define NW_GFX_VIEWPORT_H_

#include <nw/ut/ut_Rect.h>
#include <nw/gfx/gfx_IRenderTarget.h>

namespace nw
{
namespace gfx
{


//---------------------------------------------------------------------------
//! @brief        ビューポートを表すクラスです。
//---------------------------------------------------------------------------
class Viewport
{
public:
    //----------------------------------------
    //! @name コンストラクタ／デストラクタ
    //@{
    
    //--------------------------------------------------------------------------
    //! @brief        デフォルトコンストラクタです。
    //---------------------------------------------------------------------------
    Viewport()
    : m_DepthNear(0.f),
      m_DepthFar(1.f) {}

    //! @brief        コンストラクタです。
    //! 
    //! @param[in]    x      設定するビューポートのX座標です。
    //! @param[in]    y      設定するビューポートのY座標です。
    //! @param[in]    width  設定するビューポートの幅サイズです。
    //! @param[in]    height 設定するビューポートの縦サイズです。
    //! @param[in]    near   設定するnear値です。
    //! @param[in]    far    設定するfar値です。
    Viewport(
        float x,
        float y,
        float width,
        float height,
        float near, 
        float far )
    : m_Rect( x, y, x + width, y + height ),
      m_DepthNear(near),
      m_DepthFar(far) {}

    //! @brief        コンストラクタです。
    //! 
    //! @param[in]    rect   設定するビューポートの矩形です。
    //! @param[in]    near   設定するnear値です。
    //! @param[in]    far    設定するfar値です。
    Viewport(
        ut::Rect rect,
        float near,
        float far )
    : m_Rect( rect ),
      m_DepthNear(near),
      m_DepthFar(far) {}

    //! @brief        コンストラクタです。
    //! 
    //! @param[in]    renderTarget   設定するビューの矩形を保持する IRenderTarget です。
    //! @param[in]    near           設定するnear値です。
    //! @param[in]    far            設定するfar値です。
    Viewport(
        IRenderTarget* renderTarget,
        float near,
        float far)
    : m_DepthNear(near),
      m_DepthFar(far) 
    {
       NW_NULL_ASSERT(renderTarget);

       f32 width = static_cast<f32>(renderTarget->GetDescription().width);
       f32 height = static_cast<f32>(renderTarget->GetDescription().height);
       
       m_Rect.SetOriginAndSize(0.f, 0.f, width, height);
    }

    //! コピーコンストラクタです。
    Viewport( const Viewport& v )
    : m_Rect(v.m_Rect),
      m_DepthNear(v.m_DepthNear),
      m_DepthFar(v.m_DepthFar) {}

    //! デストラクタです。
    ~Viewport() {}

    //----------------------------------------
    //! @name 取得／設定
    //@{

    //! @brief       深度範囲を設定します。
    //! 
    //! @param[in]   near     設定するnear値です。
    //! @param[in]   far      設定するfar値です。
    void SetDepthRange(f32 near, f32 far)
    {
        m_DepthNear = near;
        m_DepthFar  = far;
    }

    //! @brief       ビューポートの矩形を設定します。
    //! 
    //! @param[in]   bound    設定するビューポートの矩形です。
    void SetBound(const ut::Rect& bound)
    {
        m_Rect = bound;
    }

    //! @brief        ビューの矩形を設定します。
    //! 
    //! @param[in]    x       設定するビューポートのX座標です。
    //! @param[in]    y       設定するビューポートのY座標です。
    //! @param[in]    width   設定するビューポートの幅サイズです。
    //! @param[in]    height  設定するビューポートの縦サイズです。
    void SetBound(float x, float y, float width, float height)
    {
        m_Rect.SetOriginAndSize( x, 
                                 y,
                                 width,
                                 height );
    }

    //! @brief       ビューの矩形を設定します。
    //! 
    //! @param[in]   renderTarget    設定するビューの矩形を保持するIRenderTargetです。
    void SetBound(IRenderTarget* renderTarget)
    {
        NW_NULL_ASSERT(renderTarget);

        m_Rect.SetOriginAndSize( 0.f, 
                                 0.f,
                                 static_cast<f32>(renderTarget->GetDescription().width),
                                 static_cast<f32>(renderTarget->GetDescription().height) );
    }

    //! @brief       ビューの矩形を取得します。
    const ut::Rect& GetBound() const { return m_Rect; }

    //! @brief       深度nearを取得します。
    f32 GetDepthNear() const { return m_DepthNear; }

    //! @brief       深度farを取得します。
    f32 GetDepthFar() const { return m_DepthFar; }

    //@}

private:
    ut::Rect m_Rect;
    f32 m_DepthNear;
    f32 m_DepthFar;
};

} // namespace gfx
} // namespace nw

#endif // NW_GFX_VIEWPORT_H_