The Nebula Device 3: Animation::AnimEventServer Class Reference

The Nebula Device 3

Animation::AnimEventServer Class Reference

#include <animeventserver.h>

Inheritance diagram for Animation::AnimEventServer:

Messaging::Handler Core::RefCounted

Detailed Description

This is the server, which is triggered if a animation event is emitted.

Attach here some handlers to handle special animevents. Handler can be registered via RegisterAnimEventHandler and unregistered through UnregisterAnimEventHandler messages from the GraphicsProtocol!

Animeventhandler are specified by there category name, they handle!

(C) 2009 Radon Labs GmbH

Public Member Functions

 AnimEventServer ()
 constructor
virtual ~AnimEventServer ()
 destructor
void Open ()
 open the server
void Close ()
 close the server
bool IsOpen () const
 return true if open
void OnFrame (Timing::Time time)
 delegate to attached handler
void RegisterAnimEventHandler (const Ptr< AnimEventHandlerBase > &newHandler)
 attach an animeventhandler
void UnregisterAnimEventHandler (const Util::StringAtom &categoryName)
 detach an animeventhandler
bool HandleAnimEvents (const Util::Array< Animation::AnimEventInfo > &eventz)
 delegate this event to a attached handler
virtual bool HandleMessage (const Ptr< Messaging::Message > &msg)
 handle a message, return true if handled
virtual void DoWork ()
 optional "per-frame" DoWork method for continuous handlers
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!)

Member Function Documentation

void Messaging::Handler::DoWork (  )  [virtual, inherited]

optional "per-frame" DoWork method for continuous handlers

This is an optional method for handlers which need to do continuous work (like a render thread message handler). This message will be called after messages have been handled.

Reimplemented in Debug::DebugHandler, Http::HttpMessageHandler, Interface::InterfaceHandlerBase, Debug::DebugGraphicsHandler, and Graphics::GraphicsHandler.

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.