The Nebula Device 3: CoreGraphics::RenderEventHandler Class Reference

The Nebula Device 3

CoreGraphics::RenderEventHandler Class Reference

#include <rendereventhandler.h>

Inheritance diagram for CoreGraphics::RenderEventHandler:

Core::RefCounted CoreGraphics::ThreadSafeRenderEventHandler

Detailed Description

A render event handler object is notified by the RenderDevice about noteworthy events. To react to those events, derive a class from RenderEventHandler, and attach to the render device via RenderDevice::AttachEventHandler().

(C) 2007 Radon Labs GmbH

Public Member Functions

 RenderEventHandler ()
 constructor
virtual ~RenderEventHandler ()
 destructor
virtual void OnAttach ()
 called when the event handler is attached to the RenderDevice
virtual void OnRemove ()
 called when the event handler is removed from the RenderDevice
virtual bool PutEvent (const RenderEvent &event)
 called by RenderDevice when an event happens
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Protected Member Functions

virtual bool HandleEvent (const RenderEvent &event)
 called when an event should be processed, override this method in your subclass

Member Function Documentation

bool CoreGraphics::RenderEventHandler::PutEvent ( const RenderEvent e  )  [virtual]

called by RenderDevice when an event happens

This method is called by the RenderDevice when an event happens. The default behaviour of this class is to call the HandleEvent() method directly. Subclasses of RenderEventHandler may choose to implement a different behaviour.

Reimplemented in CoreGraphics::ThreadSafeRenderEventHandler.

bool CoreGraphics::RenderEventHandler::HandleEvent ( const RenderEvent e  )  [protected, virtual]

called when an event should be processed, override this method in your subclass

Handle a render event. This method is usually called by PutEvent(), but subclasses of RenderEventHandler may choose to implement a different behaviour. Override this method in your subclass to process the incoming event.

Reimplemented in CoreGraphics::ThreadSafeRenderEventHandler.

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.