CoreAnimation::AnimResource Class Reference
#include <animresource.h>
Inheritance diagram for CoreAnimation::AnimResource:
Detailed Description
A AnimResource is a collection of related animation clips (for instance all animation clips of a character). AnimResources contain read-only data and are usually shared between several clients. One AnimResource usually contains the data of one animation resource file.(C) 2008 Radon Labs GmbH
Public Types | |
| enum | State |
| resource states (DO NOT CHANGE ORDER!) | |
Public Member Functions | |
| AnimResource () | |
| constructor | |
| virtual | ~AnimResource () |
| destructor | |
| virtual void | Unload () |
| unload the resource, or cancel the pending load | |
| SizeT | GetNumClips () const |
| get number of animation clips | |
| const AnimClip & | GetClipByIndex (IndexT clipIndex) const |
| get animation clip at index | |
| bool | HasClip (const Util::StringAtom &clipName) const |
| return true if clip exists by name | |
| IndexT | GetClipIndexByName (const Util::StringAtom &clipName) const |
| get clip index by name, returns invalid index if not found | |
| const AnimClip & | GetClipByName (const Util::StringAtom &clipName) const |
| get clip by name | |
| const Ptr< AnimKeyBuffer > & | GetKeyBuffer () const |
| get pointer to AnimKeyBuffer | |
| const Math::float4 * | ComputeKeySlicePointerAndSize (IndexT clipIndex, IndexT keyIndex, SizeT &outSliceByteSize) const |
| get pointer to start of a key slice, and return size of a key slice | |
| void | SetAsyncEnabled (bool b) |
| request synchronous/asynchronous resource loading | |
| bool | IsAsyncEnabled () const |
| return true if asynchronous resource loading is enabled | |
| void | Lock () |
| set locked to true | |
| void | Unlock () |
| set locked to false | |
| bool | IsLocked () const |
| returns true if resource will be used as source for copy process soon | |
| void | SetResourceId (const ResourceId &id) |
| set the resource identifier | |
| const ResourceId & | GetResourceId () const |
| get the resource identifier | |
| void | SetLoader (const Ptr< ResourceLoader > &loader) |
| set optional resource loader | |
| const Ptr< ResourceLoader > & | GetLoader () const |
| get optional resource loader | |
| void | SetSaver (const Ptr< ResourceSaver > &saver) |
| set optional resource saver | |
| const Ptr< ResourceSaver > & | GetSaver () const |
| get optional resource saver | |
| SizeT | GetUseCount () const |
| get current use count | |
| virtual State | Load () |
| load the resource | |
| void | SetState (State s) |
| set current state (usually only called during Load()!) | |
| State | GetState () const |
| get current state | |
| bool | IsLoaded () const |
| return true if current state is Loaded | |
| bool | IsPending () const |
| return true if current state is Pending | |
| bool | LoadFailed () const |
| return true if current state is Failed | |
| virtual bool | Save () |
| save the resource | |
| 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 | IncrUseCount () |
| increment use count | |
| void | DecrUseCount () |
| decrement use count | |
Member Function Documentation
| void CoreAnimation::AnimResource::Unload | ( | ) | [virtual] |
unload the resource, or cancel the pending load
This method is called by the resource subsystem when the resource should unload its data.
Reimplemented from Resources::Resource.
| const float4 * CoreAnimation::AnimResource::ComputeKeySlicePointerAndSize | ( | IndexT | clipIndex, | |
| IndexT | keyIndex, | |||
| SizeT & | outSliceByteSize | |||
| ) | const |
get pointer to start of a key slice, and return size of a key slice
Compute start pointer and size of a key slice of a clip in the anim resource. NOTE: if all anim curves of the clip are static (which means there are exist no actual keys), then the method will return a NULL pointer, and an outSliceByteSlice of 0.
| Resource::State Resources::Resource::Load | ( | ) | [virtual, inherited] |
load the resource
This loads the resource through the attached resource loader. Depending on the resource loader, the resource may happen synchronously or asynchronously. If the resource is loaded asynchronously, the IsPending() method will return true as long as the load is in progress, and IsLoaded() will become true when the loading process has finished. If the load has failed, IsPending() will switch to false and IsLoaded() will not be true.
| bool Resources::Resource::Save | ( | ) | [virtual, inherited] |
save the resource
This will save the resource. A resource saver must be attached to the resource and the resource must be loaded for the method to succeed. Saving will always be performed synchronously.
| 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.