Skip to main content

Class: ContextOptions

Defined in: src/context/ContextOptions.ts:12

Constructors​

Constructor​

new ContextOptions(options?): ContextOptions

Defined in: src/context/ContextOptions.ts:17

Parameters​

options?​
debugging?​

boolean = false

enable?​

() => ContextOptions

enabled?​

boolean = false

enableScene?​

() => ContextOptions

enableSetOfMark?​

() => ContextOptions

enableVisibleObjects?​

() => ContextOptions

scene?​

{ enable?: () => SceneOptions; enabled?: boolean; enableSetOfMark?: () => SceneOptions; enableVisibleObjects?: () => SceneOptions; pollingIntervalMs?: number; som?: { enable?: () => SceneSetOfMarkOptions; enabled?: boolean; }; visibleObjects?: { enable?: () => SceneVisibilityOptions; enabled?: boolean; occlusionOpacityThreshold?: number; }; } = ...

scene.enable?​

() => SceneOptions

scene.enabled?​

boolean = false

scene.enableSetOfMark?​

() => SceneOptions

scene.enableVisibleObjects?​

() => SceneOptions

scene.pollingIntervalMs?​

number = 3000

scene.som?​

{ enable?: () => SceneSetOfMarkOptions; enabled?: boolean; } = ...

scene.som.enable?​

() => SceneSetOfMarkOptions

scene.som.enabled?​

boolean = false

scene.visibleObjects?​

{ enable?: () => SceneVisibilityOptions; enabled?: boolean; occlusionOpacityThreshold?: number; } = ...

scene.visibleObjects.enable?​

() => SceneVisibilityOptions

scene.visibleObjects.enabled?​

boolean = false

scene.visibleObjects.occlusionOpacityThreshold?​

number = 0

Raycast hits on materials with effective opacity less than or equal to this threshold are ignored for line-of-sight occlusion.

Returns​

ContextOptions

Properties​

debugging​

debugging: boolean = false

Defined in: src/context/ContextOptions.ts:13

enabled​

enabled: boolean = false

Defined in: src/context/ContextOptions.ts:14

scene​

scene: SceneOptions

Defined in: src/context/ContextOptions.ts:15

Methods​

enable()​

enable(): ContextOptions

Defined in: src/context/ContextOptions.ts:23

Returns​

ContextOptions

enableScene()​

enableScene(): ContextOptions

Defined in: src/context/ContextOptions.ts:31

Returns​

ContextOptions

enableSetOfMark()​

enableSetOfMark(): ContextOptions

Defined in: src/context/ContextOptions.ts:43

Returns​

ContextOptions

enableVisibleObjects()​

enableVisibleObjects(): ContextOptions

Defined in: src/context/ContextOptions.ts:37

Returns​

ContextOptions