#include <OgreSkeleton.h>
Public Types | |
typedef std::vector < Bone * > | BoneList |
typedef VectorIterator < BoneList > | BoneIterator |
typedef std::vector < LinkedSkeletonAnimationSource > | LinkedSkeletonAnimSourceList |
typedef ConstVectorIterator < LinkedSkeletonAnimSourceList > | LinkedSkeletonAnimSourceIterator |
typedef std::vector < ushort > | BoneHandleMap |
Map to translate bone handle from one skeleton to another skeleton. | |
enum | LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING } |
Enum identifying the loading state of the resource. More... | |
Public Member Functions | |
Skeleton (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0) | |
Constructor, don't call directly, use SkeletonManager. | |
virtual | ~Skeleton () |
virtual Bone * | createBone (void) |
Creates a brand new Bone owned by this Skeleton. | |
virtual Bone * | createBone (unsigned short handle) |
Creates a brand new Bone owned by this Skeleton. | |
virtual Bone * | createBone (const String &name) |
Creates a brand new Bone owned by this Skeleton. | |
virtual Bone * | createBone (const String &name, unsigned short handle) |
Creates a brand new Bone owned by this Skeleton. | |
virtual unsigned short | getNumBones (void) const |
Returns the number of bones in this skeleton. | |
virtual Bone * | getRootBone (void) const |
Gets the root bone of the skeleton: deprecated in favour of getRootBoneIterator. | |
virtual BoneIterator | getRootBoneIterator (void) |
Get an iterator over the root bones in the skeleton, ie those with no parents. | |
virtual BoneIterator | getBoneIterator (void) |
Get an iterator over all the bones in the skeleton. | |
virtual Bone * | getBone (unsigned short handle) const |
Gets a bone by it's handle. | |
virtual Bone * | getBone (const String &name) const |
Gets a bone by it's name. | |
virtual void | setBindingPose (void) |
Sets the current position / orientation to be the 'binding pose' ie the layout in which bones were originally bound to a mesh. | |
virtual void | reset (bool resetManualBones=false) |
Resets the position and orientation of all bones in this skeleton to their original binding position. | |
virtual Animation * | createAnimation (const String &name, Real length) |
Creates a new Animation object for animating this skeleton. | |
virtual Animation * | getAnimation (const String &name, const LinkedSkeletonAnimationSource **linker=0) const |
Returns the named Animation object. | |
virtual Animation * | _getAnimationImpl (const String &name, const LinkedSkeletonAnimationSource **linker=0) const |
Internal accessor for animations (returns null if animation does not exist). | |
virtual bool | hasAnimation (const String &name) |
Returns whether this skeleton contains the named animation. | |
virtual void | removeAnimation (const String &name) |
Removes an Animation from this skeleton. | |
virtual void | setAnimationState (const AnimationStateSet &animSet) |
Changes the state of the skeleton to reflect the application of the passed in collection of animations. | |
virtual void | _initAnimationState (AnimationStateSet *animSet) |
Initialise an animation set suitable for use with this skeleton. | |
virtual void | _refreshAnimationState (AnimationStateSet *animSet) |
Refresh an animation set suitable for use with this skeleton. | |
virtual void | _getBoneMatrices (Matrix4 *pMatrices) |
Populates the passed in array with the bone matrices based on the current position. | |
virtual unsigned short | getNumAnimations (void) const |
Gets the number of animations on this skeleton. | |
virtual Animation * | getAnimation (unsigned short index) const |
Gets a single animation by index. | |
virtual SkeletonAnimationBlendMode | getBlendMode () const |
Gets the animation blending mode which this skeleton will use. | |
virtual void | setBlendMode (SkeletonAnimationBlendMode state) |
Sets the animation blending mode this skeleton will use. | |
virtual void | _updateTransforms (void) |
Updates all the derived transforms in the skeleton. | |
virtual void | optimiseAllAnimations (bool preservingIdentityNodeTracks=false) |
Optimise all of this skeleton's animations. | |
virtual void | addLinkedSkeletonAnimationSource (const String &skelName, Real scale=1.0f) |
Allows you to use the animations from another Skeleton object to animate this skeleton. | |
virtual void | removeAllLinkedSkeletonAnimationSources (void) |
Remove all links to other skeletons for the purposes of sharing animation. | |
virtual LinkedSkeletonAnimSourceIterator | getLinkedSkeletonAnimationSourceIterator (void) const |
Get an iterator over the linked skeletons used as animation sources. | |
virtual void | _notifyManualBonesDirty (void) |
Internal method for marking the manual bones as dirty. | |
virtual void | _notifyManualBoneStateChange (Bone *bone) |
Internal method for notifying that a bone is manual. | |
virtual bool | getManualBonesDirty (void) const |
Have manual bones been modified since the skeleton was last updated? | |
virtual bool | hasManualBones (void) const |
Are there any manually controlled bones? | |
virtual void | _mergeSkeletonAnimations (const Skeleton *source, const BoneHandleMap &boneHandleMap, const StringVector &animations=StringVector()) |
Merge animations from another Skeleton object into this skeleton. | |
virtual void | _buildMapBoneByHandle (const Skeleton *source, BoneHandleMap &boneHandleMap) const |
Build the bone handle map to use with Skeleton::_mergeSkeletonAnimations. | |
virtual void | _buildMapBoneByName (const Skeleton *source, BoneHandleMap &boneHandleMap) const |
Build the bone handle map to use with Skeleton::_mergeSkeletonAnimations. | |
virtual void | load (bool backgroundThread=false) |
Loads the resource, if it is not already. | |
virtual void | reload (void) |
Reloads the resource, if it is already loaded. | |
bool | isReloadable (void) const |
Returns true if the Resource is reloadable, false otherwise. | |
bool | isManuallyLoaded (void) const |
Is this resource manually loaded? | |
virtual void | unload (void) |
Unloads the resource; this is not permanent, the resource can be reloaded later if required. | |
size_t | getSize (void) const |
Retrieves info about the size of the resource. | |
virtual void | touch (void) |
'Touches' the resource to indicate it has been used. | |
const String & | getName (void) const |
Gets resource name. | |
ResourceHandle | getHandle (void) const |
bool | isLoaded (void) const |
Returns true if the Resource has been loaded, false otherwise. | |
LoadingState | isLoading () const |
Returns whether the resource is currently in the process of background loading. | |
LoadingState | getLoadingState () const |
Returns the current loading state. | |
bool | isBackgroundLoaded (void) const |
Returns whether this Resource has been earmarked for background loading. | |
void | setBackgroundLoaded (bool bl) |
Tells the resource whether it is background loaded or not. | |
void | escalateLoading () |
Escalates the loading of a background loaded resource. | |
void | addListener (Listener *lis) |
Register a listener on this resource. | |
void | removeListener (Listener *lis) |
Remove a listener on this resource. | |
const String & | getGroup (void) |
Gets the group which this resource is a member of. | |
void | changeGroupOwnership (const String &newGroup) |
Change the resource group ownership of a Resource. | |
ResourceManager * | getCreator (void) |
Gets the manager which created this resource. | |
const String & | getOrigin (void) const |
Get the origin of this resource, e.g. | |
void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. | |
virtual void | _fireBackgroundLoadingComplete (void) |
Firing of background loading complete event. | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. | |
const ParamDictionary * | getParamDictionary (void) const |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. | |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. | |
Static Public Member Functions | |
static void | cleanupDictionary () |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. | |
Protected Types | |
typedef std::map < String, Bone * > | BoneListByName |
Lookup by bone name. | |
typedef std::set < Bone * > | BoneSet |
typedef std::map < String, Animation * > | AnimationList |
Storage of animations, lookup by name. | |
typedef std::list < Listener * > | ListenerList |
Protected Member Functions | |
Skeleton () | |
Internal constructor for use by SkeletonInstance only. | |
void | deriveRootBone (void) const |
Internal method which parses the bones to derive the root bone. | |
void | _dumpContents (const String &filename) |
Debugging method. | |
void | loadImpl (void) |
Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader. | |
void | unloadImpl (void) |
Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader. | |
size_t | calculateSize (void) const |
Calculate the size of a resource; this will only be called after 'load'. | |
virtual void | preLoadImpl (void) |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'. | |
virtual void | postLoadImpl (void) |
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded. | |
virtual void | preUnloadImpl (void) |
Internal hook to perform actions before the unload process. | |
virtual void | postUnloadImpl (void) |
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded. | |
virtual void | queueFireBackgroundLoadingComplete (void) |
Queue the firing of background loading complete event. | |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. | |
Protected Attributes | |
SkeletonAnimationBlendMode | mBlendState |
BoneList | mBoneList |
Storage of bones, indexed by bone handle. | |
BoneListByName | mBoneListByName |
BoneList | mRootBones |
Pointer to root bones (can now have multiple roots). | |
unsigned short | mNextAutoHandle |
Bone automatic handles. | |
BoneSet | mManualBones |
Manual bones. | |
bool | mManualBonesDirty |
Manual bones dirty? | |
AnimationList | mAnimationsList |
LinkedSkeletonAnimSourceList | mLinkedSkeletonAnimSourceList |
List of references to other skeletons to use animations from. | |
ResourceManager * | mCreator |
Creator. | |
String | mName |
Unique name of the resource. | |
String | mGroup |
The name of the resource group. | |
ResourceHandle | mHandle |
Numeric handle for more efficient look up than name. | |
volatile LoadingState | mLoadingState |
Is the resource currently loaded? | |
volatile bool | mIsBackgroundLoaded |
Is this resource going to be background loaded? Only applicable for multithreaded. | |
size_t | mSize |
Mutex to cover the status of loading. | |
bool | mIsManual |
Is this file manually loaded? | |
String | mOrigin |
Origin of this resource (e.g. script name) - optional. | |
ManualResourceLoader * | mLoader |
Optional manual loader; if provided, data is loaded from here instead of a file. | |
ListenerList | mListenerList |
String | mParamDictName |
Class name for this instance to be used as a lookup (must be initialised by subclasses). | |
Static Protected Attributes | |
static ParamDictionaryMap | msDictionary |
Dictionary of parameters. | |
Friends | |
class | SkeletonInstance |
Definition at line 80 of file OgreSkeleton.h.
typedef std::vector<Bone*> Ogre::Skeleton::BoneList |
Definition at line 171 of file OgreSkeleton.h.
Definition at line 172 of file OgreSkeleton.h.
typedef std::vector<LinkedSkeletonAnimationSource> Ogre::Skeleton::LinkedSkeletonAnimSourceList |
Definition at line 327 of file OgreSkeleton.h.
typedef ConstVectorIterator<LinkedSkeletonAnimSourceList> Ogre::Skeleton::LinkedSkeletonAnimSourceIterator |
Definition at line 329 of file OgreSkeleton.h.
typedef std::vector<ushort> Ogre::Skeleton::BoneHandleMap |
Map to translate bone handle from one skeleton to another skeleton.
Definition at line 345 of file OgreSkeleton.h.
typedef std::map<String, Bone*> Ogre::Skeleton::BoneListByName [protected] |
typedef std::set<Bone*> Ogre::Skeleton::BoneSet [protected] |
Definition at line 411 of file OgreSkeleton.h.
typedef std::map<String, Animation*> Ogre::Skeleton::AnimationList [protected] |
typedef std::list<Listener*> Ogre::Resource::ListenerList [protected, inherited] |
Definition at line 131 of file OgreResource.h.
enum Ogre::Resource::LoadingState [inherited] |
Enum identifying the loading state of the resource.
LOADSTATE_UNLOADED | Not loaded. |
LOADSTATE_LOADING | Loading is in progress. |
LOADSTATE_LOADED | Fully loaded. |
LOADSTATE_UNLOADING | Currently unloading. |
Definition at line 96 of file OgreResource.h.
Ogre::Skeleton::Skeleton | ( | ) | [protected] |
Internal constructor for use by SkeletonInstance only.
Ogre::Skeleton::Skeleton | ( | ResourceManager * | creator, | |
const String & | name, | |||
ResourceHandle | handle, | |||
const String & | group, | |||
bool | isManual = false , |
|||
ManualResourceLoader * | loader = 0 | |||
) |
Constructor, don't call directly, use SkeletonManager.
virtual Ogre::Skeleton::~Skeleton | ( | ) | [virtual] |
virtual Bone* Ogre::Skeleton::createBone | ( | void | ) | [virtual] |
Creates a brand new Bone owned by this Skeleton.
virtual Bone* Ogre::Skeleton::createBone | ( | unsigned short | handle | ) | [virtual] |
Creates a brand new Bone owned by this Skeleton.
handle | The handle to give to this new bone - must be unique within this skeleton. You should also ensure that all bone handles are eventually contiguous (this is to simplify their compilation into an indexed array of transformation matrices). For this reason it is advised that you use the simpler createBone method which automatically assigns a sequential handle starting from 0. |
Creates a brand new Bone owned by this Skeleton.
name | The name to give to this new bone - must be unique within this skeleton. Note that the way OGRE looks up bones is via a numeric handle, so if you name a Bone this way it will be given an automatic sequential handle. The name is just for your convenience, although it is recommended that you only use the handle to retrieve the bone in performance-critical code. |
Creates a brand new Bone owned by this Skeleton.
name | The name to give to this new bone - must be unique within this skeleton. | |
handle | The handle to give to this new bone - must be unique within this skeleton. |
virtual unsigned short Ogre::Skeleton::getNumBones | ( | void | ) | const [virtual] |
Returns the number of bones in this skeleton.
virtual Bone* Ogre::Skeleton::getRootBone | ( | void | ) | const [virtual] |
Gets the root bone of the skeleton: deprecated in favour of getRootBoneIterator.
virtual BoneIterator Ogre::Skeleton::getRootBoneIterator | ( | void | ) | [virtual] |
Get an iterator over the root bones in the skeleton, ie those with no parents.
virtual BoneIterator Ogre::Skeleton::getBoneIterator | ( | void | ) | [virtual] |
Get an iterator over all the bones in the skeleton.
virtual Bone* Ogre::Skeleton::getBone | ( | unsigned short | handle | ) | const [virtual] |
Gets a bone by it's handle.
Gets a bone by it's name.
virtual void Ogre::Skeleton::setBindingPose | ( | void | ) | [virtual] |
Sets the current position / orientation to be the 'binding pose' ie the layout in which bones were originally bound to a mesh.
virtual void Ogre::Skeleton::reset | ( | bool | resetManualBones = false |
) | [virtual] |
Resets the position and orientation of all bones in this skeleton to their original binding position.
resetManualBones | If set to true, causes the state of manual bones to be reset too, which is normally not done to allow the manual state to persist even when keyframe animation is applied. |
Creates a new Animation object for animating this skeleton.
name | The name of this animation | |
length | The length of the animation in seconds |
Reimplemented in Ogre::SkeletonInstance.
virtual Animation* Ogre::Skeleton::getAnimation | ( | const String & | name, | |
const LinkedSkeletonAnimationSource ** | linker = 0 | |||
) | const [virtual] |
Returns the named Animation object.
name | The name of the animation | |
linker | Optional pointer to a pointer to the linked skeleton animation where this is coming from. |
Reimplemented in Ogre::SkeletonInstance.
virtual Animation* Ogre::Skeleton::_getAnimationImpl | ( | const String & | name, | |
const LinkedSkeletonAnimationSource ** | linker = 0 | |||
) | const [virtual] |
Internal accessor for animations (returns null if animation does not exist).
Reimplemented in Ogre::SkeletonInstance.
virtual bool Ogre::Skeleton::hasAnimation | ( | const String & | name | ) | [virtual] |
Returns whether this skeleton contains the named animation.
virtual void Ogre::Skeleton::removeAnimation | ( | const String & | name | ) | [virtual] |
virtual void Ogre::Skeleton::setAnimationState | ( | const AnimationStateSet & | animSet | ) | [virtual] |
Changes the state of the skeleton to reflect the application of the passed in collection of animations.
virtual void Ogre::Skeleton::_initAnimationState | ( | AnimationStateSet * | animSet | ) | [virtual] |
Initialise an animation set suitable for use with this skeleton.
Reimplemented in Ogre::SkeletonInstance.
virtual void Ogre::Skeleton::_refreshAnimationState | ( | AnimationStateSet * | animSet | ) | [virtual] |
Refresh an animation set suitable for use with this skeleton.
Reimplemented in Ogre::SkeletonInstance.
virtual void Ogre::Skeleton::_getBoneMatrices | ( | Matrix4 * | pMatrices | ) | [virtual] |
Populates the passed in array with the bone matrices based on the current position.
virtual unsigned short Ogre::Skeleton::getNumAnimations | ( | void | ) | const [virtual] |
virtual Animation* Ogre::Skeleton::getAnimation | ( | unsigned short | index | ) | const [virtual] |
Gets a single animation by index.
Reimplemented in Ogre::SkeletonInstance.
virtual SkeletonAnimationBlendMode Ogre::Skeleton::getBlendMode | ( | ) | const [virtual] |
Gets the animation blending mode which this skeleton will use.
virtual void Ogre::Skeleton::setBlendMode | ( | SkeletonAnimationBlendMode | state | ) | [virtual] |
Sets the animation blending mode this skeleton will use.
virtual void Ogre::Skeleton::_updateTransforms | ( | void | ) | [virtual] |
Updates all the derived transforms in the skeleton.
virtual void Ogre::Skeleton::optimiseAllAnimations | ( | bool | preservingIdentityNodeTracks = false |
) | [virtual] |
Optimise all of this skeleton's animations.
preservingIdentityNodeTracks | If true, don't destroy identity node tracks. |
virtual void Ogre::Skeleton::addLinkedSkeletonAnimationSource | ( | const String & | skelName, | |
Real | scale = 1.0f | |||
) | [virtual] |
Allows you to use the animations from another Skeleton object to animate this skeleton.
skelName | Name of the skeleton to link animations from. This skeleton will be loaded immediately if this skeleton is already loaded, otherwise it will be loaded when this skeleton is. | |
scale | A scale factor to apply to translation and scaling elements of the keyframes in the other skeleton when applying the animations to this one. Compensates for skeleton size differences. |
Reimplemented in Ogre::SkeletonInstance.
virtual void Ogre::Skeleton::removeAllLinkedSkeletonAnimationSources | ( | void | ) | [virtual] |
Remove all links to other skeletons for the purposes of sharing animation.
Reimplemented in Ogre::SkeletonInstance.
virtual LinkedSkeletonAnimSourceIterator Ogre::Skeleton::getLinkedSkeletonAnimationSourceIterator | ( | void | ) | const [virtual] |
Get an iterator over the linked skeletons used as animation sources.
Reimplemented in Ogre::SkeletonInstance.
virtual void Ogre::Skeleton::_notifyManualBonesDirty | ( | void | ) | [virtual] |
Internal method for marking the manual bones as dirty.
virtual void Ogre::Skeleton::_notifyManualBoneStateChange | ( | Bone * | bone | ) | [virtual] |
Internal method for notifying that a bone is manual.
virtual bool Ogre::Skeleton::getManualBonesDirty | ( | void | ) | const [virtual] |
Have manual bones been modified since the skeleton was last updated?
Definition at line 340 of file OgreSkeleton.h.
virtual bool Ogre::Skeleton::hasManualBones | ( | void | ) | const [virtual] |
virtual void Ogre::Skeleton::_mergeSkeletonAnimations | ( | const Skeleton * | source, | |
const BoneHandleMap & | boneHandleMap, | |||
const StringVector & | animations = StringVector() | |||
) | [virtual] |
Merge animations from another Skeleton object into this skeleton.
source | Pointer to source skeleton. It'll keep unmodified. | |
boneHandleMap | A map to translate identically bone's handle from source skeleton to this skeleton. If mapped bone handle doesn't exists in this skeleton, it'll created. You can populate bone handle map manually, or use predefined functions build bone handle map for you. ( |
animations | A list name of animations to merge, if empty, all animations of source skeleton are used to merge. Note that the animation names must not presented in this skeleton, and will NOT pick up animations in linked skeletons ( |
virtual void Ogre::Skeleton::_buildMapBoneByHandle | ( | const Skeleton * | source, | |
BoneHandleMap & | boneHandleMap | |||
) | const [virtual] |
Build the bone handle map to use with Skeleton::_mergeSkeletonAnimations.
virtual void Ogre::Skeleton::_buildMapBoneByName | ( | const Skeleton * | source, | |
BoneHandleMap & | boneHandleMap | |||
) | const [virtual] |
Build the bone handle map to use with Skeleton::_mergeSkeletonAnimations.
void Ogre::Skeleton::deriveRootBone | ( | void | ) | const [protected] |
Internal method which parses the bones to derive the root bone.
void Ogre::Skeleton::_dumpContents | ( | const String & | filename | ) | [protected] |
Debugging method.
void Ogre::Skeleton::loadImpl | ( | void | ) | [protected, virtual] |
Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.
Implements Ogre::Resource.
Reimplemented in Ogre::SkeletonInstance.
void Ogre::Skeleton::unloadImpl | ( | void | ) | [protected, virtual] |
Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.
Implements Ogre::Resource.
Reimplemented in Ogre::SkeletonInstance.
size_t Ogre::Skeleton::calculateSize | ( | void | ) | const [protected, virtual] |
Calculate the size of a resource; this will only be called after 'load'.
Implements Ogre::Resource.
Definition at line 443 of file OgreSkeleton.h.
virtual void Ogre::Resource::preLoadImpl | ( | void | ) | [protected, virtual, inherited] |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
Definition at line 149 of file OgreResource.h.
virtual void Ogre::Resource::postLoadImpl | ( | void | ) | [protected, virtual, inherited] |
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
Reimplemented in Ogre::Mesh.
Definition at line 156 of file OgreResource.h.
virtual void Ogre::Resource::preUnloadImpl | ( | void | ) | [protected, virtual, inherited] |
Internal hook to perform actions before the unload process.
Definition at line 161 of file OgreResource.h.
virtual void Ogre::Resource::postUnloadImpl | ( | void | ) | [protected, virtual, inherited] |
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
Definition at line 166 of file OgreResource.h.
virtual void Ogre::Resource::queueFireBackgroundLoadingComplete | ( | void | ) | [protected, virtual, inherited] |
Queue the firing of background loading complete event.
virtual void Ogre::Resource::load | ( | bool | backgroundThread = false |
) | [virtual, inherited] |
Loads the resource, if it is not already.
backgroundThread | Indicates whether the caller of this method is the background resource loading thread. |
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual void Ogre::Resource::reload | ( | void | ) | [virtual, inherited] |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
bool Ogre::Resource::isReloadable | ( | void | ) | const [inherited] |
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 228 of file OgreResource.h.
bool Ogre::Resource::isManuallyLoaded | ( | void | ) | const [inherited] |
virtual void Ogre::Resource::unload | ( | void | ) | [virtual, inherited] |
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
size_t Ogre::Resource::getSize | ( | void | ) | const [inherited] |
Retrieves info about the size of the resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 247 of file OgreResource.h.
virtual void Ogre::Resource::touch | ( | void | ) | [virtual, inherited] |
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material, and Ogre::UnifiedHighLevelGpuProgram.
Referenced by Ogre::Material::touch().
const String& Ogre::Resource::getName | ( | void | ) | const [inherited] |
Gets resource name.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 258 of file OgreResource.h.
ResourceHandle Ogre::Resource::getHandle | ( | void | ) | const [inherited] |
bool Ogre::Resource::isLoaded | ( | void | ) | const [inherited] |
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 270 of file OgreResource.h.
LoadingState Ogre::Resource::isLoading | ( | ) | const [inherited] |
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 279 of file OgreResource.h.
LoadingState Ogre::Resource::getLoadingState | ( | ) | const [inherited] |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 286 of file OgreResource.h.
bool Ogre::Resource::isBackgroundLoaded | ( | void | ) | const [inherited] |
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 303 of file OgreResource.h.
void Ogre::Resource::setBackgroundLoaded | ( | bool | bl | ) | [inherited] |
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 313 of file OgreResource.h.
void Ogre::Resource::escalateLoading | ( | ) | [inherited] |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
void Ogre::Resource::addListener | ( | Listener * | lis | ) | [inherited] |
void Ogre::Resource::removeListener | ( | Listener * | lis | ) | [inherited] |
const String& Ogre::Resource::getGroup | ( | void | ) | [inherited] |
Gets the group which this resource is a member of.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 337 of file OgreResource.h.
void Ogre::Resource::changeGroupOwnership | ( | const String & | newGroup | ) | [inherited] |
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
ResourceManager* Ogre::Resource::getCreator | ( | void | ) | [inherited] |
const String& Ogre::Resource::getOrigin | ( | void | ) | const [inherited] |
Get the origin of this resource, e.g.
a script file name.
Definition at line 356 of file OgreResource.h.
void Ogre::Resource::_notifyOrigin | ( | const String & | origin | ) | [inherited] |
virtual void Ogre::Resource::_fireBackgroundLoadingComplete | ( | void | ) | [virtual, inherited] |
Firing of background loading complete event.
bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) | [protected, inherited] |
Internal method for creating a parameter dictionary for the class, if it does not already exist.
className | the name of the class using the dictionary |
Definition at line 176 of file OgreStringInterface.h.
ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | [inherited] |
Retrieves the parameter dictionary for this class.
Definition at line 200 of file OgreStringInterface.h.
const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | const [inherited] |
Definition at line 213 of file OgreStringInterface.h.
const ParameterList& Ogre::StringInterface::getParameters | ( | void | ) | const [inherited] |
Retrieves a list of parameters valid for this object.
virtual bool Ogre::StringInterface::setParameter | ( | const String & | name, | |
const String & | value | |||
) | [virtual, inherited] |
Generic parameter setting method.
name | The name of the parameter to set | |
value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. |
Referenced by Ogre::StringInterface::copyParametersTo().
virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | [virtual, inherited] |
Generic multiple parameter setting method.
paramList | Name/value pair list |
virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const [virtual, inherited] |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 269 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const [virtual, inherited] |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
Definition at line 300 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
static void Ogre::StringInterface::cleanupDictionary | ( | ) | [static, inherited] |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
MaterialManager) initializes.
friend class SkeletonInstance [friend] |
Definition at line 82 of file OgreSkeleton.h.
Definition at line 399 of file OgreSkeleton.h.
BoneList Ogre::Skeleton::mBoneList [protected] |
BoneListByName Ogre::Skeleton::mBoneListByName [protected] |
Definition at line 404 of file OgreSkeleton.h.
BoneList Ogre::Skeleton::mRootBones [mutable, protected] |
unsigned short Ogre::Skeleton::mNextAutoHandle [protected] |
BoneSet Ogre::Skeleton::mManualBones [protected] |
bool Ogre::Skeleton::mManualBonesDirty [protected] |
AnimationList Ogre::Skeleton::mAnimationsList [protected] |
Definition at line 420 of file OgreSkeleton.h.
LinkedSkeletonAnimSourceList Ogre::Skeleton::mLinkedSkeletonAnimSourceList [mutable, protected] |
List of references to other skeletons to use animations from.
Definition at line 423 of file OgreSkeleton.h.
ResourceManager* Ogre::Resource::mCreator [protected, inherited] |
String Ogre::Resource::mName [protected, inherited] |
String Ogre::Resource::mGroup [protected, inherited] |
ResourceHandle Ogre::Resource::mHandle [protected, inherited] |
volatile LoadingState Ogre::Resource::mLoadingState [protected, inherited] |
volatile bool Ogre::Resource::mIsBackgroundLoaded [protected, inherited] |
Is this resource going to be background loaded? Only applicable for multithreaded.
Definition at line 119 of file OgreResource.h.
size_t Ogre::Resource::mSize [protected, inherited] |
Mutex to cover the status of loading.
The size of the resource in bytes
Definition at line 123 of file OgreResource.h.
bool Ogre::Resource::mIsManual [protected, inherited] |
String Ogre::Resource::mOrigin [protected, inherited] |
Origin of this resource (e.g. script name) - optional.
Definition at line 127 of file OgreResource.h.
ManualResourceLoader* Ogre::Resource::mLoader [protected, inherited] |
Optional manual loader; if provided, data is loaded from here instead of a file.
Definition at line 129 of file OgreResource.h.
ListenerList Ogre::Resource::mListenerList [protected, inherited] |
Definition at line 132 of file OgreResource.h.
ParamDictionaryMap Ogre::StringInterface::msDictionary [static, protected, inherited] |
String Ogre::StringInterface::mParamDictName [protected, inherited] |
Class name for this instance to be used as a lookup (must be initialised by subclasses).
Definition at line 164 of file OgreStringInterface.h.
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat May 10 16:30:02 2008