/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     gfx_ParticleSceneUpdater.h

  Copyright (C)2009-2010 Nintendo Co., Ltd./HAL Laboratory, Inc.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  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.

  $Revision: 19597 $
 *---------------------------------------------------------------------------*/

#ifndef NW_GFX_PARTICLESCENEUPDATER_H_
#define NW_GFX_PARTICLESCENEUPDATER_H_

#include <nw/gfx/gfx_ISceneUpdater.h>
#include <nw/gfx/gfx_SkeletonUpdater.h>
#include <nw/gfx/gfx_WorldMatrixUpdater.h>
#include <nw/gfx/gfx_BillboardUpdater.h>

namespace nw
{
namespace gfx
{

class SceneContext;
class ParticleContext;
class ParticleSet;

//---------------------------------------------------------------------------
//! @brief        パーティクルの更新を行うためのクラスです（仮）。
//---------------------------------------------------------------------------
class ParticleSceneUpdater  : public GfxObject
{
private:
    NW_DISALLOW_COPY_AND_ASSIGN(ParticleSceneUpdater);

public:
    NW_UT_RUNTIME_TYPEINFO;

    //! シーンノードの MoveArray の定義です。
    typedef ut::MoveArray<SceneNode*> SceneNodeArray;

    //! ParticleSetの MoveArray の定義です。
    typedef ut::MoveArray<ParticleSet*> ParticleSetArray;

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

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

        //! @brief        シーンアップデータを生成します。
        //!
        //! @param[in]    allocator
        //!
        //! @return       生成したシーンアップデータを返します。
        //!
        ParticleSceneUpdater* Create(os::IAllocator* allocator);
    };

    //@}

    //----------------------------------------
    //! @name 更新
    //@{

    //! @brief シーンコンテキストをビューに基づいて更新します。
    //!
    //! @param[in] sceneContext シーンコンテキストです。
    //! @param[in] particleContext パーティクルシーンコンテキストです。
    //!
    virtual void UpdateNode(
        SceneContext* sceneContext,
        ParticleContext* particleContext);

    //! @brief バッファを交換します。
    //!
    //! @param[in] sceneContext シーンコンテキストです。
    //!
    virtual void SwapBuffer(SceneContext* /*sceneContext*/) {}

    //@}

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

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

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

    //@}
};

} // namespace gfx
} // namespace nw

#endif // NW_GFX_SCENEUPDATER_H_