CoreGraphics::StreamAnimationLoader Class Reference
#include <streamanimationloader.h>
Inheritance diagram for CoreGraphics::StreamAnimationLoader:
Detailed Description
Setup a animation object from a stream. Supports the following file formats:
- nax2 (Nebula2 binary animation file format)
- nax3 (Nebula3 binary animation file format)
- nanim3 (Nebula3 ascii animation file format)
- Todo:
- : document file formats
Public Member Functions | |
| StreamAnimationLoader () | |
| constructor | |
| virtual | ~StreamAnimationLoader () |
| destructor | |
| virtual bool | CanLoadAsync () const |
| return true if asynchronous loading is supported | |
| virtual bool | OnLoadRequested () |
| called by resource when a load is requested | |
| virtual void | OnLoadCancelled () |
| called by resource to cancel a pending load | |
| virtual bool | OnPending () |
| call frequently while after OnLoadRequested() to put Resource into loaded state | |
| virtual void | OnAttachToResource (const Ptr< Resource > &res) |
| called when the resource loader is attached to its resource | |
| virtual void | OnRemoveFromResource () |
| called when the resource loader is removed from its resource | |
| bool | IsAttachedToResource () const |
| return true if attached to resource | |
| const Ptr< Resource > & | GetResource () const |
| get pointer to resource | |
| Resource::State | GetState () const |
| return current state | |
| 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!) | |
Protected Member Functions | |
| void | SetState (Resource::State s) |
| set current state | |
Member Function Documentation
| 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.