My Project
Public Member Functions | List of all members
ParaEngine::IScene Class Referenceabstract

Basic scene interface: implemented by the CSceneObject and CMiniScenegraph class. More...

#include <IScene.h>

Inheritance diagram for ParaEngine::IScene:
ParaEngine::CMiniSceneGraph ParaEngine::CSceneObject

Public Member Functions

virtual bool IsRenderSky ()=0
 whether rendering the sky
 
virtual void EnableSkyRendering (bool bEnable)=0
 
virtual void SetBackGroundColor (const LinearColor &bgColor)=0
 set the color of the scene ground when it is not enabled.When scene is enabled, the background color is always the fog color. More...
 
virtual LinearColor GetBackGroundColor ()=0
 Get the color of the scene ground when it is not enabled.When scene is enabled, the background color is always the fog color. More...
 
virtual void SetFogColorFactor (const LinearColor &fogColorFactor)=0
 fog parameters
 
virtual const LinearColorGetFogColorFactor ()=0
 
virtual void SetFogColor (const LinearColor &fogColor)=0
 
virtual LinearColor GetFogColor ()=0
 
virtual void SetFogStart (float fFogStart)=0
 
virtual float GetFogStart ()=0
 
virtual void SetFogEnd (float fFogEnd)=0
 
virtual float GetFogEnd ()=0
 
virtual void SetFogDensity (float fFogDensity)=0
 
virtual float GetFogDensity ()=0
 
virtual void EnableFog (bool bEnableFog)=0
 
virtual bool IsFogEnabled ()=0
 
virtual bool IsLightEnabled ()=0
 get light enable state
 
virtual void EnableLight (bool bEnable)=0
 whether use light
 
virtual CSunLightGetSunLight ()=0
 get sun light object
 
virtual CBaseCameraGetCurrentCamera ()=0
 
virtual Vector3 GetRenderOrigin ()=0
 
virtual SceneStateGetSceneState ()=0
 get the scene state
 
virtual bool IsSunLightEnabled ()=0
 get light enable state
 
virtual void EnableSunLight (bool bEnable)=0
 whether use light
 
virtual void SetShadow (bool bRenderShadow)
 whether render shadow
 
virtual float GetShadowRadius ()
 whether render shadow
 
virtual bool IsShadowMapEnabled ()
 whether render using shadow map
 
virtual bool PrepareRenderObject (CBaseObject *pObj, CBaseCamera *pCamera, SceneState &sceneState)
 automatically prepare the node for rendering by placing it to the current render pipeline. More...
 
virtual CBaseObjectGetGlobalObject (const std::string &sName)
 get the global object by its name. More...
 

Detailed Description

Basic scene interface: implemented by the CSceneObject and CMiniScenegraph class.

Member Function Documentation

§ GetBackGroundColor()

virtual LinearColor ParaEngine::IScene::GetBackGroundColor ( )
pure virtual

Get the color of the scene ground when it is not enabled.When scene is enabled, the background color is always the fog color.

Implemented in ParaEngine::CSceneObject, and ParaEngine::CMiniSceneGraph.

§ GetGlobalObject()

virtual CBaseObject* ParaEngine::IScene::GetGlobalObject ( const std::string &  sName)
inlinevirtual

get the global object by its name.

If there have been several objects with the same name, the most recently attached object is returned.

Parameters
sNameexact name of the object

§ PrepareRenderObject()

virtual bool ParaEngine::IScene::PrepareRenderObject ( CBaseObject pObj,
CBaseCamera pCamera,
SceneState sceneState 
)
inlinevirtual

automatically prepare the node for rendering by placing it to the current render pipeline.

Most IScene implementation does following: decide whether pObj is visible by the pCamera, if so, it will add it to the proper render queue in sceneState.

Reimplemented in ParaEngine::CMiniSceneGraph.

§ SetBackGroundColor()

virtual void ParaEngine::IScene::SetBackGroundColor ( const LinearColor bgColor)
pure virtual

set the color of the scene ground when it is not enabled.When scene is enabled, the background color is always the fog color.

Implemented in ParaEngine::CSceneObject, and ParaEngine::CMiniSceneGraph.


The documentation for this class was generated from the following file: