/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     gfx_ISceneVisitor.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: 23073 $
 *---------------------------------------------------------------------------*/

#ifndef NW_GFX_ISCENEVISITOR_H_
#define NW_GFX_ISCENEVISITOR_H_

#include <nw/gfx/gfx_GfxObject.h>

namespace nw
{
namespace gfx
{

class SceneNode;
class TransformNode;
class Model;
class SkeletalModel;
class Camera;
class Fog;
class Light;
class FragmentLight;
class AmbientLight;
class VertexLight;
class HemiSphereLight;
class ParticleSet;
class ParticleEmitter;
class ParticleModel;

//---------------------------------------------------------------------------
//! @brief        シーンツリーを巡回するためのインターフェースです。
//---------------------------------------------------------------------------
class ISceneVisitor : public GfxObject
{
private:
    NW_DISALLOW_COPY_AND_ASSIGN(ISceneVisitor);

public:
    NW_UT_RUNTIME_TYPEINFO;

    //! @brief        シーンノードへの処理です。
    //!
    //! @param[in]    node
    //!
    virtual void VisitSceneNode(SceneNode* node) = 0;
    
    //! @brief        トランスフォームノードへの処理です。
    //!
    //! @param[in]    node
    //!
    virtual void VisitTransformNode(TransformNode* node) = 0;
    
    //! @brief        モデルへの処理です。
    //!
    //! @param[in]    model
    //!
    virtual void VisitModel(Model* model) = 0;
    
    //! @brief        スケルタルモデルへの処理です。
    //!
    //! @param[in]    model
    //!
    virtual void VisitSkeletalModel(SkeletalModel* model) = 0;
    
    //! @brief        カメラへの処理です。
    //!
    //! @param[in]    camera
    //!
    virtual void VisitCamera(Camera* camera) = 0;

    //! @brief        フォグへの処理です。
    //!
    //! @param[in]    fog
    //!
    virtual void VisitFog(Fog* fog) = 0;
    
    //! @brief        ライトへの処理です。
    //!
    //! @param[in]    light
    //!
    virtual void VisitLight(Light* light) = 0;
    
    //! @brief        フラグメントライトへの処理です。
    //!
    //! @param[in]    light
    //!
    virtual void VisitFragmentLight(FragmentLight* light) = 0;

#if defined(NW_GFX_VERTEX_LIGHT_ENABLED)
    //! @brief        頂点ライトへの処理です。
    //!
    //! @param[in]    light
    //!
    virtual void VisitVertexLight(VertexLight* light) = 0;
#endif
    //! @brief        アンビエントライトへの処理です。
    //!
    //! @param[in]    light
    //!
    virtual void VisitAmbientLight(AmbientLight* light) = 0;

    //! @brief        半球ライトへの処理です。
    //!
    //! @param[in]    light
    //!
    virtual void VisitHemiSphereLight(HemiSphereLight* light) = 0;

    //! @brief        パーティクルセットへの処理です。
    //!
    //! @param[in]    particleSet
    //!
    virtual void VisitParticleSet(ParticleSet* particleSet) = 0;

    //! @brief        パーティクルエミッタへの処理です。
    //!
    //! @param[in]    particleEmitter
    //!
    virtual void VisitParticleEmitter(ParticleEmitter* particleEmitter) = 0;

    //! @brief        パーティクルモデルへの処理です。
    //!
    //! @param[in]    particleModel
    //!
    virtual void VisitParticleModel(ParticleModel* particleModel) = 0;

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

} // namespace gfx
} // namespace nw

#endif // NW_GFX_ISCENEVISITOR_H_