/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     gfx_TransformAnimInterpolator.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_TRANSFORMANIMINTERPOLATOR_H_
#define NW_GFX_TRANSFORMANIMINTERPOLATOR_H_

#include <nw/gfx/gfx_AnimInterpolator.h>

namespace nw {
namespace gfx {

//---------------------------------------------------------------------------
//! @brief トランスフォームアニメーション評価結果を補間ブレンドするクラスです。
//!
//! ブレンドは各メンバの移動・回転・スケール成分ごとに行われます。
//!
//! 動作の詳細は、 AnimInterpolator をご覧ください。
//---------------------------------------------------------------------------
class TransformAnimInterpolator : public AnimInterpolator
{
public:
    NW_UT_RUNTIME_TYPEINFO;

    //----------------------------------------
    //! @name 作成
    //@{

    //! @brief トランスフォームアニメーション補間を構築するクラスです。
    //!
    //! バージョン 1.0.1 以前の補間法に戻すためには、IsOldMethod か IgnoreNoAnimMember に true を指定してください。
    //!
    //! 1.0.1 以前の補間方法と現在の補間方法の違いの詳細については、アニメーションのドキュメント（高度な機能）を参照ください。
    class Builder
    {
    public:
        //! コンストラクタです。
        Builder()
        : m_MaxAnimObjects(2),
          m_IgnoreNoAnimMember(false) {}

        //! 最大アニメーションオブジェクト数を設定します。
        Builder& MaxAnimObjects(int maxAnimObjects)
        {
            NW_ASSERT(maxAnimObjects > 0);
            m_MaxAnimObjects = maxAnimObjects;
            return *this;
        }

        //! @brief アニメーションが存在しないメンバを無視するかどうかを設定します。
        //!
        //! デフォルトでは、アニメーションが存在しないメンバはバインド時の値がブレンドされます。
        //! IgnoreNoAnimMember に true を設定すると、
        //! 重みの正規化がメンバ毎に行なわれ、アニメーションが存在しないメンバは重み 0 としてブレンドされます。
        //!
        //! この挙動は バージョン 1.0.1 以前の補間法と同じです。
        //! 
        Builder& IgnoreNoAnimMember(bool ignoreNoAnimMember) { m_IgnoreNoAnimMember = ignoreNoAnimMember; return *this; }

        //! @brief 生成時に必要なメモリサイズを取得します。
        //!
        //! メモリサイズは Builder の設定によって変化します。
        //! すべての設定が終わった後にこの関数を呼び出してください。
        //!
        //! @param[in] alignment 計算に用いるアライメントです。2 のべき乗である必要があります。
        size_t GetMemorySize(size_t alignment = os::IAllocator::DEFAULT_ALIGNMENT) const
        {
            os::MemorySizeCalculator size(alignment);

            GetMemorySizeInternal(&size);

            return size.GetSizeWithPadding(alignment);
        }

        //! @details :private
        void GetMemorySizeInternal(os::MemorySizeCalculator* pSize) const
        {
            os::MemorySizeCalculator& size = *pSize;
            
            size += sizeof(TransformAnimInterpolator);
            TransformAnimInterpolator::GetMemorySizeForInitialize(pSize, m_MaxAnimObjects);
        }

        //! @brief トランスフォームアニメーション補間を生成します。
        //!
        //! @param[in] allocator アロケータです。
        //!
        //! @return 生成されたトランスフォームアニメーション補間です。
        //!
        TransformAnimInterpolator* Create(os::IAllocator* allocator)
        {
            void* buf = allocator->Alloc(sizeof(TransformAnimInterpolator));

            if (buf == NULL)
            {
                return NULL;
            }

            TransformAnimInterpolator* interpolator = new(buf) TransformAnimInterpolator(allocator);

            Result result = interpolator->Initialize(m_MaxAnimObjects, m_IgnoreNoAnimMember);
            NW_ASSERT(result.IsSuccess());

            return interpolator;
        }

    private:
        int m_MaxAnimObjects;
        bool m_IgnoreNoAnimMember;
    };

    //@}

    //----------------------------------------
    //! @name 評価
    //@{

    //! @brief メンバ単位でアニメーション結果を取得します。
    //!
    //! @param[out] target アニメーション結果を書き込む対象です。
    //! @param[in] memberIdx メンバインデックスです。
    //!
    //! @return アニメーション結果を適用した場合は NULL でない値を返します。
    //!
    virtual const anim::AnimResult* GetResult(
        void* target,
        int memberIdx) const;

    //@}
    
protected:
    //----------------------------------------
    //! @name コンストラクタ／デストラクタ
    //@{

    //! コンストラクタです。
    //!
    //! :private
    TransformAnimInterpolator(
        os::IAllocator* allocator)
    : AnimInterpolator(allocator)
    {}

    //! デストラクタです。
    //!
    //! :private
    virtual ~TransformAnimInterpolator() {}

    //@}
};

} // namespace gfx
} // namespace nw

#endif // NW_GFX_TRANSFORMANIMINTERPOLATOR_H_