Jopnal Engine  alpha 0.4
Simple Component Based 2D/3D Game Engine
Public Member Functions | Protected Member Functions | List of all members
jop::Subsystem Class Referenceabstract

#include <SubSystem.hpp>

Inheritance diagram for jop::Subsystem:
jop::AudioDevice jop::MainRenderTarget jop::PostProcessor jop::ResourceManager jop::SettingManager jop::ShaderAssembler jop::ShaderPreprocessor jop::Window

Public Member Functions

 Subsystem (const uint32 ID)
 Constructor. More...
 
virtual ~Subsystem ()=0
 Virtual destructor. More...
 
virtual void preUpdate (const float deltaTime)
 Pre-update. More...
 
virtual void postUpdate (const float deltaTime)
 Post-update. More...
 
virtual void draw ()
 Draw. More...
 
Message::Result sendMessage (const Message &message)
 Function to handle messages. More...
 
SubsystemsetActive (const bool active)
 Set this sub system active. More...
 
bool isActive () const
 Check if this sub system is active. More...
 
uint32 getID () const
 Get the ID. More...
 

Protected Member Functions

virtual Message::Result receiveMessage (const Message &message)
 Receive a message. More...
 

Detailed Description

Definition at line 38 of file SubSystem.hpp.

Constructor & Destructor Documentation

jop::Subsystem::Subsystem ( const uint32  ID)

Constructor.

Parameters
IDIdentifier of this subsystem
virtual jop::Subsystem::~Subsystem ( )
pure virtual

Virtual destructor.

Member Function Documentation

virtual void jop::Subsystem::draw ( )
virtual

Draw.

This will be called during rendering.

Reimplemented in jop::Window, and jop::PostProcessor.

uint32 jop::Subsystem::getID ( ) const

Get the ID.

Returns
The ID
bool jop::Subsystem::isActive ( ) const

Check if this sub system is active.

Returns
True if active
virtual void jop::Subsystem::postUpdate ( const float  deltaTime)
virtual

Post-update.

This will be called after the engine calls the scene's update.

Parameters
deltaTimeDelta time

Reimplemented in jop::Window.

virtual void jop::Subsystem::preUpdate ( const float  deltaTime)
virtual

Pre-update.

This will be called before the engine calls the scene's update.

Parameters
deltaTimeDelta time

Reimplemented in jop::Window, jop::SettingManager, and jop::MainRenderTarget.

virtual Message::Result jop::Subsystem::receiveMessage ( const Message message)
protectedvirtual

Receive a message.

Override this to handle messages sent to this. Don't forget to call the base class' method as well to ensure that the message gets forwarded correctly.

Parameters
messageThe message
Returns
The message result
Message::Result jop::Subsystem::sendMessage ( const Message message)

Function to handle messages.

Parameters
messageThe message
Returns
The message result
Subsystem& jop::Subsystem::setActive ( const bool  active)

Set this sub system active.

Parameters
activeTrue to set active
Returns
Reference to self

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