Animation::AnimEventHandlerBase Class Reference
#include <animeventhandlerbase.h>
Inheritance diagram for Animation::AnimEventHandlerBase:
Detailed Description
This is the baseclass for handling animation events.Create this ín Main application and register it via RegisterAnimEventHandler to the AnimEventServer. This will call the Handler to handle the AnimEvents.
Finally throw away the pointer on the application side and unregister the handler via name (wich equls the category name)!
Use in subclasses just internal graphics code stuff, cause this handler will work at the render thread side once they are attached!!!
(C) 2009 Radon Labs GmbH
Public Member Functions | |
| AnimEventHandlerBase () | |
| constructor | |
| virtual | ~AnimEventHandlerBase () |
| destructor | |
| virtual bool | HandleEvent (const Animation::AnimEventInfo &event) |
| handle a event | |
| virtual void | OnFrame (Timing::Time time) |
| optional on frame method | |
| void | SetCategoryName (const Util::StringAtom &catName) |
| set the category name | |
| const Util::StringAtom & | GetCategoryName () const |
| get the category name | |
| virtual void | Open () |
| called once on startup | |
| virtual void | Close () |
| called once before shutdown | |
| bool | IsOpen () const |
| return true if open | |
| virtual bool | HandleMessage (const Ptr< 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::String & | GetClassName () 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::Open | ( | ) | [virtual, inherited] |
called once on startup
Open the handler. This method is called once after the handler has been attached to a port and before the first call to HandleMessage().
Reimplemented in Debug::DebugHandler, Http::HttpMessageHandler, IO::IoInterfaceHandler, Animation::AnimEventServer, and Graphics::GraphicsHandler.
| void Messaging::Handler::Close | ( | ) | [virtual, inherited] |
called once before shutdown
Close the handler. This method is called once before the handler is detached from the port.
Reimplemented in Debug::DebugHandler, Http::HttpMessageHandler, IO::IoInterfaceHandler, Animation::AnimEventServer, and Graphics::GraphicsHandler.
handle a message, return true if handled
Derive this method in a subclass to handle specific messages. The method should return true only if a message has been handled.
Reimplemented in Http::HttpMessageHandler, IO::IoInterfaceHandler, Animation::AnimEventServer, Debug::DebugGraphicsHandler, and Graphics::GraphicsHandler.
| 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.