nw/gfx/gfx_Fog.h

/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     gfx_Fog.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_FOG_H_
#define NW_GFX_FOG_H_

#include <nw/gfx/gfx_TransformNode.h>
#include <nw/gfx/res/gfx_ResFog.h>

#include <nw/ut/ut_MovePtr.h>
#include <functional>

namespace nw
{
namespace gfx
{

class Camera;

//---------------------------------------------------------------------------
//! @brief        フォグを表すクラスです。
//---------------------------------------------------------------------------
class Fog : public TransformNode
{
private:
    NW_DISALLOW_COPY_AND_ASSIGN(Fog);

    #define NW_FOG_TABLE_COMMAND_NUM    (132)   // idex(2) + table128(129) + terminate(1)
    #define NW_FOG_TABLE_COMMAND_SIZE   (NW_FOG_TABLE_COMMAND_NUM * 4)

public:
    NW_UT_RUNTIME_TYPEINFO;

    //! @brief 設定内容です。
    struct Description : public TransformNode::Description
    {
        //! @brief コンストラクタです。
        Description(){}
    };

    //---------------------------------------------------------------------------
    //! @brief フォグを更新するための関数オブジェクトです。
    //---------------------------------------------------------------------------
    struct UpdateFunctor
    {
        UpdateFunctor(Camera* camera) : camera(camera) {}

        void operator() (Fog* fog)
        {
            if (fog != NULL)
            {
                fog->Update(camera);
            }
        }

        Camera* camera;
    };

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

    //! フォグを動的に構築するためのクラスです。
    //!
    //! IsFixedSizeMemory の初期値は true です。false に変更すると、各種最大数の設定は無視されます。
    class DynamicBuilder
    {
    public:
        //! コンストラクタです。
        DynamicBuilder() {}
        //! デストラクタです。
        ~DynamicBuilder() {}

        //! @brief 生成時以外にもメモリを確保するかどうかのフラグを設定します。
        //!
        //!        true を指定すると、生成時のみ固定サイズのメモリ確保を行います。
        //!
        //!        false を指定すると、生成時以外にも必要に応じて動的にメモリ確保が行われます。
        DynamicBuilder& IsFixedSizeMemory(bool isFixedSizeMemory)
        {
            m_Description.isFixedSizeMemory = isFixedSizeMemory;
            return *this;
        }

        //! 子の最大数を設定します。
        DynamicBuilder& MaxChildren(int maxChildren)
        {
            m_Description.maxChildren = maxChildren;
            return *this;
        }

        //! 管理できるコールバックの最大数を設定します。
        DynamicBuilder& MaxCallbacks(int maxCallbacks)
        {
            m_Description.maxCallbacks = maxCallbacks;
            return *this;
        }

        //! @brief        フォグを生成します。
        //!
        //! @param[in]    allocator アロケータです。
        //!
        //! @return       生成したフォグを返します。
        //!
        Fog* Create(os::IAllocator* allocator);

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

    private:
        Fog::Description m_Description;
    };

    //! @brief        フォグを生成します。
    //!
    //! @param[in]    parent 親のノードです。
    //! @param[in]    resource リソースです。
    //! @param[in]    description 設定内容です。
    //! @param[in]    allocator アロケータです。
    //!
    //! @return       生成されたフォグです。
    //!
    static Fog* Create(
        SceneNode* parent,
        ResSceneObject resource,
        const Fog::Description& description,
        os::IAllocator* allocator);

    //! @brief        生成時に必要なメモリサイズを取得します。
    //!
    //! @param[in]    resource リソースです。
    //! @param[in]    description 設定内容です。
    //! @param[in]    alignment 計算に用いるアライメントです。2 のべき乗である必要があります。
    static size_t GetMemorySize(
        ResFog resource,
        Description description,
        size_t alignment = os::IAllocator::DEFAULT_ALIGNMENT
    )
    {
        os::MemorySizeCalculator size(alignment);

        GetMemorySizeInternal(&size, resource, description);

        return size.GetSizeWithPadding(alignment);
    }

    //! @details :private
    static void GetMemorySizeInternal(
        os::MemorySizeCalculator* pSize,
        ResFog resource,
        Description description);

    //@}

    //----------------------------------------
    //! @name 参照テーブル
    //@{

    //! @brief フォグの参照テーブルを更新します。
    //!
    //! @param[in] camera カメラです。
    //!
    void Update(const Camera* camera);

    //@}

    //----------------------------------------
    //! @name シーンツリー
    //@{

    //! @brief        ビジターを受け付けます。
    //!
    //! @param[in]    visitor ビジターです。
    //!
    virtual void Accept(ISceneVisitor* visitor);

    //@}

    //----------------------------------------
    //! @name リソース
    //@{

    //! フォグのリソースを取得します。
    ResFog GetResFog()
    {
        return ResStaticCast<ResFog>(this->GetResSceneObject());
    }

    //! フォグのリソースを取得します。
    const ResFog GetResFog() const
    {
        return ResStaticCast<ResFog>(this->GetResSceneObject());
    }

    //@}

    //----------------------------------------
    //! @name アニメーション
    //@{

    //! アニメーショングループを取得します。
    AnimGroup* GetAnimGroup() { return m_AnimGroup; }

    //! アニメーショングループを取得します。
    const AnimGroup* GetAnimGroup() const { return m_AnimGroup; }

    //! アニメーションオブジェクトを取得します。
    AnimObject* GetAnimObject() { return m_AnimBinding->GetAnimObject(0); }

    //! アニメーションオブジェクトを取得します。
    const AnimObject* GetAnimObject() const { return m_AnimBinding->GetAnimObject(0); }

    //! @brief アニメーションオブジェクトを設定します。
    //!
    //! @param[in] animObject 設定するアニメーションオブジェクトです。NULL を指定するとアニメーションを解除します。
    void SetAnimObject(AnimObject* animObject) { m_AnimBinding->SetAnimObject(0, animObject); }

    //@}
protected:
    struct ResFogDataDestroyer : public std::unary_function<ResFogData*, void>
    {
        ResFogDataDestroyer(os::IAllocator* allocator = 0) : m_Allocator(allocator)
        {}
        result_type operator()(argument_type data)
        {
            DestroyResFog(m_Allocator, data);
        }

        os::IAllocator* m_Allocator;
    };

    struct ResFogUpdaterDataDestroyer : public std::unary_function<ResFogUpdaterData*, void>
    {
        ResFogUpdaterDataDestroyer(os::IAllocator* allocator = 0) : m_Allocator(allocator)
        {}
        result_type operator()(argument_type data)
        {
            DestroyResFogUpdater(m_Allocator, data);
        }

        os::IAllocator* m_Allocator;
    };

    //! 動的生成したフォグリソースを破棄するための MovePtr の定義です。
    typedef ut::MovePtr<ResFogData, ResFogDataDestroyer> ResPtr;
    typedef ut::MovePtr<ResFogUpdaterData, ResFogUpdaterDataDestroyer> ResUpdaterPtr;

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

    //! コンストラクタです。
    Fog(
        os::IAllocator* allocator,
        ResFog resObj,
        const Fog::Description& description)
     : TransformNode(
        allocator,
        resObj,
        description),
        m_Near(0.0f),
        m_Far(0.0f),
        m_WScale(0.0f),
        m_AnimGroup(NULL),
        m_OriginalValue(NULL)
    {}

    //! コンストラクタです。
    Fog(
        os::IAllocator* allocator,
        ResPtr resource,
        const Fog::Description& description)
    : TransformNode(
        allocator,
        ResFog(resource.Get()),
        description),
      m_Resource(resource),
      m_Near(0.0f),
      m_Far(0.0f),
      m_WScale(0.0f),
      m_AnimGroup(NULL),
      m_OriginalValue(NULL)
    {}

    //! デストラクタです。
    virtual ~Fog()
    {
        ut::SafeDestroy(m_AnimGroup);

        if (m_OriginalValue.IsValid())
        {
            GetAllocator().Free(m_OriginalValue.ptr());
            m_OriginalValue = ResFog(NULL);
        }
    }

    //@}

private:
    virtual Result Initialize(os::IAllocator* allocator);

    // アニメーショングループを作成します。
    Result CreateAnimGroup(os::IAllocator* allocator);

    // アニメメンバへの参照を解決します。
    void BindAnim(AnimGroup* animGroup);

    Result CreateOriginalValue(os::IAllocator* allocator);

    //---------------------------------------------------------------------------
    //! @brief        ResFogData のリソースを生成します。
    //!
    //! @param[in]    allocator   リソース用のメモリを確保するアロケータです。
    //! @param[in]    name        リソースにつける名前へのポインタです。名前が必要ない場合には NULL を指定してください。
    //!
    //! @return       ResFogData へのポインタです。
    //---------------------------------------------------------------------------
    static ResFogData*    CreateResFog(os::IAllocator* allocator, const char* name = NULL);

    //---------------------------------------------------------------------------
    //! @brief        ResFogData のリソースを破棄します。
    //!
    //! @param[in]    allocator        リソース用のメモリを開放するアロケータです。
    //! @param[in]    resFog ResFogData へのポインタです。
    //---------------------------------------------------------------------------
    static void DestroyResFog(os::IAllocator* allocator, ResFogData* resFog);

    //---------------------------------------------------------------------------
    //! @brief        ResFogUpdaterData のリソースを生成します。
    //!
    //! @param[in]    allocator   リソース用のメモリを確保するアロケータです。
    //!
    //! @return       ResFogUpdaterData へのポインタです。
    //---------------------------------------------------------------------------
    static ResFogUpdaterData*    CreateResFogUpdater(os::IAllocator* allocator);

    //---------------------------------------------------------------------------
    //! @brief        ResFogData のリソースを破棄します。
    //!
    //! @param[in]    allocator        リソース用のメモリを開放するアロケータです。
    //! @param[in]    resFogUpdater ResFogUpdaterData へのポインタです。
    //---------------------------------------------------------------------------
    static void DestroyResFogUpdater(os::IAllocator* allocator, ResFogUpdaterData* resFogUpdater);

    void SetupFogSampler(
        ResImageLookupTable fogSampler,
        ResFogUpdater fogUpdater,
        const math::MTX44& inverseProjectionMatrix);

    ResPtr m_Resource;
    ResUpdaterPtr m_UpdaterCache;
    f32 m_Near;
    f32 m_Far;
    f32 m_WScale;
    AnimGroup* m_AnimGroup;
    ResFog m_OriginalValue;
    static const float FOG_DENSITY;
    static const ResFogUpdater::FogUpdaterType FOG_UPDATER_TYPE;
    static const float FOG_MAX_DEPTH;
    static const float FOG_MIN_DEPTH;
};

} // namespace gfx
} // namespace nw

#endif // NW_GFX_FOG_H_