Class BatchedMesh

A special version of Mesh with multi draw batch rendering support. Use BatchedMesh if you have to render a large number of objects with the same material but with different world transformations and geometry. The usage of BatchedMesh will help you to reduce the number of draw calls and thus improve the overall rendering performance in your application.

If the WEBGL_multi_draw extension is not supported then a less performant callback is used.

Example

const box = new THREE.BoxGeometry( 1, 1, 1 );
const sphere = new THREE.BoxGeometry( 1, 1, 1 );
const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );

// initialize and add geometries into the batched mesh
const batchedMesh = new BatchedMesh( 10, 5000, 10000, material );
const boxId = batchedMesh.addGeometry( box );
const sphereId = batchedMesh.addGeometry( sphere );

// position the geometries
batchedMesh.setMatrixAt( boxId, boxMatrix );
batchedMesh.setMatrixAt( sphereId, sphereMatrix );

scene.add( batchedMesh );

Also

Example: WebGL / mesh / batch

Hierarchy (view full)

Mesh<BufferGeometry, Material>
- BatchedMesh

Index

Constructors

constructor

new BatchedMesh(maxGeometryCount, maxVertexCount, maxIndexCount?, material?): BatchedMesh
Parameters
- maxGeometryCount: number
  the max number of individual geometries planned to be added.
- maxVertexCount: number
  the max number of vertices to be used by all geometries.
- OptionalmaxIndexCount: number
  the max number of indices to be used by all geometries.
- Optionalmaterial: Material
  an instance of [page:Material]. Default is a new MeshBasicMaterial.
Returns BatchedMesh
Overrides Mesh.constructor

Properties

`Static`DEFAULT_UP

DEFAULT_UP: Vector3

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

Default Value

new THREE.Vector3( 0, 1, 0)

`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

boundingBox

boundingBox: Box3

This bounding box encloses all instances of the BatchedMesh. Can be calculated with .computeBoundingBox().

Default

null

boundingSphere

boundingSphere: Sphere

This bounding sphere encloses all instances of the BatchedMesh. Can be calculated with .computeBoundingSphere().

Default

null

customSort

customSort: ((this: this, list: {
    start: number;
    count: number;
    z: number;
}[], camera: Camera) => void)

perObjectFrustumCulled

perObjectFrustumCulled: boolean

If true then the individual objects within the BatchedMesh are frustum culled.

Default

true

sortObjects

sortObjects: boolean

If true then the individual objects within the BatchedMesh are sorted to improve overdraw-related artifacts. If the material is marked as "transparent" objects are rendered back to front and if not then they are rendered front to back.

Default

true

isBatchedMesh

isBatchedMesh: true

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

`Readonly`isMesh

isMesh: true

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

Remarks

This is a constant value

Default Value

true

`Readonly`type

type: string

Default Value

Mesh

geometry

geometry: BufferGeometry<NormalBufferAttributes>

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

Default Value

THREE.BufferGeometry | new THREE.BufferGeometry().

material

material: Material

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

Default Value

THREE.MeshBasicMaterial | new THREE.MeshBasicMaterial().

`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().

`Optional`morphTargetDictionary

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

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

Default Value

undefined, but rebuilt by .updateMorphTargets().

`Readonly`isObject3D

isObject3D: true

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

Remarks

This is a constant value

Default Value

true

`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. Expects a Integer

uuid

uuid: string

UUID of this object instance.

Remarks

This gets automatically assigned and shouldn't be edited.

name

name: string

Optional name of the object

Remarks

(doesn't need to be unique).

Default Value

""

parent

parent: Object3D<Object3DEventMap>

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

children

children: Object3D<Object3DEventMap>[]

Array with object's children.

See

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

Default Value

[]

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).

`Readonly`position

position: Vector3

Object's local position.

Default Value

new THREE.Vector3() - that is (0, 0, 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`quaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

Default Value

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

`Readonly`scale

scale: Vector3

The object's local scale.

Default Value

new THREE.Vector3( 1, 1, 1 )

`Readonly`modelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

`Readonly`normalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

matrix

matrix: Matrix4

The local transform matrix.

Default Value

new THREE.Matrix4()

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .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).

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

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. This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

Default Value

new THREE.Layers()

visible

visible: boolean

Object gets rendered if true.

Default Value

true

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

Default Value

false

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

Default Value

false

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

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. Sorting is from lowest to highest renderOrder.

Default Value

0

animations

animations: AnimationClip[]

Array with object's animation clips.

Default Value

[]

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

{}

`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. When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight, if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

Default Value

undefined

`Optional`customDistanceMaterial

customDistanceMaterial?: Material

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

Default Value

undefined

Accessors

maxGeometryCount

get maxGeometryCount(): number
The maximum number of individual geometries that can be stored in the BatchedMesh. Read only.

Returns number

Methods

computeBoundingBox

computeBoundingBox(): void
Computes the bounding box, updating .boundingBox attribute. Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are null.

Returns void

computeBoundingSphere

computeBoundingSphere(): void
Computes the bounding sphere, updating .boundingSphere attribute. Bounding spheres aren't computed by default. They need to be explicitly computed, otherwise they are null.

Returns void

dispose

dispose(): this
Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Returns this

setCustomSort

setCustomSort(func): this
Takes a sort a function that is run before render. The function takes a list of items to sort and a camera. The objects in the list include a "z" field to perform a depth-ordered sort with.
Parameters
- func: ((this: this, list: {
      start: number;
      count: number;
      z: number;
  }[], camera: Camera) => void)
  - - (this, list, camera): void
    - Parameters
      this: this
      list: {
          start: number;
          count: number;
          z: number;
      }[]
      camera: Camera
      Returns void
Returns this

getColorAt

getColorAt(index, color): void
Get the color of the defined geometry.
Parameters
- index: number
  The index of a geometry. Values have to be in the range [0, count].
- color: Color
  This color object will be set to the color of the defined geometry.
Returns void

getMatrixAt

getMatrixAt(index, matrix): Matrix4
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].
- matrix: Matrix4
  This 4x4 matrix will be set to the local transformation matrix of the defined instance.
Returns Matrix4

getVisibleAt

getVisibleAt(index): boolean
Get whether the given instance is marked as "visible" or not.
Parameters
- index: number
  The index of an instance. Values have to be in the range [0, count].
Returns boolean

setColorAt

setColorAt(index, color): void
Sets the given color to the defined geometry.
Parameters
- index: number
  The index of a geometry. Values have to be in the range [0, count].
- color: Color
  The color of a single geometry.
Returns void

setMatrixAt

setMatrixAt(index, matrix): this
Sets the given local transformation matrix to the defined instance. Make sure you set .instanceMatrix BufferAttribute.needsUpdate to true after updating all the matrices.
Parameters
- index: number
  The index of an instance. Values have to be in the range [0, count].
- matrix: Matrix4
  A 4x4 matrix representing the local transformation of a single instance.
Returns this

setVisibleAt

setVisibleAt(index, visible): this
Sets the visibility of the object at the given index.
Parameters
- index: number
  The index of an instance. Values have to be in the range [0, count].
- visible: boolean
  A boolean value indicating the visibility state.
Returns this

addGeometry

addGeometry(geometry, reservedVertexRange?, reservedIndexRange?): number
Adds the given geometry to the BatchedMesh and returns the associated index referring to it.
Parameters
- geometry: BufferGeometry<NormalBufferAttributes>
  The geometry to add into the BatchedMesh.
- OptionalreservedVertexRange: number
  Optional parameter specifying the amount of vertex buffer space to reserve for the added geometry. This is necessary if it is planned to set a new geometry at this index at a later time that is larger than the original geometry. Defaults to the length of the given geometry vertex buffer.
- OptionalreservedIndexRange: number
  Optional parameter specifying the amount of index buffer space to reserve for the added geometry. This is necessary if it is planned to set a new geometry at this index at a later time that is larger than the original geometry. Defaults to the length of the given geometry index buffer.
Returns number

setGeometryAt

setGeometryAt(index, geometry): number
Replaces the geometry at index with the provided geometry. Throws an error if there is not enough space reserved for geometry at the index.
Parameters
- index: number
  Which geometry index to replace with this geometry.
- geometry: BufferGeometry<NormalBufferAttributes>
  The geometry to substitute at the given geometry index.
Returns number

getInstanceCountAt

getInstanceCountAt(index): number
Gets the instance count of the geometry at index. Returns null if instance counts are not configured.
Parameters
- index: number
  The index of an instance. Values have to be in the range [0, count].
Returns number

setInstanceCountAt

setInstanceCountAt(index, instanceCount): number
Sets an instance count of the geometry at index.
Parameters
- index: number
  Which geometry index to configure an instance count for.
- instanceCount: number
  The number of instances to render of the given geometry index.
Returns number

deleteGeometry

deleteGeometry(index): this
Parameters
- index: number
Returns this

getBoundingBoxAt

getBoundingBoxAt(index, target): Box3
Parameters
- index: number
- target: Box3
Returns Box3

getBoundingSphereAt

getBoundingSphereAt(index, target): Sphere
Parameters
- index: number
- target: Sphere
Returns Sphere

updateMorphTargets

updateMorphTargets(): void
Updates the morphTargets to have no influence on the object

Returns void
Remarks
Resets the morphTargetInfluences and morphTargetDictionary properties.

Inherited from Mesh.updateMorphTargets

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

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. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D, Group or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from Mesh.onBeforeShadow

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. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D, Group or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from Mesh.onAfterShadow

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. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D, Group or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from Mesh.onBeforeRender

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. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D, Group or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from Mesh.onAfterRender

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

applyQuaternion

applyQuaternion(quaternion): this
Applies the rotation represented by the quaternion to the object.
Parameters
- quaternion: Quaternion
Returns this
Inherited from Mesh.applyQuaternion

setRotationFromAxisAngle

setRotationFromAxisAngle(axis, angle): void
Calls THREE.Quaternion.setFromAxisAngle | 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

setRotationFromEuler

setRotationFromEuler(euler): void
Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.
Parameters
- euler: Euler
  Euler angle specifying rotation amount.
Returns void
Inherited from Mesh.setRotationFromEuler

setRotationFromMatrix

setRotationFromMatrix(m): void
Calls THREE.Quaternion.setFromRotationMatrix | 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

setRotationFromQuaternion

setRotationFromQuaternion(q): void
Copy the given THREE.Quaternion | Quaternion into .quaternion.
Parameters
- q: Quaternion
  Normalized Quaternion.
Returns void
Inherited from Mesh.setRotationFromQuaternion

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

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 Method Assumes no rotated parent.

Inherited from Mesh.rotateOnWorldAxis

rotateX

rotateX(angle): this
Rotates the object around x axis in local space.
Parameters
- angle: number
Returns this
Inherited from Mesh.rotateX

rotateY

rotateY(angle): this
Rotates the object around y axis in local space.
Parameters
- angle: number
Returns this
Inherited from Mesh.rotateY

rotateZ

rotateZ(angle): this
Rotates the object around z axis in local space.
Parameters
- angle: number
Returns this
Inherited from Mesh.rotateZ

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

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

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

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

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

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

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
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

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 Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

See
- attach
- THREE.Group | Group for info on manually grouping objects.
Inherited from Mesh.add

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
THREE.Group | Group for info on manually grouping objects.

Inherited from Mesh.remove

removeFromParent

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

Returns this
Inherited from Mesh.removeFromParent

clear

clear(): this
Removes all child objects.

Returns this
Inherited from Mesh.clear

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

getObjectById

getObjectById(id): 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 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

getObjectByName

getObjectByName(name): 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 Object3D<Object3DEventMap>
Remarks
Note that for most objects the name is an empty string by default You will have to set it manually to make use of this method.

Inherited from Mesh.getObjectByName

getObjectByProperty

getObjectByProperty(name, value): 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 Object3D<Object3DEventMap>
Inherited from Mesh.getObjectByProperty

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

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

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

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

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

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 THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

See
THREE.Raycaster | Raycaster

Default Value
() => {}

Inherited from Mesh.raycast

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

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. Note: Modifying the scene graph inside the callback is discouraged.

Inherited from Mesh.traverseVisible

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

updateMatrix

updateMatrix(): void
Updates local transform.

Returns void
Inherited from Mesh.updateMatrix

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

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

toJSON

toJSON(meta?): any
Convert the object to three.js JSON Object/Scene format.
Parameters
- Optionalmeta: {
      geometries: any;
      materials: any;
      textures: any;
      images: any;
  }
  Object containing metadata such as materials, textures or images for the object.
  - geometries: any
  - materials: any
  - textures: any
  - images: any
Returns any
Inherited from Mesh.toJSON

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

copy

copy(object, recursive?): this
Copies the given object into this object.
Parameters
- object: Object3D<Object3DEventMap>
- Optionalrecursive: boolean
  If set to true, descendants of the object are copied next to the existing ones. If set to false, descendants are left unchanged. Default is true.
Returns this
Remarks
Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

Inherited from Mesh.copy

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends keyof Object3DEventMap
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<Object3DEventMap[T], T, BatchedMesh>
  The function that gets called when the event is fired.
Returns void
Inherited from Mesh.addEventListener
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, BatchedMesh>
Returns void
Inherited from Mesh.addEventListener

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof Object3DEventMap
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<Object3DEventMap[T], T, BatchedMesh>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Mesh.hasEventListener
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, BatchedMesh>
Returns boolean
Inherited from Mesh.hasEventListener

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends keyof Object3DEventMap
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<Object3DEventMap[T], T, BatchedMesh>
  The listener function that gets removed.
Returns void
Inherited from Mesh.removeEventListener
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, BatchedMesh>
Returns void
Inherited from Mesh.removeEventListener

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends keyof Object3DEventMap
Parameters
- event: BaseEvent<T> & Object3DEventMap[T]
  The event that gets fired.
Returns void
Inherited from Mesh.dispatchEvent

Class BatchedMesh

Example

Also

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BatchedMesh

Properties

StaticDEFAULT_UP

Default Value

StaticDEFAULT_MATRIX_AUTO_UPDATE

Default Value

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

Default Value

boundingBox

Default

boundingSphere

Default

customSort

perObjectFrustumCulled

Default

sortObjects

Default

isBatchedMesh

ReadonlyisMesh

Remarks

Default Value

Readonlytype

Default Value

geometry

Default Value

material

Default Value

OptionalmorphTargetInfluences

Default Value

OptionalmorphTargetDictionary

Default Value

ReadonlyisObject3D

Remarks

Default Value

Readonlyid

Remarks

uuid

Remarks

name

Remarks

Default Value

parent

Remarks

Default Value

children

See

Default Value

up

Default Value

Readonlyposition

Default Value

Readonlyrotation

Default Value

Readonlyquaternion

Default Value

Readonlyscale

Default Value

ReadonlymodelViewMatrix

Default Value

ReadonlynormalMatrix

Default Value

matrix

Default Value

matrixWorld

Remarks

Default Value

matrixAutoUpdate

Default Value

`Static`DEFAULT_UP

`Static`DEFAULT_MATRIX_AUTO_UPDATE

`Static`DEFAULT_MATRIX_WORLD_AUTO_UPDATE

`Readonly`isMesh

`Readonly`type

`Optional`morphTargetInfluences

`Optional`morphTargetDictionary

`Readonly`isObject3D

`Readonly`id

`Readonly`position

`Readonly`rotation

`Readonly`quaternion

`Readonly`scale

`Readonly`modelViewMatrix

`Readonly`normalMatrix

`Optional`customDepthMaterial

`Optional`customDistanceMaterial