Osiris Framework  0.3
OObject Class Reference

Base OsirisSDK class. More...

#include <OsirisSDK/OObject.h>

Inheritance diagram for OObject:
OCameraController OText2D

Public Member Functions

 OObject ()
 Class constructor.
 
virtual ~OObject ()
 Class destructor.
 
void scheduleDelete ()
 Schedule this object for deletion at the end of an application loop.
 
virtual void processEvent (const OEvent *evt)
 Main event handle. More...
 

Protected Member Functions

virtual void onKeyboardPress (const OKeyboardPressEvent *evt)
 Keyboard press event handler. More...
 
virtual void onKeyboardRelease (const OKeyboardPressEvent *evt)
 Mouse release event handler. More...
 
virtual void onMouseClick (const OMouseClickEvent *evt)
 Mouse click event handler. More...
 
virtual void onMouseMove (const OMouseMoveEvent *evt)
 Mouse active and passive move event handler. More...
 
virtual void onScreenResize (const OResizeEvent *evt)
 Screen resize event handler. More...
 

Detailed Description

Base OsirisSDK class.

Objects of this class are tied to the running application. They can be subscribed to listen to events. Their deletion can be handled by the application.

Member Function Documentation

void OObject::onKeyboardPress ( const OKeyboardPressEvent evt)
protectedvirtual

Keyboard press event handler.

This handler is only called if the object is set as an event recipient. By default does nothing.

Parameters
evtKeyboard event object.

Reimplemented in OCameraController.

void OObject::onKeyboardRelease ( const OKeyboardPressEvent evt)
protectedvirtual

Mouse release event handler.

This handler is only called if the object is set as an event recipient. By default does nothing.

Parameters
evtMouse click event object.

Reimplemented in OCameraController.

void OObject::onMouseClick ( const OMouseClickEvent evt)
protectedvirtual

Mouse click event handler.

This handler is only called if the object is set as an event recipient. By default does nothing.

Parameters
evtMouse click event object.

Reimplemented in OCameraController.

void OObject::onMouseMove ( const OMouseMoveEvent evt)
protectedvirtual

Mouse active and passive move event handler.

This handler is only called if the object is set as an event recipient. By default does nothing.

Parameters
evtMouse move event object.

Reimplemented in OCameraController.

void OObject::onScreenResize ( const OResizeEvent evt)
protectedvirtual

Screen resize event handler.

This handler is only called if the object is set as an event recipient. By default does nothing.

Parameters
evtScreen resize event object.

Reimplemented in OText2D.

void OObject::processEvent ( const OEvent evt)
virtual

Main event handle.

This is meant to be called by OApplication class objects. From here the specific event handlers are called. But can be overriden if necessary.

Parameters
evtEvent class object.

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