ParaEngine::CGlobals Class Reference

a class consists of static functions to access global objects in ParaEngine, such as Current Root Scene, physical world object, terrain, asset manager, environment simulator, 2d GUI root, etc. More...

#include <Globals.h>

Static Public Member Functions
static IParaEngineApp *	GetApp ()
	get the application interface. More...
static CAISimulator *	GetAISim ()
static CReport *	GetReport ()
static CFileManager *	GetFileManager ()
static CPluginManager *	GetPluginManager ()
static ParaInfoCenter::CICConfigManager *	GetICConfigManager ()
static CEventsCenter *	GetEventsCenter ()
static NPL::CNPLRuntime *	GetNPLRuntime ()
	get the current NPL runtime environment. More...
static NPL::INPLStimulationPipe *	GetNetworkLayer ()
static ParaEngineSettings &	GetSettings ()
static CGUIRoot *	GetGUI ()
static CParaWorldAsset *	GetAssetManager ()
static CSceneObject *	GetScene ()
static ParaTerrain::CGlobalTerrain *	GetGlobalTerrain ()
static SceneState *	GetSceneState ()
	get the scene state information. More...
static CWorldInfo *	GetWorldInfo ()
static const string &	GetString (int nStringID=0)
	get static string used in the game engine. More...
static bool	WillGenReport (const char *itemName=NULL)
	return whether frame based report will be generated for a specified item, itemName: name of the report item to check, this can be NULL. More...
static double	GetGameTime ()
	get the game time in seconds
static CFrameRateController *	GetFrameRateController (FRCType nType)
	get a given frame rate controller used by the game engine. More...
static const Matrix4 *	GetIdentityMatrix ()
	get an identity matrix. More...
static TransformStack &	GetWorldMatrixStack ()
	world matrix stack. More...
static TransformStack &	GetViewMatrixStack ()
static TransformStack &	GetProjectionMatrixStack ()
static CPhysicsWorld *	GetPhysicsWorld ()
static CViewportManager *	GetViewportManager ()
static CSelectionManager *	GetSelectionManager ()
static COceanManager *	GetOceanManager ()
static IEnvironmentSim *	GetEnvSim ()
static CLightManager *	GetLightManager ()
static bool	IsLoading ()
	check whether the scene is loading. More...
static void	SetLoading (bool bIsLoading)
	set whether the scene is loading. More...
static RenderDevicePtr	GetRenderDevice ()
static EffectManager *	GetEffectManager ()
static CAttributesManager *	GetAttributesManager ()
static CDataProviderManager *	GetDataProviderManager ()
static CMoviePlatform *	GetMoviePlatform ()
static HWND	GetAppHWND ()

Detailed Description

a class consists of static functions to access global objects in ParaEngine, such as Current Root Scene, physical world object, terrain, asset manager, environment simulator, 2d GUI root, etc.

Member Function Documentation

GetApp()

IParaEngineApp * CGlobals::GetApp ( )

static

get the application interface.

GetAppHWND()

HWND CGlobals::GetAppHWND ( )

static

Returns

application handle

GetFrameRateController()

CFrameRateController * CGlobals::GetFrameRateController ( FRCType  nType )

static

get a given frame rate controller used by the game engine.

GetIdentityMatrix()

const Matrix4 * CGlobals::GetIdentityMatrix ( )

static

get an identity matrix.

GetNPLRuntime()

NPL::CNPLRuntime * CGlobals::GetNPLRuntime ( )

static

get the current NPL runtime environment.

GetSceneState()

SceneState * CGlobals::GetSceneState ( )

static

get the scene state information.

The scene state contains information about the current simulation and render states.Such as which scene object is being animated or rendered, etc

GetString()

const string & CGlobals::GetString ( int  nStringID = 0 )

static

get static string used in the game engine.

Parameters

nStringID

if this is 0, "" is returned. see GLOBAL_STRING_ID

GetWorldMatrixStack()

TransformStack & CGlobals::GetWorldMatrixStack ( )

static

world matrix stack.

One can use it to keep track of matrices. It will be automatically reset at the beginning of each frame move

IsLoading()

bool CGlobals::IsLoading ( )

static

check whether the scene is loading.

We may display some progress bar to inform the user

SetLoading()

void CGlobals::SetLoading ( bool  bIsLoading )

static

set whether the scene is loading.

WillGenReport()

bool CGlobals::WillGenReport ( const char *  itemName = NULL )

static

return whether frame based report will be generated for a specified item, itemName: name of the report item to check, this can be NULL.

Returns

: return true if report should be generated.

---

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

• Client/trunk/ParaEngineClient/Core/Globals.h
• Client/trunk/ParaEngineClient/Core/Globals.cpp