Class InstancedMeshProxy

A mesh proxy handle into an InstancedMeshContainer.

Hierarchy (View Summary)

MeshProxy<InstancedMeshContainer<InstancedBasicMaterial>>
- InstancedMeshProxy

Constructors

constructor

new InstancedMeshProxy(
    container: InstancedMeshContainer,
    proxyId: number,
    srcGeometryUuid: string,
): InstancedMeshProxy
Parameters
- container: InstancedMeshContainer
- proxyId: number
- srcGeometryUuid: string
Returns InstancedMeshProxy
Inherited from MeshProxy.constructor
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:41

Properties

`Protected` `Readonly`container

container: InstancedMeshContainer

`Readonly`geometry

geometry: BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap> = ...

`Readonly`isInstancedMeshProxy

isInstancedMeshProxy: true

`Readonly`srcGeometryUuid

srcGeometryUuid: string

Accessors

triangleCount

get triangleCount(): number
Returns number
Inherited from MeshProxy.triangleCount
- Defined in packages/viewer/src/scene/geometry/containers/base/MeshProxy.ts:41

Methods

belongsToContainer

belongsToContainer(container: InstancedMeshContainer): boolean
Parameters
- container: InstancedMeshContainer
Returns boolean
Inherited from MeshProxy.belongsToContainer
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:48

getActive

getActive(): boolean
Returns boolean
Inherited from MeshProxy.getActive
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:151

getBoundingBox

getBoundingBox(target: Box3): Box3
Parameters
- target: Box3
Returns Box3
Inherited from MeshProxy.getBoundingBox
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:91

getBoundingSphere

getBoundingSphere(target: Sphere): Sphere
Parameters
- target: Sphere
Returns Sphere
Inherited from MeshProxy.getBoundingSphere
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:95

getDeepGeometry

getDeepGeometry(target: BufferGeometry): BufferGeometry
Parameters
- target: BufferGeometry
Returns BufferGeometry
Inherited from MeshProxy.getDeepGeometry
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:155

getDiffuseColor

getDiffuseColor(): ColorRepresentation
Returns ColorRepresentation
Inherited from MeshProxy.getDiffuseColor
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:127

getEmissiveColor

getEmissiveColor(): ColorRepresentation
Returns ColorRepresentation
Inherited from MeshProxy.getEmissiveColor
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:135

getGeometryBVH

getGeometryBVH(): MeshBVH | null
Returns the immutable collision acceleration structure registered for this geometry.

Returns MeshBVH | null
Inherited from MeshProxy.getGeometryBVH
- Defined in packages/viewer/src/scene/geometry/containers/base/MeshProxy.ts:49

getMaterial

getMaterial(): MaterialType
Returns MaterialType
Inherited from MeshProxy.getMaterial
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:71

getMatrix

getMatrix(matrix: Matrix4): Matrix4
Parameters
- matrix: Matrix4
Returns Matrix4
Inherited from MeshProxy.getMatrix
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:87

getMetalness

getMetalness(): number
Returns number
Inherited from MeshProxy.getMetalness
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:111

getOpacity

getOpacity(): number
Returns number
Inherited from MeshProxy.getOpacity
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:119

getPosition

getPosition(target: Vector3): Vector3
Parameters
- target: Vector3
Returns Vector3
Inherited from MeshProxy.getPosition
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:79

getRoughness

getRoughness(): number
Returns number
Inherited from MeshProxy.getRoughness
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:143

getVisible

getVisible(): boolean
Returns boolean
Inherited from MeshProxy.getVisible
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:103

raycast

raycast(raycaster: Raycaster, intersections: ProxyIntersection[]): void
Parameters
- raycaster: Raycaster
- intersections: ProxyIntersection[]
Returns void
Inherited from MeshProxy.raycast
- Defined in packages/viewer/src/scene/geometry/containers/base/MeshProxy.ts:53

setActive

setActive(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from MeshProxy.setActive
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:147

setDiffuseColor

setDiffuseColor(value: ColorRepresentation): void
Parameters
- value: ColorRepresentation
Returns void
Inherited from MeshProxy.setDiffuseColor
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:123

setEmissiveColor

setEmissiveColor(value: ColorRepresentation): void
Parameters
- value: ColorRepresentation
Returns void
Inherited from MeshProxy.setEmissiveColor
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:131

setMaterial

setMaterial(materialType: MaterialType): void
Parameters
- materialType: MaterialType
Returns void
Inherited from MeshProxy.setMaterial
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:67

setMatrix

setMatrix(matrix: Matrix4): Matrix4
Parameters
- matrix: Matrix4
Returns Matrix4
Inherited from MeshProxy.setMatrix
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:83

setMetalness

setMetalness(value: number): void
Parameters
- value: number
Returns void
Inherited from MeshProxy.setMetalness
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:107

setOpacity

setOpacity(value: number): void
Parameters
- value: number
Returns void
Inherited from MeshProxy.setOpacity
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:115

setPosition

setPosition(position: Vector3): Vector3
Parameters
- position: Vector3
Returns Vector3
Inherited from MeshProxy.setPosition
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:75

setRoughness

setRoughness(value: number): void
Parameters
- value: number
Returns void
Inherited from MeshProxy.setRoughness
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:139

setVisible

setVisible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from MeshProxy.setVisible
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:99

showBoundingBoxHelper

showBoundingBoxHelper(helperGroup: Group, value: boolean): void
Parameters
- helperGroup: Group
- value: boolean
Returns void
Inherited from MeshProxy.showBoundingBoxHelper
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:54

showNormalsHelper

showNormalsHelper(helperGroup: Group, value: boolean): void
Parameters
- helperGroup: Group
- value: boolean
Returns void
Inherited from MeshProxy.showNormalsHelper
- Defined in packages/viewer/src/scene/geometry/containers/base/MeshProxy.ts:25