Unigine.ObjectMeshSkinned Class

Inherits:

This class is used to create or modify skinned meshes.

Creating and Playing Animation#

To add the animation to the ObjectMeshSkinned and play it, do the following:

Set the number of animation layers with the setNumLayers() method. There is only one layer by default.
Enable the layer and set the animation weight for blending by calling the setLayer() function.
Add the animation .anim file by using addAnimation() or setAnimation() functions.
Notice
When you import your model with animations from an FBX container, the following path to your *.anim files should be used: <path_to_your_fbx_file>/<file.fbx>/<your_anim_file.anim>
For example: object->addAnimation("models/soldier/soldier.fbx/run.anim");

The recommended approach is to use the Custom Component System and provide the guid of the .anim file.
Source code (C++)
```
UGUID guid = FileSystem::get()->getGUID(anim_asset.getRaw());
int animation_1 = skinned_mesh->addAnimation(mesh,guid.getFileSystemString(), "run");
```
Play the added animation by calling the setFrame() function for each animation layer.

Blending is performed between all layers. The contribution of each layer depends on its weight. Also, you can optionally define single bone transformations by hand, if needed, using either setBoneTransform() or setBoneChildrenTransform().

Updating Bone Transformations#

Some of the methods require to update the animation data before the renderer makes its update and actually draws the skinned mesh. Such update allows to get the correct result of blending between the frames and layers.

The execution sequence of updating bone transformations is the following:

Call the method, which sets the update flag. This flag shows that the instance should be updated.
Update the bone transformations by calling proper functions. These functions check the flag and if the flag is set, they calculate the transformations and set the flag to the default value.
During the rendering, the engine performs animations and transformations which were calculated on the previous step or recalculates them, if the update flag has been set. If calculations have been performed, the flag is set to the default value.

If you try to update bone transformations before you set the flag to update, functions will not calculate new transformations and the engine doesn't perform them.

When you change the transformation of the bone, you should notify all skinned meshes which use these bone about these transformations to update the mesh. When you change transformations of a bone, skinned mesh instances get the flag to update. When you use the setFrame() function, you set necessary transformations for the specified skinned mesh.

Instancing#

Surfaces of identical skinned meshes which have the same materials assigned to them and the same number of bones attached to their vertices are automatically instanced and drawn in one draw call. The instancing flag is enabled by default (see corresponding console commands).

The data buffers for instanced objects that store bones transformations are limited in size; therefore, if skinned meshes have many bones, only a few meshes can populate the instance data buffer to be drawn in one draw call.

NoticeThe higher the number of bones and the more bones are attached to one surface, the less robust instancing will be.

Properties:

Name	Description
int NumAnimations	The total number of all loaded animations.
int NumBones	The number of all bones taking part in animation.
int NumLayers	The number of animation layers set for blending.
bool IsStopped	Stop status.
bool IsPlaying	Playback status.
float Speed	A multiplier for animation playback time.
float Time	The current animation time, in animation frames.
int Loop	A value indicating if the animation is looped.
bool IsControlled	A value indicating if the animation is controlled by a parent objectmeshskinned.
bool IsQuaternion	The value indicating if the dual-quaternion skinning mode is used.
string AnimName	The name of the current animation.
string MeshName	The name of the mesh.

Methods:

Name	Description View: Sort by:
ObjectMeshSkinned	ObjectMeshSkinned constructor.
Cast	Casts an ObjectMeshSkinned out of the Node instance.
SetAnimation	Sets the animation identifier for the given animation layer.
GetAnimation	Returns the animation identifier from the given animation layer.
GetAnimationID	Returns the identifier of the animation at the specified position.
GetAnimationPath	Returns the path to a file containing the specified animation.
SetAnimName	Sets the path to the animation and forces setting this path to animation for the first animation layer.
GetBoneBindTransform	Returns the bind pose bone transformation matrix.
GetBoneChild	Returns the number of a child of a given bone.
SetBoneChildrenTransform	Sets transformation for the bone and all of its children (without considering node transformations).
GetBoneName	Returns the name of the given bone.
GetBoneParent	Returns the number of the parent bone for a given one.
SetBoneTransform	Sets a transformation matrix for a given bone (without considering node transformations).
GetBoneTransform	Returns a transformation matrix of a given bone relatively to the parent object (not considering transformations of the node itself).
SetBoneTransforms	Sets a transformation matrix for given bones.
SetCIndex	Sets the new coordinate index for the given vertex of the given surface.
GetCIndex	Returns the coordinate index for the given vertex of the given surface.
SetColor	Sets the color for the given triangle vertex of the given surface.
GetColor	Returns the color of the given triangle vertex of the given surface.
SetFrame	Sets a frame for the given animation layer.
GetFrame	Returns the frame number passed as the time argument on the last setFrame() call.
GetFrameFrom	Returns the start frame passed as the from argument on the last setFrame() call.
GetFrameTo	Returns the end frame passed as the to argument on the last setFrame() call.
GetIBoneBindTransform	Returns the inverse bind pose bone transformation matrix.
GetIBoneTransform	Returns an inverse transformation matrix for a given bone relatively to the parent object.
SetLayer	Enables or disables the given animation layer and sets the value of the weight parameter.
SetLayerBoneTransform	Sets a transformation matrix for a given bone.
GetLayerBoneTransform	Returns a transformation matrix of a given bone relatively to the parent object.
IsLayerBoneTransform	Returns a value indicating if the bone transformation is applied only to the animation layer (no blending is performed).
SetLayerBoneTransformEnabled	Enables or disables a layer transformation for a given bone.
SetLayerEnabled	Enables or disables a given animation layer.
IsLayerEnabled	Returns a value indicating if a given animation layer is enabled.
SetLayerWeight	Sets a weight for the animation layer.
GetLayerWeight	Returns the weight of the animation layer.
SetMesh	Copies the source mesh into the current mesh.
GetMesh	Copies the current mesh into the source mesh.
SetMeshName	Sets the path to the mesh and forces creating of the mesh using the new path.
GetMeshSurface	Copies the specified mesh surface to the destination mesh.
GetNormal	Returns the normal for the given triangle vertex of the given surface target.
GetNumAnimationBones	Returns the number of animation bones.
GetNumAnimationFrames	Returns the number of animation frames.
GetNumBoneChildren	Returns the number of children for the specified bone.
GetNumCIndices	Returns the number of coordinate indices for the given mesh surface.
GetNumColors	Returns the total number of vertex color entries for the given surface.
GetNumFrames	Returns the number of animation frames for a given layer.
GetNumSurfaceTargets	Returns the number of surface morph targets for the given mesh surface.
GetNumTangents	Returns the number of vertex tangent entries of the given mesh surface.
SetNumTargets	Sets the number of animation morph targets for the given mesh surface.
GetNumTargets	Returns the total number of morph targets of the given mesh surface.
SetNumTexCoords0	Sets the number of the first UV map texture coordinates for the given mesh surface.
GetNumTexCoords0	Returns the number of the first UV map texture coordinates for the given mesh surface.
SetNumTexCoords1	Sets the number of the second UV map texture coordinates for the given mesh surface.
GetNumTexCoords1	Returns the number of the second UV map texture coordinates for the given mesh surface.
GetNumTIndices	Returns the number of triangle indices for the given mesh surface.
GetNumVertex	Returns the number of coordinate vertices for the given mesh surface.
GetSkinnedNormal	Returns the skinned normal for the given triangle vertex.
GetSkinnedTangent	Returns the skinned tangent vector for the given triangle vertex.
GetSkinnedVertex	Returns skinned coordinates of the given coordinate vertex.
GetSurfaceTargetName	Returns the name of the morph target for the given mesh surface.
SetSurfaceTransform	Transforms the given mesh surface target.
SetTangent	Sets the new tangent for the given triangle vertex of the given surface target.
GetTangent	Returns the tangent for the given triangle vertex of the given surface target.
SetTarget	Enables or disables a given morph target and sets all its parameters.
SetTargetEnabled	Enables or disables a given morph target.
IsTargetEnabled	Returns a value indicating if the given morph target of the given surface is enabled.
SetTargetIndex	Sets an index for the given morph target.
GetTargetIndex	Returns the index of the morph target.
SetTargetWeight	Sets a weight for the given animation target.
GetTargetWeight	Returns the weight of the given morph target.
SetTexCoord0	Sets first UV map texture coordinates for the given triangle vertex of the given surface.
GetTexCoord0	Returns first UV map texture coordinates for the given triangle vertex of the given surface.
SetTexCoord1	Sets second UV map texture coordinates for the given triangle vertex of the given surface.
GetTexCoord1	Returns second UV map texture coordinates for the given triangle vertex of the given surface.
SetTIndex	Sets the new triangle index for the given vertex of the given surface.
GetTIndex	Returns the triangle index for the given surface by using the index number.
SetVertex	Sets the coordinates of the given coordinate vertex of the given surface target.
GetVertex	Returns coordinates of the given coordinate vertex of the given surface target.
SetWorldBoneChildrenTransform	Sets the transformation for the given bone and all of its children in the world coordinate space (considering node transformations).
SetWorldBoneTransform	Sets the transformation for the given bone in the world coordinate space.
GetWorldBoneTransform	Returns the current transformation matrix applied to the bone in the world coordinate space (considering node transformations).
AddAnimation	Loads an additional animation from an external file.
AddEmptySurface	Appends a new empty surface to the current mesh.
AddLayer	Appends a new animation layer to the current mesh.
AddMeshSurface	Appends a new mesh surface to the current mesh.
AddSurfaceTarget	Appends a new morph target to the given mesh surface.
AddTarget	Appends a new empty morph target to the given mesh surface.
ClearLayer	Clears the given animation layer.
CopyLayer	Copies source layer bones transformations to the destination layer.
CreateMesh	Creates a skinned mesh.
FindAnimation	Searches for an animation using the given path.
FindBone	Searches for a bone with a given name.
FindSurfaceTarget	Searches for a surface morph target with a given name.
FlushMesh	Flushes mesh geometry to the video memory.
ImportLayer	Copies the current bone state to the given animation layer.
InverseLayer	Copies inverse transformations of bones from the source layer to the destination layer.
LerpLayer	Copies interpolated bone transformations from two source layers to a destination layer.
LoadMesh	Loads a new mesh instead of the current mesh from the .mesh file. This function doesn't change the mesh name.
MergeMeshSurface	Merges the specified surface from the source ObjectMeshSkinned with the specified destination surface of the mesh.
MulLayer	Copies multiplied bone transformations from two source layers to the destination layer.
Play	Continues playback of the animation, if it was paused, or starts playback if it was stopped.
RemoveAnimation	Removes the given animation.
RemoveLayer	Removes an animation layer.
RemoveTarget	Removes the given morph target.
SaveMesh	Saves the mesh to .mesh or .anim format.
Stop	Stops animation playback.
type	Returns the type of the node.
UpdateSurfaceBounds	Updates mesh surface bounds.

ObjectMeshSkinned Class

Properties

int NumAnimations#

The total number of all loaded animations.

int NumBones#

The number of all bones taking part in animation.

int NumLayers#

The number of animation layers set for blending. for more details, see the article on Skinned Mesh.

set

Sets the number of animation layers for blending. For example, when two layers are blended, bone transformations in between the layers are interpolated, and vertex positions can be calculated using the interpolated results. For more details, see the article on Skinned Mesh.

set value - Number of animation layers (must be greater than 0).

bool IsStopped#

Stop status.

bool IsPlaying#

Playback status.

float Speed#

A multiplier for animation playback time.

set

Updates a multiplier value for the animation playback time.

set value - Playback speed multiplier value.

float Time#

The current animation time, in animation frames. The time count starts from the zero frame.

set

Sets the animation time, in animation frames. The time count starts from the zero frame. If the time is set to be between frames, animation is blended. If the time is set outside the animation frame range, the animation is looped.

Notice

The setTime() function corresponds to The Play and Stop options in the editor. In all other cases use setFrame() to set the animation.

set value - Animation time.

int Loop#

A value indicating if the animation is looped. 1 if the animation is looped; otherwise - 0.

set

Sets a value indicating if the animation should be looped.

set value - 1 is to play the animation in a loop, 0 is to play it only once.

bool IsControlled#

A value indicating if the animation is controlled by a parent objectmeshskinned.

set

Sets a value indicating if the animation should be controlled by a parent ObjectMeshSkinned (useful for attaching clothes to a character body).

set value - Controlled flag: 1 if the animation is controlled by a parent ObjectMeshSkinned; otherwise - 0.

bool IsQuaternion#

The value indicating if the dual-quaternion skinning mode is used. the dual-quaternion model is an accurate, computationally efficient, robust, and flexible method of representing rigid transforms and it is used in skeletal animation. see a Wikipedia article on dual quaternions and a beginners guide to dual-quaternions for more information.

set

Enables or disables the dual-quaternion skinning mode. The dual-quaternion model is an accurate, computationally efficient, robust, and flexible method of representing rigid transforms and it is used in skeletal animation. See a Wikipedia article on dual quaternions and a beginners guide to dual-quaternions for more information.

set value - 1 to enable dual-quaternion skinning mode, 0 to disable it.

string AnimName#

The name of the current animation.

set

Sets the path to the animation.

set value - Path to the animation.

string MeshName#

The name of the mesh.

set

Sets the path to the mesh.

set value - Path to the mesh.

Members

static ObjectMeshSkinned ( Mesh mesh ) #

ObjectMeshSkinned constructor.

Arguments

Mesh mesh - Pointer to Mesh.

static ObjectMeshSkinned ( string path, bool unique = 0 ) #

ObjectMeshSkinned constructor.

Arguments

string path - Path to the skinned mesh file.
bool unique - When you create several objects out of a single .mesh file, the instance of the mesh geometry is created. If you then change the source geometry, its instances will be changed as well. To avoid this, set the unique flag to 1, so a copy of the mesh geometry will be created and changes won't be applied.

static ObjectMeshSkinned Cast ( Node node ) #

Casts an ObjectMeshSkinned out of the Node instance.

Arguments

Node node - Node instance.

Return value

ObjectMeshSkinned instance.

static ObjectMeshSkinned Cast ( Object base ) #

Casts an ObjectMeshSkinned out of the Object instance.

Arguments

Object base - Object instance.

Return value

ObjectMeshSkinned instance.

int SetAnimation ( int layer, int animation ) #

Sets the animation identifier for the given animation layer.

Arguments

int layer - Layer number.
int animation - Animation identifier.

int SetAnimation ( int layer, string path ) #

Sets the path to animation for the given animation layer.

Arguments

int layer - Layer number.
string path - Path to animation file.

int GetAnimation ( int layer ) #

Returns the animation identifier from the given animation layer.

Arguments

int layer - Layer number.

Return value

Animation identifier.

int GetAnimationID ( int num ) #

Returns the identifier of the animation at the specified position.

Arguments

int num - Animation number.

Return value

Animation identifier.

string GetAnimationPath ( int animation ) #

Returns the path to a file containing the specified animation.

Arguments

int animation - Animation identifier.

Return value

Path to a file containing the specified animation.

void SetAnimName ( string name, bool force_load = 0 ) #

Sets the path to the animation and forces setting this path to animation for the first animation layer.

Arguments

string name - Path to the animation.
bool force_load - Force flag. If 1 is specified, the new animation name will be set for the first animation layer immediately.

void SetAnimName ( string name ) #

Sets the path to the animation.

Arguments

string name - Path to the animation.

mat4 GetBoneBindTransform ( int bone ) #

Returns the bind pose bone transformation matrix. Bone transformations are relative.

Arguments

int bone - Bone number.

Return value

Bind pose bone transformation matrix.

int GetBoneChild ( int bone, int child ) #

Returns the number of a child of a given bone.

Arguments

int bone - Bone number.
int child - Child number.

Return value

Number of the child in the collection of all bones.

void SetBoneChildrenTransform ( int bone, mat4 transform ) #

Sets transformation for the bone and all of its children (without considering node transformations).

Notice

Bones can be scaled only uniformly.

Arguments

int bone - Bone number.
mat4 transform - Transformation matrix.

string GetBoneName ( int bone ) #

Returns the name of the given bone.

Arguments

int bone - Bone number.

Return value

Bone name.

int GetBoneParent ( int bone ) #

Returns the number of the parent bone for a given one.

Arguments

int bone - Number of the bone, for which the parent will be returned.

Return value

Parent bone number, if the parent exists; otherwise, -1.

void SetBoneTransform ( int bone, mat4 transform ) #

Sets a transformation matrix for a given bone (without considering node transformations).

Notice

Bones can be scaled only uniformly.

Arguments

int bone - Bone number.
mat4 transform - Transformation matrix.

mat4 GetBoneTransform ( int bone ) #

Returns a transformation matrix of a given bone relatively to the parent object (not considering transformations of the node itself).

Arguments

int bone - Bone number.

Return value

Transformation matrix.

void SetBoneTransforms ( int[] bones, mat4[] transforms, int num_bones ) #

Sets a transformation matrix for given bones.

Arguments

int[] bones - Bone numbers.
mat4[] transforms - Transformation matrices.
int num_bones - Number of bones.

void SetCIndex ( int num, int index, int surface ) #

Sets the new coordinate index for the given vertex of the given surface.

Arguments

int num - Vertex number in the range from 0 to the total number of coordinate indices for the given surface.
Notice
To get the total number of coordinate indices for the given surface, use the getNumCIndices() method.
int index - Coordinate index to be set in the range from 0 to the total number of coordinate vertices for the given surface.
Notice
To get the total number of coordinate vertices for the given surface, use the getNumCVertex() method.
int surface - Mesh surface number.

int GetCIndex ( int num, int surface ) #

Returns the coordinate index for the given vertex of the given surface.

Arguments

int num - Vertex number in the range from 0 to the total number of coordinate indices for the given surface.
Notice
To get the total number of coordinate indices for the given surface, use the getNumCIndices() method.
int surface - Mesh surface number.

Return value

Coordinate index.

void SetColor ( int num, vec4 color, int surface ) #

Sets the color for the given triangle vertex of the given surface.

Arguments

int num - Triangle vertex number in the range from 0 to the total number of vertex color entries of the given surface.
Notice
To get the total number of vertex color entries for the surface, call the getNumColors() method.
vec4 color - Vertex color to be set.
int surface - Mesh surface number.

vec4 GetColor ( int num, int surface ) #

Returns the color of the given triangle vertex of the given surface.

Arguments

int num - Triangle vertex number in the range from 0 to the total number of vertex color entries of the given surface.
Notice
To get the total number of vertex color entries for the surface, call the getNumColors() method.
int surface - Mesh surface number.

Return value

Vertex color.

float SetFrame ( int layer, float frame, int from = -1, int to = -1 ) #

Sets a frame for the given animation layer.

Arguments

int layer - Animation layer number.
float frame - Frame number in the "from-to" interval. If the float argument is passed, animation is interpolated between nearby frames. 0 means the from frame. For larger values, a residue of a modulo (from-to) is calculated. If a negative value is provided, interpolation will be done from the current frame to the from frame.
int from - Start frame. -1 means the first frame of the animation.
int to - End frame. -1 means the last frame of the animation.

Return value

The number of the frame.

float GetFrame ( int layer ) #

Returns the frame number passed as the time argument on the last setFrame() call.

Arguments

int layer - Animation layer number.

Return value

Frame number.

int GetFrameFrom ( int layer ) #

Returns the start frame passed as the from argument on the last setFrame() call.

Arguments

int layer - Animation layer number.

Return value

Start frame.

int GetFrameTo ( int layer ) #

Returns the end frame passed as the to argument on the last setFrame() call.

Arguments

int layer - Animation layer number.

Return value

End frame.

mat4 GetIBoneBindTransform ( int bone ) #

Returns the inverse bind pose bone transformation matrix.

Arguments

int bone - Bone number.

Return value

Inverse bind pose transformation matrix.

mat4 GetIBoneTransform ( int bone ) #

Returns an inverse transformation matrix for a given bone relatively to the parent object.

Arguments

int bone - Bone number.

Return value

Inverse transformation matrix.

void SetLayer ( int layer, bool enabled, float weight ) #

Enables or disables the given animation layer and sets the value of the weight parameter.

Arguments

int layer - Animation layer number.
bool enabled - Enable flag. 1 to enable the layer, 0 to disable it.
float weight - Animation layer weight.

void SetLayerBoneTransform ( int layer, int bone, mat4 transform ) #

Sets a transformation matrix for a given bone. The difference from the setBoneTransform() function is that this method takes into account only the transformation in the animation layer (no blending is done). Take notice that a bone can be scaled only uniformly.

Arguments

int layer - Animation layer number.
int bone - Bone number.
mat4 transform - Bone transformation matrix.

mat4 GetLayerBoneTransform ( int layer, int bone ) #

Returns a transformation matrix of a given bone relatively to the parent object.

Notice

The difference from getBoneTransform() is that this method takes into account only the transformation in the animation layer (no blending is done).

Arguments

int layer - Animation layer number.
int bone - Bone number.

Return value

Bone transformation matrix.

bool IsLayerBoneTransform ( int layer, int bone ) #

Returns a value indicating if the bone transformation is applied only to the animation layer (no blending is performed).

Arguments

int layer - Animation layer number.
int bone - Bone number.

Return value

1 if the bone transformation is applied only to the animation layer; otherwise, 0.

void SetLayerBoneTransformEnabled ( int layer, int bone, bool enabled ) #

Enables or disables a layer transformation for a given bone.

Arguments

int layer - Animation layer number.
int bone - Bone number.
bool enabled - Enabled flag: 1 to enable layer transformation, 0 to disable it.

void SetLayerEnabled ( int layer, bool enabled ) #

Enables or disables a given animation layer.

Arguments

int layer - Animation layer number.
bool enabled - 1 to enable the animation layer, 0 to disable it.

bool IsLayerEnabled ( int layer ) #

Returns a value indicating if a given animation layer is enabled.

Arguments

int layer - Animation layer number.

Return value

1 if the layer is disabled; otherwise, 0.

void SetLayerWeight ( int layer, float weight ) #

Sets a weight for the animation layer.

Arguments

int layer - Animation layer number.
float weight - Animation layer weight.

float GetLayerWeight ( int layer ) #

Returns the weight of the animation layer.

Arguments

int layer - Animation layer number.

Return value

Weight of the animation layer.

int SetMesh ( Mesh mesh ) #

Copies the source mesh into the current mesh.

Source code (C#)

// create ObjectMeshSkinned instances 
ObjectMeshSkinned skinnedMesh = new ObjectMeshSkinned("soldier.mesh");
ObjectMeshSkinned skinnedMesh_2 = new ObjectMeshSkinned("doll.mesh");

// create a Mesh instance
Mesh firstMesh = new Mesh();

// get the mesh of the ObjectMeshSkinned and copy it to the Mesh class instance
skinnedMesh.getMesh(firstMesh);

// put the firstMesh mesh to the skinnedMesh_2 instance
skinnedMesh_2.setMesh(firstMesh);

Arguments

Mesh mesh - The source mesh to be copied.

Return value

1 if the mesh is copied successfully; otherwise, 0.

int GetMesh ( Mesh mesh ) #

Copies the current mesh into the source mesh.

Source code (C#)

// a skinned mesh from which geometry will be obtained
ObjectMeshSkinned skinnedMesh = new ObjectMeshSkinned("skinned.mesh");
// create a new mesh
Mesh mesh = new Mesh();
// copy geometry to the created mesh
if (skinnedMesh.getMesh(mesh) == 1) {
	// do something with the obtained mesh
}
else {
	Log.error("Failed to copy a mesh\n");
}

Arguments

Mesh mesh - Source mesh.

Return value

1 if the mesh is copied successfully; otherwise, 0.

void SetMeshName ( string path, bool force_load = 0 ) #

Sets the path to the mesh and forces creating of the mesh using the new path.

Arguments

string path - Path to the mesh.
bool force_load - Force flag.
- If 1 is specified, the new path to the mesh is set immediately with the unique flag set to 0.
- If 0 is specified, only the path to the mesh is updated.

void SetMeshName ( string name ) #

Sets the path to the mesh.

Arguments

string name - Path to the mesh.

int GetMeshSurface ( Mesh mesh, int surface, int target = -1 ) #

Copies the specified mesh surface to the destination mesh.

Arguments

Mesh mesh - Destination Mesh to copy the surface to.
int surface - Number of the mesh surface to be copied.
int target - Number of the surface morph target to be copied. The default value is -1 (all morph targets).

Return value

Number of the new added mesh surface.

vec3 GetNormal ( int num, int surface, int target = 0 ) #

Returns the normal for the given triangle vertex of the given surface target.

Arguments

int num - Triangle vertex number in the range from 0 to the total number of vertex tangent entries of the given surface target.
Notice
Vertex normals are calculated using vertex tangents. To get the total number of vertex tangent entries for the surface target, call the getNumTangents() method.
int surface - Mesh surface number.
int target - Surface target number. The default value is 0.

Return value

Vertex normal.

int GetNumAnimationBones ( int animation ) #

Returns the number of animation bones.

Arguments

int animation - Animation number.

Return value

Number of animation bones.

int GetNumAnimationFrames ( int animation ) #

Returns the number of animation frames.

Arguments

int animation - Animation number.

Return value

Number of animation frames.

int GetNumBoneChildren ( int bone ) #

Returns the number of children for the specified bone.

Arguments

int bone - Bone number.

Return value

Number of child bones.

int GetNumCIndices ( int surface ) #

Returns the number of coordinate indices for the given mesh surface.

Arguments

int surface - Mesh surface number.

Return value

Number of coordinate indices.

int GetNumColors ( int surface ) #

Returns the total number of vertex color entries for the given surface.

Notice

Colors are specified for triangle vertices.

Arguments

int surface - Surface number.

Return value

Number of vertex color entries.

int GetNumFrames ( int layer ) #

Returns the number of animation frames for a given layer.

Arguments

int layer - Animation layer number.

Return value

Number of animation frames.

int GetNumSurfaceTargets ( int surface ) #

Returns the number of surface morph targets for the given mesh surface.

Arguments

int surface - Mesh surface number.

Return value

Number of surface morph targets.

int GetNumTangents ( int surface ) #

Returns the number of vertex tangent entries of the given mesh surface.

Notice

Tangents are specified for triangle vertices.

Arguments

int surface - Mesh surface number.

Return value

Number of surface tangent vectors.

void SetNumTargets ( int num, int surface ) #

Sets the number of animation morph targets for the given mesh surface.

Arguments

int num - Number of animation morph targets.
int surface - Mesh surface number.

int GetNumTargets ( int surface ) #

Returns the total number of morph targets of the given mesh surface.

Arguments

int surface - Mesh surface number.

Return value

Number of animation morph targets.

void SetNumTexCoords0 ( int num, int surface ) #

Sets the number of the first UV map texture coordinates for the given mesh surface.

Notice

First UV map texture coordinates are specified for triangle vertices.

Arguments

int num - Number of the first UV map texture coordinates to be set.
int surface - Mesh surface number.

int GetNumTexCoords0 ( int surface ) #

Returns the number of the first UV map texture coordinates for the given mesh surface.

Notice

First UV map texture coordinates are specified for triangle vertices.

Arguments

int surface - Mesh surface number.

Return value

Number of the first UV map texture coordinates.

void SetNumTexCoords1 ( int num, int surface ) #

Sets the number of the second UV map texture coordinates for the given mesh surface.

Notice

Second UV map texture coordinates are specified for triangle vertices.

Arguments

int num - Number of the second UV map texture coordinates to be set.
int surface - Mesh surface number.

int GetNumTexCoords1 ( int surface ) #

Returns the number of the second UV map texture coordinates for the given mesh surface.

Notice

Second UV map texture coordinates are specified for triangle vertices.

Arguments

int surface - Mesh surface number.

Return value

Number of the second UV map texture coordinates.

int GetNumTIndices ( int surface ) #

Returns the number of triangle indices for the given mesh surface.

Arguments

int surface - Mesh surface number.

Return value

Number of triangle indices.

int GetNumVertex ( int surface ) #

Returns the number of coordinate vertices for the given mesh surface.

Arguments

int surface - Mesh surface number.

Return value

Number of the surface vertices.

vec3 GetSkinnedNormal ( int num, int index, int surface ) #

Returns the skinned normal for the given triangle vertex.

NoticeA skinned normal is a recalculated normal for bones and morph targets used in skinning.

Arguments

int num - Triangle vertex number in the range from 0 to the total number of vertex tangent entries of the given surface target.
Notice
Vertex normals are calculated using vertex tangents. To get the total number of vertex tangent entries for the surface target, call the getNumTangents() method.
int index - Coordinate index of the vertex.
Notice
if -1 is passed, the coordinate index will be obtained for the first vertex having its triangle index equal to the specified triangle vertex number.
int surface - Mesh surface number.

Return value

Skinned normal.

quat GetSkinnedTangent ( int num, int index, int surface ) #

Returns the skinned tangent vector for the given triangle vertex.

NoticeA skinned tangent vector is a recalculated tangent vector for bones and morph targets used in skinning.

Arguments

int num - Triangle vertex number in the range from 0 to the total number of vertex tangent entries of the given surface target.
Notice
To get the total number of vertex tangent entries for the surface target, call the getNumTangents() method.
int index - Coordinate index of the vertex.
Notice
if -1 is passed, the coordinate index will be obtained for the first vertex having its triangle index equal to the specified triangle vertex number.
int surface - Mesh surface number.

Return value

Skinned tangent.

vec3 GetSkinnedVertex ( int num, int surface ) #

Returns skinned coordinates of the given coordinate vertex.

NoticeA skinned vertex is a recalculated vertex for bones and morph targets used in skinning.

Arguments

int num - Coordinate vertex number in the range from 0 to the total number of coordinate vertices for the given surface.
Notice
To get the total number of coordinate vertices for the given surface, use the getNumVertex() method.
int surface - Mesh surface number.

Return value

Vertex coordinates.

string GetSurfaceTargetName ( int surface, int target ) #

Returns the name of the morph target for the given mesh surface.

Arguments

int surface - Mesh surface number.
int target - Morph target number.

Return value

Morph target name.

void SetSurfaceTransform ( mat4 transform, int surface, int target = -1 ) #

Transforms the given mesh surface target.

Arguments

mat4 transform - Transformation matrix.
int surface - Mesh surface number.
int target - Morph target number. The default value is -1 (the transformation will be applied to all morph targets).

void SetTangent ( int num, quat tangent, int surface, int target = 0 ) #

Sets the new tangent for the given triangle vertex of the given surface target.

Arguments

int num - Triangle vertex number in the range from 0 to the total number of vertex tangent entries of the given surface.
Notice
To get the total number of vertex tangent entries for the surface, call the getNumTangents() method.
quat tangent - Tangent to be set.
int surface - Mesh surface number.
int target - Surface target number. The default value is 0.

quat GetTangent ( int num, int surface, int target = 0 ) #

Returns the tangent for the given triangle vertex of the given surface target.

Arguments

int num - Triangle vertex number in the range from 0 to the total number of vertex tangent entries of the given surface.
Notice
To get the total number of vertex tangent entries for the surface, call the getNumTangents() method.
int surface - Mesh surface number.
int target - Surface target number. The default value is 0.

Return value

Vertex tangent.

void SetTarget ( int target, bool enabled, int index, float weight, int surface ) #

Enables or disables a given morph target and sets all its parameters.

Arguments

int target - Morph target number.
bool enabled - Enable flag: 1 to enable the morph target; 0 to disable it.
int index - Target index.
float weight - Target weight.
int surface - Surface number.

void SetTargetEnabled ( int target, bool enabled, int surface ) #

Enables or disables a given morph target.

Arguments

int target - Morph target number.
bool enabled
int surface

int IsTargetEnabled ( int target, int surface ) #

Returns a value indicating if the given morph target of the given surface is enabled.

Arguments

int target - Morph target number.
int surface - Mesh surface number.

Return value

1 if the given morph target of the given surface is enabled; otherwise, 0.

void SetTargetIndex ( int target, int index, int surface ) #

Sets an index for the given morph target.

Arguments

int target - Morph target number.
int index - Morph target index.
int surface - Mesh surface number.

int GetTargetIndex ( int target, int surface ) #

Returns the index of the morph target. Returns the index of the given morph target.

Arguments

int target - Morph target number.
int surface - Mesh surface number.

Return value

Index of the given morph target.

void SetTargetWeight ( int target, float weight, int surface ) #

Sets a weight for the given animation target.

Arguments

int target - Morph target number.
float weight - Morph target weight.
int surface - Mesh surface number.

float GetTargetWeight ( int target, int surface ) #

Returns the weight of the given morph target.

Arguments

int target - Morph target number.
int surface - Mesh surface number.

Return value

Morph target weight.

void SetTexCoord0 ( int num, vec2 texcoord, int surface ) #

Sets first UV map texture coordinates for the given triangle vertex of the given surface.

Arguments

int num - Triangle vertex number in the range from 0 to the total number of first UV map texture coordinate entries of the given surface.
Notice
To get the total number of first UV map texture coordinate entries for the surface, call the getNumTexCoords0() method.
vec2 texcoord - First UV map texture coordinates to be set.
int surface - Mesh surface number.

vec2 GetTexCoord0 ( int num, int surface ) #

Returns first UV map texture coordinates for the given triangle vertex of the given surface.

Arguments

int num - Triangle vertex number in the range from 0 to the total number of first UV map texture coordinate entries of the given surface.
Notice
To get the total number of first UV map texture coordinate entries for the surface, call the getNumTexCoords0() method.
int surface - Mesh surface number.

Return value

First UV map texture coordinates.

void SetTexCoord1 ( int num, vec2 texcoord, int surface ) #

Sets second UV map texture coordinates for the given triangle vertex of the given surface.

Arguments

int num - Triangle vertex number in the range from 0 to the total number of second UV map texture coordinate entries of the given surface.
Notice
To get the total number of second UV map texture coordinate entries for the surface, call the getNumTexCoords1() method.
vec2 texcoord - Second UV map texture coordinates to be set.
int surface - Mesh surface number.

vec2 GetTexCoord1 ( int num, int surface ) #

Returns second UV map texture coordinates for the given triangle vertex of the given surface.

Arguments

int num - Triangle vertex number in the range from 0 to the total number of second UV map texture coordinate entries of the given surface.
Notice
To get the total number of second UV map texture coordinate entries for the surface, call the getNumTexCoords1() method.
int surface - Mesh surface number.

Return value

Second UV map texture coordinates.

void SetTIndex ( int num, int index, int surface ) #

Sets the new triangle index for the given vertex of the given surface.

Arguments

int num - Vertex number in the range from 0 to the total number of triangle indices for the given surface.
Notice
To get the total number of triangle indices, use the getNumTIndices() method.
int index - Triangle index to be set in the range from 0 to the total number of triangle vertices for the given surface.
Notice
To get the total number of triangle vertices for the given surface, use the getNumTVertex() method.
int surface - Mesh surface number.

int GetTIndex ( int num, int surface ) #

Returns the triangle index for the given surface by using the index number.

Arguments

int num - Vertex number in the range from 0 to the total number of triangle indices for the given surface.
Notice
To get the total number of triangle indices for the given surface, use the getNumTIndices() method.
int surface - Mesh surface number.

Return value

Triangle index.

void SetVertex ( int num, vec3 vertex, int surface, int target = 0 ) #

Sets the coordinates of the given coordinate vertex of the given surface target.

Arguments

int num - Coordinate vertex number in the range from 0 to the total number of coordinate vertices for the given surface.
Notice
To get the total number of coordinate vertices for the given surface, use the getNumCVertex() method.
vec3 vertex - Vertex coordinates to be set.
int surface - Mesh surface number.
int target - Surface target number. The default value is 0.

vec3 GetVertex ( int num, int surface, int target = 0 ) #

Returns coordinates of the given coordinate vertex of the given surface target.

Arguments

int num - Coordinate vertex number in the range from 0 to the total number of coordinate vertices for the given surface.
Notice
To get the total number of coordinate vertices for the given surface, use the getNumCVertex() method.
int surface - Mesh surface number.
int target - Surface target number. The default value is 0.

Return value

Vertex coordinates.

void SetWorldBoneChildrenTransform ( int bone, Mat4 transform ) #

Sets the transformation for the given bone and all of its children in the world coordinate space (considering node transformations).

Notice

Bones can be scaled only uniformly.

Arguments

int bone - Bone number.
Mat4 transform - Transformation matrix in the world space.

void SetWorldBoneTransform ( int bone, Mat4 transform ) #

Sets the transformation for the given bone in the world coordinate space.

Notice

Bones can be scaled only uniformly.

Arguments

int bone - Bone number.
Mat4 transform - Transformation matrix in the world space.

Mat4 GetWorldBoneTransform ( int bone ) #

Returns the current transformation matrix applied to the bone in the world coordinate space (considering node transformations).

Arguments

int bone - Bone number.

Return value

Transformation matrix in the world space.

int AddAnimation ( Mesh mesh, string path = 0, string name = 0 ) #

Loads an additional animation from an external file.

Source code (C++)

UGUID guid;
guid.generate();
int animation_1 = skinned_mesh->addAnimation(mesh,guid.getFileSystemString(), "run");

Arguments

Mesh mesh - Mesh containing the animation to be added.
string path - The value depends on the Legacy mode:
- If it is enabled, the parameter is the name of the animation to be loaded. The default 0 value loads all animation clips from the mesh.
- If it is disabled, the parameter is a virtual unique path defining the animation. After loading the animation clip, its internal representation will be identified by the path when using findAnimation, setAnimation, etc. The default 0 value implies that the names of the animation clips will be used.
  Notice
  As the given mesh isn't associated with a file and, therefore, doesn't have path data, the path must be represented by an arbitrary unique string. You can generate a new string and use it as the virtual path for the animation.
string name - Name of the animation to be loaded. The parameter is used only when the Legacy mode is disabled.

Return value

Animation identifier.

int AddAnimation ( string path, string name = 0 ) #

Loads the additional animation from an external file.

Arguments

string path - Path to the animation file. Two modes are supported:
- If the Legacy mode for skinned mesh animations is enabled, the value is a path to the animation file.
- In the disabled legacy mode the path can be represented by either a path to the file or its GUID, which is the recommended approach. After loading the animation, its internal representation is identified by the path when using findAnimation, setAnimation, etc.
Notice
When you import your model with animations from an FBX container, the following path to your *.anim files should be used: <path_to_your_fbx_file>/<file.fbx>/<your_anim_file.anim>
For example: object->addAnimation("models/soldier/soldier.fbx/run.anim");
string name - Name of the animation to be loaded. The default value is 0 which implies that:
- In the Legacy mode all animation clips from the file will be loaded.
- In the Current mode only the first animation clip from the file will be loaded.
Notice
If the path and the name are not provided,

Return value

Animation identifier.

int AddEmptySurface ( string name, int num_vertex, int num_indices ) #

Appends a new empty surface to the current mesh.

Arguments

string name - Name of the new surface.
int num_vertex - Number of vertices of the new surface.
int num_indices - Number of indices of the new surface.

Return value

Number of the new added surface.

int AddLayer ( ) #

Appends a new animation layer to the current mesh.

Return value

Number of the new added animation layer.

int AddMeshSurface ( string name, ObjectMeshSkinned mesh, int surface, int target = -1 ) #

Appends a new mesh surface to the current mesh.

Arguments

string name - Name of the new surface of the current mesh.
ObjectMeshSkinned mesh - Mesh pointer to copy a surface from.
int surface - Number of mesh surface to copy.
int target - Number of mesh target to copy. The default value is -1 (all morph targets will be copied).

Return value

Number of the added mesh surface.

int AddMeshSurface ( int dest_surface, ObjectMeshSkinned mesh, int surface, int target = -1 ) #

Merges the specified surface from the source ObjectMeshSkinned with the specified destination surface of the mesh.

Arguments

int dest_surface - Number of the destination surface, with which a surface from the source ObjectMeshSkinned is to be merged.
ObjectMeshSkinned mesh - Source ObjectMeshSkinned to copy a surface from.
int surface - Number of the source mesh surface to copy.
int target - Number of mesh target to merge. The default value is -1 (all morph targets will be merged).

Return value

Number of the destination mesh surface.

int AddMeshSurface ( string name, Mesh mesh, int surface, int target = -1 ) #

Appends a new mesh surface to the current mesh by copying the specified surface from the source mesh.

Arguments

string name - Name of the new surface of the current mesh.
Mesh mesh - Source mesh to copy a surface from.
int surface - Number of the source mesh surface to copy.
int target - Number of mesh target to copy. The default value is -1 (all morph targets will be copied).

Return value

Number of the added mesh surface.

int AddSurfaceTarget ( int surface, string name = 0 ) #

Appends a new morph target to the given mesh surface.

Arguments

int surface - Number of the surface, to which the morph target will be appended.
string name - Name of the new morph target.

Return value

Number of the new added morph target.

int AddSurfaceTarget ( int dest_surface, ObjectMeshSkinned src_mesh, int src_surface, int src_target = -1 ) #

Appends a new morph target to the given mesh surface by copying it from the specified surface of the source ObjectMeshSkinned.

Arguments

int dest_surface - Number of the surface, to which the morph target will be appended.
ObjectMeshSkinned src_mesh - Source ObjectMeshSkinned to copy the morph target from.
int src_surface - Number of the surface of the source ObjectMeshSkinned to copy the morph target from.
int src_target - Number of the morph target to copy. The default value is -1 (all morph targets will be copied).

Return value

Number of the new added morph target.

int AddTarget ( int surface ) #

Appends a new empty morph target to the given mesh surface.

Arguments

int surface - Number of the surface, to which the morph target will be appended.

Return value

number of the new added morph target.

void ClearLayer ( int layer ) #

Clears the given animation layer.

Arguments

int layer - Animation layer number.

void CopyLayer ( int dest, int src ) #

Copies source layer bones transformations to the destination layer. The copying conditions are the following:

If the destination layer has more bones than the source one, it will keep its former transformations.
If the source layer has more bones than destination one, those bones will be added to the destination layer.

Arguments

int dest - Number of the destination layer in the range from 0 to the total number of animation layers.
Notice
To get the total number of animation layers, use the getNumLayers() method.
int src - Number of the source layer in range from 0 to the total number of animation layers.
Notice
To get the total number of animation layers, use the getNumLayers() method.

int CreateMesh ( string path, bool unique = 0 ) #

Creates a skinned mesh.

Arguments

string path - Path to the mesh file.
bool unique - Dynamic flag:
- 0 - If the mesh vertices are changed in run-time, meshes loaded from the same file will be also changed.
- 1 - If the mesh vertices are changed in run-time, meshes loaded from the same file won't be changed

Return value

1 if the mesh is created successfully; otherwise - 0.

int FindAnimation ( string path ) #

Searches for an animation using the given path.

Arguments

string path - Path to animation file.
Notice
Use the path specified on animation loading.

Return value

Animation number, if found; otherwise, -1.

int FindBone ( string name ) #

Searches for a bone with a given name.

Arguments

string name - Bone name.

Return value

bone number if found; otherwise, -1.

int FindSurfaceTarget ( string name, int surface ) #

Searches for a surface morph target with a given name.

Arguments

string name - Name of the morph target.
int surface - Mesh surface number.

Return value

Number of the morph target, if exists; otherwise, -1.

void FlushMesh ( ) #

Flushes mesh geometry to the video memory.

void ImportLayer ( int layer ) #

Copies the current bone state to the given animation layer.

Arguments

int layer - Animation layer number.

void InverseLayer ( int dest, int src ) #

Copies inverse transformations of bones from the source layer to the destination layer.

NoticeDestination layer is not cleared before transformations are written to it.

Arguments

int dest - Number of the destination layer in the range from 0 to the total number of animation layers.
Notice
To get the total number of animation layers, use the getNumLayers() method.
int src - Number of the source layer in the range from 0 to the total number of animation layers.
Notice
To get the total number of animation layers, use the getNumLayers() method.

void LerpLayer ( int dest, int layer0, int layer1, float weight ) #

Copies interpolated bone transformations from two source layers to a destination layer.

NoticeIf there is no bone in one of the source layers, the bone transformation from another one will be copied to the destination layer without interpolation.

Arguments

int dest - Number of the destination layer in the range from 0 to the total number of animation layers.
Notice
To get the total number of animation layers, use the getNumLayers() method.
int layer0 - Number of the first source layer in the range from 0 to the total number of animation layers.
Notice
To get the total number of animation layers, use the getNumLayers() method.
int layer1 - Number of the second source layer in range from 0 to the total number of animation layers.
Notice
To get the total number of animation layers, use the getNumLayers() method.
float weight - Interpolation weight.

int LoadMesh ( string path ) #

Loads a new mesh instead of the current mesh from the .mesh file. This function doesn't change the mesh name.

Arguments

string path - The path to the .mesh file.

Return value

1 if the mesh is loaded successfully; otherwise, 0.

void MergeMeshSurface ( int dest_surface, ObjectMeshSkinned src_mesh, int src_surface ) #

Merges the specified surface from the source ObjectMeshSkinned with the specified destination surface of the mesh.

Arguments

int dest_surface - Number of the destination surface, with which a surface from the source ObjectMeshSkinned is to be merged.
ObjectMeshSkinned src_mesh - Source ObjectMeshSkinned to copy a surface from.
int src_surface - Number of source mesh surface to merge.

void MulLayer ( int dest, int layer0, int layer1, float weight = 1.0f ) #

Copies multiplied bone transformations from two source layers to the destination layer.

Arguments

int dest - Number of the destination layer in the range from 0 to the total number of animation layers.
Notice
To get the total number of animation layers, use the getNumLayers() method.
int layer0 - Number of the first source layer in the range from 0 to the total number of animation layers.
Notice
To get the total number of animation layers, use the getNumLayers() method.
int layer1 - Number of the second source layer in the range from 0 to the total number of animation layers.
Notice
To get the total number of animation layers, use the getNumLayers() method.
float weight - Interpolation weight.

void Play ( ) #

Continues playback of the animation, if it was paused, or starts playback if it was stopped.

void RemoveAnimation ( int animation ) #

Removes the given animation.

Arguments

int animation - Animation number.

void RemoveLayer ( int layer ) #

Removes an animation layer.

Arguments

int layer - Layer number in the range from 0 to the total number of animation layers.
Notice
To get the total number of animation layers, use the getNumLayers() method.

void RemoveTarget ( int target, int surface ) #

Removes the given morph target.

Arguments

int target - Target number in the range from 0 to the total number of morph targets.
Notice
To get the total number of morph targets for a given surface, use the getNumTargets() method.
int surface - Mesh surface number.

int SaveMesh ( string path ) #

Saves the mesh to .mesh or .anim format.

Arguments

string path - Path to the .mesh file.

Return value

1 if the mesh is saved successfully; otherwise, 0.

void Stop ( ) #

Stops animation playback. This function saves the playback position so that playing of the animation can be resumed from the same point.

static int type ( ) #

Returns the type of the node.

Return value

Node type identifier.

void UpdateSurfaceBounds ( int surface = -1 ) #

Updates mesh surface bounds. This method is to be called to recalculate bounds after changing a mesh surface (e.g. modifying positions of coordinate vertices).

Arguments

int surface - Number of the surface to recalculate bound for. The default value is -1 (all surfaces).

Last update: 2019-08-16

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

Unigine.ObjectMeshSkinned Class

Creating and Playing Animation#

Updating Bone Transformations#

Instancing#

See Also#

Properties:

Methods:

ObjectMeshSkinned Class

Properties

int NumAnimations#

int NumBones#

int NumLayers#

bool IsStopped#

bool IsPlaying#

float Speed#

float Time#

int Loop#

bool IsControlled#

bool IsQuaternion#

string AnimName#

string MeshName#

Members

static ObjectMeshSkinned ( Mesh mesh ) #

Arguments

static ObjectMeshSkinned ( string path, bool unique = 0 ) #

Arguments

static ObjectMeshSkinned Cast ( Node node ) #

Arguments

Return value

static ObjectMeshSkinned Cast ( Object base ) #

Arguments

Return value

int SetAnimation ( int layer, int animation ) #

Arguments

int SetAnimation ( int layer, string path ) #

Arguments

int GetAnimation ( int layer ) #

Arguments

Return value

int GetAnimationID ( int num ) #

Arguments

Return value

string GetAnimationPath ( int animation ) #

Arguments

Return value

void SetAnimName ( string name, bool force_load = 0 ) #

Arguments

void SetAnimName ( string name ) #

Arguments

mat4 GetBoneBindTransform ( int bone ) #

Arguments

Return value

int GetBoneChild ( int bone, int child ) #

Arguments

Return value

void SetBoneChildrenTransform ( int bone, mat4 transform ) #

Arguments

string GetBoneName ( int bone ) #

Arguments

Return value

int GetBoneParent ( int bone ) #

Arguments

Return value

void SetBoneTransform ( int bone, mat4 transform ) #

Arguments

mat4 GetBoneTransform ( int bone ) #

Arguments

Return value

void SetBoneTransforms ( int[] bones, mat4[] transforms, int num_bones ) #

Arguments

void SetCIndex ( int num, int index, int surface ) #

Arguments

int GetCIndex ( int num, int surface ) #

Arguments

Return value

void SetColor ( int num, vec4 color, int surface ) #

Arguments

vec4 GetColor ( int num, int surface ) #

Arguments

Return value