Class LineProxy<TContainer>`Abstract`

A proxy for line-segment geometry, raycasting and projecting against its edges rather than triangles.

Type Parameters

TContainer extends BaseContainer = BaseContainer

Hierarchy (View Summary)

BaseProxy<TContainer>
- LineProxy
  - BatchedLineProxy
  - InstancedWideLineProxy

Constructors

constructor

new LineProxy<
    TContainer extends
        BaseContainer<Material<MaterialEventMap>> = BaseContainer<
        Material<MaterialEventMap>,
    >,
>(
    container: TContainer,
    proxyId: number,
    srcGeometryUuid: string,
): LineProxy<TContainer>
Type Parameters
- TContainer extends BaseContainer<Material<MaterialEventMap>> = BaseContainer<Material<MaterialEventMap>>
Parameters
- container: TContainer
- proxyId: number
- srcGeometryUuid: string
Returns LineProxy<TContainer>
Inherited from BaseProxy.constructor
- 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
Inherited from BaseProxy.belongsToContainer
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseProxy.ts:48

getActive

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

getDiffuseColor

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

getEmissiveColor

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

getMaterial

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

getMetalness

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

getOpacity

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

getRoughness

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

getVisible

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

Class LineProxy<TContainer>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

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

projectPointOnEdges

Parameters

Returns boolean

raycast

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

Class LineProxy<TContainer>`Abstract`

`Protected` `Readonly`container

`Readonly`geometry

`Readonly`srcGeometryUuid