Skip to main content

Class: WorldOptions

Defined in: src/world/WorldOptions.ts:8

Constructors​

Constructor​

new WorldOptions(options?): WorldOptions

Defined in: src/world/WorldOptions.ts:16

Parameters​

options?​
debugging?​

boolean = false

enabled?​

boolean = false

enableMeshDetection?​

() => WorldOptions

enableObjectDetection?​

() => WorldOptions

enablePlaneDetection?​

() => WorldOptions

initiateRoomCapture?​

boolean = false

meshes?​

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

meshes.enable?​

() => MeshDetectionOptions

meshes.enabled?​

boolean = false

meshes.showDebugVisualizations?​

boolean = false

objects?​

{ backendConfig?: { activeBackend?: "gemini" | "mediapipe"; gemini?: { responseSchema?: { items?: ... | ...; type?: ... | ...; }; systemInstruction?: string; }; mediapipe?: { }; }; debugging?: boolean; enable?: () => ObjectsOptions; enabled?: boolean; objectImageMargin?: number; showDebugVisualizations?: boolean; } = ...

objects.backendConfig?​

{ activeBackend?: "gemini" | "mediapipe"; gemini?: { responseSchema?: { items?: ... | ...; type?: ... | ...; }; systemInstruction?: string; }; mediapipe?: { }; } = ...

Configuration for the detection backends.

objects.backendConfig.activeBackend?​

"gemini" | "mediapipe" = ...

The active backend to use for detection.

objects.backendConfig.gemini?​

{ responseSchema?: { items?: ... | ...; type?: ... | ...; }; systemInstruction?: string; } = ...

objects.backendConfig.gemini.responseSchema?​

{ items?: ... | ...; type?: ... | ...; } = ...

objects.backendConfig.gemini.responseSchema.items?​

... | ... = ...

objects.backendConfig.gemini.responseSchema.type?​

... | ... = 'ARRAY'

objects.backendConfig.gemini.systemInstruction?​

string = ...

objects.backendConfig.mediapipe?​

{ } = {}

Placeholder for a future MediaPipe backend configuration.

objects.debugging?​

boolean = false

objects.enable?​

() => ObjectsOptions

objects.enabled?​

boolean = false

objects.objectImageMargin?​

number = 0.05

Margin to add when cropping the object image, as a percentage of image size.

objects.showDebugVisualizations?​

boolean = false

planes?​

{ debugging?: boolean; enable?: () => PlanesOptions; enabled?: boolean; showDebugVisualizations?: boolean; } = ...

planes.debugging?​

boolean = false

planes.enable?​

() => PlanesOptions

planes.enabled?​

boolean = false

planes.showDebugVisualizations?​

boolean = false

Returns​

WorldOptions

Properties​

debugging​

debugging: boolean = false

Defined in: src/world/WorldOptions.ts:9

enabled​

enabled: boolean = false

Defined in: src/world/WorldOptions.ts:10

initiateRoomCapture​

initiateRoomCapture: boolean = false

Defined in: src/world/WorldOptions.ts:11

meshes​

meshes: MeshDetectionOptions

Defined in: src/world/WorldOptions.ts:14

objects​

objects: ObjectsOptions

Defined in: src/world/WorldOptions.ts:13

planes​

planes: PlanesOptions

Defined in: src/world/WorldOptions.ts:12

Methods​

enableMeshDetection()​

enableMeshDetection(): WorldOptions

Defined in: src/world/WorldOptions.ts:43

Enables mesh detection.

Returns​

WorldOptions

enableObjectDetection()​

enableObjectDetection(): WorldOptions

Defined in: src/world/WorldOptions.ts:34

Enables object detection.

Returns​

WorldOptions

enablePlaneDetection()​

enablePlaneDetection(): WorldOptions

Defined in: src/world/WorldOptions.ts:25

Enables plane detection.

Returns​

WorldOptions