/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     gfx_SkeletonUpdater.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_GFX_SKELETONUPDATER_H_
#define NW_GFX_SKELETONUPDATER_H_

#include <nw/gfx/gfx_GfxObject.h>
#include <nw/gfx/gfx_CalculatedTransform.h>

namespace nw
{
namespace os
{
class IAllocator;
} // namesapce os

namespace gfx
{

class Skeleton;
class WorldMatrixUpdater;
class BillboardUpdater;
class Camera;

//---------------------------------------------------------------------------
//! @brief        スケルトン内のボーンの情報を更新するためのクラスです。
//---------------------------------------------------------------------------
class SkeletonUpdater : public GfxObject
{
private:
    NW_DISALLOW_COPY_AND_ASSIGN(SkeletonUpdater);

public:
    //---------------------------------------------------------------------------
    //! @brief        スケルトンアップデータクラスを構築するためのクラスです。
    //---------------------------------------------------------------------------
    class Builder
    {
    public:
        //! コンストラクタです。
        Builder() {}

        //---------------------------------------------------------------------------
        //! @brief        スケルトンアップデータを生成します。
        //!
        //! @param[in]    allocator アロケータです。
        //!
        //! @return       生成したスケルトンアップデータを返します。
        //---------------------------------------------------------------------------
        SkeletonUpdater* Create(os::IAllocator* allocator);
    };
    
    //---------------------------------------------------------------------------
    //! @brief        スケルトンを更新します。
    //!
    //! @param[in]    skeleton 更新するスケルトンです。
    //! @param[in]    worldMatrixUpdater 更新に用いるアップデータです。
    //---------------------------------------------------------------------------
    void UpdateWorld(
        Skeleton* skeleton,
        const WorldMatrixUpdater& worldMatrixUpdater) const;

    //---------------------------------------------------------------------------
    //! @brief        カメラを用いてスケルトンを更新します。
    //!
    //! @param[in]    skeleton 更新するスケルトンです。
    //! @param[in]    billboardUpdater 更新に用いるビルボードアップデータです。
    //! @param[in]    camera 更新に用いるカメラです。
    //---------------------------------------------------------------------------
    void UpdateView(
        Skeleton* skeleton,
        const BillboardUpdater& billboardUpdater,
        const Camera& camera) const;

private:
    //! コンストラクタです。
    SkeletonUpdater(os::IAllocator* allocator);
    
    //! デストラクタです。
    virtual ~SkeletonUpdater();
};

} // namespace gfx
} // namespace nw

#endif // NW_GFX_SKELETONUPDATER_H_