Skip to main content

Interface: BabylonInteractionsOptions

Defined in: babylon-interactions/src/host.ts:28

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
attachToScene?booleanDrive update(dt) from scene.onBeforeRenderObservable, using the engine's frame delta in seconds. Default false - the app calls update from its own loop.-babylon-interactions/src/host.ts:37
camera?BabylonCameraLike | nullHead pose camera. Defaults to scene.activeCamera.BabylonProviderOptions.camerababylon-interactions/src/provider.ts:56
defaultRadius?numberTargeting radius for a node registered without one. Default 0.1 m.BabylonHitTesterOptions.defaultRadiusbabylon-interactions/src/hit-tester.ts:46
desktopGripDistance?numberMetres along the pointer ray at which the desktop fallback places its synthetic grip pose. Default 1 metre, matching the three.js adapter, so grab, hinge, dial and slide follow the cursor on desktop. Set it near the distance of the things being manipulated; at 0 the grip sits on the camera and a mouse drag reports camera motion only.BabylonProviderOptions.desktopGripDistancebabylon-interactions/src/provider.ts:64
dwellDefaults?DwellConfig--babylon-interactions/src/host.ts:31
maxRayDistance?numberRay length handed to pickWithRay, in metres. Default 100.BabylonHitTesterOptions.maxRayDistancebabylon-interactions/src/hit-tester.ts:48
pickWithRay?BabylonPickWithRayOptional mesh-accurate pick. Absent, the sphere test is used.BabylonHitTesterOptions.pickWithRaybabylon-interactions/src/hit-tester.ts:50
sceneBabylonSceneLikeThe scene. Supplies the pointer fallback, the camera and the engine.BabylonProviderOptions.scenebabylon-interactions/src/provider.ts:54
xr?BabylonXRExperienceLike | nullThe WebXRDefaultExperience (or anything with the same surface). Omit it, or pass null, for a desktop-only app: the provider then only ever reports the scene pointer.BabylonProviderOptions.xrbabylon-interactions/src/provider.ts:52