Mesh 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 UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
Mesh class is a container and provides an interface for mesh loading, manipulating and saving.
By using this class, you can create a mesh, add geometry to it (e.g. box, plane, capsule or cylinder surface), add animations and bones (if you want to create a skinned mesh) and then use it to create the following objects:
Also you can get geometry of all of these objects via the Mesh class.
Features of the mesh are listed below:
- Each surface of the mesh supports several morph targets.
- Each surface has a quaternion-based tangent basis for the better loading speed.
- 8-bit vertex colors are supported.
- Each vertex of a surface has 2 sets of indices: coordinate and triangle indices. It improves the loading speed and reduces data duplication.
- Each vertex of a surface has 2 UV sets.
- A bind pose transformation is stored for each mesh (even if there are no animations and animation frames). See also the getBoneTransfroms() method.
NoticeThe 1st animation frame should not contain the bind pose.
Vertex Data and Indices#
Each surface of the mesh consists of triangles, and each triangle has 3 vertices. Thus, for each mesh surface we have:
Total number of vertices = 3 * number of triangles.
If a vertex belongs to several triangles, we have to store several copies of such vertex. Each of these copies would store information about position, normal, binormal, tangent and texture coordinates. In order to reduce data duplication and increase loading speed UNIGINE uses the optimization described below.
There are 2 separate vertex data buffers are used:
- CVertices coordinate buffer, which stores only vertex coordinates.
- TVertices triangle buffer, which stores vertex attributes such as normal, binormal, tangent, color, UV coordinates.
On the picture below, two examples are given (arrows are used to show normals):
Both surfaces contain 2 adjacent triangles. Here C0...C3 are coordinate vertices, T0...T5 are triangle vertices
The coordinate buffer is an array of coordinate vertices. Each coordinate vertex contains coordinates (float[3]) of the vertex. For example, the coordinate buffer for the surfaces presented on the picture above is the following:
Output
CB = [C0,C1,C2,C3]The triangle buffer is an array of triangle vertices. For example, the triangle buffer for the surface presented on the left picture above is the following:
Output
TB = [T0,T1,T2,T3,T4,T5]Notice
The surface presented on the right picture above consist of 2 triangles with 2 vertices (C1 and C3) which have the same normal attributes (T1 and T3) compared to the surface on the left (where C1 and C3 have more than one attribute). So the triangle buffer of vertices for the surface on the right is:
The coordinate and triangle buffers describe the same surface. Both of these buffers are required to describe the final surface. The actual amount of final vertices is the number of tvertices.
Output
Each triangle vertex can store:
TB = [T0,T1,T2,T3]- Normal
- Binormal
- Tangent
- 1st UV map texture coordinates
- 2nd UV map texture coordinates
- Color
Notice
The number of triangle vertices depends on the number of triangles, to which the vertex belongs.
For example, if 2 triangles have an adjacent vertex with different normals for each triangle, 2 triangle vertices will be stored (relevant for vertices C1 and C3 on the left picture above).
However, if the attributes of the vertex are the same for all of the adjacent triangles, only 1 triangle vertex will be stored (relevant for vertices C1 and C3 on the right picture above).
The number of coordinate vertices and triangle vertices can be different.
Both the coordinate and triangle vertices have indices. There are 2 index buffers to get proper cvertex and tvertex data for each vertex of mesh surface:
- CIndices buffer — coordinate indices, which are links to CVertices data.
- TIndices buffer — triangle indices, which are links to TVertices data.
Notice
The number of elements in these index buffers is equal to the total number of vertices of a mesh surface.
Coordinate Indices#
Each vertex of a mesh surface has a coordinate index - a number of the corresponding element of the coordinate buffer, where the data is stored. For the given surface the array of the coordinate indices is as follows:
Output
Here:
CIndices = [Ci0,Ci1,Ci3,Ci1,Ci2,Ci3]- The first 3 elements are the coordinate indices of the first (bottom) triangle.
- The second 3 elements are the coordinate indices of the second (top) triangle.
Triangle Indices#
Each vertex of a mesh surface also has a triangle index - a number of the corresponding element of the triangle buffer, where the data is stored. For the given surface on the left the array of the triangle indices is as follows:
Output
Here:
TIndices = [Ti0,Ti1,Ti5,Ti2,Ti3,Ti4]- The first 3 elements are the triangle indices of the first (bottom) triangle.
- The second 3 elements are the triangle indices of the second (top) triangle.
For the surface on the right the array of the triangle indices is a bit different (both triangles share data for vertices C1 and C3):
Output
TIndices = [Ti0,Ti1,Ti3,Ti1,Ti2,Ti3]
Notice
The number of the coordinate and triangle indices is the same.
Serialization#
You can save your created mesh to a file to be used later via the save() method. Later on, you can create a new mesh from this file using the constructor, or load a mesh via the load() method.
Notice
Normals of mesh are not serializable. The whole tangent basis is serialized instead.
So, to get your normals from a saved mesh you should do the following:
Source code (UnigineScript)
// adding a surface and vertices to the mesh
Mesh mesh = new Mesh();
// adding a surface and vertices to the mesh
mesh.addSurface("0");
mesh.addVertex(vec3(1.f, 1.f, 0.f), 0);
mesh.addVertex(vec3(1.f, 0.f, 1.f), 0);
mesh.addVertex(vec3(0.f, 1.f, 1.f), 0);
// create normals
mesh.addNormal(vec3(0.f, 0.f, 1.f), 0);
mesh.addNormal(vec3(0.f, 0.f, 1.f), 0);
mesh.addNormal(vec3(0.f, 0.f, 1.f), 0);
// adding vertex indices
mesh.addIndex(0, 0);
mesh.addIndex(1, 0);
mesh.addIndex(2, 0);
// creating serializable tangent basis
mesh.createTangents();
// saving a mesh to a file
mesh.save("hello.mesh");
// ...Now to get your normals after creating a mesh from a file:
Source code (UnigineScript)
// creating a mesh from a previously saved file
Mesh mesh = new Mesh("hello.mesh");
// getting the total number of vertex tangent entries for the first surface of the mesh
int numTangents = mesh.getNumTangents(0);
// retrieving normals from the tangent basis for the first point of the first surface of the mesh
vec3 normal = mesh.getTangent(0, 0).getNormal();
// ...See Also#
- Article on Mesh File Formats
- Mesh Class Usage Example
Mesh Class
Members
static Mesh ( ) #
Constructor. Creates an empty mesh.static Mesh ( string name ) #
Constructor. Creates a mesh using the specified file.Arguments
- string name - Path to the mesh file.
void assignFrom ( Mesh mesh ) #
Copies the data including bones, surfaces, and animations from the specified source mesh.Arguments
- Mesh mesh - Source mesh instance.
void setAnimationBones ( int animation ) #
Copies bones from the given array to the current array of animation bones.Arguments
- int animation - Animation number.
void getAnimationBones ( int animation ) #
Adds all bones of the given animation to the given array of bones.Arguments
- int animation - Animation number.
void setAnimationFrame ( int animation, int num, int xyz_id, int rot_id, int scale_id ) #
Updates the animation frame coordinates, rotation quaternions and scaling vectors.Arguments
- int animation - Animation number.
- int num - Frame number in the array of the animation frames.
- int xyz_id - Array with coordinates of the animation frame.
- int rot_id - Array with rotation quaternions of the animation frame.
- int scale_id - Array with scaling vectors of the animation frame.
void setAnimationFrame ( int animation, int num, int id ) #
Updates the animation frame coordinates, rotation quaternions and scaling vectors.Arguments
- int animation - Animation number.
- int num - Frame number in the array of the animation frames.
- int id - Matrix that includes coordinates, rotation quaternions and scaling vectors of the animation frame.
void getAnimationFrame ( int animation, int num, int id ) #
Adds the animation frame coordinates, rotation quaternions and scaling vectors to the corresponding arrays passed to the function as arguments.Notice
The arrays can be set by using the setAnimationFrame() method.
Arguments
- int animation - Animation number.
- int num - Frame number in the array of the animation frames.
- int id - Matrix that includes coordinates, rotation quaternions and scaling vectors of the animation frame.
void setAnimationName ( int animation, string name ) #
Sets a name for the given animation.Arguments
- int animation - Animation number.
- string name - Animation name to be set.
string getAnimationName ( int animation ) #
Returns the name of the given animation.Arguments
- int animation - Animation number.
Return value
Animation name.void setBoneName ( int bone, string name ) #
Sets a name for the given bone.Arguments
- int bone - Bone number.
- string name - Bone name to be set.
string getBoneName ( int bone ) #
Returns the name of the given bone.Arguments
- int bone - Bone number.
Return value
Bone name.void setBoneParent ( int bone, int parent ) #
Sets the parent bone for the given one.Arguments
- int bone - Bone number, for which the parent bone should be set.
- int parent - Bone to be set as a parent.
int getBoneParent ( int bone ) #
Returns the number of the parent bone of the given one.Arguments
- int bone - Bone number, for which the parent bone will be returned.
Return value
Parent bone number.void setBoneTransform ( int bone, mat4 transform ) #
Sets the transformation matrix for the given bone.Arguments
- int bone - Bone number.
- mat4 transform - Transformation matrix to be set.
mat4 getBoneTransform ( int bone ) #
Returns the transformation matrix for the given bone.Arguments
- int bone - Bone number.
Return value
Transformation matrix.int setBoneTransforms ( int animation = -1, int frame = 0 ) #
Updates the array of the world-space transformation matrices for bones of the given animation frame.Notice
If the passed animation number is -1, the bind pose will be updated to the given array.
Arguments
- int animation - Animation number. The default value is -1.
- int frame - Animation frame number. The default value is 0.
Return value
Returns 1 if the array of bones' transformations is updated successfully; otherwise, 0.int getBoneTransforms ( int animation = -1, int frame = 0 ) #
Appends the world-space transformation matrices for bones of the given animation frame to the given array.Notice
The number of array elements must be equal to the number of animation bones.
If the passed animation number is -1, the bind pose will be added to the given array.
Arguments
- int animation - Animation number. The default value is -1.
- int frame - Animation frame number. The default value is 0.
Return value
Returns 1 if the array of bones' transformations is filled successfully; otherwise, 0.void setBoundBox ( BoundBox bb, int surface ) #
Sets the bounding box for the given mesh surface.Arguments
- BoundBox bb - Bounding box to be set.
- int surface - Mesh surface number.
void setBoundBox ( BoundBox bb ) #
Sets the bounding box for the given mesh surface.Arguments
- BoundBox bb - Bounding box to be set.
BoundBox getBoundBox ( int surface ) #
Returns the bounding box of the given mesh surface.Arguments
- int surface - Mesh surface number.
Return value
Bounding box.BoundBox getBoundBox ( ) #
Returns the bounding box of the given mesh surface.Return value
Bounding box.void setBoundSphere ( BoundSphere bs ) #
Sets the bounding sphere for the given mesh surface.Arguments
- BoundSphere bs - Bounding sphere to be set.
void setBoundSphere ( BoundSphere bs, int surface ) #
Sets the bounding sphere for the given mesh surface.Arguments
- BoundSphere bs - Bounding sphere to be set.
- int surface - Mesh surface number.
BoundSphere getBoundSphere ( ) #
Returns the bounding sphere of the given surface.Return value
Bounding sphere.BoundSphere getBoundSphere ( int surface ) #
Returns the bounding sphere of the given mesh surface.Arguments
- int surface - Mesh surface number.
Return value
Bounding sphere.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 setIndex ( int num, int index, int surface ) #
Sets both coordinate and triangle indices for the given vertex of the given surface equal to the specified index.Arguments
- int num - Vertex number in the range from 0 to the total number of coordinate indices of the given surface.
NoticeTo get the total number of coordinate indices for the surface, use the getNumCIndices() method.
- int index - Index to be set in the range from 0 to the total number of coordinate vertices.
NoticeTo get the total number of coordinate vertices, use the getNumVertex() method.
- int surface - Mesh surface number.
int getIndex ( int num, int surface ) #
Returns the coordinate index of the given vertex of the given surface if the coordinate index is equal to the triangle index.Arguments
- int num - Vertex number in the range from 0 to the total number of coordinate indices of the given surface.
NoticeTo get the total number of coordinate indices for the surface, use the getNumCIndices() method.
- int surface - Mesh surface number.
Return value
Coordinate index.int getIntersection ( vec3 p0, vec3 p1, vec3 * ret_point, vec3 * ret_normal, int * ret_index, int surface, int target = 0 ) #
Performs the search for the intersection of the given surface target with the given traced line.Notice
Mesh local space coordinates are used for this method.
Arguments
- vec3 p0 - Start point coordinates.
- vec3 p1 - End point coordinates.
- vec3 * ret_point - Return array to write the intersection point coordinates into.
- vec3 * ret_normal - Return array to write the intersection point normal into.
- int * ret_index - Return array to write the intersection point indices into.
- int surface - Mesh surface number.
- int target - Surface target number. The default value is 0.
Return value
1 if the intersection is found; otherwise, 0.void setNormal ( int num, vec3 normal, int surface, int target = 0 ) #
Sets the normal for the given triangle vertex of the given surface target.Notice
The normal of the vertex won't be written to the *.mesh file. It will be stored only in memory.
Arguments
- int num - Triangle vertex number in the range from 0 to the total number of vertex normal entries of the given surface target.
NoticeTo get the total number of vertex normal entries for the surface target, call the getNumNormals() method.
- vec3 normal - Normal to be set.
- int surface - Mesh surface number.
- int target - Surface target number. The default value is 0.
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 normal entries of the given surface target.
NoticeTo get the total number of vertex normal entries for the surface target, call the getNumNormals() method.
- int surface - Mesh surface number.
- int target - Surface target number. The default value is 0.
Return value
Vertex normal.void setNumAnimationFrames ( int animation, int num ) #
Sets the number of animation frames for the given animation.Arguments
- int animation - Animation number in the range from 0 to the total number of mesh animations.
NoticeTo get the total number of mesh animations, call the getNumAnimations() method.
- int num - Number of the animation frames to be set.
int getNumAnimationFrames ( int animation ) #
Returns the number of animation frames for the given animation.Arguments
- int animation - Animation number in the range from 0 to the total number of mesh animations.
NoticeTo get the total number of mesh animations, call the getNumAnimations() method.
Return value
Number of the animation frames.int getNumAnimations ( ) #
Returns the total number of mesh animations.Return value
Number of the mesh animations.int getNumBones ( ) #
Returns the total number of mesh bones.Return value
Number of the mesh bones.void setNumCIndices ( int size, int surface ) #
Sets the total number of coordinate indices for the given surface.Arguments
- int size - Number of the coordinate indices to be set.
- int surface - Mesh surface number.
int getNumCIndices ( int surface ) #
Returns the total number of coordinate indices for the given surface.Arguments
- int surface - Mesh surface number.
Return value
Number of coordinate indices.void setNumColors ( int size, int surface ) #
Sets the total number of vertex color entries for the given surface.Notice
Colors are specified for triangle vertices.
Arguments
- int size - Number of vertex color entries to be set.
- int surface - Mesh surface number.
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 - Mesh surface number.
Return value
Number of vertex color entries.int getNumCVertex ( int surface ) #
Returns the number of coordinate vertices of the given surface.Arguments
- int surface - Mesh surface number.
Return value
Number of coordinate vertices.void setNumIndices ( int size, int surface ) #
Sets the number of indices for the given surface: updates the number of coordinate and triangle indices. For example, if you pass 5 as the first argument, the number of the coordinate indices and the number of triangle indices will be set to 5.Arguments
- int size - Number of indices to be set.
- int surface - Mesh surface number.
int getNumIndices ( int surface ) #
Returns the number of coordinate indices of the given surface if the number of the coordinate indices is equal to the number of triangle indices.Arguments
- int surface - Mesh surface number.
Return value
Number of coordinate indices.void setNumNormals ( int size, int surface, int target = 0 ) #
Sets the total number of vertex normal entries for the given surface target.Notice
Normals are specified for triangle vertices.
Arguments
- int size - Number of vertex normal entries to be set.
- int surface - Mesh surface number.
- int target - Surface target number. The default value is 0.
int getNumNormals ( int surface, int target = 0 ) #
Returns the total number of vertex normal entries for the given surface target.Notice
Normals are specified for triangle vertices.
Arguments
- int surface - Mesh surface number.
- int target - Surface target number. The default value is 0.
Return value
Number of vertex normal entries.int getNumSurfaces ( ) #
Returns the total number of mesh surfaces.Return value
Number of mesh surfaces.void setNumSurfaceTargets ( int surface, int num ) #
Sets the number of targets for the given mesh surface.Arguments
- int surface - Mesh surface number.
- int num - Number of surface targets to be set.
int getNumSurfaceTargets ( int surface ) #
Returns the number of surface targets for the given surface.Arguments
- int surface - Mesh surface number.
Return value
Number of surface targets.void setNumTangents ( int size, int surface, int target = 0 ) #
Sets the total number of vertex tangent entries for the given surface target.Notice
Tangents are specified for triangle vertices.
Arguments
- int size - Number of vertex tangent entries to be set.
- int surface - Mesh surface number.
- int target - Surface target number. The default value is 0.
int getNumTangents ( int surface, int tangent = 0 ) #
Returns the total number of vertex tangent entries for the given surface target.Notice
Tangents are specified for triangle vertices.
Arguments
- int surface - Mesh surface number.
- int tangent - Surface target number. The default value is 0.
Return value
Number of vertex tangent entries.void setNumTexCoords0 ( int size, int surface ) #
Sets the total number of the first UV map texture coordinate entries for the given mesh surface.Notice
First UV map texture coordinates are specified for triangle vertices.
Arguments
- int size - Number of the first UV map texture coordinate entries to be set.
- int surface - Mesh surface number.
int getNumTexCoords0 ( int surface ) #
Returns the total number of the first UV map texture coordinate entries for the given mesh surface.Notice
First UV map texture coordinates are specified for triangle vertices.
Arguments
- int surface - Mesh surface number.
Return value
Total number of the first UV map texture coordinate entries.void setNumTexCoords1 ( int size, int surface ) #
Sets the total number of the second UV map texture coordinate entries for the given mesh surface.Notice
Second UV map texture coordinates are specified for triangle vertices.
Arguments
- int size - Number of the second UV map texture coordinates to be set.
- int surface - Mesh surface number.
int getNumTexCoords1 ( int surface ) #
Returns the total number of the second UV map texture coordinate entries for the given mesh surface.Notice
Second UV map texture coordinates are specified for triangle vertices.
Arguments
- int surface - Mesh surface number.
Return value
Total number of the second UV map texture coordinate entries.void setNumTIndices ( int size, int surface ) #
Sets the total number of triangle indices for the given surface.Arguments
- int size - Number of triangle indices to be set.
- int surface - Mesh surface number.
int getNumTIndices ( int surface ) #
Returns the total number of triangle indices for the given surface.Arguments
- int surface - Mesh surface number.
Return value
Number of triangle indices.int getNumTVertex ( int surface ) #
Returns the number of triangle vertices for the given mesh surface.Arguments
- int surface - Mesh surface number.
Return value
Number of the triangle vertices.void setNumVertex ( int size, int surface, int target = 0 ) #
Sets the total number of vertices for the given surface target.Notice
The numbers of vertices and coordinate vertices are equal.
Arguments
- int size - Number of the vertices to be set.
- int surface - Mesh surface number.
- int target - Surface target number. The default value is 0.
int getNumVertex ( int surface, int target = 0 ) #
Returns the total number of vertices for the given surface target.Notice
The numbers of vertices and coordinate vertices are equal.
Arguments
- int surface - Mesh surface number.
- int target - Surface target number. The default value is 0.
Return value
Number of the vertices.void setNumWeights ( int size, int surface ) #
Sets the number of weights set for vertices of the given surface.Notice
Weights are specified for coordinate vertices.
Arguments
- int size - Number of weights to be set.
- int surface - Mesh surface number.
int getNumWeights ( int surface ) #
Returns the number of weights set for vertices of the given surface.Notice
Weights are specified for coordinate vertices.
Arguments
- int surface - Mesh surface number.
Return value
Number of the weights.void setSurfaceName ( int surface, string name ) #
Sets the name for the given mesh surface.Arguments
- int surface - Mesh surface number.
- string name - Surface name to be set.
string getSurfaceName ( int surface ) #
Returns the name of the given surface.Arguments
- int surface - Mesh surface number.
Return value
Surface name.void setSurfaceTargetName ( int surface, int target, string name ) #
Sets the name for the given surface target.Arguments
- int surface - Mesh surface number.
- int target - Surface target number.
- string name - Surface target name to be set.
string getSurfaceTargetName ( int surface, int target ) #
Returns the name of the given surface target.Arguments
- int surface - Mesh surface number.
- int target - Surface target number.
Return value
Surface target name.int setSurfaceTransform ( mat4 transform, int surface = -1, int target = -1 ) #
Sets the transformation matrix for the given surface target.Arguments
- mat4 transform - Transformation matrix to be set.
- int surface - Mesh surface number. The default value is -1 (apply to all of the mesh surfaces).
NoticeIf all surfaces are chosen, the transformations of bones and animations will also be recalculated.
- int target - Surface target number. The default value is -1 (apply to all of the surface targets).
Return value
1 if the transformation matrix is set successfully; otherwise, 0.void setSurfaceLightmapUVChannel ( int surface, char uv_channel ) #
Sets a new UV channel to be used for lightmaps of the surface with the specified number.Arguments
- int surface - Mesh surface number.
- char uv_channel - UV channel to be used for lightmaps of the surface with the specified number.
char getSurfaceLightmapUVChannel ( int surface ) #
Returns the current UV channel used for lightmaps of the surface with the specified number.Arguments
- int surface - Mesh surface number.
Return value
UV channel currently used for lightmaps of the surface with the specified number.void setSurfaceLightmapResolution ( int surface, int resolution ) #
Sets a new lightmap resolution for the surface with the specified number.Arguments
- int surface - Mesh surface number.
- int resolution - Lightmap resolution to be used for the surface with the specified number.
int getSurfaceLightmapResolution ( int surface ) #
Returns the current lightmap resolution for the surface with the specified number.Arguments
- int surface - Mesh surface number.
Return value
Current lightmap resolution for the surface with the specified number.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 target.
NoticeTo get the total number of vertex tangent entries for the surface target, 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 target.
NoticeTo 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 tangent.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 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.
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 setWeightBones ( int num, ivec4 bones, int surface ) #
Sets the vector of bone indices that affect the vertex with the given weight.Notice
Vertex weight is characterized by the following values:
- The 4 bone indices (see setWeightBones() / getWeightBones() methods);
- The 4 bone weights (see setWeightWeights() / getWeightWeights() methods);
- Number of weights (see setWeightCount() / getWeightCount() methods).
Arguments
- int num - Coordinate vertex number in the range from 0 to the total number of vertex weight entries for the given surface.
NoticeTo get the total number of of vertex weight entries for the given surface, use the getNumWeights() method.
- ivec4 bones - Vector of the bone indices to be set.
- int surface - Mesh surface number.
ivec4 getWeightBones ( int num, int surface ) #
Returns a vector of bone indices that affect the vertex with the given weight.Notice
Vertex weight is characterized by the following values:
- The 4 bone indices (see setWeightBones() / getWeightBones() methods);
- The 4 bone weights (see setWeightWeights() / getWeightWeights() methods);
- Number of weights (see setWeightCount() / getWeightCount() methods).
Arguments
- int num - Coordinate vertex number in the range from 0 to the total number of vertex weight entries for the given surface.
NoticeTo get the total number of of vertex weight entries for the given surface, use the getNumWeights() method.
- int surface - Mesh surface number.
Return value
Vector of the bone indices associated with the given weight.void setWeightCount ( int num, int count, int surface ) #
Sets the number of weights that affect the vertex with the given weight.Notice
Vertex weight is characterized by the following values:
- The 4 bone indices (see setWeightBones() / getWeightBones() methods);
- The 4 bone weights (see setWeightWeights() / getWeightWeights() methods);
- Number of weights (see setWeightCount() / getWeightCount() methods).
Arguments
- int num - Coordinate vertex number in the range from 0 to the total number of vertex weight entries for the given surface.
NoticeTo get the total number of of vertex weight entries for the given surface, use the getNumWeights() method.
- int count - Number of weights to be set.
- int surface - Mesh surface number.
int getWeightCount ( int num, int surface ) #
Returns the number of weights that affect the vertex with the given weight.Notice
Vertex weight is characterized by the following values:
- The 4 bone indices (see setWeightBones() / getWeightBones() methods);
- The 4 bone weights (see setWeightWeights() / getWeightWeights() methods);
- Number of weights (see setWeightCount() / getWeightCount() methods).
Arguments
- int num - Coordinate vertex number in the range from 0 to the total number of vertex weight entries for the given surface.
NoticeTo get the total number of of vertex weight entries for the given surface, use the getNumWeights() method.
- int surface - Mesh surface number.
Return value
Number of weights.void setWeightWeights ( int num, vec4 weights, int surface ) #
Sets the vector of bone weights that affect the vertex with the given weight.Notice
Vertex weight is characterized by the following values:
- The 4 bone indices (see setWeightBones() / getWeightBones() methods);
- The 4 bone weights (see setWeightWeights() / getWeightWeights() methods);
- Number of weights (see setWeightCount() / getWeightCount() methods).
Arguments
- int num - Coordinate vertex number in the range from 0 to the total number of vertex weight entries for the given surface.
NoticeTo get the total number of of vertex weight entries for the given surface, use the getNumWeights() method.
- vec4 weights - Vector of bone weights to be set.
- int surface - Mesh surface number.
vec4 getWeightWeights ( int num, int surface ) #
Returns a vector of bone weights that affect the vertex with the given weight.Notice
Vertex weight is characterized by the following values:
- The 4 bone indices (see setWeightBones() / getWeightBones() methods);
- The 4 bone weights (see setWeightWeights() / getWeightWeights() methods);
- Number of weights (see setWeightCount() / getWeightCount() methods).
Arguments
- int num - Coordinate vertex number in the range from 0 to the total number of vertex weight entries for the given surface.
NoticeTo get the total number of of vertex weight entries for the given surface, use the getNumWeights() method.
- int surface - Mesh surface number.
Return value
Bone weights associated with the given weight.int addAnimation ( string name = 0 ) #
Appends an animation with a given name to the current mesh.Arguments
- string name - Name of the animation. This argument is empty by default.
Return value
Number of mesh animations.int addBone ( string name = 0, int parent = -1 ) #
Appends a new mesh bone.Arguments
- string name - Bone name. This argument is empty by default.
- int parent - Parent bone number. The default value is -1 (the new bone has no parent bone).
Return value
Number of mesh bones.int addBoxSurface ( string name, vec3 size ) #
Appends a box surface to the current mesh.Source code (UnigineScript)
// create a mesh instance
Mesh mesh = new Mesh();
// add box surface with the name "box_surface" and the size of the surface is Vec3(1.0, 1.0, 1.0)
mesh.addBoxSurface("box_surface", Vec3(1.0f));
// create the ObjectMeshDynamic from the Mesh object
ObjectMeshDynamic dynamicMesh = new ObjectMeshDynamic(mesh);
// set the position of the mesh
dynamicMesh.setWorldTransform(translate(Vec3(10.0f,10.0f,10.0f)));
// set the name of the mesh
dynamicMesh.Name = "Dynamic Mesh";The mesh will appear.
Arguments
- string name - Surface name.
- vec3 size - Box size along the X, Y and Z axes.
Return value
Added surface number.int addCapsuleSurface ( string name, float radius, float height, int stacks, int slices ) #
Appends a capsule surface to the current mesh. The stacks and slices specify the surface's subdivision.Source code (UnigineScript)
// create a mesh instance
Mesh mesh = new Mesh();
// add capsule surface with the name "capsule_surface".
// the radius of the capsule is 1.0, the height is 2.0,
// stacks and slices are equals to 200 and 100, respectively
mesh.addCapsuleSurface("box_surface", 1.0f, 2.0f, 200, 100);
// create the ObjectMeshDynamic from the Mesh object
ObjectMeshDynamic dynamicMesh = new ObjectMeshDynamic(mesh);
// set the position of the mesh
dynamicMesh.setWorldTransform(translate(Vec3(10.0f,10.0f,10.0f)));
// set the name of the mesh
dynamicMesh.Name = "Dynamic Mesh";The mesh will appear.
Arguments
- string name - Surface name.
- float radius - Capsule radius.
- float height - Capsule height.
- int stacks - Number of stacks that divide the capsule radially.
- int slices - Number of slices that divide the capsule horizontally.
Return value
The added surface number.void addCIndex ( int index, int surface ) #
Appends a new Coordinate index the array of coordinate indices for the given surface.Arguments
- int index - Coordinate index to be added in the range from 0 to the total number of coordinate vertices.
NoticeTo get the total number of coordinate vertices for the given surface, use the getNumCVertex() method.
- int surface - Mesh surface number.
void addColor ( vec4 color, int surface ) #
Appends the given color to the vertex color array of the given surface.Arguments
- vec4 color - Color to be added.
- int surface - Mesh surface number.
int addCylinderSurface ( string name, float radius, float height, int stacks, int slices ) #
Appends a cylinder surface to the current mesh. The stacks and slices specify the surface's subdivision.Source code (UnigineScript)
// create a mesh instance
Mesh mesh = new Mesh();
// add cylinder surface with the name "cylinder_surface".
// the radius of the cylinder is 1.0, the height is 2.0,
// stacks and slices are equals to 200 and 100, respectively
mesh.addCylinderSurface("cylinder_surface", 1.0f, 2.0f, 200, 100);
// create the ObjectMeshDynamic from the Mesh object
ObjectMeshDynamic dynamicMesh = new ObjectMeshDynamic(mesh);
// set the position of the mesh
dynamicMesh.setWorldTransform(translate(Vec3(10.0f,10.0f,10.0f)));
// set the name of the mesh
dynamicMesh.Name = "Dynamic Mesh";The mesh will appear.
Arguments
- string name - Surface name.
- float radius - Cylinder radius.
- float height - Cylinder height.
- int stacks - Number of stacks that divide the cylinder radially.
- int slices - Number of slices that divide the cylinder horizontally.
Return value
The added surface number.int addDodecahedronSurface ( string name, float radius ) #
Appends a dodecahedron surface to the current mesh.Source code (UnigineScript)
// create a mesh instance
Mesh mesh = new Mesh();
// add dodecahedron surface with the name "dodecahedron_surface".
// the radius of the dodecahedron is 1.0
mesh.addDodecahedronSurface("dodecahedron_surface", 1.0f);
// create the ObjectMeshDynamic from the Mesh object
ObjectMeshDynamic dynamicMesh = new ObjectMeshDynamic(mesh);
// set the position of the mesh
dynamicMesh.setWorldTransform(translate(Vec3(10.0f,10.0f,10.0f)));
// set the name of the mesh
dynamicMesh.Name = "Dynamic Mesh";After adding to the editor, the mesh will appear.
Arguments
- string name - Surface name.
- float radius - Dodecahedron radius.
Return value
The added surface number.int addEmptySurface ( string name, int num_vertex, int num_indices ) #
Appends a new empty surface to the current mesh.Notice
This function allocates only vertex and index arrays. Texture coordinates, tangent basis, weights and color arrays must be allocated manually.
Arguments
- string name - Surface name.
- int num_vertex - Number of surface vertices.
- int num_indices - Number of surface indices.
Return value
Number of the mesh surfaces.int addIcosahedronSurface ( string name, float radius ) #
Appends an icosahedron surface to the current mesh.Source code (UnigineScript)
// create a mesh instance
Mesh mesh = new Mesh();
// add icosahedron surface with the name "icosahedron_surface".
// the radius of the icosahedron is 1.0
mesh.addIcosahedronSurface("icosahedron_surface", 1.0f);
// create the ObjectMeshDynamic from the Mesh object
ObjectMeshDynamic dynamicMesh = new ObjectMeshDynamic(mesh);
// set the position of the mesh
dynamicMesh.setWorldTransform(translate(Vec3(10.0f,10.0f,10.0f)));
// set the name of the mesh
dynamicMesh.Name = "Dynamic Mesh";The mesh will appear.
Arguments
- string name - Surface name.
- float radius - Icosahedron radius.
Return value
Added surface number.void addIndex ( int index, int surface ) #
Appends a given index to the arrays of coordinate and triangle indices for the given surface.Arguments
- int index - Index to be added in the range from 0 to the total number of coordinate vertices for the surface.
NoticeTo get the total number of coordinate vertices for the surface, use the getNumCVertex() method.
- int surface - Mesh surface number.
int addMeshSurface ( int surface, int target = -1 ) #
Depending on the first variable passed as an argument, the function appends the source mesh surface to the existing or the new surface of the current mesh, namely, the specified morph targets, all surface weights, bones, texture coordinates and colors.The following example shows how to add a surface from the one mesh to another.
Source code (UnigineScript)
// create mesh instances
Mesh mesh_1 = new Mesh();
Mesh mesh_2 = new Mesh();
// add Surfaces for the added meshes
mesh_1.addCapsuleSurface("capsule_surface", 1.0f, 2.0f, 200, 100);
mesh_2.addBoxSurface("box_surface", vec3(2.2));
// add the surface from the mesh_2 to the mesh_1 as a new surface
// with the name "new_box_surface"
mesh_1.addMeshSurface("new_box_surface", mesh_2, 0);
// create the ObjectMeshDynamic from the mesh_1 object
ObjectMeshDynamic dynamicMesh = new ObjectMeshDynamic(mesh_1);
// set the position of the mesh
dynamicMesh.setWorldTransform(translate(Vec3(10.0f,10.0f,10.0f)));
// set the name of the mesh
dynamicMesh.Name = "Dynamic Mesh";The mesh will appear.
|
|
Arguments
- int surface - Number of the source mesh surface to copy.
- int target - Number of the target of the source mesh surface. The default value is -1 (all of the surface targets).
Return value
Depending on the first variable passed as an argument, the function returns the following:- int - the number of the surface to which the geometry has been added.
- string - the number of the mesh surfaces.
If the geometry (or the surface) is not added, the function will return -1.
void addNormal ( vec3 normal, int surface, int target = 0 ) #
Appends a given normal to the array of normals of the given surface target.Arguments
- vec3 normal - Normal to be added.
- int surface - Mesh surface number.
- int target - Surface target number. The default value is 0.
int addPlaneSurface ( string name, float width, float height, float step ) #
Appends a plane surface to the current mesh. The plane is divided into equal squares whose size is defined by the given step.Source code (UnigineScript)
// create a mesh instance
Mesh mesh = new Mesh();
// add the plane surface with the name "plane_surface".
// the width is 2 and the height is 3
mesh.addPlaneSurface("plane_surface", 2.0f, 3.0f, 1.0f);
// create the ObjectMeshDynamic from the Mesh object
ObjectMeshDynamic dynamicMesh = new ObjectMeshDynamic(mesh);
// set the position of the mesh
dynamicMesh.setWorldTransform(translate(Vec3(10.0f,10.0f,10.0f)));
// set the name of the mesh
dynamicMesh.Name = "Dynamic Mesh";The mesh will appear. You could see that the plane divided each 1 unit to equal squares.
Arguments
- string name - Surface name.
- float width - Plane width.
- float height - Plane height.
- float step - Step of surface subdivision (vertical and horizontal).
Return value
Added surface number.int addPrismSurface ( string name, float size_0, float size_1, float height, int sides ) #
Appends a prism surface to the current mesh.Source code (UnigineScript)
// create a mesh instance
Mesh mesh = new Mesh();
// add the prism surface with the name "prism_surface".
// the radius of the top is 1.0f, of the bottom is 2.0f
// the height of the prism is 3.0f, and it has 4 sides
mesh.addPrismSurface("prism_surface", 1.0f, 2.0f, 3.0f, 4);
// create the ObjectMeshDynamic from the Mesh object
ObjectMeshDynamic dynamicMesh = new ObjectMeshDynamic(mesh);
// set the position of the mesh
dynamicMesh.setWorldTransform(translate(Vec3(10.0f,10.0f,10.0f)));
// set the name of the mesh
dynamicMesh.Name = "Dynamic Mesh";The mesh will appear.
Arguments
- string name - Surface name.
- float size_0 - Radius of the circle circumscribed about the top prism base.
- float size_1 - Radius of the circle circumscribed about the bottom prism base.
- float height - Height of the prism.
- int sides - Number of the prism faces.
Return value
The added surface number.int addSphereSurface ( string name, float radius, int stacks, int slices ) #
Appends a sphere surface to the current mesh. The stacks and slices specify the surface's subdivision.Source code (UnigineScript)
// create a mesh instance
Mesh mesh = new Mesh();
// add the sphere surface with the name "sphere_surface".
// the radius of the sphere is 1.0f
// and it has 200 stacks and 100 slices
mesh.addSphereSurface("sphere_surface", 1.0f, 200, 100);
// create the ObjectMeshDynamic from the Mesh object
ObjectMeshDynamic dynamicMesh = new ObjectMeshDynamic(mesh);
// set the position of the mesh
dynamicMesh.setWorldTransform(translate(Vec3(10.0f,10.0f,10.0f)));
// set the name of the mesh
dynamicMesh.Name = "Dynamic Mesh";The mesh will appear.
Arguments
- string name - Surface name.
- float radius - Sphere radius.
- int stacks - Number of stacks that divide the sphere radially.
- int slices - Number of slices that divide the sphere horizontally.
Return value
Added surface number.int addSurface ( string name = 0 ) #
Appends a new surface with the given name to the current mesh.In the following example, we create a new surface and add vertices and indices to create a plane.
Source code (UnigineScript)
// create a mesh instance
Mesh mesh = new Mesh();
// add a new surface
mesh.addSurface("surface_0");
// add vertices of the plane
mesh.addVertex(vec3(0.0f,0.0f,0.0f),0);
mesh.addVertex(vec3(0.0f,0.0f,1.0f),0);
mesh.addVertex(vec3(0.0f,1.0f,0.0f),0);
mesh.addVertex(vec3(0.0f,1.0f,1.0f),0);
// add indices
mesh.addIndex(0,0);
mesh.addIndex(1,0);
mesh.addIndex(2,0);
mesh.addIndex(3,0);
mesh.addIndex(2,0);
mesh.addIndex(1,0);
// create tangents
mesh.createTangents();
// create mesh bounds
mesh.createBounds(0);
// create the ObjectMeshDynamic from the Mesh object
ObjectMeshDynamic dynamicMesh = new ObjectMeshDynamic(mesh);
// set the position of the mesh
dynamicMesh.setWorldTransform(translate(Vec3(10.0f,10.0f,10.0f)));
// set the name of the mesh
dynamicMesh.setName("new_mesh");Arguments
- string name - Surface name. This argument is empty by default.
Return value
Number of mesh surfaces.int addSurfaceTarget ( int surface, string name = 0 ) #
Appends a target with the given name to the given surface.Arguments
- int surface - Mesh surface number.
- string name - Name of the surface target. This argument is empty by default.
Return value
Number of surface targets.void addTangent ( quat tangent, int surface, int target = 0 ) #
Appends the given tangent to the array of tangents of the specified surface target.Arguments
- quat tangent - Tangent to be added.
- int surface - Surface number.
- int target - Surface target number. The default value is 0.
void addTexCoord0 ( vec2 texcoord, int surface ) #
Appends texture coordinates to the array of the first UV map coordinates of the given mesh surface.Arguments
- vec2 texcoord - Coordinates of the first UV map to be added.
- int surface - Mesh surface number.
void addTexCoord1 ( vec2 texcoord, int surface ) #
Appends texture coordinates to the array of the second UV map coordinates of the given mesh surface.Arguments
- vec2 texcoord - Coordinates of the second UV map to be added.
- int surface - Mesh surface number.
void addTIndex ( int index, int surface ) #
Appends an index of a triangle vertex to the array of triangle indices for the given surface.Arguments
- int index - Index number of the vertex in the triangle buffer in the range from 0 to the total number of triangle vertices.
NoticeTo get the total number of triangle vertices for the given surface, use the getNumTVertex() method.
- int surface - Number of the surface to which the triangle index is added.
void addVertex ( vec3 vertex, int surface, int target = 0 ) #
Appends a new coordinate vertex with the given coordinates to the morph target of the mesh surface.In the following example, we create a new surface and add 4 vertices to it. We use local coordinates to define a vertex and specify the surface. After that we specify 6 indices to create a plane by using defined vertices.
Source code (UnigineScript)
// create a mesh instance
Mesh mesh = new Mesh();
// add a new surface
mesh.addSurface("surface_0");
// add vertices of the plane
mesh.addVertex(vec3(0.0f,0.0f,0.0f),0);
mesh.addVertex(vec3(0.0f,0.0f,1.0f),0);
mesh.addVertex(vec3(0.0f,1.0f,0.0f),0);
mesh.addVertex(vec3(0.0f,1.0f,1.0f),0);
// add indices
mesh.addIndex(0,0);
mesh.addIndex(1,0);
mesh.addIndex(2,0);
mesh.addIndex(3,0);
mesh.addIndex(2,0);
mesh.addIndex(1,0);
// create tangents
mesh.createTangents();
// create mesh bounds
mesh.createBounds(0);
// create the ObjectMeshDynamic from the Mesh object
ObjectMeshDynamic dynamicMesh = new ObjectMeshDynamic(mesh);
// set the position of the mesh
dynamicMesh.setWorldTransform(translate(Vec3(10.0f,10.0f,10.0f)));
// set the name of the mesh
dynamicMesh.setName("new_mesh");Arguments
- vec3 vertex - Coordinates of the vertex to be added.
- int surface - Mesh surface number.
- int target - Surface target number. The default value is 0.
void clear ( ) #
Clears the mesh (including its bones, animation, surfaces and bounds).int createBounds ( int surface = -1 ) #
Creates bounds (a bounding box and a bounding sphere) for the given surface. If the default value is used as an argument, the bounds will be created for all of the mesh surfaces.Arguments
- int surface - Mesh surface number. The default value is -1 (all of the mesh surfaces).
Return value
1 if bounds are created successfully; otherwise, 0.int createIndices ( int surface = -1 ) #
Creates indices for the given surface. If the default value is used as an argument, the indices will be created for all of the mesh surfaces.Arguments
- int surface - Mesh surface number. The default value is -1 (all of the mesh surfaces).
Return value
1 if indices are created successfully; otherwise, 0.int createIntersection ( int surface = -1 ) #
Calculates a potentially visible set for the given surface. This function prepares the mesh for working with getIntersection() method.Arguments
- int surface - Mesh surface number. The default value is -1 (all of the mesh surfaces).
Return value
1 if the potentially visible set is calculated successfully; otherwise, 0.int createTangents ( int surface = -1, int target = -1 ) #
Creates tangents for the given surface target.Arguments
- int surface - Mesh surface number. -1 means all of the mesh surfaces.
- int target - Surface target number. -1 means all of the surface targets.
Return value
1 if the tangents are created successfully; otherwise, 0.int findAnimation ( string name ) #
Searches for the animation by the name and returns its number.Arguments
- string name - Name of the animation.
Return value
Animation number, if found; otherwise, -1.int findBone ( string name ) #
Searches for a bone with a given name and returns its number.Arguments
- string name - Name of the bone.
Return value
Bone number.int findSurface ( string name ) #
Searches for the surface number by its name.Arguments
- string name - Mesh surface name.
Return value
Mesh surface number, if it is found; otherwise, -1.int findSurfaceTarget ( int surface, string name ) #
Searches for the surface target number by the morph target name.Arguments
- int surface - Mesh surface number.
- string name - Morph target name.
Return value
Target number, if exists; otherwise, -1.int flipTangent ( int surface = -1 ) #
Flips the sign of the binormal component of the surface tangent space.Arguments
- int surface - Mesh surface number.
Return value
1 if the sign of the binormal component is flipped successfully; otherwise, 0.int flipYZ ( int surface = -1 ) #
Flips the Y and Z axes for the given surface:- Y axis becomes equal to -Z
- Z axis becomes equal to Y
Arguments
- int surface - Mesh surface number.
Return value
1 if the axes are flipped successfully; otherwise, 0.int info ( string name ) #
Returns an information about the given mesh or animation.Arguments
- string name - Mesh or animation name.
Return value
1 if the information returned successfully; otherwise, 0.int load ( string name ) #
Loads the mesh with the given name for the current mesh.Arguments
- string name - Mesh name.
Return value
1 if the mesh is loaded successfully; otherwise, 0.int optimizeIndices ( int flags, int surface = -1 ) #
Optimizes indices of the given mesh surface. As polygons are added to a surface, vertices of the adjacent polygons are duplicated (you can get the number of such the vertices by using the getNumTVertex()), because normals, texture coordinates and tangents of such the vertices differ depending on the polygons, to which this vertices belongs. The optimizeIndices() function serves to decrease the number of such vertices and create indices for them that will be stored in the corresponding normals, tangents and texture coordinates.Arguments
- int flags - One of the flags used for indices' optimization: MESH_BACK_TO_FRONT or MESH_VERTEX_CACHE.
- int surface - Mesh surface number.
Return value
1 if the indices are optimized successfully; otherwise, 0.int remapCVertex ( int surface ) #
Sets the size of the array of coordinate indices to be equal to the size of the array of triangle indices and increases the size of the vertex buffer to the size of the array of triangle vertices by using the coordinate vertex duplicating.Arguments
- int surface - Mesh surface number.
Return value
1 if indices are copied successfully; otherwise, 0.int removeIndices ( int surface = -1 ) #
Clears the coordinate and triangle indices of the given surface.Arguments
- int surface - The mesh surface number. -1 means all of the mesh surfaces.
Return value
1 if the indices were cleared successfully; otherwise, 0.int save ( string name ) #
Saves the given mesh in either MESH or ANIM file format. Creates the given mesh path if it doesn’t exist yet (including subdirectories).Arguments
- string name - Path to the mesh including the file name and extension — *.mesh or *.anim.
Return value
1 if the mesh is saved successfully; otherwise, 0.void sortAnimations ( ) #
Sort all animations by their names.void sortSurfaces ( ) #
Sort all surfaces by their names.Last update:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)