Class InstancedMesh<TGeometry, TMaterial>

A special version of Mesh with instanced rendering support

Remarks

Use InstancedMesh if you have to render a large number of objects with the same geometry and material but with different world transformations

Index

Constructors

constructor

Constructors

constructor

new InstancedMesh<TGeometry, TMaterial>(geometry, material, count): InstancedMesh<TGeometry, TMaterial>
Create a new instance of InstancedMesh
Type Parameters
- TGeometry extends BufferGeometry<NormalBufferAttributes> = BufferGeometry<NormalBufferAttributes>
- TMaterial extends Material | Material[] = Material | Material[]
Parameters
- geometry: undefined | TGeometry
  An instance of BufferGeometry.
- material: undefined | TMaterial
  A single or an array of Material. Default new THREE.MeshBasicMaterial().
- count: number
  The maximum number of instances of this Mesh. Expects a Integer
Returns InstancedMesh<TGeometry, TMaterial>
Overrides Mesh.constructor
- Defined in ../node_modules/@types/three/src/objects/InstancedMesh.d.ts:38

Properties

animations

animations: AnimationClip[]

Array with object's animation clips.

Default Value

[]

boundingBox

boundingBox: null | Box3

This bounding box encloses all instances of the InstancedMesh,, which can be calculated with .computeBoundingBox().

Remarks

Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are null.

Default Value

null

boundingSphere

boundingSphere: null | Sphere

This bounding sphere encloses all instances of the InstancedMesh, which can be calculated with .computeBoundingSphere().

Remarks

bounding spheres aren't computed by default. They need to be explicitly computed, otherwise they are null.

Default Value

null

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

Default Value

false

children

children: Object3D<Object3DEventMap>[]

Array with object's children.

See

THREE.Object3DGroup | Group for info on manually grouping objects.

Default Value

[]

count

count: number

The number of instances.

Remarks

The count value passed into the constructor represents the maximum number of instances of this mesh. You can change the number of instances at runtime to an integer value in the range [0, count].

`Optional`customDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

Remarks

Can only be used in context of meshes.

Default Value

undefined

`Optional`customDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

Default Value

undefined

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object. If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

Default Value

true

geometry

geometry: TGeometry

An instance of BufferGeometry (or derived classes), defining the object's structure.

Default Value

new THREE.BufferGeometry().

`Readonly`id

id: number

Unique number for this Object3D instance.

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

instanceColor

instanceColor: null | InstancedBufferAttribute

Represents the colors of all instances. You have to set .instanceColor.needsUpdate() flag to true if you modify instanced data via .setColorAt().

Default Value

null

instanceMatrix

instanceMatrix: InstancedBufferAttribute

Represents the local transformation of all instances. You have to set .instanceMatrix.needsUpdate() flag to true if you modify instanced data via .setMatrixAt().

`Readonly`isInstancedMesh

isInstancedMesh

Read-only flag to check if a given object is of type InstancedMesh.

Remarks

This is a constant value

Default Value

true

`Readonly`isMesh

isMesh

Read-only flag to check if a given object is of type Mesh.

Remarks

This is a constant value

Default Value

true

`Readonly`isObject3D

isObject3D

Flag to check if a given object is of type Object3D.

Remarks

This is a constant value

Default Value

true

layers

layers: Layers

The layer membership of the object.

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.

Default Value

new THREE.Layers()

material

material: TMaterial

An instance of material derived from the Material base class or an array of materials, defining the object's appearance.

Default Value

new THREE.MeshBasicMaterial().

matrix

matrix: Matrix4

The local transform matrix.

Default Value

new THREE.Matrix4()

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

Remarks

If the Object3D has no parent, then it's identical to the local transform .matrix.

Default Value

new THREE.Matrix4()

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates. When it isn't, then you have to maintain all matrices in the object and its children yourself.

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

Default Value

false

`Readonly`modelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

`Optional`morphTargetDictionary

morphTargetDictionary?: {
[key: string]: number;
}

A dictionary of morphTargets based on the morphTarget.name property.

Default Value

undefined, but rebuilt by updateMorphTargets | .updateMorphTargets().

`Optional`morphTargetInfluences

morphTargetInfluences?: number[]

An array of weights typically from 0-1 that specify how much of the morph is applied.

Default Value

undefined, but reset to a blank array by updateMorphTargets | .updateMorphTargets().

name

name: string

Optional name of the object

Remarks

(doesn't need to be unique).

Default Value

""

`Readonly`normalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

parent

parent: null | Object3D<Object3DEventMap>

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

`Readonly`position

position: Vector3

Object's local position.

Default Value

new THREE.Vector3() - that is (0, 0, 0).

`Readonly`quaternion

quaternion: Quaternion

Object's local rotation as a Quaternion.

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

Default Value

false

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph objects to be overridden although opaque and transparent objects remain sorted independently.

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.

Default Value

0

`Readonly`rotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

`Readonly`scale

scale: Vector3

The object's local scale.

Default Value

new THREE.Vector3( 1, 1, 1 )

`Readonly`type

type: string

Default Value

Mesh

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

Remarks

It should not hold references to functions as these will not be cloned.

Default

{}

uuid

uuid: string

UUID of this object instance.

Remarks

This gets automatically assigned and shouldn't be edited.

visible

visible: boolean

Object gets rendered if true.

Default Value

true

`Static`DEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

Default Value

true

`Static`DEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

Default Value

true

`Static`DEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for DirectionalLight, HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

Default Value

new THREE.Vector3( 0, 1, 0)

Methods

add

add(...object): this
Adds another Object3D as child of this Object3D.
Parameters
- Rest...object: Object3D<Object3DEventMap>[]
Returns this
Remarks
An arbitrary number of objects may be added
See
- attach
- Group for info on manually grouping objects.
Inherited from Mesh.add
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:451

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends keyof InstancedMeshEventMap
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<InstancedMeshEventMap[T], T, InstancedMesh<TGeometry, TMaterial>>
  The function that gets called when the event is fired.
Returns void
Inherited from Mesh.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, InstancedMesh<TGeometry, TMaterial>>
Returns void
Inherited from Mesh.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:56

applyMatrix4

applyMatrix4(matrix): void
Applies the matrix transform to the object and updates the object's position, rotation and scale.
Parameters
- matrix: Matrix4
Returns void
Inherited from Mesh.applyMatrix4
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:321

applyQuaternion

applyQuaternion(quaternion): this
Applies the rotation represented by the quaternion to the object.
Parameters
- quaternion: Quaternion
Returns this
Inherited from Mesh.applyQuaternion
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:327

attach

attach(object): this
Adds a Object3D as a child of this, while maintaining the object's world transform.
Parameters
- object: Object3D<Object3DEventMap>
Returns this
Remarks
Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

See
add
Inherited from Mesh.attach
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:477

clear

clear(): this
Removes all child objects.

Returns this
Inherited from Mesh.clear
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:469

clone

clone(recursive?): this
Returns a clone of this object and optionally all descendants.
Parameters
- Optionalrecursive: boolean
  If true, descendants of the object are also cloned. Default true
Returns this
Inherited from Mesh.clone
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:600

computeBoundingBox

computeBoundingBox(): void
Computes bounding box of the all instances, updating .boundingBox attribute.

Returns void
Remarks
Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are null.
- Defined in ../node_modules/@types/three/src/objects/InstancedMesh.d.ts:88

computeBoundingSphere

computeBoundingSphere(): void
Computes bounding sphere of the all instances, updating .boundingSphere attribute.

Returns void
Remarks
bounding spheres aren't computed by default. They need to be explicitly computed, otherwise they are null.
- Defined in ../node_modules/@types/three/src/objects/InstancedMesh.d.ts:94

copy

copy(source, recursive?): this
Copy the given object into this object
Parameters
- source: this
- Optionalrecursive: boolean
  If true, descendants of the object are also copied. Default true
Returns this
Remarks
Note: event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.
Inherited from Mesh.copy
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:608

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends keyof InstancedMeshEventMap
Parameters
- event: BaseEvent<T> & InstancedMeshEventMap[T]
  The event that gets fired.
Returns void
Inherited from Mesh.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:84

dispose

dispose(): void
Frees the GPU-related resources allocated by this instance

Returns void
Remarks
Call this method whenever this instance is no longer used in your app.
- Defined in ../node_modules/@types/three/src/objects/InstancedMesh.d.ts:140

getColorAt

getColorAt(index, color): void
Get the color of the defined instance.
Parameters
- index: number
  The index of an instance. Values have to be in the range [0, count]. Expects a Integer
- color: Color
  This color object will be set to the color of the defined instance.
Returns void
- Defined in ../node_modules/@types/three/src/objects/InstancedMesh.d.ts:101

getMatrixAt

getMatrixAt(index, matrix): void
Get the local transformation matrix of the defined instance.
Parameters
- index: number
  The index of an instance Values have to be in the range [0, count]. Expects a Integer
- matrix: Matrix4
  This 4x4 matrix will be set to the local transformation matrix of the defined instance.
Returns void
- Defined in ../node_modules/@types/three/src/objects/InstancedMesh.d.ts:117

getObjectById

getObjectById(id): undefined | Object3D<Object3DEventMap>
Searches through an object and its children, starting with the object itself, and returns the first with a matching id.
Parameters
- id: number
  Unique number of the object instance. Expects a Integer
Returns undefined | Object3D<Object3DEventMap>
Remarks
Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

See
id
Inherited from Mesh.getObjectById
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:485

getObjectByName

getObjectByName(name): undefined | Object3D<Object3DEventMap>
Searches through an object and its children, starting with the object itself, and returns the first with a matching name.
Parameters
- name: string
  String to match to the children's Object3D.name property.
Returns undefined | Object3D<Object3DEventMap>
Remarks
Note that for most objects the name is an empty string by default
Inherited from Mesh.getObjectByName
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:493

getObjectByProperty

getObjectByProperty(name, value): undefined | Object3D<Object3DEventMap>
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
Parameters
- name: string
  the property name to search for.
- value: any
  value of the given property.
Returns undefined | Object3D<Object3DEventMap>
Inherited from Mesh.getObjectByProperty
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:502

getObjectsByProperty

getObjectsByProperty(name, value, optionalTarget?): Object3D<Object3DEventMap>[]
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
Parameters
- name: string
  The property name to search for.
- value: any
  Value of the given property.
- OptionaloptionalTarget: Object3D<Object3DEventMap>[]
  target to set the result. Otherwise a new Array is instantiated. If set, you must clear this array prior to each call (i.e., array.length = 0;).
Returns Object3D<Object3DEventMap>[]
Inherited from Mesh.getObjectsByProperty
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:512

getVertexPosition

getVertexPosition(index, target): Vector3
Get the local-space position of the vertex at the given index, taking into account the current animation state of both morph targets and skinning.
Parameters
- index: number
  Expects a Integer
- target: Vector3
Returns Vector3
Inherited from Mesh.getVertexPosition
- Defined in ../node_modules/@types/three/src/objects/Mesh.d.ts:84

getWorldDirection

getWorldDirection(target): Vector3
Returns a vector representing the direction of object's positive z-axis in world space.
Parameters
- target: Vector3
  The result will be copied into this Vector3.
Returns Vector3
Inherited from Mesh.getWorldDirection
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:536

getWorldPosition

getWorldPosition(target): Vector3
Returns a vector representing the position of the object in world space.
Parameters
- target: Vector3
  The result will be copied into this Vector3.
Returns Vector3
Inherited from Mesh.getWorldPosition
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:518

getWorldQuaternion

getWorldQuaternion(target): Quaternion
Returns a quaternion representing the rotation of the object in world space.
Parameters
- target: Quaternion
  The result will be copied into this Quaternion.
Returns Quaternion
Inherited from Mesh.getWorldQuaternion
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:524

getWorldScale

getWorldScale(target): Vector3
Returns a vector of the scaling factors applied to the object for each axis in world space.
Parameters
- target: Vector3
  The result will be copied into this Vector3.
Returns Vector3
Inherited from Mesh.getWorldScale
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:530

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof InstancedMeshEventMap
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<InstancedMeshEventMap[T], T, InstancedMesh<TGeometry, TMaterial>>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Mesh.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:63
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, InstancedMesh<TGeometry, TMaterial>>
Returns boolean
Inherited from Mesh.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:67

localToWorld

localToWorld(vector): Vector3
Converts the vector from this object's local space to world space.
Parameters
- vector: Vector3
  A vector representing a position in this object's local space.
Returns Vector3
Inherited from Mesh.localToWorld
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:420

lookAt

lookAt(vector): void
Rotates the object to face a point in world space.
Parameters
- vector: Vector3
  A vector representing a position in world space to look at.
Returns void
Remarks
This method does not support objects having non-uniformly-scaled parent(s).
Inherited from Mesh.lookAt
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:433
lookAt(x, y, z): void
Rotates the object to face a point in world space.
Parameters
- x: number
  Expects a Float
- y: number
  Expects a Float
- z: number
  Expects a Float
Returns void
Remarks
This method does not support objects having non-uniformly-scaled parent(s).
Inherited from Mesh.lookAt
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:441

onAfterRender

onAfterRender(renderer, scene, camera, geometry, material, group): void
An optional callback that is executed immediately after a 3D object is rendered.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- material: Material
- group: Group<Object3DEventMap>
Returns void
Remarks
This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
Inherited from Mesh.onAfterRender
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:289

onAfterShadow

onAfterShadow(renderer, scene, shadowCamera, geometry, depthMaterial, group): void
An optional callback that is executed immediately after a 3D object is rendered to a shadow map.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- shadowCamera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- depthMaterial: Material
- group: Group<Object3DEventMap>
Returns void
Remarks
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group.
Inherited from Mesh.onAfterShadow
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:255

onBeforeRender

onBeforeRender(renderer, scene, camera, geometry, material, group): void
An optional callback that is executed immediately before a 3D object is rendered.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- material: Material
- group: Group<Object3DEventMap>
Returns void
Remarks
This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
Inherited from Mesh.onBeforeRender
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:272

onBeforeShadow

onBeforeShadow(renderer, scene, shadowCamera, geometry, depthMaterial, group): void
An optional callback that is executed immediately before a 3D object is rendered to a shadow map.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- shadowCamera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- depthMaterial: Material
- group: Group<Object3DEventMap>
Returns void
Remarks
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group.
Inherited from Mesh.onBeforeShadow
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:237

raycast

raycast(raycaster, intersects): void
Abstract (empty) method to get intersections between a casted ray and this object
Parameters
- raycaster: Raycaster
- intersects: Intersection<Object3D<Object3DEventMap>>[]
Returns void
Remarks
Subclasses such as Mesh, Line, and Points implement this method in order to use raycasting.

See
Raycaster

Default Value
() => {}
Inherited from Mesh.raycast
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:546

remove

remove(...object): this
Removes a Object3D as child of this Object3D.
Parameters
- Rest...object: Object3D<Object3DEventMap>[]
Returns this
Remarks
An arbitrary number of objects may be removed.

See
Group for info on manually grouping objects.
Inherited from Mesh.remove
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:459

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends keyof InstancedMeshEventMap
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<InstancedMeshEventMap[T], T, InstancedMesh<TGeometry, TMaterial>>
  The listener function that gets removed.
Returns void
Inherited from Mesh.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, InstancedMesh<TGeometry, TMaterial>>
Returns void
Inherited from Mesh.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:78

removeFromParent

removeFromParent(): this
Removes this object from its current parent.

Returns this
Inherited from Mesh.removeFromParent
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:464

rotateOnAxis

rotateOnAxis(axis, angle): this
Rotate an object along an axis in object space.
Parameters
- axis: Vector3
  A normalized vector in object space.
- angle: number
  The angle in radians. Expects a Float
Returns this
Remarks
The axis is assumed to be normalized.
Inherited from Mesh.rotateOnAxis
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:361

rotateOnWorldAxis

rotateOnWorldAxis(axis, angle): this
Rotate an object along an axis in world space.
Parameters
- axis: Vector3
  A normalized vector in world space.
- angle: number
  The angle in radians. Expects a Float
Returns this
Remarks
The axis is assumed to be normalized
Inherited from Mesh.rotateOnWorldAxis
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:370

rotateX

rotateX(angle): this
Rotates the object around x axis in local space.
Parameters
- angle: number
Returns this
Inherited from Mesh.rotateX
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:376

rotateY

rotateY(angle): this
Rotates the object around y axis in local space.
Parameters
- angle: number
Returns this
Inherited from Mesh.rotateY
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:382

rotateZ

rotateZ(angle): this
Rotates the object around z axis in local space.
Parameters
- angle: number
Returns this
Inherited from Mesh.rotateZ
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:388

setColorAt

setColorAt(index, color): void
Sets the given color to the defined instance
Parameters
- index: number
  The index of an instance. Values have to be in the range [0, count]. Expects a Integer
- color: Color
  The color of a single instance.
Returns void
Remarks
Make sure you set .instanceColor.needsUpdate() to true after updating all the colors.
- Defined in ../node_modules/@types/three/src/objects/InstancedMesh.d.ts:110

setMatrixAt

setMatrixAt(index, matrix): void
Sets the given local transformation matrix to the defined instance.
Parameters
- index: number
  The index of an instance. Values have to be in the range [0, count]. Expects a Integer
- matrix: Matrix4
  A 4x4 matrix representing the local transformation of a single instance.
Returns void
Remarks
Make sure you set .instanceMatrix.needsUpdate() flag to true after updating all the matrices.
- Defined in ../node_modules/@types/three/src/objects/InstancedMesh.d.ts:126

setRotationFromAxisAngle

setRotationFromAxisAngle(axis, angle): void
Calls setFromAxisAngle(axis, angle) on the .quaternion.
Parameters
- axis: Vector3
  A normalized vector in object space.
- angle: number
  Angle in radians. Expects a Float
Returns void
Inherited from Mesh.setRotationFromAxisAngle
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:334

setRotationFromEuler

setRotationFromEuler(euler): void
Calls setFromEuler(euler) on the .quaternion.
Parameters
- euler: Euler
  Euler angle specifying rotation amount.
Returns void
Inherited from Mesh.setRotationFromEuler
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:340

setRotationFromMatrix

setRotationFromMatrix(m): void
Calls setFromRotationMatrix(m) on the .quaternion.
Parameters
- m: Matrix4
  Rotate the quaternion by the rotation component of the matrix.
Returns void
Remarks
Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).
Inherited from Mesh.setRotationFromMatrix
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:347

setRotationFromQuaternion

setRotationFromQuaternion(q): void
Copy the given Quaternion into .quaternion.
Parameters
- q: Quaternion
  Normalized Quaternion.
Returns void
Inherited from Mesh.setRotationFromQuaternion
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:353

toJSON

toJSON(meta?): any
Convert the object to three.js JSON Object/Scene format.
Parameters
- Optionalmeta: {
      geometries: any;
      images: any;
      materials: any;
      textures: any;
  }
  Object containing metadata such as materials, textures or images for the object.
  - geometries: any
  - images: any
  - materials: any
  - textures: any
Returns any
Inherited from Mesh.toJSON
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:594

translateOnAxis

translateOnAxis(axis, distance): this
Translate an object by distance along an axis in object space
Parameters
- axis: Vector3
  A normalized vector in object space.
- distance: number
  The distance to translate. Expects a Float
Returns this
Remarks
The axis is assumed to be normalized.
Inherited from Mesh.translateOnAxis
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:396

translateX

translateX(distance): this
Translates object along x axis in object space by distance units.
Parameters
- distance: number
  Expects a Float
Returns this
Inherited from Mesh.translateX
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:402

translateY

translateY(distance): this
Translates object along y axis in object space by distance units.
Parameters
- distance: number
  Expects a Float
Returns this
Inherited from Mesh.translateY
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:408

translateZ

translateZ(distance): this
Translates object along z axis in object space by distance units.
Parameters
- distance: number
  Expects a Float
Returns this
Inherited from Mesh.translateZ
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:414

traverse

traverse(callback): void
Executes the callback on this object and all descendants.
Parameters
- callback: ((object: Object3D<Object3DEventMap>) => any)
  A function with as first argument an Object3D object.
  - - (object): any
    - Parameters
      object: Object3D<Object3DEventMap>
      Returns any
Returns void
Remarks
Note: Modifying the scene graph inside the callback is discouraged.
Inherited from Mesh.traverse
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:553

traverseAncestors

traverseAncestors(callback): void
Executes the callback on all ancestors.
Parameters
- callback: ((object: Object3D<Object3DEventMap>) => any)
  A function with as first argument an Object3D object.
  - - (object): any
    - Parameters
      object: Object3D<Object3DEventMap>
      Returns any
Returns void
Remarks
Note: Modifying the scene graph inside the callback is discouraged.
Inherited from Mesh.traverseAncestors
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:568

traverseVisible

traverseVisible(callback): void
Like traverse, but the callback will only be executed for visible objects
Parameters
- callback: ((object: Object3D<Object3DEventMap>) => any)
  A function with as first argument an Object3D object.
  - - (object): any
    - Parameters
      object: Object3D<Object3DEventMap>
      Returns any
Returns void
Remarks
Descendants of invisible objects are not traversed.
Inherited from Mesh.traverseVisible
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:561

updateMatrix

updateMatrix(): void
Updates local transform.

Returns void
Inherited from Mesh.updateMatrix
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:573

updateMatrixWorld

updateMatrixWorld(force?): void
Updates the global transform of the object. And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.
Parameters
- Optionalforce: boolean
  A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame. Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.
Returns void
Inherited from Mesh.updateMatrixWorld
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:581

updateWorldMatrix

updateWorldMatrix(updateParents, updateChildren): void
Updates the global transform of the object.
Parameters
- updateParents: boolean
  Recursively updates global transform of ancestors.
- updateChildren: boolean
  Recursively updates global transform of descendants.
Returns void
Inherited from Mesh.updateWorldMatrix
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:588

worldToLocal

worldToLocal(vector): Vector3
Converts the vector from world space to this object's local space.
Parameters
- vector: Vector3
  A vector representing a position in world space.
Returns Vector3
Inherited from Mesh.worldToLocal
- Defined in ../node_modules/@types/three/src/core/Object3D.d.ts:426

Class InstancedMesh<TGeometry, TMaterial>

Remarks

See

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns InstancedMesh<TGeometry, TMaterial>

Properties

animations

Default Value

boundingBox

Remarks

Default Value

boundingSphere

Remarks

Default Value

castShadow

Default Value

children

See

Default Value

count

Remarks

OptionalcustomDepthMaterial

Remarks

Default Value

OptionalcustomDistanceMaterial

Default Value

frustumCulled

Default Value

geometry

Default Value

Readonlyid

Remarks

instanceColor

Default Value

instanceMatrix

ReadonlyisInstancedMesh

Remarks

Default Value

ReadonlyisMesh

Remarks

Default Value

ReadonlyisObject3D

Remarks

Default Value

layers

Remarks

Default Value

material

Default Value

matrix

Default Value

matrixAutoUpdate

Default Value

matrixWorld

Remarks

Default Value

matrixWorldAutoUpdate

Default Value

matrixWorldNeedsUpdate

Default Value

ReadonlymodelViewMatrix

Default Value

OptionalmorphTargetDictionary

Default Value

OptionalmorphTargetInfluences

Default Value

name

Remarks

Default Value

ReadonlynormalMatrix

Default Value

`Optional`customDepthMaterial

`Optional`customDistanceMaterial

`Readonly`id

`Readonly`isInstancedMesh

`Readonly`isMesh

`Readonly`isObject3D

`Readonly`modelViewMatrix

`Optional`morphTargetDictionary

`Optional`morphTargetInfluences

`Readonly`normalMatrix

`Readonly`position

`Readonly`quaternion

`Readonly`rotation

`Readonly`scale

`Readonly`type

`Static`DEFAULT_MATRIX_AUTO_UPDATE

`Static`DEFAULT_MATRIX_WORLD_AUTO_UPDATE

`Static`DEFAULT_UP