SO3::SRoot Class Reference

#include <SO3Root.h>

Public Types
enum	RenderSystem { SO3_NONE_RENDER_SYSTEM = -1, SO3_DIRECTX9_RENDERER, SO3_DIRECTX11_RENDERER, SO3_OPENGL_RENDERER }
Public Member Functions
	SRoot (WindowHandle windowHandle)
	~SRoot ()
void	InitRenderer ()
bool	SetFullScreenState (SWindow *window, bool state, int width, int height)
void	AddLogListener (SLogListener *newLogListener)
void	RemoveLogListener (SLogListener *existingLogListener)
void	SetLogEnable (bool state)
bool	GetLogEnable ()
void	SetLogMask (Ogre::LoggingLevel level)
Ogre::Root *	GetOgreRootPointer ()
WindowHandle	GetRootWindowHandle ()
SScene *	CreateScene (std::string newSceneName, const int scolChannel)
void	DeleteScene (SScene *existingScene)
SScene *	GetScene (std::string sceneName)
const SSceneMap &	GetSceneList () const
bool	checkFSAA (Ogre::String val)
RenderSystem	GetRenderSystem ()
void	SetRenderSystem (RenderSystem selectedRenderSystem)
std::vector< std::string >	GetMultisamplingMode (RenderSystem wishedRenderSystem)
SWindow *	CreateRenderWindow (WindowHandle windowHandle, std::string windowName, int width, int height, std::string fsaa)
void	DeleteRenderWindow (SWindow *existingWindow)
const SWindowMap &	GetRenderWindowList () const
SWindow *	GetRenderWindow (std::string windowName)
SWindow *	GetRenderWindow (WindowHandle hwnd)
bool	CheckDirectxVersion ()
void	SetDebugEnable (bool enable)
bool	GetDebugEnable ()
void	SetDebugDisplay (SMaterial *material, int color, int posx, int posy, int width, int height, int charHeight)
void	SetDebugText (std::string text)
bool	Update ()
Static Public Member Functions
static SRoot &	getSingleton ()
static SRoot *	getSingletonPtr ()
Protected Member Functions
virtual void	messageLogged (const Ogre::String &message, Ogre::LogMessageLevel lml, bool maskDebug, const Ogre::String &logName, bool &skipMessage)
void	AddScene (SScene *existingScene)
void	RemoveScene (SScene *existingScene)
void	RemoveScene (std::string sceneName)
void	AddRenderWindow (SWindow *existingWindow)
void	RemoveRenderWindow (SWindow *existingWindow)
void	RemoveRenderWindow (std::string windowName)

Detailed Description

Definition at line 49 of file SO3Root.h.

Member Enumeration Documentation

enum SO3::SRoot::RenderSystem

Enumerator:

SO3_NONE_RENDER_SYSTEM
SO3_DIRECTX9_RENDERER
SO3_DIRECTX11_RENDERER
SO3_OPENGL_RENDERER

Definition at line 52 of file SO3Root.h.

Constructor & Destructor Documentation

SO3::SRoot::SRoot ( WindowHandle windowHandle )

Constructor.

Definition at line 76 of file SO3Root.cpp.

SO3::SRoot::~SRoot ( )

Destructor.

Definition at line 221 of file SO3Root.cpp.

Member Function Documentation

void SO3::SRoot::AddLogListener ( SLogListener * newLogListener )

Definition at line 164 of file SO3Root.cpp.

void SO3::SRoot::AddRenderWindow ( SWindow * existingWindow ) [protected]

Add a SWindow object to the list of handled windows.

Definition at line 376 of file SO3Root.cpp.

void SO3::SRoot::AddScene ( SScene * existingScene ) [protected]

Add a SScene object to the list of handled scenes.

Definition at line 290 of file SO3Root.cpp.

bool SO3::SRoot::CheckDirectxVersion ( )

Check if a supported version of DirectX is present.

Definition at line 495 of file SO3Root.cpp.

bool SO3::SRoot::checkFSAA ( Ogre::String val )

Definition at line 195 of file SO3Root.cpp.

SWindow * SO3::SRoot::CreateRenderWindow	(	WindowHandle	windowHandle,
		std::string	windowName,
		int	width,
		int	height,
		std::string	fsaa
	)

Create a new SWindow Object

Definition at line 324 of file SO3Root.cpp.

SScene * SO3::SRoot::CreateScene	(	std::string	newSceneName,
		const int	scolChannel
	)

Create a new SScene Object

Definition at line 263 of file SO3Root.cpp.

void SO3::SRoot::DeleteRenderWindow ( SWindow * existingWindow )

Delete an existing SWindow Object

Definition at line 337 of file SO3Root.cpp.

void SO3::SRoot::DeleteScene ( SScene * existingScene )

Delete an existing SScene Object

Definition at line 270 of file SO3Root.cpp.

bool SO3::SRoot::GetDebugEnable ( )

Definition at line 770 of file SO3Root.cpp.

bool SO3::SRoot::GetLogEnable ( )

Definition at line 185 of file SO3Root.cpp.

std::vector< std::string > SO3::SRoot::GetMultisamplingMode ( RenderSystem wishedRenderSystem )

Definition at line 453 of file SO3Root.cpp.

Ogre::Root * SO3::SRoot::GetOgreRootPointer ( )

Definition at line 146 of file SO3Root.cpp.

SRoot::RenderSystem SO3::SRoot::GetRenderSystem ( )

Definition at line 410 of file SO3Root.cpp.

SWindow * SO3::SRoot::GetRenderWindow ( WindowHandle hwnd )

Get the window by window handle.

Definition at line 346 of file SO3Root.cpp.

SWindow * SO3::SRoot::GetRenderWindow ( std::string windowName )

Get the named window.

Definition at line 362 of file SO3Root.cpp.

const SWindowMap & SO3::SRoot::GetRenderWindowList ( ) const

Get a list of the handled window.

Definition at line 371 of file SO3Root.cpp.

WindowHandle SO3::SRoot::GetRootWindowHandle ( )

Definition at line 141 of file SO3Root.cpp.

SScene * SO3::SRoot::GetScene ( std::string sceneName )

Return the SScene pointer corresponding to the name of an existing scene handled by this class.

Definition at line 276 of file SO3Root.cpp.

const SSceneMap & SO3::SRoot::GetSceneList ( ) const

Get a list of the handled scenes.

Definition at line 285 of file SO3Root.cpp.

SRoot & SO3::SRoot::getSingleton ( ) [static]

Definition at line 70 of file SO3Root.cpp.

SRoot * SO3::SRoot::getSingletonPtr ( ) [static]

Definition at line 65 of file SO3Root.cpp.

void SO3::SRoot::InitRenderer ( )

Init dummy window and resources

Definition at line 579 of file SO3Root.cpp.

void SO3::SRoot::messageLogged	(	const Ogre::String &	message,
		Ogre::LogMessageLevel	lml,
		bool	maskDebug,
		const Ogre::String &	logName,
		bool &	skipMessage
	)			`[protected, virtual]`

Definition at line 151 of file SO3Root.cpp.

void SO3::SRoot::RemoveLogListener ( SLogListener * existingLogListener )

Definition at line 172 of file SO3Root.cpp.

void SO3::SRoot::RemoveRenderWindow ( std::string windowName ) [protected]

Remove a SWindow object from the list of handled windows.

Definition at line 396 of file SO3Root.cpp.

void SO3::SRoot::RemoveRenderWindow ( SWindow * existingWindow ) [protected]

Remove a SWindow object from the list of handled windows.

Definition at line 391 of file SO3Root.cpp.

void SO3::SRoot::RemoveScene ( std::string sceneName ) [protected]

Remove a SScene object from the list of handled scenes.

Definition at line 310 of file SO3Root.cpp.

void SO3::SRoot::RemoveScene ( SScene * existingScene ) [protected]

Remove a SScene object from the list of handled scenes.

Definition at line 305 of file SO3Root.cpp.

void SO3::SRoot::SetDebugDisplay	(	SMaterial *	material,
		int	color,
		int	posx,
		int	posy,
		int	width,
		int	height,
		int	charHeight
	)

Definition at line 778 of file SO3Root.cpp.

void SO3::SRoot::SetDebugEnable ( bool enable )

Definition at line 759 of file SO3Root.cpp.

void SO3::SRoot::SetDebugText ( std::string text )

Definition at line 801 of file SO3Root.cpp.

bool SO3::SRoot::SetFullScreenState	(	SWindow *	window,
		bool	state,
		int	width,
		int	height
	)

Set the fullscreen state and manage the dummy window

Definition at line 663 of file SO3Root.cpp.

void SO3::SRoot::SetLogEnable ( bool state )

Definition at line 180 of file SO3Root.cpp.

void SO3::SRoot::SetLogMask ( Ogre::LoggingLevel level )

Definition at line 190 of file SO3Root.cpp.

void SO3::SRoot::SetRenderSystem ( RenderSystem selectedRenderSystem )

Remarks:: Exception throw if render system as been already setted.

Definition at line 415 of file SO3Root.cpp.

bool SO3::SRoot::Update ( )

Definition at line 823 of file SO3Root.cpp.

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

SO3Engine/SO3Renderer/SO3Root.h
SO3Engine/SO3Renderer/SO3Root.cpp

SO3::SRoot Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation