Class BaseProxy<TContainer>`Abstract`

A handle onto one logical object stored inside a BaseContainer. Holds no geometry or material state of its own: every accessor forwards to the container's indexed API using this proxy's proxyId.

Type Parameters

TContainer extends BaseContainer = BaseContainer

Hierarchy (View Summary)

BaseProxy
- LineProxy
- MeshProxy

Constructors

constructor

new BaseProxy<
    TContainer extends
        BaseContainer<Material<MaterialEventMap>> = BaseContainer<
        Material<MaterialEventMap>,
    >,
>(
    container: TContainer,
    proxyId: number,
    srcGeometryUuid: string,
): BaseProxy<TContainer>
Type Parameters
- TContainer extends BaseContainer<Material<MaterialEventMap>> = BaseContainer<Material<MaterialEventMap>>
Parameters
- container: TContainer
- proxyId: number
- srcGeometryUuid: string
Returns BaseProxy<TContainer>
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:41

Properties

`Protected` `Readonly`container

container: TContainer

`Readonly`geometry

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

`Readonly`srcGeometryUuid

srcGeometryUuid: string

Methods

belongsToContainer

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

getActive

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

getBoundingBox

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

getBoundingSphere

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

getDeepGeometry

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

getDiffuseColor

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

getEmissiveColor

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

getMaterial

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

getMatrix

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

getMetalness

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

getOpacity

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

getPosition

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

getRoughness

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

getVisible

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

`Abstract`raycast

raycast(raycast: Raycaster, intersections: ProxyIntersection[]): void
Parameters
- raycast: Raycaster
- intersections: ProxyIntersection[]
Returns void
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:52

setActive

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

setDiffuseColor

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

setEmissiveColor

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

setMaterial

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

setMatrix

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

setMetalness

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

setOpacity

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

setPosition

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

setRoughness

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

setVisible

setVisible(value: boolean): void
Parameters
- value: boolean
Returns void
- 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
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:54

Class BaseProxy<TContainer>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseProxy<TContainer>

Properties

Protected Readonlycontainer

Readonlygeometry

ReadonlysrcGeometryUuid

Methods

belongsToContainer

Parameters

Returns boolean

getActive

Returns boolean

getBoundingBox

Parameters

Returns Box3

getBoundingSphere

Parameters

Returns Sphere

getDeepGeometry

Parameters

Returns BufferGeometry

getDiffuseColor

Returns ColorRepresentation

getEmissiveColor

Returns ColorRepresentation

getMaterial

Returns MaterialType

getMatrix

Parameters

Returns Matrix4

getMetalness

Returns number

getOpacity

Returns number

getPosition

Parameters

Returns Vector3

getRoughness

Returns number

getVisible

Returns boolean

Abstractraycast

Parameters

Returns void

setActive

Parameters

Returns void

setDiffuseColor

Parameters

Returns void

setEmissiveColor

Parameters

Returns void

setMaterial

Parameters

Returns void

setMatrix

Parameters

Returns Matrix4

setMetalness

Parameters

Returns void

setOpacity

Parameters

Returns void

setPosition

Parameters

Returns Vector3

setRoughness

Parameters

Class BaseProxy<TContainer>`Abstract`

`Protected` `Readonly`container

`Readonly`geometry

`Readonly`srcGeometryUuid

`Abstract`raycast