FIFE  be64c707dea6b3250bd4355bf5c825d25920087d
Public Member Functions | Private Attributes | List of all members
FIFE::Engine Class Reference

Engine acts as a controller to the whole system Responsibilities of the engine are: More...

#include <engine.h>

+ Collaboration diagram for FIFE::Engine:

Public Member Functions

 Engine ()
 Constructor. More...
 
virtual ~Engine ()
 Destructor. More...
 
EngineSettings & getSettings ()
 Gets settings class for engine. More...
 
const DeviceCaps & getDeviceCaps () const
 Gets device capabilities. More...
 
void changeScreenMode (const ScreenMode &mode)
 Changes the screen mode. More...
 
void init ()
 Initializes the engine. More...
 
void destroy ()
 Explicit destruction of engine. More...
 
void initializePumping ()
 Initializes the continuous processing of the engine Call this only once in your program. More...
 
void finalizePumping ()
 Finalizes the continuous processing of the engine Call this only once in your program, after you have called initializePumping + (pump() * N times) More...
 
void pump ()
 Runs one cycle for the engine. More...
 
SoundManager * getSoundManager () const
 Provides access point to the SoundManager. More...
 
EventManager * getEventManager () const
 Provides access point to the EventManager. More...
 
TimeManager * getTimeManager () const
 Provides access point to the TimeManager. More...
 
void setGuiManager (IGUIManager *guimanager)
 Sets the GUI Manager to use. More...
 
IGUIManager * getGuiManager () const
 Provides access point to the GUI Manager. More...
 
ImageManager * getImageManager () const
 Provides access point to the ImageManager. More...
 
AnimationManager * getAnimationManager () const
 Provides access point to the ImageManager. More...
 
SoundClipManager * getSoundClipManager () const
 Provides access point to the SoundClipManager. More...
 
RenderBackend * getRenderBackend () const
 Provides access point to the RenderBackend. More...
 
Model * getModel () const
 Provides access point to the Model. More...
 
LogManager * getLogManager () const
 Provides access point to the LogManager. More...
 
VFS * getVFS () const
 Provides access point to the VFS. More...
 
Cursor * getCursor () const
 Returns cursor used in the engine. More...
 
OffRenderer * getOffRenderer () const
 Provides access point to the OffRenderer. More...
 
TargetRenderer * getTargetRenderer () const
 Provides access point to the TargetRenderer. More...
 
void addChangeListener (IEngineChangeListener *listener)
 Adds new change listener. More...
 
void removeChangeListener (IEngineChangeListener *listener)
 Removes associated change listener. More...
 

Private Attributes

RenderBackend * m_renderbackend
 
IGUIManager * m_guimanager
 
EventManager * m_eventmanager
 
SoundManager * m_soundmanager
 
TimeManager * m_timemanager
 
ImageManager * m_imagemanager
 
AnimationManager * m_animationmanager
 
SoundClipManager * m_soundclipmanager
 
VFS * m_vfs
 
Model * m_model
 
LogManager * m_logmanager
 
Cursor * m_cursor
 
bool m_destroyed
 
EngineSettings m_settings
 
DeviceCaps m_devcaps
 
ScreenMode m_screenMode
 
OffRenderer * m_offrenderer
 
TargetRenderer * m_targetrenderer
 
std::vector< RendererBase * > m_renderers
 
std::vector< IEngineChangeListener * > m_changelisteners
 

Detailed Description

Engine acts as a controller to the whole system Responsibilities of the engine are:

  • Construct and initialize engine internals
  • Clean-up when the program ends
  • Act as an entry point to the engine subsystems

Definition at line 80 of file engine.h.

Constructor & Destructor Documentation

◆ Engine()

FIFE::Engine::Engine ( )

Constructor.

Definition at line 91 of file engine.cpp.

References FIFE::LogManager::instance(), and m_logmanager.

◆ ~Engine()

FIFE::Engine::~Engine ( )
virtual

Destructor.

Definition at line 316 of file engine.cpp.

References destroy(), and m_destroyed.

Member Function Documentation

◆ addChangeListener()

void FIFE::Engine::addChangeListener ( IEngineChangeListener *  listener)

Adds new change listener.

Parameters
listenerto add

Definition at line 389 of file engine.cpp.

References m_changelisteners.

◆ changeScreenMode()

void FIFE::Engine::changeScreenMode ( const ScreenMode &  mode)

Changes the screen mode.

This should be called instead of the renderer's setScreenMode() function. It takes care of any objects that need to be re-created after switching screen modes.

Parameters
modeA valid ScreenMode retrieved from FIFE::DeviceCaps::getNearestScreenMode()

Definition at line 140 of file engine.cpp.

References FIFE::RenderBackend::createMainScreen(), FIFE::ScreenMode::getHeight(), FIFE::ScreenMode::getWidth(), FIFE::EngineSettings::getWindowIcon(), FIFE::EngineSettings::getWindowTitle(), FIFE::Cursor::invalidate(), FIFE::ImageManager::invalidateAll(), m_changelisteners, m_cursor, m_guimanager, m_imagemanager, m_renderbackend, m_settings, and FIFE::IGUIManager::resizeTopContainer().

◆ destroy()

void FIFE::Engine::destroy ( )

Explicit destruction of engine.

Definition at line 322 of file engine.cpp.

References FIFE::_log, FL_LOG, m_animationmanager, m_cursor, m_destroyed, m_eventmanager, m_guimanager, m_imagemanager, m_model, m_offrenderer, m_renderbackend, m_renderers, m_soundclipmanager, m_soundmanager, m_targetrenderer, m_timemanager, and m_vfs.

Referenced by ~Engine().

+ Here is the caller graph for this function:

◆ finalizePumping()

void FIFE::Engine::finalizePumping ( )

Finalizes the continuous processing of the engine Call this only once in your program, after you have called initializePumping + (pump() * N times)

Definition at line 385 of file engine.cpp.

◆ getAnimationManager()

AnimationManager* FIFE::Engine::getAnimationManager ( ) const
inline

Provides access point to the ImageManager.

Definition at line 158 of file engine.h.

◆ getCursor()

Cursor* FIFE::Engine::getCursor ( ) const
inline

Returns cursor used in the engine.

Definition at line 182 of file engine.h.

◆ getDeviceCaps()

const DeviceCaps & FIFE::Engine::getDeviceCaps ( ) const

Gets device capabilities.

Definition at line 136 of file engine.cpp.

References m_devcaps.

◆ getEventManager()

EventManager* FIFE::Engine::getEventManager ( ) const
inline

Provides access point to the EventManager.

Definition at line 136 of file engine.h.

◆ getGuiManager()

IGUIManager* FIFE::Engine::getGuiManager ( ) const
inline

Provides access point to the GUI Manager.

Definition at line 150 of file engine.h.

◆ getImageManager()

ImageManager* FIFE::Engine::getImageManager ( ) const
inline

Provides access point to the ImageManager.

Definition at line 154 of file engine.h.

◆ getLogManager()

LogManager* FIFE::Engine::getLogManager ( ) const
inline

Provides access point to the LogManager.

Definition at line 174 of file engine.h.

◆ getModel()

Model* FIFE::Engine::getModel ( ) const
inline

Provides access point to the Model.

Definition at line 170 of file engine.h.

◆ getOffRenderer()

OffRenderer* FIFE::Engine::getOffRenderer ( ) const
inline

Provides access point to the OffRenderer.

Definition at line 186 of file engine.h.

◆ getRenderBackend()

RenderBackend* FIFE::Engine::getRenderBackend ( ) const
inline

Provides access point to the RenderBackend.

Definition at line 166 of file engine.h.

◆ getSettings()

EngineSettings & FIFE::Engine::getSettings ( )

Gets settings class for engine.

Definition at line 132 of file engine.cpp.

References m_settings.

◆ getSoundClipManager()

SoundClipManager* FIFE::Engine::getSoundClipManager ( ) const
inline

Provides access point to the SoundClipManager.

Definition at line 162 of file engine.h.

◆ getSoundManager()

SoundManager* FIFE::Engine::getSoundManager ( ) const
inline

Provides access point to the SoundManager.

Definition at line 132 of file engine.h.

◆ getTargetRenderer()

TargetRenderer* FIFE::Engine::getTargetRenderer ( ) const
inline

Provides access point to the TargetRenderer.

Definition at line 190 of file engine.h.

◆ getTimeManager()

TimeManager* FIFE::Engine::getTimeManager ( ) const
inline

Provides access point to the TimeManager.

Definition at line 140 of file engine.h.

◆ getVFS()

VFS* FIFE::Engine::getVFS ( ) const
inline

Provides access point to the VFS.

Definition at line 178 of file engine.h.

◆ init()

void FIFE::Engine::init ( )

Initializes the engine.

Definition at line 159 of file engine.cpp.

References FIFE::_log, FIFE::VFS::addProvider(), FIFE::VFS::addSource(), FIFE::Model::adoptCellGrid(), FIFE::Model::adoptPather(), FIFE::RenderBackend::createMainScreen(), FIFE::DeviceCaps::fillDeviceCaps(), FL_LOG, FL_WARN, FIFE::DeviceCaps::getAvailableRenderDrivers(), FIFE::DeviceCaps::getAvailableVideoDrivers(), FIFE::EngineSettings::getBitsPerPixel(), FIFE::EngineSettings::getColorKey(), FIFE::EngineSettings::getDisplay(), FIFE::EngineSettings::getFrameLimit(), FIFE::EngineSettings::getGLAlphaTestValue(), FIFE::EngineSettings::getGLTextureFiltering(), FIFE::EngineSettings::getInitialVolume(), FIFE::EngineSettings::getLightingModel(), FIFE::EngineSettings::getMouseSensitivity(), FIFE::DeviceCaps::getNearestScreenMode(), FIFE::EngineSettings::getRefreshRate(), FIFE::EngineSettings::getRenderBackend(), FIFE::EngineSettings::getScreenHeight(), FIFE::EngineSettings::getScreenWidth(), FIFE::EngineSettings::getSDLDriver(), FIFE::EngineSettings::getVideoDriver(), FIFE::EngineSettings::getWindowIcon(), FIFE::EngineSettings::getWindowTitle(), FIFE::RenderBackend::init(), FIFE::EngineSettings::isColorKeyEnabled(), FIFE::EngineSettings::isFrameLimitEnabled(), FIFE::EngineSettings::isFullScreen(), FIFE::EngineSettings::isGLCompressImages(), FIFE::EngineSettings::isGLUseDepthBuffer(), FIFE::EngineSettings::isGLUseFramebuffer(), FIFE::EngineSettings::isGLUseMipmapping(), FIFE::EngineSettings::isGLUseMonochrome(), FIFE::EngineSettings::isGLUseNPOT(), FIFE::EngineSettings::isJoystickSupport(), FIFE::EngineSettings::isMouseAccelerationEnabled(), FIFE::EngineSettings::isNativeImageCursorEnabled(), FIFE::EngineSettings::isVSync(), m_animationmanager, m_cursor, m_destroyed, m_devcaps, m_eventmanager, m_imagemanager, m_model, m_offrenderer, m_renderbackend, m_renderers, m_screenMode, m_settings, m_soundclipmanager, m_soundmanager, m_targetrenderer, m_timemanager, m_vfs, FIFE::RenderBackend::setAlphaTestValue(), FIFE::RenderBackend::setColorKeyEnabled(), FIFE::RenderBackend::setDepthBufferEnabled(), FIFE::RenderBackend::setFramebufferEnabled(), FIFE::RenderBackend::setFrameLimit(), FIFE::RenderBackend::setFrameLimitEnabled(), FIFE::RenderBackend::setImageCompressingEnabled(), FIFE::EventManager::setJoystickSupport(), FIFE::RenderBackend::setLightingModel(), FIFE::RenderBackend::setMipmappingEnabled(), FIFE::RenderBackend::setMonochromeEnabled(), FIFE::EventManager::setMouseAccelerationEnabled(), FIFE::EventManager::setMouseSensitivity(), FIFE::Cursor::setNativeImageCursorEnabled(), FIFE::RenderBackend::setNPOTEnabled(), FIFE::DeviceCaps::setRenderDriverName(), FIFE::RenderBackend::setTextureFiltering(), FIFE::DeviceCaps::setVideoDriverName(), FIFE::SoundManager::setVolume(), and FIFE::RenderBackend::setVSyncEnabled().

◆ initializePumping()

void FIFE::Engine::initializePumping ( )

Initializes the continuous processing of the engine Call this only once in your program.

Definition at line 359 of file engine.cpp.

References m_eventmanager, and FIFE::EventManager::processEvents().

◆ pump()

void FIFE::Engine::pump ( )

Runs one cycle for the engine.

Definition at line 363 of file engine.cpp.

References FIFE::RenderBackend::clearBackBuffer(), FIFE::Cursor::draw(), FIFE::RenderBackend::endFrame(), FIFE::Model::getActiveCameraCount(), m_cursor, m_eventmanager, m_guimanager, m_model, m_offrenderer, m_renderbackend, m_soundmanager, m_targetrenderer, m_timemanager, FIFE::EventManager::processEvents(), FIFE::TargetRenderer::render(), FIFE::OffRenderer::render(), FIFE::RenderBackend::startFrame(), FIFE::IGUIManager::turn(), FIFE::TimeManager::update(), FIFE::Model::update(), and FIFE::SoundManager::update().

◆ removeChangeListener()

void FIFE::Engine::removeChangeListener ( IEngineChangeListener *  listener)

Removes associated change listener.

Parameters
listenerto remove

Definition at line 393 of file engine.cpp.

References m_changelisteners.

◆ setGuiManager()

void FIFE::Engine::setGuiManager ( IGUIManager *  guimanager)
inline

Sets the GUI Manager to use.

Engine takes ownership of the manager so DONT DELETE IT!

Definition at line 146 of file engine.h.

Member Data Documentation

◆ m_animationmanager

AnimationManager* FIFE::Engine::m_animationmanager
private

Definition at line 209 of file engine.h.

Referenced by destroy(), and init().

◆ m_changelisteners

std::vector<IEngineChangeListener*> FIFE::Engine::m_changelisteners
private

Definition at line 228 of file engine.h.

Referenced by addChangeListener(), changeScreenMode(), and removeChangeListener().

◆ m_cursor

Cursor* FIFE::Engine::m_cursor
private

Definition at line 216 of file engine.h.

Referenced by changeScreenMode(), destroy(), init(), and pump().

◆ m_destroyed

bool FIFE::Engine::m_destroyed
private

Definition at line 217 of file engine.h.

Referenced by destroy(), init(), and ~Engine().

◆ m_devcaps

DeviceCaps FIFE::Engine::m_devcaps
private

Definition at line 220 of file engine.h.

Referenced by getDeviceCaps(), and init().

◆ m_eventmanager

EventManager* FIFE::Engine::m_eventmanager
private

Definition at line 205 of file engine.h.

Referenced by destroy(), init(), initializePumping(), and pump().

◆ m_guimanager

IGUIManager* FIFE::Engine::m_guimanager
private

Definition at line 204 of file engine.h.

Referenced by changeScreenMode(), destroy(), and pump().

◆ m_imagemanager

ImageManager* FIFE::Engine::m_imagemanager
private

Definition at line 208 of file engine.h.

Referenced by changeScreenMode(), destroy(), and init().

◆ m_logmanager

LogManager* FIFE::Engine::m_logmanager
private

Definition at line 214 of file engine.h.

Referenced by Engine().

◆ m_model

Model* FIFE::Engine::m_model
private

Definition at line 213 of file engine.h.

Referenced by destroy(), init(), and pump().

◆ m_offrenderer

OffRenderer* FIFE::Engine::m_offrenderer
private

Definition at line 224 of file engine.h.

Referenced by destroy(), init(), and pump().

◆ m_renderbackend

RenderBackend* FIFE::Engine::m_renderbackend
private

Definition at line 203 of file engine.h.

Referenced by changeScreenMode(), destroy(), init(), and pump().

◆ m_renderers

std::vector<RendererBase*> FIFE::Engine::m_renderers
private

Definition at line 226 of file engine.h.

Referenced by destroy(), and init().

◆ m_screenMode

ScreenMode FIFE::Engine::m_screenMode
private

Definition at line 222 of file engine.h.

Referenced by init().

◆ m_settings

EngineSettings FIFE::Engine::m_settings
private

Definition at line 219 of file engine.h.

Referenced by changeScreenMode(), getSettings(), and init().

◆ m_soundclipmanager

SoundClipManager* FIFE::Engine::m_soundclipmanager
private

Definition at line 210 of file engine.h.

Referenced by destroy(), and init().

◆ m_soundmanager

SoundManager* FIFE::Engine::m_soundmanager
private

Definition at line 206 of file engine.h.

Referenced by destroy(), init(), and pump().

◆ m_targetrenderer

TargetRenderer* FIFE::Engine::m_targetrenderer
private

Definition at line 225 of file engine.h.

Referenced by destroy(), init(), and pump().

◆ m_timemanager

TimeManager* FIFE::Engine::m_timemanager
private

Definition at line 207 of file engine.h.

Referenced by destroy(), init(), and pump().

◆ m_vfs

VFS* FIFE::Engine::m_vfs
private

Definition at line 212 of file engine.h.

Referenced by destroy(), and init().

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