Documentation / @ripl/vue-3d / RiplContext3DProps
Interface: RiplContext3DProps ​
Defined in: vue-3d/src/types.ts:20
Props accepted by RiplContext3D.
Extends ​
Properties ​
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
ambientIntensity? | number | Intensity of the default rig's ambient light. Defaults to 0.3. | - | vue-3d/src/types.ts:42 |
context? | Context3D | An existing 3D context to draw into instead of creating one. | - | vue-3d/src/types.ts:22 |
dragThreshold? | number | Minimum pointer movement, in pixels, before a drag gesture is recognised. Defaults to 3. | - | vue-3d/src/types.ts:26 |
far? | number | The distance to the far clipping plane. Defaults to 1000. | - | vue-3d/src/types.ts:34 |
fog? | Fog | Atmospheric haze blending distant geometry towards a colour. | - | vue-3d/src/types.ts:44 |
fov? | number | The vertical field of view, in degrees. Defaults to 60. | - | vue-3d/src/types.ts:30 |
interactive? | boolean | Whether the context listens for and emits pointer and drag events. Defaults to true. | - | vue-3d/src/types.ts:24 |
lightDirection? | Vector3 | The directional light vector used by the default lighting rig. | - | vue-3d/src/types.ts:36 |
lightMode? | LightMode | Whether the default rig's light is fixed in world space or follows the camera. Defaults to world. | - | vue-3d/src/types.ts:38 |
lights? | Light[] | The lights illuminating the scene, replacing the default ambient-plus-directional rig. | - | vue-3d/src/types.ts:40 |
meta? | Record<string, unknown> | Arbitrary metadata attached to the context. | - | vue-3d/src/types.ts:28 |
near? | number | The distance to the near clipping plane. Defaults to 0.1. | - | vue-3d/src/types.ts:32 |
onClick? | RiplListener<RiplPointerPayload> | Fired when the pointer is pressed and released without an intervening drag. | RiplPointerListeners.onClick | vue/src/types.ts:54 |
onDrag? | RiplListener<RiplDragPayload> | Fired on each pointer move during a drag gesture. | RiplPointerListeners.onDrag | vue/src/types.ts:68 |
onDragend? | RiplListener<RiplDragPayload> | Fired when a drag gesture ends. | RiplPointerListeners.onDragend | vue/src/types.ts:70 |
onDragstart? | RiplListener<RiplDragPayload> | Fired once the pointer has moved past the drag threshold with the button held. | RiplPointerListeners.onDragstart | vue/src/types.ts:66 |
onMousedown? | RiplListener<RiplPointerPayload> | Fired when the pointer is pressed down. | RiplPointerListeners.onMousedown | vue/src/types.ts:56 |
onMouseenter? | RiplListener<null> | Fired when the pointer enters. | RiplPointerListeners.onMouseenter | vue/src/types.ts:62 |
onMouseleave? | RiplListener<null> | Fired when the pointer leaves. | RiplPointerListeners.onMouseleave | vue/src/types.ts:64 |
onMousemove? | RiplListener<RiplPointerPayload> | Fired as the pointer moves. | RiplPointerListeners.onMousemove | vue/src/types.ts:60 |
onMouseup? | RiplListener<RiplPointerPayload> | Fired when the pointer is released. | RiplPointerListeners.onMouseup | vue/src/types.ts:58 |
onReady? | (context) => void | Fired once the context exists and its host element is in the document. | - | vue-3d/src/types.ts:46 |
onRender? | () => void | Fired when the context requests a repaint that no element change triggered. | - | vue-3d/src/types.ts:50 |
onResize? | () => void | Fired when the context's surface is resized. | - | vue-3d/src/types.ts:48 |