# Ogre::Skeleton Class Reference

A collection of Bone objects used to animate a skinned mesh. More...

`#include <OgreSkeleton.h>`

Inheritance diagram for Ogre::Skeleton:

List of all members.

## Public Types

typedef std::vector< Bone * > | BoneList
typedef VectorIterator< BoneList > | BoneIterator
typedef std::vector< LinkedSkeletonAnimationSource > | LinkedSkeletonAnimSourceList
typedef ConstVectorIterator< LinkedSkeletonAnimSourceList > | LinkedSkeletonAnimSourceIterator

## 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 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 const AnimationStateSet & | getAnimationState (void) const
| Gets the last animation state of this skeleton.
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 ()
| 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 (void)
| 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 | load (void)
| 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.
const String & | getGroup (void)
| Gets the group which this resource is a member of.
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.
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 &paramList)
| 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

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::map< String, Animation * > | AnimationList
| Storage of animations, lookup by name.

## 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)
void | unloadImpl (void)
size_t | calculateSize (void) const
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.
AnimationList | mAnimationsList
AnimationStateSet | mLastAnimationState
| Saved version of last animation.
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.
bool | mIsLoaded
| Is the resource currently loaded?
size_t | mSize
| The size of the resource in bytes.
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.
String | mParamDictName
| Class name for this instance to be used as a lookup (must be initialised by subclasses).

## Static Protected Attributes

ParamDictionaryMap | msDictionary
| Dictionary of parameters.

## Friends

class | SkeletonInstance

## Detailed Description

A collection of Bone objects used to animate a skinned mesh.

Remarks:
  Skeletal animation works by having a collection of 'bones' which are actually just joints with a position and orientation, arranged in a tree structure. For example, the wrist joint is a child of the elbow joint, which in turn is a child of the shoulder joint. Rotating the shoulder automatically moves the elbow and wrist as well due to this hierarchy.

  So how does this animate a mesh? Well every vertex in a mesh is assigned to one or more bones which affects it's position when the bone is moved. If a vertex is assigned to more than one bone, then weights must be assigned to determine how much each bone affects the vertex (actually a weight of 1.0 is used for single bone assignments). Weighted vertex assignments are especially useful around the joints themselves to avoid 'pinching' of the mesh in this region.

  Therefore by moving the skeleton using preset animations, we can animate the mesh. The advantage of using skeletal animation is that you store less animation data, especially as vertex counts increase. In addition, you are able to blend multiple animations together (e.g. walking and looking around, running and shooting) and provide smooth transitions between animations without incurring as much of an overhead as would be involved if you did this on the core vertex data.

  Skeleton definitions are loaded from datafiles, namely the .skeleton file format. They are loaded on demand, especially when referenced by a Mesh.

Definition at line 75 of file OgreSkeleton.h.

## Member Typedef Documentation

typedef std::map<String, Animation*> Ogre::Skeleton::AnimationList `[protected]`

| Storage of animations, lookup by name. Definition at line 338 of file OgreSkeleton.h.

typedef VectorIterator<BoneList> Ogre::Skeleton::BoneIterator

| Definition at line 167 of file OgreSkeleton.h.

typedef std::vector<Bone*> Ogre::Skeleton::BoneList

| Definition at line 166 of file OgreSkeleton.h.

typedef std::map<String, Bone*> Ogre::Skeleton::BoneListByName `[protected]`

| Lookup by bone name. Definition at line 327 of file OgreSkeleton.h.

typedef ConstVectorIterator<LinkedSkeletonAnimSourceList> Ogre::Skeleton::LinkedSkeletonAnimSourceIterator

| Definition at line 317 of file OgreSkeleton.h.

typedef std::vector<LinkedSkeletonAnimationSource> Ogre::Skeleton::LinkedSkeletonAnimSourceList

| Definition at line 315 of file OgreSkeleton.h.

## Constructor & Destructor Documentation

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.

Remarks:
  On creation, a Skeleton has a no bones, you should create them and link them together appropriately.

virtual Ogre::Skeleton::~Skeleton | ( |  | ) | `[virtual]`

## Member Function Documentation

void Ogre::Skeleton::_dumpContents | ( | const String & | filename | ) | `[protected]`

| Debugging method.

virtual void Ogre::Skeleton::_getBoneMatrices | ( | Matrix4 * | pMatrices | ) | `[virtual]`

Populates the passed in array with the bone matrices based on the current position.

Remarks:
  Internal use only. The array pointed to by the passed in pointer must be at least as large as the number of bones. Assumes animation has already been updated.

virtual void Ogre::Skeleton::_initAnimationState | ( | AnimationStateSet * | animSet | ) | `[virtual]`

Initialise an animation set suitable for use with this skeleton.

Remarks:
  Only recommended for use inside the engine, not by applications.

Reimplemented in Ogre::SkeletonInstance.

void Ogre::Resource::_notifyOrigin | ( | const String & | origin | ) | `[inherited]`

| Notify this resource of it's origin. Definition at line 214 of file OgreResource.h. References Ogre::String.

virtual void Ogre::Skeleton::_refreshAnimationState | ( | AnimationStateSet * | animSet | ) | `[virtual]`

Refresh an animation set suitable for use with this skeleton.

Remarks:
  Only recommended for use inside the engine, not by applications.

Reimplemented in Ogre::SkeletonInstance.

virtual void Ogre::Skeleton::_updateTransforms | ( | void |  | ) | `[virtual]`

| Updates all the derived transforms in the skeleton.

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.

Remarks:
  If you have skeletons of identical structure (that means identically named bones with identical handles, and with the same hierarchy), but slightly different proportions or binding poses, you can re-use animations from one in the other. Because animations are actually stored as changes to bones from their bind positions, it's possible to use the same animation data for different skeletons, provided the skeletal structure matches and the 'deltas' stored in the keyframes apply equally well to the other skeletons bind position (so they must be roughly similar, but don't have to be identical). You can use the 'scale' option to adjust the translation and scale keyframes where there are large differences in size between the skeletons.

Note:
  This method takes a skeleton name, rather than a more specific animation name, for two reasons; firstly it allows some validation of compatibility of skeletal structure, and secondly skeletons are the unit of loading. Linking a skeleton to another in this way means that the linkee will be prevented from being destroyed until the linker is destroyed.

You cannot set up cyclic relationships, e.g. SkeletonA uses SkeletonB's animations, and SkeletonB uses SkeletonA's animations. This is because it would set up a circular dependency which would prevent proper unloading - make one of the skeletons the 'master' in this case.

Parameters:

  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.

size_t Ogre::Skeleton::calculateSize | ( | void |  | ) | const`[protected, virtual]`

| Implements Ogre::Resource. Definition at line 365 of file OgreSkeleton.h.

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.

virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const`[virtual, inherited]`

Method for copying this object's parameters to another object.

Remarks:
  This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.

  Any unrecognised parameters will be ignored as with setParameter method.

Parameters:

  dest | Pointer to object to have it's parameters set the same as this object.

Definition at line 296 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

virtual Animation* Ogre::Skeleton::createAnimation | ( | const String & | name,
|  | Real | length
| ) | `[virtual]`

Creates a new Animation object for animating this skeleton.

Parameters:

  name | The name of this animation
  length | The length of the animation in seconds

Reimplemented in Ogre::SkeletonInstance.

virtual Bone* Ogre::Skeleton::createBone | ( | const String & | name,
|  | unsigned short | handle
| ) | `[virtual]`

Creates a brand new Bone owned by this Skeleton.

Remarks:
  This method creates an unattached new Bone for this skeleton and assigns it a specific name and handle. Unless this is to be a root bone (there may be more than one of these), you must attach it to another Bone in the skeleton using addChild for it to be any use. For this reason you will likely be better off creating child bones using the Bone::createChild method instead, once you have created the root bone.

Parameters:

  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 Bone* Ogre::Skeleton::createBone | ( | const String & | name | ) | `[virtual]`

Creates a brand new Bone owned by this Skeleton.

Remarks:
  This method creates an unattached new Bone for this skeleton and assigns it a specific name.Unless this is to be a root bone (there may be more than one of these), you must attach it to another Bone in the skeleton using addChild for it to be any use. For this reason you will likely be better off creating child bones using the Bone::createChild method instead, once you have created the root bone.

Parameters:

  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.

virtual Bone* Ogre::Skeleton::createBone | ( | unsigned short | handle | ) | `[virtual]`

Creates a brand new Bone owned by this Skeleton.

Remarks:
  This method creates an unattached new Bone for this skeleton and assigns it a specific handle. Unless this is to be a root bone (there may be more than one of these), you must attach it to another Bone in the skeleton using addChild for it to be any use. For this reason you will likely be better off creating child bones using the Bone::createChild method instead, once you have created a root bone.

Parameters:

  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.

virtual Bone* Ogre::Skeleton::createBone | ( | void |  | ) | `[virtual]`

Creates a brand new Bone owned by this Skeleton.

Remarks:
  This method creates an unattached new Bone for this skeleton. Unless this is to be a root bone (there may be more than one of these), you must attach it to another Bone in the skeleton using addChild for it to be any use. For this reason you will likely be better off creating child bones using the Bone::createChild method instead, once you have created the root bone.

  Note that this method automatically generates a handle for the bone, which you can retrieve using Bone::getHandle. If you wish the new Bone to have a specific handle, use the alternate form of this method which takes a handle as a parameter, although you should note the restrictions.

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.

Remarks:
  This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).

Parameters:

  className | the name of the class using the dictionary

Returns:
  true if a new dictionary was created, false if it was already there

Definition at line 172 of file OgreStringInterface.h.

References Ogre::String.

void Ogre::Skeleton::deriveRootBone | ( | void |  | ) | const`[protected]`

Internal method which parses the bones to derive the root bone.

Remarks:
  Must be const because called in getRootBone but mRootBone is mutable since lazy-updated.

virtual Animation* Ogre::Skeleton::getAnimation | ( | unsigned short | index | ) | const`[virtual]`

Gets a single animation by index.

Remarks:
  Will NOT pick up animations in linked skeletons (

See also:
  addLinkedSkeletonAnimationSource).

Reimplemented in Ogre::SkeletonInstance.

virtual Animation* Ogre::Skeleton::getAnimation | ( | const String & | name,
|  | const LinkedSkeletonAnimationSource ** | linker = 0
| ) | const`[virtual]`

Returns the named Animation object.

Remarks:
  Will pick up animations in linked skeletons (

See also:
  addLinkedSkeletonAnimationSource).

Parameters:

  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 const AnimationStateSet& Ogre::Skeleton::getAnimationState | ( | void |  | ) | const`[virtual]`

| Gets the last animation state of this skeleton.

virtual SkeletonAnimationBlendMode Ogre::Skeleton::getBlendMode | ( |  | ) | `[virtual]`

| Gets the animation blending mode which this skeleton will use.

virtual Bone* Ogre::Skeleton::getBone | ( | const String & | name | ) | const`[virtual]`

| Gets a bone by it's name.

virtual Bone* Ogre::Skeleton::getBone | ( | unsigned short | handle | ) | const`[virtual]`

| Gets a bone by it's handle.

virtual BoneIterator Ogre::Skeleton::getBoneIterator | ( | void |  | ) | `[virtual]`

| Get an iterator over all the bones in the skeleton.

ResourceManager* Ogre::Resource::getCreator | ( | void |  | ) | `[inherited]`

| Gets the manager which created this resource. Definition at line 205 of file OgreResource.h.

const String& Ogre::Resource::getGroup | ( | void |  | ) | `[inherited]`

| Gets the group which this resource is a member of. Definition at line 202 of file OgreResource.h. References Ogre::String.

ResourceHandle Ogre::Resource::getHandle | ( | void |  | ) | const`[inherited]`

| Definition at line 188 of file OgreResource.h. References Ogre::ResourceHandle.

virtual LinkedSkeletonAnimSourceIterator Ogre::Skeleton::getLinkedSkeletonAnimationSourceIterator | ( | void |  | ) | const`[virtual]`

| Get an iterator over the linked skeletons used as animation sources. Reimplemented in Ogre::SkeletonInstance.

const String& Ogre::Resource::getName | ( | void |  | ) | const`[inherited]`

| Gets resource name. Definition at line 183 of file OgreResource.h. References Ogre::String.

virtual unsigned short Ogre::Skeleton::getNumAnimations | ( | void |  | ) | const`[virtual]`

| Gets the number of animations on this skeleton. Reimplemented in Ogre::SkeletonInstance.

virtual unsigned short Ogre::Skeleton::getNumBones | ( | void |  | ) | const`[virtual]`

| Returns the number of bones in this skeleton.

const String& Ogre::Resource::getOrigin | ( | void |  | ) | const`[inherited]`

Get the origin of this resource, e.g.

a script file name.

Remarks:
  This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it.

Definition at line 212 of file OgreResource.h.

References Ogre::String.

const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | const`[inherited]`

| Definition at line 209 of file OgreStringInterface.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | `[inherited]`

Retrieves the parameter dictionary for this class.

Remarks:
  Only valid to call this after createParamDictionary.

Returns:
  Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 196 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const`[virtual, inherited]`

Generic parameter retrieval method.

Remarks:
  Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.

Parameters:

  name | The name of the parameter to get

Returns:
  String value of parameter, blank if not found

Definition at line 265 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), Ogre::ParamDictionary::getParamCommand(), and Ogre::String.

const ParameterList& Ogre::StringInterface::getParameters | ( | void |  | ) | const`[inherited]`

Retrieves a list of parameters valid for this object.

Returns:
  A reference to a static list of ParameterDef objects.

virtual Bone* Ogre::Skeleton::getRootBone | ( | void |  | ) | const`[virtual]`

Gets the root bone of the skeleton: deprecated in favour of getRootBoneIterator.

Remarks:
  The system derives the root bone the first time you ask for it. The root bone is the only bone in the skeleton which has no parent. The system locates it by taking the first bone in the list and going up the bone tree until there are no more parents, and saves this top bone as the root. If you are building the skeleton manually using createBone then you must ensure there is only one bone which is not a child of another bone, otherwise your skeleton will not work properly. If you use createBone only once, and then use Bone::createChild from then on, then inherently the first bone you create will by default be the root.

virtual BoneIterator Ogre::Skeleton::getRootBoneIterator | ( | void |  | ) | `[virtual]`

| Get an iterator over the root bones in the skeleton, ie those with no parents.

size_t Ogre::Resource::getSize | ( | void |  | ) | const`[inherited]`

| Retrieves info about the size of the resource. Definition at line 172 of file OgreResource.h.

bool Ogre::Resource::isLoaded | ( | void |  | ) | const`[inherited]`

| Returns true if the Resource has been loaded, false otherwise. Definition at line 195 of file OgreResource.h. References OGRE_LOCK_AUTO_MUTEX.

bool Ogre::Resource::isManuallyLoaded | ( | void |  | ) | const`[inherited]`

| Is this resource manually loaded? Definition at line 160 of file OgreResource.h.

bool Ogre::Resource::isReloadable | ( | void |  | ) | const`[inherited]`

| Returns true if the Resource is reloadable, false otherwise. Definition at line 153 of file OgreResource.h.

virtual void Ogre::Resource::load | ( | void |  | ) | `[virtual, inherited]`

Loads the resource, if it is not already.

Remarks:
  If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it's data from procedural calls rather than loading from a file, then this resource will not reload on it's own

Reimplemented in Ogre::Mesh, and Ogre::GLSLGpuProgram.

void Ogre::Skeleton::loadImpl | ( | void |  | ) | `[protected, virtual]`

| Implements Ogre::Resource. Reimplemented in Ogre::SkeletonInstance.

virtual void Ogre::Skeleton::optimiseAllAnimations | ( | void |  | ) | `[virtual]`

Optimise all of this skeleton's animations.

See also:
  Animation::optimise

virtual void Ogre::Resource::reload | ( | void |  | ) | `[virtual, inherited]`

Reloads the resource, if it is already loaded.

Remarks:
  Calls unload() and then load() again, if the resource is already loaded. If it is not loaded already, then nothing happens.

virtual void Ogre::Skeleton::removeAllLinkedSkeletonAnimationSources | ( | void |  | ) | `[virtual]`

| Remove all links to other skeletons for the purposes of sharing animation. Reimplemented in Ogre::SkeletonInstance.

virtual void Ogre::Skeleton::removeAnimation | ( | const String & | name | ) | `[virtual]`

| Removes an Animation from this skeleton. Reimplemented in Ogre::SkeletonInstance.

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.

Remarks:
  A skeleton is bound to a mesh in a binding pose. Bone positions are then modified from this position during animation. This method returns all the bones to their original position and orientation.

Parameters:

  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.

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.

Remarks:
  Animating a skeleton involves both interpolating between keyframes of a specific animation, and blending between the animations themselves. Calling this method sets the state of the skeleton so that it reflects the combination of all the passed in animations, at the time index specified for each, using the weights specified. Note that the weights between animations do not have to sum to 1.0, because some animations may affect only subsets of the skeleton. If the weights exceed 1.0 for the same area of the skeleton, the movement will just be exaggerated.

Parameters:

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::setBlendMode | ( | SkeletonAnimationBlendMode | state | ) | `[virtual]`

| Sets the animation blending mode this skeleton will use.

virtual bool Ogre::StringInterface::setParameter | ( | const String & | name,
|  | const String & | value
| ) | `[virtual, inherited]`

Generic parameter setting method.

Remarks:
  Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters:

  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.

Returns:
  true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | `[virtual, inherited]`

Generic multiple parameter setting method.

Remarks:
  Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters:

  paramList | Name/value pair list

virtual void Ogre::Resource::touch | ( | void |  | ) | `[virtual, inherited]`

| 'Touches' the resource to indicate it has been used. Reimplemented in Ogre::Material.

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::GLSLGpuProgram.

void Ogre::Skeleton::unloadImpl | ( | void |  | ) | `[protected, virtual]`

| Implements Ogre::Resource. Reimplemented in Ogre::SkeletonInstance.

## Friends And Related Function Documentation

friend class SkeletonInstance `[friend]`

| Definition at line 77 of file OgreSkeleton.h.

## Member Data Documentation

AnimationList Ogre::Skeleton::mAnimationsList `[protected]`

| Definition at line 339 of file OgreSkeleton.h.

SkeletonAnimationBlendMode Ogre::Skeleton::mBlendState `[protected]`

| Definition at line 323 of file OgreSkeleton.h.

BoneList Ogre::Skeleton::mBoneList `[protected]`

| Storage of bones, indexed by bone handle. Definition at line 325 of file OgreSkeleton.h.

BoneListByName Ogre::Skeleton::mBoneListByName `[protected]`

| Definition at line 328 of file OgreSkeleton.h.

ResourceManager* Ogre::Resource::mCreator `[protected, inherited]`

| Creator. Definition at line 73 of file OgreResource.h.

String Ogre::Resource::mGroup `[protected, inherited]`

| The name of the resource group. Definition at line 77 of file OgreResource.h.

ResourceHandle Ogre::Resource::mHandle `[protected, inherited]`

| Numeric handle for more efficient look up than name. Definition at line 79 of file OgreResource.h.

bool Ogre::Resource::mIsLoaded `[protected, inherited]`

| Is the resource currently loaded? Definition at line 81 of file OgreResource.h.

bool Ogre::Resource::mIsManual `[protected, inherited]`

| Is this file manually loaded? Definition at line 85 of file OgreResource.h.

AnimationStateSet Ogre::Skeleton::mLastAnimationState `[protected]`

| Saved version of last animation. Definition at line 342 of file OgreSkeleton.h.

LinkedSkeletonAnimSourceList Ogre::Skeleton::mLinkedSkeletonAnimSourceList `[mutable, protected]`

| List of references to other skeletons to use animations from. Definition at line 345 of file OgreSkeleton.h.

ManualResourceLoader* Ogre::Resource::mLoader `[protected, inherited]`

| Optional manual loader; if provided, data is loaded from here instead of a file. Definition at line 89 of file OgreResource.h.

String Ogre::Resource::mName `[protected, inherited]`

| Unique name of the resource. Definition at line 75 of file OgreResource.h.

unsigned short Ogre::Skeleton::mNextAutoHandle `[protected]`

| Bone automatic handles. Definition at line 334 of file OgreSkeleton.h.

String Ogre::Resource::mOrigin `[protected, inherited]`

| Origin of this resource (e.g. script name) - optional. Definition at line 87 of file OgreResource.h.

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 160 of file OgreStringInterface.h.

BoneList Ogre::Skeleton::mRootBones `[mutable, protected]`

| Pointer to root bones (can now have multiple roots). Definition at line 332 of file OgreSkeleton.h.

ParamDictionaryMap Ogre::StringInterface::msDictionary `[static, protected, inherited]`

| Dictionary of parameters. Definition at line 157 of file OgreStringInterface.h.

size_t Ogre::Resource::mSize `[protected, inherited]`

| The size of the resource in bytes. Definition at line 83 of file OgreResource.h.

The documentation for this class was generated from the following file:

- OgreSkeleton.h

Copyright © 2000-2005 by The OGRE Team
Last modified Sun Nov 20 12:39:56 2005