Class BatchedLineProxy

A line-segment proxy handle into a BatchedLineContainer.

Hierarchy (View Summary)

LineProxy<BatchedLineContainer>
- BatchedLineProxy

Constructors

constructor

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

Properties

`Protected` `Readonly`container

container: BatchedLineContainer

`Readonly`geometry

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

`Readonly`isBatchedLineProxy

isBatchedLineProxy: true

`Readonly`srcGeometryUuid

srcGeometryUuid: string

Methods

belongsToContainer

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

getActive

getActive(): boolean
Returns boolean
Inherited from LineProxy.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 LineProxy.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 LineProxy.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 LineProxy.getDeepGeometry
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:155

getDiffuseColor

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

getEmissiveColor

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

getMaterial

getMaterial(): MaterialType
Returns MaterialType
Inherited from LineProxy.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 LineProxy.getMatrix
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:87

getMetalness

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

getOpacity

getOpacity(): number
Returns number
Inherited from LineProxy.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 LineProxy.getPosition
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:79

getRoughness

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

getVisible

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

projectPointOnEdges

projectPointOnEdges(
    point: Vector3,
    target: Vector3,
    maxEdgeDistance?: number,
): boolean
Projects the given point on the edge geometry of the line proxy.
Parameters
- point: Vector3
- target: Vector3
- maxEdgeDistance: number = 0.3
  The maximum distance between the point and its projection
Returns boolean
Inherited from LineProxy.projectPointOnEdges
- Defined in packages/viewer/src/scene/geometry/containers/base/LineProxy.ts:61

raycast

raycast(
    raycaster: Raycaster,
    intersections: ProxyIntersection[],
    marginError?: number,
): void
Parameters
- raycaster: Raycaster
- intersections: ProxyIntersection[]
- marginError: number = 0.05
Returns void
Inherited from LineProxy.raycast
- Defined in packages/viewer/src/scene/geometry/containers/base/LineProxy.ts:24

setActive

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