ObjectMeshSkinned Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
| Inherits: | Object |
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.
NoticeThe recommended approach is to use the Component System and provide the guid of the .anim file.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");
Source code (C++)UGUID guid = FileSystem::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 setBoneTransformWithChildren().
Usage Example
The following example shows how to blend 2 different animations assigned to a mesh. In this example we use the mesh and animations from UNIGINE samples located in <UnigineSDK>/data/samples/animation/meshes and <UnigineSDK>/data/samples/animation/animations folders, respectively. Animations are added by using the addAnimation() function.
Source code (UnigineScript)
// define the new ObjectMeshSkinned class instance
ObjectMeshSkinned skinned_mesh;
int init() {
/* ... */
// create the new ObjectMeshSkinned mesh based on an existing mesh
skinned_mesh = new ObjectMeshSkinned("samples/animation/meshes/agent.mesh");
// add a material to the mesh
skinned_mesh.setMaterial("mesh_base","*");
// set the number of animation layers
skinned_mesh.setNumLayers(2);
// load animations from the files
int animation_1 = skinned_mesh.addAnimation("samples/animation/animations/agent_run.anim");
int animation_2 = skinned_mesh.addAnimation("samples/animation/animations/agent_punch.anim");
// enable each layer and set an animation weight
skinned_mesh.setLayer(0,1,0.7);
skinned_mesh.setLayer(1,1,0.3);
// set animations to layers
skinned_mesh.setAnimation(0, animation_1);
skinned_mesh.setAnimation(1, animation_2);
/* ... */
}
int update() {
/* ... */
// get the current time spent in the game
float time = engine.game.getTime();
// start each animation playing
skinned_mesh.setFrame(0,time * 25.0f);
skinned_mesh.setFrame(1,time * 25.0f);
/* ... */
}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.
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.
Notice
The higher the number of bones and the more bones are attached to one surface, the less robust instancing will be.
See Also#
- Mesh class
- Article on Mesh File Formats
- Samples located in the <UnigineSDK>/data/samples/animation folder
ObjectMeshSkinned Class
Members
static ObjectMeshSkinned ( string path, int unique = false ) #
ObjectMeshSkinned constructor.Arguments
- string path - Path to the skinned mesh file.
- int 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 true (1), so a copy of the mesh geometry will be created and changes won't be applied.
int setAnimation ( int layer, variable v, int animation ) #
Sets the animation parameter (name or id) for the given animation layer.Arguments
- int layer - Layer number.
- variable v - The variable of one of the following types:
- string name - The animation layer name.
- int animation - The animation identifier.
- int animation - Animation identifier.
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 ) #
Sets a new path to the animation. Does not update animation immediately using the new path, unlike the setAnimNameForce() method.Arguments
- string name - Path to the animation.
void setAnimNameForce ( string name ) #
Sets the new path to the animation and forces setting this animation for the first animation layer.Arguments
- string name - Path to the animation file.
string getAnimName ( ) #
Returns the path to the current animation.Return value
Path to 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 setBoneTransformWithChildren ( 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo get the total number of vertex color entries for the surface, call the getNumColors() method.
- int surface - Mesh surface number.
Return value
Vertex color.void setControlled ( int controlled ) #
Sets a value indicating if the animation should be controlled by a parent ObjectMeshSkinned (useful for attaching clothes to a character body).Arguments
- int controlled - Controlled flag: 1 if the animation is controlled by a parent ObjectMeshSkinned; otherwise - 0.
int isControlled ( ) #
Returns a value indicating if the animation is controlled by a parent ObjectMeshSkinned.Return value
1 if the animation is controlled by a parent ObjectMeshSkinned; otherwise, 0.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 getBoneBindITransform ( int bone ) #
Returns the inverse bone transformation matrix of the bind pose in the world-space.Notice
To get the bind pose transformation matrix in the world-space, use the inverse(getBoneITransform()).
Arguments
- int bone - Bone number.
Return value
Inverse bind pose transformation matrix.mat4 getBoneITransform ( 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, int enabled, float weight ) #
Enables or disables the given animation layer and sets the value of the weight parameter.Arguments
- int layer - Animation layer number.
- int enabled - Enable flag. 1 to enable the layer, 0 to disable it.
- float weight - Animation layer weight.
void setBoneLayerTransform ( 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 specified animation layer (no blending is performed).Notice
The bone can be scaled only uniformly.
Arguments
- int layer - Animation layer number.
- int bone - Bone number.
- mat4 transform - Bone transformation matrix.
mat4 getBoneLayerTransform ( 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.int isBoneLayerTransform ( 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 setBoneLayerTransformEnabled ( int layer, int bone, int enabled ) #
Enables or disables a layer transformation for a given bone.Arguments
- int layer - Animation layer number.
- int bone - Bone number.
- int enabled - Enabled flag: 1 to enable layer transformation, 0 to disable it.
void setLayerEnabled ( int layer, int enabled ) #
Enables or disables a given animation layer.Arguments
- int layer - Animation layer number.
- int enabled - 1 to enable the animation layer, 0 to disable it.
int 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.void setLoop ( int loop ) #
Sets a value indicating if the animation should be looped.Arguments
- int loop - 1 is to play the animation in a loop, 0 is to play it only once.
int getLoop ( ) #
Returns a value indicating if the animation is looped. 1 if the animation is looped; otherwise - 0.Return value
The loop flag.int setMesh ( Mesh mesh ) #
Copies the source mesh into the current mesh.Source code (UnigineScript)
// 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 (UnigineScript)
// 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)) {
// 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.void setMeshName ( string name ) #
Sets the path to the mesh. Does not update mesh immediately using the new path, unlike the setMeshNameForce() methodArguments
- string name - Path to the mesh.
void setMeshNameForce ( string path ) #
Sets the new path to the mesh and forces mesh creation using the new path. The new mesh is created from the specified path immediately with the unique flag set to 0.Arguments
- string path - Path to the mesh file.
string getMeshName ( ) #
Returns the path to the mesh.Return value
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.
NoticeVertex 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 getNumAnimations ( ) #
Returns the total number of all loaded animations.Return value
Number of loaded animations.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 getNumBones ( ) #
Returns the number of all bones taking part in animation.Return value
Number of 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.void setNumLayers ( int layers ) #
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.Arguments
- int layers - Number of animation layers (must be greater than 0).
int getNumLayers ( ) #
Returns the number of animation layers set for blending. For more details, see the article on Skinned Mesh.Return value
Number of animation layers.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.int isPlaying ( ) #
Returns playback status.Return value
1 if animation is playing; otherwise, 0.void setQuaternion ( int quaternion ) #
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.Arguments
- int quaternion - 1 to enable dual-quaternion skinning mode, 0 to disable it.
int isQuaternion ( ) #
Returns 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.Return value
1 if dual-quaternion skinning mode is used; otherwise, 0.vec3 getSkinnedNormal ( int num, int index, int surface ) #
Returns the skinned normal for the given triangle vertex.Notice
A 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.
NoticeVertex 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.
Noticeif -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.Notice
A 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.
NoticeTo get the total number of vertex tangent entries for the surface target, call the getNumTangents() method.
- int index - Coordinate index of the vertex.
Noticeif -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.Notice
A 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.
NoticeTo get the total number of coordinate vertices for the given surface, use the getNumVertex() method.
- int surface - Mesh surface number.
Return value
Vertex coordinates.void setSpeed ( float speed ) #
Updates a multiplier value for the animation playback time.Arguments
- float speed - Playback speed multiplier value.
float getSpeed ( ) #
Returns a multiplier for animation playback time.Return value
Playback speed multiplier value.int isStopped ( ) #
Returns stop status.Return value
1 if animation is stopped; otherwise, 0.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.
NoticeTo 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.
NoticeTo 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, int 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.
- int 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, int enabled, int surface ) #
Enables or disables a given morph target.Arguments
- int target - Morph target number.
- int enabled - 1 to enable the morph target, 0 to disable it.
- 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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 setTime ( float time ) #
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.
Arguments
- float time - Animation time.
float getTime ( ) #
Returns the current animation time, in animation frames. The time count starts from the zero frame.Return value
Animation time.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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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 setBoneWorldTransformWithChildren ( 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 setBoneWorldTransform ( 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 getBoneWorldTransform ( 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 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 ( variable v0, variable v1, int surface, int target = -1 ) #
Appends the specified surface of the source mesh to the current mesh. Variables, passed as arguments, can be of the following types:
- string and Mesh.
- string and ObjectMeshSkinned.
- int and ObjectMeshSkinned.
Arguments
- variable v0 - Argument of one of the following types:
- string name - Name of the new surface.
- int dest_surface - Number of the surface to append geometry to.
- variable v1 - Argument of one of the following types:
- Mesh mesh - Source mesh to copy the surface from.
- ObjectMeshSkinned mesh - Source mesh to copy the 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 addSurfaceTarget ( int surface ) #
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.
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.
NoticeTo 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.
NoticeTo get the total number of animation layers, use the getNumLayers() method.
int createMesh ( string path, int unique = 0 ) #
Creates a skinned mesh.Arguments
- string path - Path to the mesh file.
- int unique - Dynamic flag:
- false (0) - If the mesh vertices are changed in run-time, meshes loaded from the same file will be also changed.
- true (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.
NoticeUse 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.Notice
Destination 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.
NoticeTo 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.
NoticeTo 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.Notice
If 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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.
NoticeTo 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).
void setFPSVisibleCamera ( int camera = -1 ) #
Sets the update rate value when the object is rendered to the viewport. The default value is set to infinity.Arguments
- int camera - Update rate value when the object is rendered.
int getFPSVisibleCamera ( ) #
Returns the update rate value when the object is rendered to the viewport.Return value
Update rate value when the object is rendered.void setFPSVisibleShadow ( int shadow = 30 ) #
Sets the update rate value when only object shadows are rendered. The default value is set to 30 fps.Arguments
- int shadow - Update rate value when only object shadows are rendered.
int getFPSVisibleShadow ( ) #
Returns the update rate value when only object shadows are rendered.Return value
Update rate value when only object shadows are rendered.void setFPSInvisible ( int invisible = 0 ) #
Sets the update rate value when the object is not rendered at all. The default value is 0 fps.Arguments
- int invisible - Update rate value when the object is not rendered at all.
int getFPSInvisible ( ) #
Returns the update rate value when the object is not rendered at all.Return value
Update rate value when the object is not rendered at all.void setUpdateDistanceLimit ( float limit = 200 ) #
Sets the distance from the camera within which the object should be updated. The default value is 200 units.Arguments
- float limit - Distance from the camera within which the object should be updated.
float getUpdateDistanceLimit ( ) #
Returns the distance from the camera within which the object should be updated.Return value
Distance from the camera within which the object should be updated.void updateSkinned ( ) #
Forces update of all bone transformations.mat4 getBoneNotAdditionalBindLocalTransform ( int bone ) #
Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
mat4 getBoneNotAdditionalBindObjectTransform ( int bone ) #
Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
Mat4 getBoneNotAdditionalBindWorldTransform ( int bone ) #
Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
void setBindNode ( int bone, Node node ) #
Sets a new node whose transformation is to be used to control the transformation of the bone with the specified number.Arguments
- int bone - Number of the bone to be controlled by the specified node, in the range from 0 to the total number of bones.
- Node node - Node whose transformation is used to control the transformation of the bone.
void removeBindNode ( int bone ) #
Removes the assigned bind node from the bone with the specified number.Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
Node getBindNode ( int bone ) #
Returns the bind node currently assigned to the bone with the specified number.Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
Return value
Node whose transformation is used to control the transformation of the bone if it is assigned; otherwise - nullptr.void setBindNodeSpace ( int bone, int space ) #
Sets a new value indicating which transformation of the bind node (World or Local) is to be used to override the transformation of the specified bone.Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
- int space - Type of transformation of the bind node to be used to override the transformation of the specified bone, one of the NODE_SPACE* values.
int getBindNodeSpace ( int bone ) #
Returns the current value indicating which transformation of the bind node (World or Local) is to be used to override the transformation of the specified bone.Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
Return value
Type of transformation of the bind node to be used to override the transformation of the specified bone, one of the NODE_SPACE* values.void setBindBoneSpace ( int bone, int space ) #
Sets a value indicating which transformation of the specified bone is to be overridden by the bind node's transformation.Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
- int space - Type of transformation of the specified bone to be overridden by the bind node's transformation, one of the BONE_SPACE* values.
int getBindBoneSpace ( int bone ) #
Returns the current value indicating which transformation of the specified bone is to be overridden by the bind node's transformation.Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
Return value
Current type of transformation of the specified bone overridden by the bind node's transformation, one of the BONE_SPACE* values.void setBindMode ( int bone, int mode ) #
Sets a new type of blending of bind node's and bone's transformations.Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
- int mode - New type of blending of bind node's and bone's transformations:
- OVERRIDE - replace bone's transformation with the transformation of the node.
- ADDITIVE - node's transformation is added to the current transformation of the bone.
int getBindMode ( int bone ) #
Returns the current type of blending of bind node's and bone's transformations.Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
Return value
Current type of blending of bind node's and bone's transformations:- OVERRIDE - replace bone's transformation with the transformation of the node.
- ADDITIVE - node's transformation is added to the current transformation of the bone.
void setBindNodeOffset ( int bone, const Mat4 & offset ) #
Sets a new transformation matrix to be applied to the node's transformation before applying it to bone's transformation. This parameter serves for the purpose of additional correction of the node's transform for the bone's basis.Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
- const Mat4 & offset - Transformation matrix applied to the node's transformation before applying it to bone's transformation.
Mat4 getBindNodeOffset ( int bone ) #
Returns the current transformation matrix which is applied to the node's transformation before applying it to bone's transformation. This parameter serves for the purpose of additional correction of the node's transform for the bone's basis.Arguments
- int bone - Number of the bone, in the range from 0 to the total number of bones.
Return value
Transformation matrix currently applied to the node's transformation before applying it to bone's transformation.void addVisualizeBone ( int bone ) #
Adds a bone with the specified number to the list of the bones for which the basis vectors are to be visualized.Arguments
- int bone - Number of the bone to be added to the visualizer, in the range from 0 to the total number of bones.
void removeVisualizeBone ( int bone ) #
Removes a bone with the specified number from the list of the bones for which the basis vectors are to be visualized.Arguments
- int bone - Number of the bone to be removed from the visualizer, in the range from 0 to the total number of bones.
void clearVisualizeBones ( ) #
Clears the list of the bones for which the basis vectors are to be visualized.void setVisualizeAllBones ( int bones ) #
Sets a value indicating if visualization for bones and their basis vectors is enabled. The visualizer can be used for debugging purposes showing positions of bones and their basis vectors for multiple meshes simultaneously.Arguments
- int bones - 1 to enable visualization of bones and their basis vectors; 0 — to disable it.
int isVisualizeAllBones ( ) #
Returns a value indicating if visualization for bones and their basis vectors is enabled. The visualizer can be used for debugging purposes showing positions of bones and their basis vectors for multiple meshes simultaneously.Return value
1 if visualization for bones and their basis vectors is enabled; otherwise, 0.Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)