xref: /NW4C-2.0.3/include/nw/lyt/lyt_Util.h

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

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

  These coded instructions, statements, and computer programs contain proprietary
  information of Nintendo and/or its licensed developers and are protected by
  national and international copyright laws. 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.

  The content herein is highly confidential and should be handled accordingly.

  $Revision: 31311 $
 *---------------------------------------------------------------------------*/

#ifndef NW_LYT_UTIL_H_
#define NW_LYT_UTIL_H_

#include <nw/lyt/lyt_Types.h>

namespace nw
{
namespace math
{

struct VEC2;
struct MTX23;

} // namespace nw::math

namespace lyt
{

class Pane;
class Layout;
class DrawInfo;
class Group;
class AnimTransform;
class TexMap;

//----------------------------------------
//! @name アニメーション
//@{

//---------------------------------------------------------------------------
//! @brief グループ内の個々のペインにアニメーションを関連付けます。
//!
//! @param pGroup グループへのポインタです。
//! @param pAnimTrans アニメーションへのポインタです。
//! @param bRecursive 子ペインも検索する場合は true を指定します。
//! @param bDisable アニメーションを無効状態で関連付ける場合は true を指定します。
//!
//! @details
//! bRecursive に true を渡して呼び出した場合は、関連付けるペインを
//! 子ペインからも検索します。
//!
//! bDisable に true を渡して呼び出した場合は、アニメーションを無効状態で
//! 関連付けます。
//! 有効にする場合は、 SetAnimationEnable() を使用してください。
//!
//! @sa nw::lyt::UnbindAnimation
//! @sa nw::lyt::Pane::BindAnimation
//! @sa nw::lyt::Pane::SetAnimationEnable
//!
//! @since 2009/09/18 初版。
//---------------------------------------------------------------------------
void                BindAnimation(
                        Group*          pGroup,
                        AnimTransform*  pAnimTrans,
                        bool            bRecursive  = true,
                        bool            bDisable    = false);

//---------------------------------------------------------------------------
//! @brief グループ内の個々のペインからアニメーションの関連付けを解除します。
//!
//! @param pGroup グループへのポインタです。
//! @param pAnimTrans アニメーションへのポインタです。
//! @param bRecursive 子ペインも検索する場合は true を指定します。
//!
//! @sa nw::lyt::BindAnimation
//! @sa nw::lyt::Pane::UnbindAnimation
//!
//! @since 2009/09/18 初版。
//---------------------------------------------------------------------------
void                UnbindAnimation(
                        Group*          pGroup,
                        AnimTransform*  pAnimTrans,
                        bool            bRecursive = true);

//---------------------------------------------------------------------------
//! @brief グループ内の個々のペインに対して、アニメーションの
//! 有効／無効状態を設定します。
//!
//! @param pGroup グループへのポインタです。
//! @param pAnimTrans アニメーションへのポインタです。
//! @param bEnable 有効にする場合は true を指定します。
//! @param bRecursive 子ペインも検索する場合は true を指定します。
//!
//! @details
//! bRecursive に true を渡して呼び出した場合は、設定するペインを子ペイン
//! からも検索します。
//!
//! @since 2009/09/18 初版。
//---------------------------------------------------------------------------
void                SetAnimationEnable(
                        Group*          pGroup,
                        AnimTransform*  pAnimTrans,
                        bool            bEnable,
                        bool            bRecursive = true);

//@}

//----------------------------------------
//! @name ヒットチェック
//@{

//---------------------------------------------------------------------------
//! @brief ペインが指定した点を含むかどうかを判定します。
//!
//! @param pPane ペインへのポインタです。
//! @param pos チェックする点の位置です。
//!
//! @return ペインが pos で指定した点を含む場合は true を返します。
//!
//! @details
//! ペインの で指定した点を含むかどうかを判別します。
//!
//! Pane::CalculateMtx() によって計算された行列の値を使用するため、
//! この関数を呼び出す前に、 Pane::CalculateMtx() が呼び出されている
//! 必要があります。
//!
//! この関数は、ペインの回転の x, y の値が 0 であることを前提にしています。
//! 0 以外の値の場合は正しく判定できません。
//!
//! @sa nw::lyt::FindHitPane
//!
//! @since 2009/09/18 初版。
//---------------------------------------------------------------------------
bool                IsContain(
                        Pane*               pPane,
                        const math::VEC2&   pos);

//---------------------------------------------------------------------------
//! @brief 指定した点を含むペインを検索します。
//!
//! @param pPane ペインへのポインタです。
//! @param pos チェックする点の位置です。
//!
//! @return 指定した点を含む境界ペインが見つかった場合は境界ペインへの
//! ポインタを、見つからなかった場合は NULL を返します。
//!
//! @details
//! pos で指定した点を含む境界ペインを検索します。検索順は、描画順と逆の
//! 順序になります。非表示のペインとその子階層は検索対象になりません。
//!
//! pPane で指定したペインをルートとして検索します。
//!
//! @since 2009/09/18 初版。
//---------------------------------------------------------------------------
Pane*               FindHitPane(
                        Pane*               pPane,
                        const math::VEC2&   pos);

//---------------------------------------------------------------------------
//! @brief 指定した点を含むペインを検索します。
//!
//! @param pLayout レイアウトへのポインタです。
//! @param pos チェックする点の位置です。
//!
//! @return 指定した点を含む境界ペインが見つかった場合は境界ペインへの
//! ポインタを、見つからなかった場合は NULL を返します。
//!
//! @details
//! pos で指定した点を含む境界ペインを検索します。検索順は、描画順と逆の
//! 順序になります。非表示のペインとその子階層は検索対象になりません。
//!
//! レイアウト全てのペインを検索対象とします。
//!
//! Pane::CalculateMtx() によって計算された行列の値を使用するため、
//! この関数を呼び出す前に、 Pane::CalculateMtx() が呼び出されている
//! 必要があります。
//!
//! この関数は、ペインの回転の x, y の値が 0 であることを前提にしています。」
//! 0 以外の値の場合は正しく判定できません。
//!
//! @since 2009/09/18 初版。
//---------------------------------------------------------------------------
Pane*               FindHitPane(
                        Layout*             pLayout,
                        const math::VEC2&   pos);

//@}

//---------------------------------------------------------------------------
//! @brief ペインの子供、あるいは兄弟のペインのポインタを返します。
//!
//! @param pPane ペインへのポインタです。
//!
//! @return ペインの子供、あるいは兄弟のペインのポインタを返します。
//! 該当するペインが無い場合は NULL を返します。
//!
//! @details
//! 引数 pPane で指定されたペインの子供、あるいは兄弟のペインを返します。
//! 最初にルートペインを引数にして呼び出し、以後 NULL が返るまで返り値を引数に
//! 設定して呼び出すことで、全てのペインを列挙することが出来ます。
//!
//! @since 2009/09/18 初版。
//---------------------------------------------------------------------------
Pane*               GetNextPane(Pane* pPane);

//---------------------------------------------------------------------------
//! @brief テクスチャをロードします。
//!
//! @details
//! texLoadFlag が 0 の場合、テクスチャリソースに設定されたメモリ配置に
//! 従います。
//! テクスチャリソースへのメモリ配置の設定は TexResource::SetImageArea()
//! を参照してください。
//!
//! テクスチャリソースでメモリ配置が指定されない場合には
//! NN_GX_MEM_FCRAM | GL_NO_COPY_FCRAM_DMP が指定されます。
//!
//! 本関数でロードしたテクスチャは DeleteTexture() で破棄してください。
//!
//! Layout::SetLayoutDrawEnable()が true に設定されている場合には
//! DMPGL のテクスチャオブジェクトを生成します。
//!
//! Layout::SetLayoutDrawEnable()が false に設定されている場合、
//! または NW_LYT_DMPGL_ENABLED が未定義の場合には、
//! DMPGL のテクスチャオブジェクトは生成しません。
//! TextureInfo のテクスチャオブジェクト・フィールドはテクスチャの破棄に
//! 必要な情報の保持に使用されます。
//!
//! @param pImgRes リソースです。
//! @param size リソースのサイズです。
//! @param texLoadFlag ロード方法を制御するフラグです。
//!
//! @return テクスチャ情報を返します。
//!
//! @sa DeleteTexture
//! @sa TexResource::SetImageArea
//! @sa Layout::SetLayoutDrawEnable
//!
//! @since 2009/09/18 初版。
//! @date 2010/06/18 texLoadFlag 引数を追加しました。
//! @date 2011/02/28 テクスチャリソースの設定によるメモリ配置について加筆しました。
//! @date 2011/02/28 DeleteTexture() について加筆しました。
//---------------------------------------------------------------------------
const TextureInfo   LoadTexture(const void* pImgRes, u32 size, int texLoadFlag = 0);

//---------------------------------------------------------------------------
//! @brief テクスチャを破棄します。
//!
//! @details
//! LoadTexture() でロードしたテクスチャを破棄します。
//!
//! LoadTexture() と DeleteTexture() の呼び出し時には
//! Layout::SetLayoutDrawEnable() は同じ設定がされていなければなりません。
//!
//! @param[in] texInfo テクスチャ情報です。
//!
//! @sa LoadTexture
//! @sa Layout::SetLayoutDrawEnable
//!
//! @since 2011/02/28 初版。
//---------------------------------------------------------------------------
void DeleteTexture(const TextureInfo& texInfo);

//---------------------------------------------------------------------------
//! @brief テクスチャの座標変換行列を求めます。
//!
//! @param[out] pTexMtx 計算結果の格納先です。
//! @param texSRT テクスチャのSRT情報です。
//! @param texMap テクスチャ情報です。
//!
//! @since 2010/03/26 初版。
//---------------------------------------------------------------------------
void CalcTextureMtx(math::MTX23* pTexMtx, const TexSRT& texSRT, const TexMap& texMap);

} // namespace nw::lyt
} // namespace nw

#endif // NW_LYT_UTIL_H_