Ocular::Engine Class Reference

Inheritance diagram for Ocular::Engine:

Public Member Functions
bool	initialize (Graphics::GraphicsDriver *driver)
bool	shutdown ()
bool	isRunning () const
bool	run ()
std::shared_ptr< Core::Logger >	Logger () const
std::shared_ptr< Core::Clock >	Clock () const
std::shared_ptr< Core::EventManager >	EventManager () const
std::shared_ptr< Core::WindowManager >	WindowManager () const
std::shared_ptr< Core::ThreadManager >	ThreadManager () const
std::shared_ptr< Utils::HashGenerator >	HashGenerator () const
std::shared_ptr< Utils::String >	StringUtils () const
std::shared_ptr< Utils::Config >	Config () const
std::shared_ptr< Core::ResourceManager >	ResourceManager () const
std::shared_ptr< Core::SceneManager >	SceneManager () const
std::shared_ptr< Core::CameraManager >	CameraManager () const
std::shared_ptr< Core::LightManager >	LightManager () const
std::shared_ptr< Core::Profiler >	Profiler () const
std::shared_ptr< Core::InputHandler >	Input () const
std::shared_ptr< Graphics::GraphicsDriver >	GraphicsDriver () const

Static Public Member Functions
static Engine &	get ()

Protected Member Functions
virtual bool	onEvent (std::shared_ptr< Core::AEvent > event)
Protected Member Functions inherited from Ocular::Core::AEventListener
virtual bool	onEvent (std::shared_ptr< AEvent > event)=0

Member Function Documentation

std::shared_ptr< Core::CameraManager > Ocular::Engine::CameraManager

(

)

const

Returns

Reference to the primary CameraManager

std::shared_ptr< Core::Clock > Ocular::Engine::Clock

(

)

const

Returns

Reference to the primary Clock

std::shared_ptr< Utils::Config > Ocular::Engine::Config

(

)

const

Returns

Reference to the primary Configuration handler

std::shared_ptr< Core::EventManager > Ocular::Engine::EventManager

(

)

const

Returns

Reference to the primary EventManager

std::shared_ptr< Graphics::GraphicsDriver > Ocular::Engine::GraphicsDriver

(

)

const

Returns

Reference to the primary GraphicsDriver.

std::shared_ptr< Utils::HashGenerator > Ocular::Engine::HashGenerator

(

)

const

Returns

Reference to the primary Hash Generator

bool Ocular::Engine::initialize

(

Graphics::GraphicsDriver *

driver

)

Initializes all of the core objects and subsystems of the Ocular Engine. These include:

• Clock
• Logger
• WindowManager

Note

Engine must be initialized before any other action is taken

Returns

TRUE if intiailized without any issues.

std::shared_ptr< Core::InputHandler > Ocular::Engine::Input

(

)

const

Returns

Reference to the primary InputHandler.

bool Ocular::Engine::isRunning

(

)

const

Returns

TRUE if the engine is running.

std::shared_ptr< Core::LightManager > Ocular::Engine::LightManager

(

)

const

Returns

Reference to the primary LightManager

std::shared_ptr< Core::Logger > Ocular::Engine::Logger

(

)

const

Returns

Reference to the primary Logger

std::shared_ptr< Core::Profiler > Ocular::Engine::Profiler

(

)

const

Returns

Reference to the primary Profiler

std::shared_ptr< Core::ResourceManager > Ocular::Engine::ResourceManager

(

)

const

Returns

Reference to the primary ResourceManager

bool Ocular::Engine::run

(

)

Runs a single frame of the engine. Each frame consists of the following actions in the specified order:

1. Update
     I. Clock tick
    II. System info refresh
   III. Windows updated (system messages)
    IV. Event queue processed
     V. Scene update (tree restructures, routines update)
2. Render

Returns

Returns true as long as no shutdown message (Core::Events::ShutdownEvent) has been received (value of isRunning).

std::shared_ptr< Core::SceneManager > Ocular::Engine::SceneManager

(

)

const

Returns

Reference to the primary SceneManager

bool Ocular::Engine::shutdown

(

)

Safely destroys and removes all subsystems used by the Ocular Engine.

Returns

TRUE is shutdown without any issues.

std::shared_ptr< Utils::String > Ocular::Engine::StringUtils

(

)

const

Returns

Reference to the primary String Utilities

std::shared_ptr< Core::ThreadManager > Ocular::Engine::ThreadManager

(

)

const

Returns

Reference to the primary ThreadManager

std::shared_ptr< Core::WindowManager > Ocular::Engine::WindowManager

(

)

const

Returns

Reference to the primary WindowManager

---

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

• C:/Projects/OcularEngine/OcularCore/include/OcularEngine.hpp
• C:/Projects/OcularEngine/OcularCore/src/OcularEngine.cpp