SO3Engine
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
SO3::SRoot Class Reference

#include <SO3Root.h>

Inheritance diagram for SO3::SRoot:

Public Types

enum  RenderSystem {
  SO3_NONE_RENDER_SYSTEM = -1 , SO3_DIRECTX9_RENDERER , SO3_DIRECTX11_RENDERER , SO3_OPENGL_RENDERER ,
  SO3_OPENGL3_RENDERER , SO3_VULKAN_RENDERER , SO3_METAL_RENDERER , SO3_TINY_RENDERER
}
 

Public Member Functions

 SRoot (const std::string &firstPartition)
 
 ~SRoot ()
 
void * GetD3Ddevice ()
 
void InitRenderer (SWindow *pwin=0)
 
bool IsRenderInitialised ()
 
bool SetFullScreenState (SWindow *window, const bool &state, const int &width, const int &height)
 
void AddLogListener (SLogListener *newLogListener)
 
void RemoveLogListener (SLogListener *existingLogListener)
 
void SetLogEnable (const bool &state)
 
bool GetLogEnable ()
 
void SetLogMask (const Ogre::LogMessageLevel &level)
 
Ogre::Root * GetOgreRootPointer ()
 
Ogre::RenderSystem * GetOgreRenderSystem ()
 
bool IsUpdating ()
 
bool IsRendering ()
 
SDeferredShading * GetDeferredManager ()
 
SScene * CreateScene (const std::string &newSceneName)
 
void DeleteScene (SScene *existingScene)
 
SScene * GetScene (const std::string &sceneName)
 
void AddManualRessourceGroup (std::string name)
 
void RemoveManualRessourceGroup (std::string name)
 
void ClearManualRessourceGroups ()
 
const SSceneMap & GetSceneList () const
 
bool checkFSAA (const Ogre::String &val)
 
RenderSystem GetRenderSystem ()
 
std::vector< std::string > GetMultisamplingMode (const RenderSystem &wishedRenderSystem)
 
SWindow * CreateRenderWindow (const ScolWindowHandle windowHandle, const std::string &windowName, const int &width, const int &height, const std::string &renderWindowFsaa="default")
 
void DeleteRenderWindow (SWindow *existingWindow)
 
const SWindowMap & GetRenderWindowList () const
 
SWindow * GetRenderWindow (const std::string &windowName)
 
SWindow * GetRenderWindow (const ScolWindowHandle &hwnd)
 
bool CheckDirectxVersion ()
 
void SetDebugEnable (const bool &enable)
 
bool GetDebugEnable ()
 
void SetDebugDisplay (const int &color, const int &posx, const int &posy, const int &width, const int &height, const int &charHeight)
 
void SetDebugText (const std::string &text)
 
void UpdateCamera (SViewPort *viewport)
 
void RegisterViewport (SViewPort *viewport)
 
void UnregisterViewport (SViewPort *viewport)
 
bool Update ()
 
void DestroyInternalRessources ()
 
void ReloadInternalRessources ()
 
void Pause ()
 
void Resume ()
 
bool GetQuadBufferEnable ()
 
float GetQuadBufferFocalLength ()
 
float GetQuadBufferEyesSeparation ()
 
bool GetVSyncEnable ()
 
bool isDeviceLost ()
 
bool GetRttPixelFormat (Ogre::PixelFormat &format, bool alpha=false, bool floattex=false)
 
void InvalidateGeneratedMaterial (Ogre::Material *mat)
 
void RemoveGeneratedMaterial (Ogre::Material *mat)
 
void ParseConfigFile ()
 
void SetSlicePlaneState (bool state)
 
void SetSlicePlane (Ogre::Vector4 plane)
 
bool GetSlicePlaneState ()
 
Ogre::Vector4 GetSlicePlane ()
 
void SetProgramCameraParameter (float fov, float znear, float zfar, float focalLength)
 

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)
 
virtual void eventOccurred (const Ogre::String &eventName, const Ogre::NameValuePairList *parameters)
 
void AddScene (SScene *existingScene)
 
void RemoveScene (SScene *existingScene)
 
void RemoveScene (const std::string &sceneName)
 
void AddRenderWindow (SWindow *existingWindow)
 
void RemoveRenderWindow (SWindow *existingWindow)
 
void RemoveRenderWindow (const std::string &windowName)
 

Detailed Description

Definition at line 72 of file SO3Root.h.

Member Enumeration Documentation

◆ RenderSystem

enum SO3::SRoot::RenderSystem
Enumerator
SO3_NONE_RENDER_SYSTEM 
SO3_DIRECTX9_RENDERER 
SO3_DIRECTX11_RENDERER 
SO3_OPENGL_RENDERER 
SO3_OPENGL3_RENDERER 
SO3_VULKAN_RENDERER 
SO3_METAL_RENDERER 
SO3_TINY_RENDERER 

Definition at line 75 of file SO3Root.h.

Constructor & Destructor Documentation

◆ SRoot()

SO3::SRoot::SRoot ( const std::string &  firstPartition)

Constructor.

Definition at line 122 of file SO3Root.cpp.

◆ ~SRoot()

SO3::SRoot::~SRoot ( )

Destructor.

Definition at line 416 of file SO3Root.cpp.

Member Function Documentation

◆ AddLogListener()

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

Definition at line 358 of file SO3Root.cpp.

◆ AddManualRessourceGroup()

void SO3::SRoot::AddManualRessourceGroup ( std::string  name)

Definition at line 607 of file SO3Root.cpp.

◆ AddRenderWindow()

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

Add a SWindow object to the list of handled windows.

Definition at line 826 of file SO3Root.cpp.

◆ AddScene()

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

Add a SScene object to the list of handled scenes.

Definition at line 565 of file SO3Root.cpp.

◆ CheckDirectxVersion()

bool SO3::SRoot::CheckDirectxVersion ( )

Check if a supported version of DirectX is present.

Definition at line 1066 of file SO3Root.cpp.

◆ checkFSAA()

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

Definition at line 389 of file SO3Root.cpp.

◆ ClearManualRessourceGroups()

void SO3::SRoot::ClearManualRessourceGroups ( )

Definition at line 633 of file SO3Root.cpp.

◆ CreateRenderWindow()

SWindow * SO3::SRoot::CreateRenderWindow ( const ScolWindowHandle  windowHandle,
const std::string &  windowName,
const int &  width,
const int &  height,
const std::string &  renderWindowFsaa = "default" 
)

Create a new SWindow Object

Definition at line 768 of file SO3Root.cpp.

◆ CreateScene()

SScene * SO3::SRoot::CreateScene ( const std::string &  newSceneName)

Create a new SScene Object

Definition at line 535 of file SO3Root.cpp.

◆ DeleteRenderWindow()

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

Delete an existing SWindow Object

Definition at line 787 of file SO3Root.cpp.

◆ DeleteScene()

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

Delete an existing SScene Object

Definition at line 542 of file SO3Root.cpp.

◆ DestroyInternalRessources()

void SO3::SRoot::DestroyInternalRessources ( )

Definition at line 1701 of file SO3Root.cpp.

◆ eventOccurred()

void SO3::SRoot::eventOccurred ( const Ogre::String &  eventName,
const Ogre::NameValuePairList *  parameters 
)
protectedvirtual

Definition at line 1621 of file SO3Root.cpp.

◆ GetD3Ddevice()

void * SO3::SRoot::GetD3Ddevice ( )

Definition at line 290 of file SO3Root.cpp.

◆ GetDebugEnable()

bool SO3::SRoot::GetDebugEnable ( )

Definition at line 1554 of file SO3Root.cpp.

◆ GetDeferredManager()

SDeferredShading * SO3::SRoot::GetDeferredManager ( )

Definition at line 312 of file SO3Root.cpp.

◆ GetLogEnable()

bool SO3::SRoot::GetLogEnable ( )

Definition at line 379 of file SO3Root.cpp.

◆ GetMultisamplingMode()

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

Definition at line 992 of file SO3Root.cpp.

◆ GetOgreRenderSystem()

Ogre::RenderSystem * SO3::SRoot::GetOgreRenderSystem ( )

Definition at line 865 of file SO3Root.cpp.

◆ GetOgreRootPointer()

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

Definition at line 301 of file SO3Root.cpp.

◆ GetQuadBufferEnable()

bool SO3::SRoot::GetQuadBufferEnable ( )

Definition at line 1984 of file SO3Root.cpp.

◆ GetQuadBufferEyesSeparation()

float SO3::SRoot::GetQuadBufferEyesSeparation ( )

Definition at line 2008 of file SO3Root.cpp.

◆ GetQuadBufferFocalLength()

float SO3::SRoot::GetQuadBufferFocalLength ( )

Definition at line 2003 of file SO3Root.cpp.

◆ GetRenderSystem()

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

Definition at line 860 of file SO3Root.cpp.

◆ GetRenderWindow() [1/2]

SWindow * SO3::SRoot::GetRenderWindow ( const ScolWindowHandle &  hwnd)

Get the window by window handle.

Definition at line 796 of file SO3Root.cpp.

◆ GetRenderWindow() [2/2]

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

Get the named window.

Definition at line 812 of file SO3Root.cpp.

◆ GetRenderWindowList()

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

Get a list of the handled window.

Definition at line 821 of file SO3Root.cpp.

◆ GetRttPixelFormat()

bool SO3::SRoot::GetRttPixelFormat ( Ogre::PixelFormat &  format,
bool  alpha = false,
bool  floattex = false 
)

Definition at line 650 of file SO3Root.cpp.

◆ GetScene()

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

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

Definition at line 551 of file SO3Root.cpp.

◆ GetSceneList()

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

Get a list of the handled scenes.

Definition at line 560 of file SO3Root.cpp.

◆ getSingleton()

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

Definition at line 116 of file SO3Root.cpp.

◆ getSingletonPtr()

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

Definition at line 111 of file SO3Root.cpp.

◆ GetSlicePlane()

Ogre::Vector4 SO3::SRoot::GetSlicePlane ( )

Definition at line 2804 of file SO3Root.cpp.

◆ GetSlicePlaneState()

bool SO3::SRoot::GetSlicePlaneState ( )

Definition at line 2797 of file SO3Root.cpp.

◆ GetVSyncEnable()

bool SO3::SRoot::GetVSyncEnable ( )

Definition at line 2013 of file SO3Root.cpp.

◆ InitRenderer()

void SO3::SRoot::InitRenderer ( SWindow *  pwin = 0)

Init dummy window and resources

Definition at line 1310 of file SO3Root.cpp.

◆ InvalidateGeneratedMaterial()

void SO3::SRoot::InvalidateGeneratedMaterial ( Ogre::Material *  mat)

Definition at line 2350 of file SO3Root.cpp.

◆ isDeviceLost()

bool SO3::SRoot::isDeviceLost ( )

Definition at line 1633 of file SO3Root.cpp.

◆ IsRendering()

bool SO3::SRoot::IsRendering ( )

Definition at line 1779 of file SO3Root.cpp.

◆ IsRenderInitialised()

bool SO3::SRoot::IsRenderInitialised ( )

Definition at line 306 of file SO3Root.cpp.

◆ IsUpdating()

bool SO3::SRoot::IsUpdating ( )

Definition at line 1774 of file SO3Root.cpp.

◆ messageLogged()

void SO3::SRoot::messageLogged ( const Ogre::String &  message,
Ogre::LogMessageLevel  lml,
bool  maskDebug,
const Ogre::String &  logName,
bool &  skipMessage 
)
protectedvirtual

Definition at line 334 of file SO3Root.cpp.

◆ ParseConfigFile()

void SO3::SRoot::ParseConfigFile ( )

Load config from "usmuser.ini" or "usm.ini" files.

Definition at line 2018 of file SO3Root.cpp.

◆ Pause()

void SO3::SRoot::Pause ( )

Definition at line 1750 of file SO3Root.cpp.

◆ RegisterViewport()

void SO3::SRoot::RegisterViewport ( SViewPort *  viewport)

Used to update components that need a viewport setting

Definition at line 1601 of file SO3Root.cpp.

◆ ReloadInternalRessources()

void SO3::SRoot::ReloadInternalRessources ( )

Definition at line 1642 of file SO3Root.cpp.

◆ RemoveGeneratedMaterial()

void SO3::SRoot::RemoveGeneratedMaterial ( Ogre::Material *  mat)

Definition at line 2343 of file SO3Root.cpp.

◆ RemoveLogListener()

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

Definition at line 366 of file SO3Root.cpp.

◆ RemoveManualRessourceGroup()

void SO3::SRoot::RemoveManualRessourceGroup ( std::string  name)

Definition at line 620 of file SO3Root.cpp.

◆ RemoveRenderWindow() [1/2]

void SO3::SRoot::RemoveRenderWindow ( const std::string &  windowName)
protected

Remove a SWindow object from the list of handled windows.

Definition at line 846 of file SO3Root.cpp.

◆ RemoveRenderWindow() [2/2]

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

Remove a SWindow object from the list of handled windows.

Definition at line 841 of file SO3Root.cpp.

◆ RemoveScene() [1/2]

void SO3::SRoot::RemoveScene ( const std::string &  sceneName)
protected

Remove a SScene object from the list of handled scenes.

Definition at line 592 of file SO3Root.cpp.

◆ RemoveScene() [2/2]

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

Remove a SScene object from the list of handled scenes.

Definition at line 585 of file SO3Root.cpp.

◆ Resume()

void SO3::SRoot::Resume ( )

Definition at line 1755 of file SO3Root.cpp.

◆ SetDebugDisplay()

void SO3::SRoot::SetDebugDisplay ( const int &  color,
const int &  posx,
const int &  posy,
const int &  width,
const int &  height,
const int &  charHeight 
)

Definition at line 1559 of file SO3Root.cpp.

◆ SetDebugEnable()

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

Definition at line 1543 of file SO3Root.cpp.

◆ SetDebugText()

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

Definition at line 1569 of file SO3Root.cpp.

◆ SetFullScreenState()

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

Set the fullscreen state and manage the dummy window

Definition at line 1493 of file SO3Root.cpp.

◆ SetLogEnable()

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

Definition at line 374 of file SO3Root.cpp.

◆ SetLogMask()

void SO3::SRoot::SetLogMask ( const Ogre::LogMessageLevel &  level)

Definition at line 384 of file SO3Root.cpp.

◆ SetProgramCameraParameter()

void SO3::SRoot::SetProgramCameraParameter ( float  fov,
float  znear,
float  zfar,
float  focalLength 
)

Definition at line 2810 of file SO3Root.cpp.

◆ SetSlicePlane()

void SO3::SRoot::SetSlicePlane ( Ogre::Vector4  plane)

Definition at line 2785 of file SO3Root.cpp.

◆ SetSlicePlaneState()

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

Definition at line 2733 of file SO3Root.cpp.

◆ UnregisterViewport()

void SO3::SRoot::UnregisterViewport ( SViewPort *  viewport)

Used to update components that need a viewport setting

Definition at line 1611 of file SO3Root.cpp.

◆ Update()

bool SO3::SRoot::Update ( )

Definition at line 1784 of file SO3Root.cpp.

◆ UpdateCamera()

void SO3::SRoot::UpdateCamera ( SViewPort *  viewport)

Used to update components that need a camera setting

Definition at line 1591 of file SO3Root.cpp.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8