/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     gfx_StandardSkeleton.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: 25986 $
 *---------------------------------------------------------------------------*/

#ifndef NW_GFX_STANDARDSKELETON_H_
#define NW_GFX_STANDARDSKELETON_H_

#include <nw/gfx/gfx_Skeleton.h>
#include <nw/gfx/res/gfx_ResSkeleton.h>

namespace nw
{
namespace gfx
{

//---------------------------------------------------------------------------
//! @brief        SkeletalModel 内の階層構造を表すクラスです。
//!
//! Skeleton は StandardSkeleton に変更されました。
//---------------------------------------------------------------------------
class StandardSkeleton  : public Skeleton
{
private:
    NW_DISALLOW_COPY_AND_ASSIGN(StandardSkeleton);

public:
    NW_UT_RUNTIME_TYPEINFO;

    //----------------------------------------
    //! @name 作成／破棄
    //@{

    //! @brief        スケルトンを生成します。
    //!
    //! @param[in]    resource リソースです。
    //! @param[in]    maxCallbacks コールバックの最大数です。
    //! @param[in]    isFixedSizeMemory 固定サイズのメモリで生成するかを表すフラグです。
    //! @param[in]    poseTransforms ポーズ用のトランスフォームリストです。
    //! @param[in]    allocator アロケータです。
    //!
    static StandardSkeleton* Create(
        ResSkeleton resource,
        int maxCallbacks,
        bool isFixedSizeMemory,
        Skeleton::TransformPose::TransformArray poseTransforms,
        os::IAllocator* allocator
    );
    

    //! @brief   生成時に必要なメモリサイズを取得します。
    //!
    //! @param[in]    resource リソースです。
    //! @param[in]    maxCallbacks コールバックの最大数です。
    static size_t GetMemorySize(
        ResSkeleton resource,
        int maxCallbacks, 
        size_t alignment = os::IAllocator::DEFAULT_ALIGNMENT)
    {
        os::MemorySizeCalculator size(alignment);

        GetMemorySizeInternal(&size, resource, maxCallbacks);

        return size.GetSizeWithPadding(alignment);
    }
    
    //! @details :private
    static void GetMemorySizeInternal(
        os::MemorySizeCalculator* pSize,
        ResSkeleton resource,
        int maxCallbacks)
    {
        // StandardSkeleton::Create
        os::MemorySizeCalculator& size = *pSize;

        size += sizeof(StandardSkeleton);
#ifdef NW_MOVE_ARRAY_CACHE_LINE_ALIGNMENT_ENABLED
        size.Add(sizeof(Skeleton::TransformPose::Transform) * resource.GetBonesCount(), Skeleton::TransformPose::TransformArray::MEMORY_ALIGNMENT);
        size.Add(sizeof(math::MTX34) * resource.GetBonesCount(), Skeleton::TransformPose::TransformArray::MEMORY_ALIGNMENT);
        size.Add(sizeof(math::MTX34) * resource.GetBonesCount(), Skeleton::TransformPose::TransformArray::MEMORY_ALIGNMENT);
#else
        size += sizeof(Skeleton::TransformPose::Transform) * resource.GetBonesCount();
        size += sizeof(math::MTX34) * resource.GetBonesCount();
        size += sizeof(math::MTX34) * resource.GetBonesCount();
#endif
        Skeleton::GetMemorySizeForConstruct(pSize, maxCallbacks);
    }

    //@}
    
    //----------------------------------------
    //! @name ポーズ
    //@{
    
    //! @brief        ローカルトランスフォームのポーズを取得します。
    //!
    //! @return       ローカルトランスフォームのポーズです。
    //!
    virtual TransformPose& LocalTransformPose() { return m_Pose; }
    
    //! @brief        ローカルトランスフォームのポーズを取得します。
    //!
    //! @return       ローカルトランスフォームのポーズです。
    //!
    virtual const TransformPose& LocalTransformPose() const { return m_Pose; }

    //! @brief        ワールドトランスフォームのポーズを取得します。
    //!
    //! @return       ワールドトランスフォームのポーズです。
    //!
    virtual TransformPose& WorldTransformPose() { return m_WorldTransformPose; }
    
    //! @brief        ワールドトランスフォームのポーズを取得します。
    //!
    //! @return       ワールドトランスフォームのポーズです。
    //!
    virtual const TransformPose& WorldTransformPose() const { return m_WorldTransformPose; }

    //! @brief        ワールドマトリクスのポーズを取得します。
    //!
    //! @return       ワールドマトリクスのポーズです。
    //!
    virtual MatrixPose& WorldMatrixPose() { return m_WorldMatrixPose; }
    
    //! @brief        ワールドマトリクスのポーズを取得します。
    //!
    //! @return       ワールドマトリクスのポーズです。
    //!
    virtual const MatrixPose& WorldMatrixPose() const { return m_WorldMatrixPose; }

    //! @brief        スキニングマトリクスのポーズを取得します。
    //!
    //! @return       スキニングマトリクスのポーズです。
    //!
    virtual MatrixPose& SkiningMatrixPose() { return m_SkiningMatrixPose; }
    
    //! @brief        スキニングマトリクスのポーズを取得します。
    //!
    //! @return       スキニングマトリクスのポーズです。
    //!
    virtual const MatrixPose& SkiningMatrixPose() const { return m_SkiningMatrixPose; }

    //! @brief        オリジナルポーズを取得します。
    //!
    //! @return       オリジナルポーズです。
    //!
    virtual OriginalPose& LocalOriginalPose() { return m_OriginalPose; }

    //! @brief        オリジナルポーズを取得します。
    //!
    //! @return       オリジナルポーズです。
    //!
    virtual const OriginalPose& LocalOriginalPose() const { return m_OriginalPose; }

    //@}
    
protected:
    //----------------------------------------
    //! @name コンストラクタ／デストラクタ
    //@{
    
    //! コンストラクタです。
    StandardSkeleton(
        os::IAllocator* allocator,
        ResSkeleton resource,
        int maxCallbacks,
        bool isFixedSizeMemory,
        Skeleton::TransformPose::TransformArray poseTransforms,
        Skeleton::TransformPose::TransformArray poseWorldTransforms,
        Skeleton::MatrixPose::MatrixArray poseWorldMatrices,
        Skeleton::MatrixPose::MatrixArray skiningMatrices)
    : Skeleton(allocator, resource, maxCallbacks, isFixedSizeMemory),
      m_Pose(poseTransforms),
      m_WorldTransformPose(poseWorldTransforms),
      m_WorldMatrixPose(poseWorldMatrices),
      m_SkiningMatrixPose(skiningMatrices),
      m_OriginalPose(resource)
    {
    }

    //! デストラクタです。
    virtual ~StandardSkeleton()
    {}
    
    //@}
    
private:
    TransformPose m_Pose;
    TransformPose m_WorldTransformPose;
    MatrixPose m_WorldMatrixPose;
    MatrixPose m_SkiningMatrixPose;
    OriginalPose m_OriginalPose;
};

} // namespace gfx
} // namespace nw

#endif // NW_GFX_STANDARDSKELETON_H_