A Pose is a final transformation apply to the Bone of a SkeletalMesh which is in the most case driven by an Action.

Using the Pose interface you can gain access to the transformation matrix of each Bone forming the final pose of the SkeletalMesh that will be presented on the screen, and update them as you see fit.

The Pose API below you can also blend two pose together and form a new resulting pose that can be reassigned directly to a SkeletalMesh.

See Also

SkeletalMesh, Skeleton, Bone, Action

Static Variables

Name Description

bone_count Amount of Bone currently available by the current Pose.

Declaration

unsigned short bone_count

Functions

Name	Description
`GetBoneMatrix`	Retrieve a specific Bone transformation matrix.
Declaration mat4 GetBoneMatrix( unsigned short index ) Parameters `index`: Index of the Bone. Return Value In case the index is invalid a zeroed matrix will be returned; else the matrix will be filled with the current transformation of the Bone specified by index.
`SetBoneMatrix`	Retrieve a specific Bone transformation matrix.
Declaration bool SetBoneMatrix( unsigned short index, const mat4 m ) Parameters `index`: Index of the Bone to update. `m`: The new transformation matrix to apply to the Bone. Return Value `true` if the update was successfull; else return `false` if the index was out of bounds. Note Bone matrix is always returned in bone local space (relative to their parent/root).
`Blend`	Helper function that allows you to blend the current Pose with another.
Declaration bool Blend( const Pose poseB, const float blend ) Parameters* `poseB`: Reference to a valid Pose that contains the same amount of bones as the active one. `blend`: The blending factor to use; a value of `0.0` will keep the active Pose unchanged, while a value of `1.0` will create a direct copy of `poseB`. Any value in between will linearly interpolate between the two poses. Return Value `true` if the function was able to blend the two poses; return `false` if `poseB` was invalid; or if the bone count doesn't match.

Scripting

Dealing with pose blending is a bit different than dealing with other table and references. You first need to actually create a Pose variable and transfer the SkeletalMesh pose to it; operate than release it.

Lua

-- Create two new local pose variable.
local poseA = Pose.Init()
local poseB = Pose.Init()
-- Transfer the first animation pose to the variable `poseA`.
this.animation.object.data.skeletalmesh:GetPose(poseA)
-- Insert here the code to change to another pose.
-- Transfer the second animation pose to the variable `poseB`.
this.animation.object.data.skeletalmesh:GetPose(poseB)
-- Blend poseA and poseB at 50%
poseA:Blend(poseB,0.5)
-- Assign back the resulting pose to the skeletalmesh.
this.animation.object.data.skeletalmesh:SetPose(poseA)
-- Important: Always manually release the pose variables when 
-- they are no longer required.
poseA = nil
poseB = nil