gfx_FragmentLight.h - OpenGrok cross reference for /NW4C-2.0.3/include/nw/gfx/gfx_FragmentLight.h

/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     gfx_FragmentLight.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_FRAGMENTLIGHT_H_
#define NW_GFX_FRAGMENTLIGHT_H_

#include <nw/gfx/gfx_Light.h>
#include <nw/gfx/res/gfx_ResLight.h>
#include <nw/anim/res/anim_ResAnim.h>

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

namespace nw
{
namespace gfx
{

//---------------------------------------------------------------------------
//! @brief        フラグメントライトを表すクラスです。
//---------------------------------------------------------------------------
class FragmentLight : public Light
{
private:
    NW_DISALLOW_COPY_AND_ASSIGN(FragmentLight);

public:
    NW_UT_RUNTIME_TYPEINFO;


    //----------------------------------------
    //! @name 取得／設定
    //@{

    //! @brief ライト方向を取得します。
    //!
    //! SceneUpdater で ResLight の m_Direction から親ノードの回転を継承フラグに応じて計算もしくはコピーされます。
    //! Direction を変更する場合は、SceneUpdater::UpdateTransformNode の実行前ならば ResLight::SetDirection を用い、
    //! SceneUpdater の実行後ではこちらの Direction を直接編集してください。
    //!
    //! @return ライト方向です。
    //!
    const math::VEC3& Direction() const
    {
        return this->m_Direction;
    }

    //! @brief ライト方向を取得します。
    //!
    //! SceneUpdater で ResLight の m_Direction から親ノードの回転を継承フラグに応じて計算もしくはコピーされます。
    //! Direction を変更する場合は、SceneUpdater::UpdateTransformNode の実行前ならば ResLight::SetDirection を用い、
    //! SceneUpdater の実行後ではこちらの Direction を直接編集してください。
    //!
    //! @return ライト方向です。
    //!
    math::VEC3& Direction()
    {
        return this->m_Direction;
    }

    //@}

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

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

    //! @brief フラグメントライトを動的に構築するためのクラスです。
    //!
    //! 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       生成したフラグメントライトを返します。
        //!
        FragmentLight* Create(os::IAllocator* allocator);

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

    private:
        FragmentLight::Description m_Description;
    };

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

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

        GetMemorySizeInternal(&size, resource, description);

        return size.GetSizeWithPadding(alignment);
    }

    //! @brief        リソースを複製し、フラグメントライトを生成します。
    //!
    //!               内部で複製したリソースを基にフラグメントライトを生成します。
    //!               複製されたリソースは生成されたフラグメントライトを破棄するときに
    //!               自動的に破棄されます。
    //!
    //!               リソースのメンバのうち Name, UserData, ChildrenTable などは複製されす NULL になります。
    //!               また、LUT も複製されずにオリジナルと同じものを参照するため、複製元の LUT が破棄された後に使用すると
    //!               正しい動作は保証されません。
    //!
    //! @param[in]    parent 親のノードです。
    //! @param[in]    resource 複製元のリソースです。
    //! @param[in]    description 設定内容です。
    //! @param[in]    allocator アロケータです。
    //!
    //! @return       生成されたフラグメントライトです。
    //!
    static FragmentLight* CreateClone(
        SceneNode* parent,
        ResFragmentLight resource,
        const FragmentLight::Description& description,
        os::IAllocator* allocator);

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

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

    //@}

    //----------------------------------------
    //! @name トランスフォーム
    //@{

    //! @brief 方向情報を更新します。
    virtual void UpdateDirection();

    //@}

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

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

    //@}

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

    //! フラグメントライトのリソースを取得します。
    ResFragmentLight GetResFragmentLight()
    {
        return ResStaticCast<ResFragmentLight>(this->GetResSceneObject());
    }

    //! フラグメントライトのリソースを取得します。
    const ResFragmentLight GetResFragmentLight() const
    {
        return ResStaticCast<ResFragmentLight>(this->GetResSceneObject());
    }

    //@}

protected:
    struct ResFragmentLightDataDestroyer : public std::unary_function<ResFragmentLightData*, void>
    {
        ResFragmentLightDataDestroyer(
            os::IAllocator* allocator = NULL
        )
        : m_Allocator(allocator)
        {}
        result_type operator()(argument_type data)
        {
            DestroyResFragmentLight(m_Allocator, data);
        }

        os::IAllocator* m_Allocator;
    };

    //! 動的生成したライトリソースを破棄するための MovePtr の定義です。
    typedef ut::MovePtr<ResFragmentLightData, ResFragmentLightDataDestroyer> ResPtr;

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

    //! コンストラクタです。
    FragmentLight(
        os::IAllocator* allocator,
        ResFragmentLight resObj,
        const FragmentLight::Description& description)
    : Light(
        allocator,
        resObj,
        description),
      m_Direction(resObj.GetDirection())
    {}

    //! コンストラクタです。
    FragmentLight(
        os::IAllocator* allocator,
        ResPtr resource,
        const FragmentLight::Description& description)
    : Light(
        allocator,
        ResFragmentLight(resource.Get()),
        description),
      m_Resource(resource)
    {
        m_Direction = this->GetResFragmentLight().GetDirection();
    }

    //! デストラクタです。
    virtual ~FragmentLight()
    {
        DestroyOriginalValue();
    }

    //@}

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

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

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

    //---------------------------------------------------------------------------
    //! @brief        ResFragmentLightData のリソースを複製します。
    //!
    //! @param[in]    resource    複製元のリソースです。
    //! @param[in]    allocator   リソース用のメモリを確保するアロケータです。
    //!
    //! @return       ResFragmentLightData へのポインタです。
    //---------------------------------------------------------------------------
    static ResFragmentLightData*    CloneResFragmentLight(ResFragmentLight resource, os::IAllocator* allocator);

    //! アニメーションを初期状態に戻すため、初期化時の状態を保存します。
    Result CreateOriginalValue(os::IAllocator* allocator);

        //! :private
    virtual u32 GetLightType() const
    {
        return anim::ResLightAnimData::LIGHT_TYPE_FRAGMENT;
    }

    //! :private
    virtual u32 GetLightKind() const
    {
        return GetResFragmentLight().GetLightKind();
    }

    ResPtr m_Resource;
    math::VEC3 m_Direction;
};

} // namespace gfx
} // namespace nw

#endif // NW_GFX_FRAGMENTLIGHT_H_