General

modelGetName

Descritption: Get the filename of the model

• None

• string - filename (or empty string)

Notes: If the model does not have a filename this function will return an empty string.

modelSaveAs

Descritption: Save the model as a specified format.

• string format - Format to save as (file extension)

• string - filename

Notes: Existing files will not be over-written. If writing the file in the specified format would cause an over-write, a number is added to the filename and incremented until the filename is unique.

modelGetVertexCount

Descritption: Get the number of vertices in the model.

• None

• int - number of vertices

Notes: None

modelGetFaceCount

Descritption: Get the number of faces (polygons (triangles)) in the model.

• None

• int - number of faces

Notes: None

modelGetGroupCount

Descritption: Get the number of polygon groups in the model.

• None

• int - number of groups

Notes: None

modelGetJointCount

Descritption: Get the number of bone joints in the model.

• None

• int - number of bone joints

Notes: None

modelGetTextureCount

Descritption: Get the number of textures in the model.

• None

• int - number of textures

Notes: None

modelGetGroupByName

Descritption: Get the ID of a group from its name.

• string name - Name of group

• int - Group ID (-1 if not found)

Notes: None

groupGetName

Descritption: Get the name of the specified group.

• int groupID - ID number of group

• string - Name of group

Notes: IDs of any type are integers from zero to count-1 inclusive. Negative numbers are invalid.

modelGetTextureByName

Descritption: Get the ID of a texture from its name.

• string name - Name of texture

• int - Texture ID (-1 if not found)

Notes: In most circumstances the name of the texture is the filename without its full path or extension. The exeption to this is if the model did not have textures explicitly associated with it and the model filter had to guess at texture file names. In this case the texture name will be the texture filename including the extension, but without the full path.

textureGetName

Descritption: Get the name of the specified texture.

• int textureID - ID number of texture

• string - Name of texture

Notes: IDs of any type are integers from zero to count-1 inclusive. Negative numbers are invalid.

textureGetFilename

Descritption: Get the filename of the specified texture.

• int textureID - ID number of texture

• string - Filename of texture (full path)

Notes: IDs of any type are integers from zero to count-1 inclusive. Negative numbers are invalid.

Primitive Creation

modelCreateMeshRectangle

Descritption: Create a rectangular mesh.

• float x1 - X coordinate of vertex 1
• float y1 - Y coordinate of vertex 1
• float z1 - Z coordinate of vertex 1
• float x2 - X coordinate of vertex 2
• float y2 - Y coordinate of vertex 2
• float z2 - Z coordinate of vertex 2
• float x3 - X coordinate of vertex 3
• float y3 - Y coordinate of vertex 3
• float z3 - Z coordinate of vertex 3
• float x4 - X coordinate of vertex 4
• float y4 - Y coordinate of vertex 4
• float z4 - Z coordinate of vertex 4
• segments (opt) - Number of rows/columns in rectangle (defaults to 1)

• int - Mesh ID

Notes: None

modelCreateBoneJoint

Descritption: Get the number of vertices in the model.

• string name - Name of bone joint
• float x - X coordinate of bone joint
• float y - Y coordinate of bone joint
• float z - Z coordinate of bone joint
• float xrot - X rotation of bone joint (in degrees)
• float yrot - Y rotation of bone joint (in degrees)
• float zrot - Z rotation of bone joint (in degrees)
• int parentID - ID of parent joint (-1 is no parent, root joint)

• int - Joint ID

Notes: None

vertexSetCoords

Descritption: Move a vertex to a new position

• int vertexID ID of vertex to move
• float x New X coordinate
• float y New Y coordinate
• float z New Z coordinate

• None

Notes: IDs of any type are integers from zero to count-1 inclusive. Negative numbers are invalid.

modelAddTexture

Descritption: Add an image file to a model as a texture.

• string filename - Filename of texture to add (can be relative)

• int - Texture ID

Notes: None

vertexSetCoords

Descritption: Assign a texture to a group.

• int groupID ID of group
• int textureID ID of texture for group

• None

Notes: IDs of any type are integers from zero to count-1 inclusive. Negative numbers are invalid.

faceSetTextureCoords

Descritption: Set the UV texture coordinates for a vertex of a polygon

• int faceID Polygon ID
• int vertexIndex Index of polygon vertex to assign (0-2 for triangles)
• float u U (horizontal) coordinate for vertex on the group texture (0.0 - 1.0)
• float v V (vertical) coordinate for vertex on the group texture (0.0 - 1.0)

• None

Notes: IDs of any type are integers from zero to count-1 inclusive. Negative numbers are invalid.

Texture coordinates are from 0.0 to 1.0. The origin (0.0, 0.0) is the lower-left corner of the texture, not the upper-right corner.

Selection manipulation

selectedRotate

Descritption: Rotate the selected vertices and bone joints around the origin.

• float x - Rotation around X axis in degrees
• float y - Rotation around Y axis in degrees
• float z - Rotation around Z axis in degrees

• None

Notes: Rotation is around the origin. If you want to rotate around an arbitrary point (x0,y0,z0) you can use the following steps:

1. selectedTranslate ( -x0, -y0, -z0 )
2. selectedRotate( x, y, z )
3. selectedTranslate ( x0, y0, z0 )

selectedTranslate

Descritption: Translate the selected vertices and bone joints.

• float x - Units to translate on the X axis
• float y - Units to translate on the Y axis
• float z - Units to translate on the Z axis

• None

Notes: None

selectedScale

Descritption: Scale the distance between selected vertices and bone joints.

• float x - Units to scale on the X axis
• float y - Units to scale on the Y axis
• float z - Units to scale on the Z axis

• None

Notes: None

selectedApplyMatrix

Descritption: Apply an arbitrary 4x4 matrix to the selected vertices and joints.

• float m1 - First matrix element
• m2 ... m14
• float m15 - Last matrix element

• None

Notes: The m13, m14, m15 elements are the translation elements.

selectedWeldVertices

Descritption: Any selected vertcies that share coordinates into one vertex.

• None

• None

Notes: This does not weld all verticies into one. It only welds vertices that are very, very close to each other.

selectedInvertNormals

Descritption: Invertes the normals on any selected faces (polygons (triangles)). Effectively this turns objects inside-out so that light reflects off the opposite sides of the faces.

• None

• None

Notes: None

selectedGroupFaces

Descritption: Assigns all selected faces to a group specified by name. The group is created if it does not exist.

• string name - Name of group for faces

• int groupID - Group ID

Notes: None

selectedAddToGroup

Descritption: Adds selected faces to an existing group.

• int groupID ID of group

• None

Notes: IDs of any type are integers from zero to count-1 inclusive. Negative numbers are invalid.

Animation

modelCreateAnimation

Descritption: Creates a new animation

• string mode - Animation mode: "skeletal" or "frame"
• string name - Name of new animation
• int frameIndex - Frame count
• float fps - Frames per second

• int - AnimationID

Notes: Animation IDs are unique to their type, but can be the same for two different types. In other words, the first skeletal animation and the first frame animation are always zero (0). This is why you must use an animation type/mode string when you specify an animation ID.

setAnimByIndex

Descritption: Sets the current animation from a mode string and an ID value.

• string mode - Animation mode: "skeletal" or "frame"
• int animID - Animation ID

• bool - Returns true if animation exists, false otherwise.

Notes: IDs of any type are integers from zero to count-1 inclusive. Negative numbers are invalid.

You can set frame animation vertex positions or skeletal animation keyframes directly using functions below. You only need to use this function if you want to use matrix transformations to manipulate several animated primitives at once; for example, translating or rotating many vertex positions at one time.

setAnimByName

Descritption: Sets the current animation from a mode string and a name string.

• string mode - Animation mode: "skeletal" or "frame"
• string name - Name of animation

• bool - Returns true if animation exists, false otherwise.

Notes: You can set frame animation vertex positions or skeletal animation keyframes directly using functions below. You only need to use this function if you want to use matrix transformations to manipulate several animated primitives at once; for example, translating or rotating many vertex positions at one time.

animSetFrame

Descritption: Sets the current frame of the current animation.

• int frameIndex - Frame index of current animation (0 to frame_count-1)

• None

Notes: You can set frame animation vertex positions or skeletal animation keyframes directly using functions below. You only need to use this function if you want to use matrix transformations to manipulate several animated primitives at once; for example, translating or rotating many vertex positions at one time.

animGetCount

Descritption: Get the number of animations of a specified type.

• string mode - Animation mode: "skeletal" or "frame"

• int - The number of animations of this type

Notes: None

animGetName

Descritption: Get the name of an animation.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation

• string - The animation name

Notes: None

animGetFrameCount

Descritption: Get the frame count of an animation.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation

• int - The frame count of the animation

Notes: None

animSetName

Descritption: Change the name of the specified animation.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation
• string name - New animation name

• None

Notes: None

animSetFrameCount

Descritption: Change the frame count of the specified animation.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation
• int frameCount - New animation frame count

• None

Notes: None

animSetFPS

Descritption: Change the animation speed.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation
• float fps - New animation speed in frames per second

• None

Notes: None

animClearFrame

Descritption: Clear an animation frame so that all primitives are in their default position and orientation.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation
• int frame - Frame number (0 to frame_count-1, inclusive)

• None

Notes: None

animCopyFrame

Descritption: Copy an animation frame to another frame so that each frame is identical.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation
• int src - Source frame number (0 to frame_count-1, inclusive), the frame you want to make a copy of
• int dest - Destination frame number (0 to frame_count-1, inclusive), the frame you want to copy to

• None

Notes: None

Animation set manipulation

animMove

Descritption: Move an animation from one index to another. This changes the order in which animations are listed.

• string mode - Animation mode: "skeletal" or "frame"
• int animIndex1 - The current animation index (ID number)
• int animIndex2 - The new animation index

• None

Notes: Animation indices and IDs are the same thing. If you move an animation its ID changes to its new index position. Other animation IDs may be changed as well if they appear after the old or new animation index.

animCopy

Descritption: Create a new animation that is a copy of an existing animation.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation
• string name - Name of new animation

• int - ID number of the new animation

Notes: None

animSplit

Descritption: Split an animation into two separate animations at a specified frame.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation
• string name - Name of new animation
• int frame - The frame at which to split the animation (0 to frame_count-1, inclusive)

• int - ID number of the new animation

Notes: None

animJoin

Descritption: Join two animations together into one.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID1 - The ID number of the animation to join to
• int animationID2 - The ID number of the animation to join from

• None

Notes: In case the above argument descriptions are unclear, animation 2 will be appended to animation 1.

animConvertToFrame

Descritption: Convert a skeletal animation to a frame animation.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation to convert
• string name - The name of the new animation
• int frame_count - The number of frames in the new animation

• None

Notes: The two animations will complete in the same amount of time. The existing animation may be resampled if the frame count of the new animation is different from the existing animation. The new animation's frames per second will be changed to make the two animations compelte in the same amount of time.

In other words: frame_count1 * fps1 = frame_count2 * fps2

Mode-specific animation manipulations

skelAnimSetKeyframe

Descritption: Set a keyframe for a specified animation, frame, and joint. Keyframe may be rotation or translation.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation
• int frame - The index of the frame (0 to frame_count-1, inclusive)
• int jointID - The ID number of the joint
• bool isRotation - Is true for rotation keyframe, false for translation keyframe
• float x - Coordinate or rotation on X axis
• float y - Coordinate or rotation on Y axis
• float z - Coordinate or rotation on Z axis

• None

Notes: None

skelAnimDeleteKeyframe

Descritption: Deletes a keyframe for a specified animation, frame, and joint. Keyframe may be rotation or translation.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation
• int frame - The index of the frame (0 to frame_count-1, inclusive)
• int jointID - The ID number of the joint
• bool isRotation - Is true for rotation keyframe, false for translation keyframe

• None

Notes: The joint will have its default position or orientation after calling this function. If there are rotation and translation keyframes, you must call this function twice to delete both; once with isRotation true, and once with isRotation false.

frameAnimSetVertex

Descritption: Deletes a keyframe for a specified animation, frame, and joint. Keyframe may be rotation or translation.

• string mode - Animation mode: "skeletal" or "frame"
• int animationID - The ID number of the animation
• int frame - The index of the frame (0 to frame_count-1, inclusive)
• int vertexID - The ID number of the joint
• float x - New X coordinate
• float y - New Y coordinate
• float z - New Z coordinate

• None

Notes: None

Selection

modelSelectAll

Descritption: Selects all primitives (vertices, faces, and bone joints)

• None

• None

Notes: None

modelSelectAllVertices

Descritption: Selects all vertices

• None

• None

Notes: None

modelSelectAllFaces

Descritption: Selects all faces

• None

• None

Notes: None

modelSelectAllGroups

Descritption: Selects all faces of all groups

• None

• None

Notes: None

modelSelectVertices

Descritption: Selects all vertices

• None

• None

Notes: None

modelSelectVertex

Descritption: Selects specified vertex

• int vertexID - ID of vertex to select

• None

Notes: IDs of any type are integers from zero to count-1 inclusive. Negative numbers are invalid.

modelSelectFace

Descritption: Selects specified face

• int faceID - ID of face to select

• None

Notes: IDs of any type are integers from zero to count-1 inclusive. Negative numbers are invalid.

modelSelectGroup

Descritption: Selects faces of specified group

• int groupID - ID of group to select

• None

Notes: IDs of any type are integers from zero to count-1 inclusive. Negative numbers are invalid.

modelSelectJoint

Descritption: Selects specified joint

• int jointID - ID of joint to select

• None

Notes: IDs of any type are integers from zero to count-1 inclusive. Negative numbers are invalid.

modelUnselectAll

Descritption: Unselects all primitives (vertices, faces, bone joints)

• None

• None

Notes: None

Logging

logDebug

Descritption: Send a message string to the debug log.

• string message - message to log

• None

Notes: None

logWarning

Descritption: Send a message string to the warning log.

• string message - message to log

• None

Notes: None

logError

Descritption: Send a message string to the error log.

• string message - message to log

• None

Notes: None