SRoot Class Reference

#include <SO3Root.h>

List of all members.

Public Types
enum	RenderSystem { SO3_NONE_RENDER_SYSTEM = -1, SO3_DIRECTX_RENDERER, SO3_OPENGL_RENDERER }
Public Member Functions
	SRoot ()
	~SRoot ()
Ogre::Root *	GetOgreRootPointer ()
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)
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)
Static Public Member Functions
static SRoot &	getSingleton ()
static SRoot *	getSingletonPtr ()
Public Attributes
Hikari::HikariManager *	O3HikariManager
Protected Member Functions
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 41 of file SO3Root.h.

---

Member Enumeration Documentation

enum SRoot::RenderSystem

Enumerator:

SO3_NONE_RENDER_SYSTEM
SO3_DIRECTX_RENDERER
SO3_OPENGL_RENDERER

Definition at line 44 of file SO3Root.h.

---

Constructor & Destructor Documentation

SRoot::SRoot

(

)

Constructor.

Definition at line 61 of file SO3Root.cpp.

SRoot::~SRoot

(

)

Destructor.

Definition at line 171 of file SO3Root.cpp.

---

Member Function Documentation

void SRoot::AddRenderWindow

(

SWindow *

existingWindow )

[protected]

Add a SWindow object to the list of handled windows.

Definition at line 325 of file SO3Root.cpp.

void SRoot::AddScene

(

SScene *

existingScene )

[protected]

Add a SScene object to the list of handled scenes.

Definition at line 217 of file SO3Root.cpp.

bool SRoot::CheckDirectxVersion

(

)

Check if a supported version of DirectX is present.

Definition at line 437 of file SO3Root.cpp.

bool SRoot::checkFSAA

(

Ogre::String

val )

Definition at line 107 of file SO3Root.cpp.

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

Create a new SWindow Object

Definition at line 251 of file SO3Root.cpp.

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

Create a new SScene Object

Definition at line 190 of file SO3Root.cpp.

void SRoot::DeleteRenderWindow

(

SWindow *

existingWindow )

Delete an existing SWindow Object

Definition at line 305 of file SO3Root.cpp.

void SRoot::DeleteScene

(

SScene *

existingScene )

Delete an existing SScene Object

Definition at line 197 of file SO3Root.cpp.

bool SRoot::GetDebugEnable

(

)

Definition at line 519 of file SO3Root.cpp.

std::vector< std::string > SRoot::GetMultisamplingMode

(

RenderSystem

wishedRenderSystem )

Definition at line 398 of file SO3Root.cpp.

Ogre::Root * SRoot::GetOgreRootPointer

(

)

Definition at line 102 of file SO3Root.cpp.

SRoot::RenderSystem SRoot::GetRenderSystem

(

)

Definition at line 359 of file SO3Root.cpp.

SWindow * SRoot::GetRenderWindow

(

std::string

windowName )

Get the named window.

Definition at line 311 of file SO3Root.cpp.

const SWindowMap & SRoot::GetRenderWindowList

(

)

const

Get a list of the handled window.

Definition at line 320 of file SO3Root.cpp.

SScene * SRoot::GetScene

(

std::string

sceneName )

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

Definition at line 203 of file SO3Root.cpp.

const SSceneMap & SRoot::GetSceneList

(

)

const

Get a list of the handled scenes.

Definition at line 212 of file SO3Root.cpp.

SRoot & SRoot::getSingleton

(

void

)

[static]

Definition at line 55 of file SO3Root.cpp.

SRoot * SRoot::getSingletonPtr

(

)

[static]

Definition at line 50 of file SO3Root.cpp.

void SRoot::RemoveRenderWindow

(

std::string

windowName )

[protected]

Remove a SWindow object from the list of handled windows.

Definition at line 345 of file SO3Root.cpp.

void SRoot::RemoveRenderWindow

(

SWindow *

existingWindow )

[protected]

Remove a SWindow object from the list of handled windows.

Definition at line 340 of file SO3Root.cpp.

void SRoot::RemoveScene

(

SScene *

existingScene )

[protected]

Remove a SScene object from the list of handled scenes.

Definition at line 232 of file SO3Root.cpp.

void SRoot::RemoveScene

(

std::string

sceneName )

[protected]

Remove a SScene object from the list of handled scenes.

Definition at line 237 of file SO3Root.cpp.

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

Definition at line 527 of file SO3Root.cpp.

void SRoot::SetDebugEnable

(

bool

enable )

Definition at line 508 of file SO3Root.cpp.

void SRoot::SetDebugText

(

std::string

text )

Definition at line 550 of file SO3Root.cpp.

void SRoot::SetRenderSystem

(

RenderSystem

selectedRenderSystem )

Remarks:

Exception throw if render system as been already setted.

Definition at line 364 of file SO3Root.cpp.

---

Member Data Documentation

Hikari::HikariManager* SRoot::O3HikariManager

Definition at line 51 of file SO3Root.h.

---

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

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