/*---------------------------------------------------------------------------* Project: NintendoWare File: gfx_ResSkeleton.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: $ *---------------------------------------------------------------------------*/ #ifndef NW_GFX_RESSKELETON_H_ #define NW_GFX_RESSKELETON_H_ #include #include #include #include #include namespace nw { namespace gfx { namespace res { //! @details :private struct ResBoneData { enum Flag { FLAG_IS_IDENTITY = 0x1 << 0, FLAG_IS_TRANSLATE_ZERO = 0x1 << 1, FLAG_IS_ROTATE_ZERO = 0x1 << 2, FLAG_IS_SCALE_ONE = 0x1 << 3, FLAG_IS_UNIFORM_SCALE = 0x1 << 4, FLAG_IS_SEGMENTSCALE_COMPENSATE = 0x1 << 5, FLAG_IS_NEED_RENDERING = 0x1 << 6, FLAG_IS_LOCAL_MATRIX_CALCULATE = 0x1 << 7, FLAG_IS_WORLD_MATRIX_CALCULATE = 0x1 << 8, FLAG_HAS_SKINNING_MATRIX = 0x1 << 9 }; nw::ut::BinString toName; nw::ut::ResU32 m_Flags; nw::ut::ResS32 m_Index; nw::ut::ResS32 m_ParentBoneIndex; nw::ut::Offset toParentBone; nw::ut::Offset toChildBone; nw::ut::Offset toPrevSibling; nw::ut::Offset toNextSibling; nw::ut::ResTransform3 m_Transform; nw::ut::ResMtx34 m_LocalMatrix; nw::ut::ResMtx34 m_WorldMatrix; // 行列計算用のバッファへ正式対応後、削除予定。 nw::ut::ResMtx34 m_InverseBaseMatrix; nw::ut::ResS32 m_BillboardMode; nw::ut::ResS32 m_UserDataDicCount; nw::ut::Offset toUserDataDic; }; //! @details :private struct ResSkeletonData : public ResSceneObjectData { enum Flag { FLAG_MODEL_COORDINATE = 0x1 << 0, FLAG_TRANSLATE_ANIMATION_ENABLED = 0x1 << 1 }; nw::ut::ResS32 m_BonesDicCount; nw::ut::Offset toBonesDic; nw::ut::Offset toRootBone; nw::ut::ResS32 m_ScalingRule; nw::ut::ResU32 m_Flags; }; //-------------------------------------------------------------------------- //! @brief スケルタルモデルのボーンを表すバイナリリソースクラスです。 //--------------------------------------------------------------------------- class ResBone : public nw::ut::ResCommon< ResBoneData > { public: //! ビルボードの種類の定義です。 enum BillboardMode { BILLBOARD_MODE_OFF, //!< ビルボード処理を行いません。 BILLBOARD_MODE_WORLD, //!< Z 軸が視点軸と平行となるように回転させます。 BILLBOARD_MODE_WORLD_VIEWPOINT, //!< Z 軸が視点方向に向くように回転させます。 BILLBOARD_MODE_SCREEN, //!< Z 軸が視点軸と平行で、Y 軸が画面上方向になるように回転させます。 BILLBOARD_MODE_SCREEN_VIEWPOINT, //!< Z 軸が視点方向に向くき、Y 軸が画面上方向になるように回転させます。 BILLBOARD_MODE_Y_AXIAL, //!< Z 軸が視点軸と平行となるように Y 軸だけ 回転させます。 BILLBOARD_MODE_Y_AXIAL_VIEWPOINT //!< Z 軸が視点方向に向くように Y 軸だけ 回転させます。 }; NW_RES_CTOR( ResBone ) //--------------------------------------------------------------------------- //! @fn void SetWorldMatrix(const nw::math::MTX34 & value) //! @brief ワールドマトリクスを設定します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn void SetTransform(const nw::math::Transform3 & value) //! @brief トランスフォーム情報を設定します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn void SetParentBoneIndex(s32 value) //! @brief 親ボーンのインデックス番号を設定します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn void SetLocalMatrix(const nw::math::MTX34 & value) //! @brief ローカルマトリクスを設定します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn void SetInverseBaseMatrix(const nw::math::MTX34 & value) //! @brief ベースマトリクスの逆行列を設定します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn void SetIndex(s32 value) //! @brief インデックス番号を設定します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn void SetFlags(u32 value) //! @brief フラグの値を設定します。 //! 設定されなかったフラグは無効になります。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn void EnableFlags(u32 value) //! @brief 指定された Flag の値を有効にします。 //! 設定されなかったフラグは変更されません。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn void DisableFlags(u32 value) //! @brief 指定された Flag の値を無効にします。 //! 設定されなかったフラグは変更されません。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn void SetBillboardMode(BillboardMode value) //! @brief ビルボード表示のモードを設定します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn nw::math::MTX34 & GetWorldMatrix() //! @brief ワールドマトリクスを取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn nw::math::Transform3 & GetTransform() //! @brief トランスフォーム情報を取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn ResBone GetPrevSibling() //! @brief 前の兄弟ボーンを取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn s32 GetParentBoneIndex() const //! @brief 親ボーンのインデックス番号を取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn ResBone GetParentBone() //! @brief 親ボーンを取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn ResBone GetNextSibling() //! @brief 次の兄弟ボーンを取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn const char * GetName() const //! @brief 名前を取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn nw::math::MTX34 & GetLocalMatrix() //! @brief ローカルマトリクスを取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn nw::math::MTX34 & GetInverseBaseMatrix() //! @brief ベースマトリクスの逆行列を取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn s32 GetIndex() const //! @brief インデックス番号を取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn u32 GetFlags() const //! @brief フラグの値を取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn ResBone GetChildBone() //! @brief 子ボーンを取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn BillboardMode GetBillboardMode() const //! @brief ビルボード表示のモードを取得します。 //--------------------------------------------------------------------------- NW_RES_FIELD_STRING_DECL( Name ) // GetName() NW_RES_FIELD_FLAGS_DECL( u32, Flags ) // GetFlags(), SetFlags(), EnableFlags(), DisableFlags() NW_RES_FIELD_PRIMITIVE_DECL( s32, Index ) // GetIndex(), SetIndex() NW_RES_FIELD_PRIMITIVE_DECL( s32, ParentBoneIndex ) // GetParentBoneIndex(), SetParentBoneIndex() NW_RES_FIELD_CLASS_DECL( ResBone, ParentBone ) // GetParentBone() NW_RES_FIELD_CLASS_DECL( ResBone, ChildBone ) // GetChildBone() NW_RES_FIELD_CLASS_DECL( ResBone, PrevSibling ) // GetPrevSibling() NW_RES_FIELD_CLASS_DECL( ResBone, NextSibling ) // GetNextSibling() NW_RES_FIELD_STRUCT_DECL( nw::math::Transform3, Transform ) // GetTransform() NW_RES_FIELD_STRUCT_DECL( nw::math::MTX34, LocalMatrix ) // GetLocalMatrix() NW_RES_FIELD_STRUCT_DECL( nw::math::MTX34, WorldMatrix ) // 行列計算用のバッファへ正式対応後、削除予定。 NW_RES_FIELD_STRUCT_DECL( nw::math::MTX34, InverseBaseMatrix ) // GetInverseBaseMatrix() NW_RES_FIELD_PRIMITIVE_DECL( BillboardMode, BillboardMode ) // GetBillboardMode(), SetBillboardMode() //--------------------------------------------------------------------------- //! @fn s32 GetUserDataIndex(const char * key) const //! @brief ユーザデータの辞書データ中でのインデックス番号を取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn s32 GetUserDataCount() const //! @brief ユーザデータの要素数を取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn nw::ut::ResMetaData GetUserData(int idx) //! @brief ユーザデータを取得します。 //--------------------------------------------------------------------------- NW_RES_FIELD_CLASS_DIC_DECL( nw::ut::ResMetaData, UserData, nw::ut::ResDicPatricia ) // GetMetaData(int idx), GetMetaData(const char*), GetMetaDataIndex(const char*), GetMetaDataCount() }; typedef nw::ut::ResArrayPatricia::type ResBoneArray; //-------------------------------------------------------------------------- //! @brief ボーンを束ねるスケルトンを表すバイナリリソースクラスです。 //--------------------------------------------------------------------------- class ResSkeleton : public ResSceneObject { public: enum Flag { FLAG_MODEL_COORDINATE = 0x1 << 0, FLAG_TRANSLATE_ANIMATION_ENABLED = 0x1 << 1 }; enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResSkeleton) }; enum { SIGNATURE = NW_RES_SIGNATURE32('CSKL') }; NW_RES_CTOR_INHERIT( ResSkeleton, ResSceneObject ) //--------------------------------------------------------------------------- //! @fn void SetScalingRule(s32 value) //! @brief スケールの方式を設定します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn void SetFlags(u32 value) //! @brief Flag の値を設定します。 //! ワールド座標、モデル座標などを設定できます。 //! 設定されなかったフラグは無効になります。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn void EnableFlags(u32 value) //! @brief 指定された Flag の値を有効にします。 //! 設定されなかったフラグは変更されません。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn void DisableFlags(u32 value) //! @brief 指定された Flag の値を無効にします。 //! 設定されなかったフラグは変更されません。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn s32 GetScalingRule() const //! @brief スケールの方式を取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn ResBone GetRootBone() //! @brief ルートのボーンを取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn u32 GetFlags() const //! @brief フラグの値を取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn s32 GetBonesIndex(const char * key) const //! @brief ボーンの辞書データ中でのインデックス番号を取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn s32 GetBonesCount() const //! @brief ボーンの要素数を取得します。 //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- //! @fn ResBone GetBones(int idx) //! @brief ボーンを取得します。 //--------------------------------------------------------------------------- NW_RES_FIELD_CLASS_DIC_DECL( ResBone, Bones, nw::ut::ResDicPatricia ) // GetBones(int idx), GetBones(const char*), GetBonesIndex(const char*), GetBonesCount() NW_RES_FIELD_CLASS_DECL( ResBone, RootBone ) // GetRootBone() NW_RES_FIELD_PRIMITIVE_DECL( s32, ScalingRule ) // GetScalingRule(), SetScalingRule() NW_RES_FIELD_FLAGS_DECL( u32, Flags ) // GetFlags(), SetFlags(), EnableFlags(), DisableFlags() }; } // namespace res } // namespace gfx } // namespace nw #endif // NW_GFX_RESSKELETON_H_