Class BatchedMesh

Hierarchy

(Anonymous class)<
    BatchedGeometry,
    BatchedMaterial,
    {
        prototype: Mesh<any, any, any>;
        new (
            geometry?: BatchedGeometry,
            material?: BatchedMeshStandardMaterial,
        ): Mesh<BatchedGeometry, BatchedMeshStandardMaterial, Object3DEventMap>;
    },
    this,
> & Mesh<
    BatchedGeometry,
    BatchedMeshStandardMaterial,
    Object3DEventMap,
    this,
>
- BatchedMesh

Constructors

constructor

new BatchedMesh(
geometry?: BatchedGeometry,
material?: BatchedMeshStandardMaterial,
): BatchedMesh
Create a new instance of Mesh
Parameters
- Optionalgeometry: BatchedGeometry
  An instance of THREE.BufferGeometry | BufferGeometry. Default THREE.BufferGeometry | new THREE.BufferGeometry().
- Optionalmaterial: BatchedMeshStandardMaterial
  A single or an array of THREE.Material | Material. Default THREE.MeshBasicMaterial | new THREE.MeshBasicMaterial().
Returns BatchedMesh
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).constructor
- Defined in node_modules/@types/three/src/objects/Mesh.d.ts:40

Properties

_active

_active: boolean[]

_activeChanged

_activeChanged: boolean = true

_colorsTexture

_colorsTexture: null

_indirectTexture

_indirectTexture: DataTexture

_lastGeometryCount

_lastGeometryCount: number

_multiDrawCount

_multiDrawCount: number

_multiDrawCounts

_multiDrawCounts: Int32Array

_multiDrawInstances

_multiDrawInstances: null

Called internally by three.js Behavior of THREE.BatchedMesh Both have to be set to null The texture has a size of 0

_multiDrawStarts

_multiDrawStarts: Int32Array

_visibility

_visibility: boolean[]

_visibilityChanged

_visibilityChanged: boolean = true

count

count: number

customSort

customSort: null | CustomSortFunction = null

geometry

geometry: BatchedGeometry

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

Default Value

THREE.BufferGeometry | new THREE.BufferGeometry().

`Readonly`isBatchedMesh

isBatchedMesh: true

Called internally by three.js Behavior of THREE.BatchedMesh

material

material: BatchedMaterial & BatchedMeshStandardMaterial

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

perObjectFrustumCulled

perObjectFrustumCulled: boolean = false

sortObjects

sortObjects: boolean = false

type

type: string = 'Mesh'

A Read-only string to check this object type.

Remarks

This can be used to find a specific type of Object3D in a scene. Sub-classes will update this value.

Default Value

Object3D

Accessors

_matricesTexture

get _matricesTexture(): DataTexture
DO NOT REMOVE THIS FUNCTION

Called internally by three.js to send the matrices texture to the GPU as we replicate the behavior of THREE.BatchedMesh

Returns DataTexture
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, )._matricesTexture
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:124

Methods

_initIndirectTexture

_initIndirectTexture(): DataTexture
Store the instance id for each draw call Not used by us but by three.js, so we must keep the initialization of the texture

Returns DataTexture
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, )._initIndirectTexture
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:270

getActiveAt

getActiveAt(geometryId: number): boolean
Parameters
- geometryId: number
Returns boolean
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).getActiveAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:154

getDiffuseColorAt

getDiffuseColorAt(geometryId: number): ColorRepresentation
Parameters
- geometryId: number
Returns ColorRepresentation
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).getDiffuseColorAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:175

getEmissiveColorAt

getEmissiveColorAt(geometryId: number): ColorRepresentation
Parameters
- geometryId: number
Returns ColorRepresentation
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).getEmissiveColorAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:194

getMetalnessAt

getMetalnessAt(geometryId: number): number
Parameters
- geometryId: number
Returns number
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).getMetalnessAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:228

getOpacityAt

getOpacityAt(geometryId: number): number
Parameters
- geometryId: number
Returns number
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).getOpacityAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:211

getRoughnessAt

getRoughnessAt(geometryId: number): number
Parameters
- geometryId: number
Returns number
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).getRoughnessAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:245

getVisibleAt

getVisibleAt(geometryId: number): boolean
Parameters
- geometryId: number
Returns boolean
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).getVisibleAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:140

onObjectBeforeRender

onObjectBeforeRender(
    renderer: WebGLRenderer,
    _scene: Scene,
    camera: Camera,
    _geometry: BufferGeometry<NormalBufferAttributes>,
    material: Material,
    _group: Group,
): void
Parameters
- renderer: WebGLRenderer
- _scene: Scene
- camera: Camera
- _geometry: BufferGeometry<NormalBufferAttributes>
- material: Material
- _group: Group
Returns void
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).onObjectBeforeRender
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:277

setActiveAt

setActiveAt(geometryId: number, value: boolean): void
Parameters
- geometryId: number
- value: boolean
Returns void
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).setActiveAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:146

setAllDiffuseColor

setAllDiffuseColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).setAllDiffuseColor
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:167

setAllVisibility

setAllVisibility(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).setAllVisibility
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:128

setCustomSort

setCustomSort(func: null | CustomSortFunction): BatchedMesh
Parameters
- func: null | CustomSortFunction
Returns BatchedMesh
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).setCustomSort
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:108

setDiffuseColorAt

setDiffuseColorAt(geometryId: number, color: ColorRepresentation): void
Parameters
- geometryId: number
- color: ColorRepresentation
Returns void
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).setDiffuseColorAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:160

setEmissiveColorAt

setEmissiveColorAt(geometryId: number, color: ColorRepresentation): void
Parameters
- geometryId: number
- color: ColorRepresentation
Returns void
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).setEmissiveColorAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:187

setMetalnessAt

setMetalnessAt(geometryId: number, value: number): void
Parameters
- geometryId: number
- value: number
Returns void
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).setMetalnessAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:223

setOpacityAt

setOpacityAt(geometryId: number, value: number): void
Parameters
- geometryId: number
- value: number
Returns void
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).setOpacityAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:206

setRoughnessAt

setRoughnessAt(geometryId: number, value: number): void
Parameters
- geometryId: number
- value: number
Returns void
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).setRoughnessAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:240

setVisibleAt

setVisibleAt(geometryId: number, value: boolean): void
Parameters
- geometryId: number
- value: boolean
Returns void
Inherited from BatchedObjectMixin( Mesh<BatchedGeometry, BatchedMeshStandardMaterial>, ).setVisibleAt
- Defined in src/viewer/core/objects/batching/BatchedObjects.ts:132

Class BatchedMesh

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BatchedMesh

Properties

_active

_activeChanged

_colorsTexture

_indirectTexture

_lastGeometryCount

_multiDrawCount

_multiDrawCounts

_multiDrawInstances

_multiDrawStarts

_visibility

_visibilityChanged

count

customSort

geometry

Default Value

ReadonlyisBatchedMesh

material

Default Value

perObjectFrustumCulled

sortObjects

type

Remarks

Default Value

Accessors

_matricesTexture

Returns DataTexture

Methods

_initIndirectTexture

Returns DataTexture

getActiveAt

Parameters

Returns boolean

getDiffuseColorAt

Parameters

Returns ColorRepresentation

getEmissiveColorAt

Parameters

Returns ColorRepresentation

getMetalnessAt

Parameters

Returns number

getOpacityAt

Parameters

Returns number

getRoughnessAt

Parameters

Returns number

getVisibleAt

Parameters

Returns boolean

onObjectBeforeRender

Parameters

Returns void

setActiveAt

Parameters

Returns void

setAllDiffuseColor

Parameters

Returns void

setAllVisibility

Parameters

Returns void

setCustomSort

Parameters

Returns BatchedMesh

setDiffuseColorAt

Parameters

Returns void

`Readonly`isBatchedMesh