Skip to main content

Class: SceneOptions

Defined in: src/context/scene/SceneOptions.ts:28

Constructors

Constructor

new SceneOptions(options?): SceneOptions

Defined in: src/context/scene/SceneOptions.ts:34

Parameters

options?
enable?

() => SceneOptions

enabled?

boolean = false

enableSetOfMark?

() => SceneOptions

enableVisibleObjects?

() => SceneOptions

pollingIntervalMs?

number = 3000

som?

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

som.enable?

() => SceneSetOfMarkOptions

som.enabled?

boolean = false

visibleObjects?

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

visibleObjects.enable?

() => SceneVisibilityOptions

visibleObjects.enabled?

boolean = false

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

SceneOptions

Properties

enabled

enabled: boolean = false

Defined in: src/context/scene/SceneOptions.ts:29


pollingIntervalMs

pollingIntervalMs: number = 3000

Defined in: src/context/scene/SceneOptions.ts:30


som

som: SceneSetOfMarkOptions

Defined in: src/context/scene/SceneOptions.ts:32


visibleObjects

visibleObjects: SceneVisibilityOptions

Defined in: src/context/scene/SceneOptions.ts:31

Methods

enable()

enable(): SceneOptions

Defined in: src/context/scene/SceneOptions.ts:40

Returns

SceneOptions


enableSetOfMark()

enableSetOfMark(): SceneOptions

Defined in: src/context/scene/SceneOptions.ts:51

Returns

SceneOptions


enableVisibleObjects()

enableVisibleObjects(): SceneOptions

Defined in: src/context/scene/SceneOptions.ts:45

Returns

SceneOptions