/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     gfx_AnimOverrider.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_ANIMOVERRIDER_H_
#define NW_GFX_ANIMOVERRIDER_H_

#include <nw/gfx/gfx_AnimBlender.h>
#include <nw/ut/ut_RuntimeTypeInfo.h>

namespace nw {
namespace gfx {

//---------------------------------------------------------------------------
//! @brief 汎用アニメーション評価結果を上書きブレンドするクラスです。
//! 
//! AddAnimObject() で登録された順番にアニメーションオブジェクトを評価します。
//! 同じメンバに複数のアニメーションがあった場合、後に登録されたアニメーションの結果で上書きされます。
//! アニメーションを持っていないメンバについては、上書き処理は行われません。
//---------------------------------------------------------------------------
class AnimOverrider : public AnimBlender
{
public:
    NW_UT_RUNTIME_TYPEINFO;

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

    //! 汎用アニメーション上書きを構築するクラスです。
    class Builder
    {
    public:
        //! コンストラクタです。
        Builder()
        : m_MaxAnimObjects(2) {}

        //! 最大アニメーションオブジェクト数を設定します。
        Builder& MaxAnimObjects(int maxAnimObjects)
        {
            NW_ASSERT(maxAnimObjects > 0);
            m_MaxAnimObjects = maxAnimObjects;
            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(AnimOverrider);
            AnimOverrider::GetMemorySizeForInitialize(pSize, m_MaxAnimObjects);
        }

        //! @brief 汎用アニメーション上書きを生成します。
        //!
        //! @param[in] allocator アロケータです。
        //!
        //! @return 生成された汎用アニメーション上書きです。
        //!
        AnimOverrider* Create(os::IAllocator* allocator)
        {
            void* buf = allocator->Alloc(sizeof(AnimOverrider));

            if (buf == NULL)
            {
                return NULL;
            }
            
            AnimOverrider* animOverrider = new(buf) AnimOverrider(allocator);

            Result result = animOverrider->Initialize(m_MaxAnimObjects);
            NW_ASSERT(result.IsSuccess());
            
            return animOverrider;
        }

    private:
        int m_MaxAnimObjects;
    };

    //@}

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

    //! @brief メンバ単位でアニメーション結果を取得します。
    //!
    //! @param[out] target アニメーション結果を書き込む対象です。
    //! @param[in] memberIdx メンバインデックスです。
    //!
    //! @return アニメーション結果を返します。
    //! ブレンドオペレーションを使用する場合は、返り値のアニメーション結果を使用してください。
    //!
    virtual const anim::AnimResult* GetResult(
        void* target,
        int memberIdx) const;

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

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

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

    //@}
};

} // namespace gfx
} // namespace nw

#endif // NW_GFX_ANIMOVERRIDER_H_