ThreeScalaJS
0.0.7
DocsAPI
Generated with
Copyright (c) 2022-2025, Olivier NOUGUIER
Copyright (c) 2022-2025, Olivier NOUGUIER
ThreeScalaJS/THREE/SkinnedMesh

SkinnedMesh

THREE.SkinnedMesh
See theSkinnedMesh companion object
class SkinnedMesh(geo: UndefOr[BufferGeometry], mat: UndefOr[Material | Array[Material]]) extends Mesh

A mesh that has a Skeleton that can then be used to animate the vertices of the geometry with skinning/skeleton animation.

Next to a valid skeleton, the skinned mesh requires skin indices and weights as buffer attributes in its geometry. These attribute define which bones affect a single vertex to a certain extend.

Typically skinned meshes are not created manually but loaders like GLTFLoader or FBXLoader import respective models.

Attributes

Companion
object
Graph
Supertypes
class Mesh
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def applyBoneTransform(index: Int, target: Vector3): Vector3

Applies the bone transform associated with the given index to the given vertex position. Returns the updated vector.

Applies the bone transform associated with the given index to the given vertex position. Returns the updated vector.

Value parameters

index

The vertex index

target

The target object that is used to store the method's result

Attributes

Returns

The updated vertex position

def bind(skeleton: Skeleton, bindMatrix: UndefOr[Matrix4]): Unit

Binds the given skeleton to the skinned mesh.

Binds the given skeleton to the skinned mesh.

Value parameters

bindMatrix

The bind matrix. If no bind matrix is provided, the skinned mesh's world matrix will be used instead

skeleton

The skeleton to bind

Attributes

def computeBoundingBox(): Unit

Computes the bounding box of the skinned mesh, and updates boundingBox. The bounding box is not automatically computed by the engine; this method must be called by your app. If the skinned mesh is animated, the bounding box should be recomputed per frame in order to reflect the current animation state.

Computes the bounding box of the skinned mesh, and updates boundingBox. The bounding box is not automatically computed by the engine; this method must be called by your app. If the skinned mesh is animated, the bounding box should be recomputed per frame in order to reflect the current animation state.

Attributes

def computeBoundingSphere(): Unit

Computes the bounding sphere of the skinned mesh, and updates boundingSphere. The bounding sphere is automatically computed by the engine once when it is needed, e.g., for ray casting and view frustum culling. If the skinned mesh is animated, the bounding sphere should be recomputed per frame in order to reflect the current animation state.

Computes the bounding sphere of the skinned mesh, and updates boundingSphere. The bounding sphere is automatically computed by the engine once when it is needed, e.g., for ray casting and view frustum culling. If the skinned mesh is animated, the bounding sphere should be recomputed per frame in order to reflect the current animation state.

Attributes

def normalizeSkinWeights(): Unit

Normalizes the skin weights which are defined as a buffer attribute in the skinned mesh's geometry.

Normalizes the skin weights which are defined as a buffer attribute in the skinned mesh's geometry.

Attributes

def pose(): Unit

This method sets the skinned mesh in the rest pose.

This method sets the skinned mesh in the rest pose.

Attributes

Inherited methods

def add(obj: Object3D*): this.type

Attributes

Inherited from:
Object3D
def applyMatrix4(matrix: Matrix4): Unit

Attributes

Inherited from:
Object3D
def applyQuaternion(q: Quaternion): this.type

Attributes

Inherited from:
Object3D
def attach(obj: Object3D): this.type

Attributes

Inherited from:
Object3D
def clear(): this.type

Attributes

Inherited from:
Object3D
def copy(source: Object3D, recursive: Boolean): this.type

Attributes

Inherited from:
Object3D
def getObjectById(id: Int): UndefOr[Object3D]

Attributes

Inherited from:
Object3D
def getObjectByName(name: String): UndefOr[Object3D]

Attributes

Inherited from:
Object3D
def getObjectByProperty(name: String, value: Any): UndefOr[Object3D]

Attributes

Inherited from:
Object3D
def getVertexPosition(index: Int, target: Vector3): Vector3

Returns the local-space position of the vertex at the given index, taking into account the current animation state of both morph targets and skinning.

Returns the local-space position of the vertex at the given index, taking into account the current animation state of both morph targets and skinning.

Value parameters

index

The vertex index

target

The target object that is used to store the method's result

Attributes

Returns

The vertex position in local space

Inherited from:
Mesh
def getWorldDirection(target: Vector3): Vector3

Attributes

Inherited from:
Object3D
def getWorldPosition(target: Vector3): Vector3

Attributes

Inherited from:
Object3D
def getWorldQuaternion(target: Quaternion): Quaternion

Attributes

Inherited from:
Object3D
def getWorldScale(target: Vector3): Vector3

Attributes

Inherited from:
Object3D
def hasOwnProperty(v: String): Boolean

Attributes

Inherited from:
Object
def isPrototypeOf(v: Object): Boolean

Attributes

Inherited from:
Object
def jsClone(recursive: Boolean): this.type

Attributes

Inherited from:
Object3D
def localToWorld(vector: Vector3): Vector3

Attributes

Inherited from:
Object3D
def lookAt(x: Any, y: UndefOr[Double], z: UndefOr[Double]): Unit

Attributes

Inherited from:
Object3D
def propertyIsEnumerable(v: String): Boolean

Attributes

Inherited from:
Object
def raycast(raycaster: Object, intersects: Array[Object]): Unit

Attributes

Inherited from:
Object3D
def remove(ob: Object3D*): this.type

Attributes

Inherited from:
Object3D
def rotateOnAxis(axis: Vector3, angle: Double): this.type

Attributes

Inherited from:
Object3D
def rotateOnWorldAxis(axis: Vector3, angle: Double): this.type

Attributes

Inherited from:
Object3D
def rotateX(angle: Double): this.type

Attributes

Inherited from:
Object3D
def rotateY(angle: Double): this.type

Attributes

Inherited from:
Object3D
def rotateZ(angle: Double): this.type

Attributes

Inherited from:
Object3D
def setRotationFromAxisAngle(axis: Vector3, angle: Double): Unit

Attributes

Inherited from:
Object3D
def setRotationFromEuler(euler: Euler): Unit

Attributes

Inherited from:
Object3D
def setRotationFromMatrix(m: Matrix4): Unit

Attributes

Inherited from:
Object3D
def setRotationFromQuaternion(q: Quaternion): Unit

Attributes

Inherited from:
Object3D
def toLocaleString(): String

Attributes

Inherited from:
Object
def translateOnAxis(axis: Vector3, distance: Double): this.type

Attributes

Inherited from:
Object3D
def translateX(distance: Double): this.type

Attributes

Inherited from:
Object3D
def translateY(distance: Double): this.type

Attributes

Inherited from:
Object3D
def translateZ(distance: Double): this.type

Attributes

Inherited from:
Object3D
def traverse(callback: Function1[Object3D, Unit]): Unit

Attributes

Inherited from:
Object3D
def traverseAncestors(callback: Function1[Object3D, Unit]): Unit

Attributes

Inherited from:
Object3D
def traverseVisible(callback: Function1[Object3D, Unit]): Unit

Attributes

Inherited from:
Object3D
def updateMatrix(): Unit

Attributes

Inherited from:
Object3D
def updateMatrixWorld(force: Boolean): Unit

Attributes

Inherited from:
Object3D
def updateMorphTargets(): Unit

Sets the values of morphTargetDictionary and morphTargetInfluences to make sure existing morph targets can influence this 3D object.

Sets the values of morphTargetDictionary and morphTargetInfluences to make sure existing morph targets can influence this 3D object.

Attributes

Inherited from:
Mesh
def updateWorldMatrix(updateParent: Boolean, updateChildren: Boolean): Unit

Attributes

Inherited from:
Object3D
def valueOf(): Any

Attributes

Inherited from:
Object
def worldToLocal(vector: Vector3): Vector3

Attributes

Inherited from:
Object3D

Concrete fields

override val `type`: String

The type of this object.

The type of this object.

Attributes

var bindMatrix: Matrix4

The base matrix that is used for the bound bone transforms.

The base matrix that is used for the bound bone transforms.

Attributes

var bindMatrixInverse: Matrix4

The base matrix that is used for resetting the bound bone transforms.

The base matrix that is used for resetting the bound bone transforms.

Attributes

var bindMode: String

AttachedBindMode means the skinned mesh shares the same world space as the skeleton. This is not true when using DetachedBindMode which is useful when sharing a skeleton across multiple skinned meshes.

AttachedBindMode means the skinned mesh shares the same world space as the skeleton. This is not true when using DetachedBindMode which is useful when sharing a skeleton across multiple skinned meshes.

Attributes

var boundingBox: UndefOr[Box3]

The bounding box of the skinned mesh. Can be computed via computeBoundingBox.

The bounding box of the skinned mesh. Can be computed via computeBoundingBox.

Attributes

var boundingSphere: UndefOr[Sphere]

The bounding sphere of the skinned mesh. Can be computed via computeBoundingSphere.

The bounding sphere of the skinned mesh. Can be computed via computeBoundingSphere.

Attributes

val isSkinnedMesh: Boolean

This flag can be used for type testing.

This flag can be used for type testing.

Attributes

var skeleton: UndefOr[Skeleton]

The skeleton of this skinned mesh.

The skeleton of this skinned mesh.

Attributes

Inherited fields

var castShadow: Boolean

Attributes

Inherited from:
Object3D
val children: Array[Object3D]

Attributes

Inherited from:
Object3D
var frustumCulled: Boolean

Attributes

Inherited from:
Object3D
var geometry: UndefOr[BufferGeometry]

Attributes

Inherited from:
Mesh
val id: Int

Attributes

Inherited from:
Object3D
val isMesh: Boolean

This flag can be used for type testing.

This flag can be used for type testing.

Attributes

Inherited from:
Mesh
var layers: Object

Attributes

Inherited from:
Object3D
var material: UndefOr[Material | Array[Material]]

Attributes

Inherited from:
Mesh
var matrix: Matrix4

Attributes

Inherited from:
Object3D
var matrixAutoUpdate: Boolean

Attributes

Inherited from:
Object3D
var matrixWorld: Matrix4

Attributes

Inherited from:
Object3D
var matrixWorldNeedsUpdate: Boolean

Attributes

Inherited from:
Object3D
var morphTargetDictionary: UndefOr[Dictionary[Int]]

A dictionary representing the morph targets in the geometry. The key is the morph targets name, the value its attribute index. This member is undefined by default and only set when morph targets are detected in the geometry.

A dictionary representing the morph targets in the geometry. The key is the morph targets name, the value its attribute index. This member is undefined by default and only set when morph targets are detected in the geometry.

Attributes

Inherited from:
Mesh
var morphTargetInfluences: UndefOr[Array[Double]]

An array of weights typically in the range [0,1] that specify how much of the morph is applied. This member is undefined by default and only set when morph targets are detected in the geometry.

An array of weights typically in the range [0,1] that specify how much of the morph is applied. This member is undefined by default and only set when morph targets are detected in the geometry.

Attributes

Inherited from:
Mesh
var name: String

Attributes

Inherited from:
Object3D
var parent: UndefOr[Object3D]

Attributes

Inherited from:
Object3D
var position: Vector3

Attributes

Inherited from:
Object3D
var quaternion: Quaternion

Attributes

Inherited from:
Object3D
var receiveShadow: Boolean

Attributes

Inherited from:
Object3D
var renderOrder: Double

Attributes

Inherited from:
Object3D
var rotation: Euler

Attributes

Inherited from:
Object3D
var scale: Vector3

Attributes

Inherited from:
Object3D
var userData: Object

Attributes

Inherited from:
Object3D
val uuid: String

Attributes

Inherited from:
Object3D
var visible: Boolean

Attributes

Inherited from:
Object3D
Generated with
Copyright (c) 2022-2025, Olivier NOUGUIER
Copyright (c) 2022-2025, Olivier NOUGUIER