UNPKG

@react-three/xr

Version:

VR/AR for react-three-fiber

github.com/pmndrs/xr

pmndrs/xr

133 lines (132 loc) • 8.93 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
import { DefaultXRControllerOptions, DefaultXRGazeOptions, DefaultXRHandOptions, DefaultXRHandTouchPointerOptions, DefaultXRInputSourceGrabPointerOptions, DefaultXRInputSourceRayPointerOptions, DefaultXRInputSourceTeleportPointerOptions, DefaultXRScreenInputOptions, DefaultXRTransientPointerOptions } from '@pmndrs/xr/internals'; import { ReactNode } from 'react'; export { defaultGrabPointerOpacity, defaultRayPointerOpacity, defaultTouchPointerOpacity, type DefaultXRControllerOptions, type DefaultXRGazeOptions, type DefaultXRHandOptions, type DefaultXRHandTouchPointerOptions, type DefaultXRInputSourceGrabPointerOptions, type DefaultXRInputSourceRayPointerOptions, type DefaultXRScreenInputOptions, type DefaultXRTransientPointerOptions, } from '@pmndrs/xr/internals'; /** * Grab pointer for the XRHand * * @param {DefaultXRInputSourceGrabPointerOptions} props * #### `clickThresholdMs` - Time in milliseconds between `pointerdown` and `pointerup` to trigger a click event * #### `dblClickThresholdMs` - Time in milliseconds between the first click and the second click to trigger a `dblclick` event * #### `contextMenuButton` - The button that triggers context menu events * #### `makeDefault` - Used the set the default pointer inside a combined pointer * #### `cursorModel` - Properties for configuring how the cursor should look * #### `radius` - The size of the intersection sphere * #### `customSort` - Overrides the default sort function to use for sorting the intersection results */ export declare const DefaultXRHandGrabPointer: (props: DefaultXRInputSourceGrabPointerOptions) => ReactNode; /** * Grab pointer for the XRController * * @param {DefaultXRInputSourceGrabPointerOptions} props * #### `clickThresholdMs` - Time in milliseconds between `pointerdown` and `pointerup` to trigger a click event * #### `dblClickThresholdMs` - Time in milliseconds between the first click and the second click to trigger a `dblclick` event * #### `contextMenuButton` - The button that triggers context menu events * #### `makeDefault` - Used the set the default pointer inside a combined pointer * #### `cursorModel` - Properties for configuring how the cursor should look * #### `radius` - The size of the intersection sphere * #### `customSort` - Overrides the default sort function to use for sorting the intersection results */ export declare const DefaultXRControllerGrabPointer: (props: DefaultXRInputSourceGrabPointerOptions) => ReactNode; /** * Ray pointer for the XRInputSource * * @param {DefaultXRInputSourceRayPointerOptions} props * #### `clickThresholdMs` - Time in milliseconds between pointerdown and pointerup to trigger a click event * #### `dblClickThresholdMs` - Time in milliseconds between the first click and the second click to trigger a dblclick event * #### `contextMenuButton` - The button that triggers contextmenu events * #### `makeDefault` - Used the set the default pointer inside a combined pointer * #### `radius` - The size of the intersection sphere * #### `minDistance` - Minimal distance to trigger interactions * #### `linePoints` - The points thay make up the shape of the ray if undefined the ray goes in a straight line * #### `direction` - The direction of the ray * #### `rayModel` - Properties for configuring how the ray should look * #### `cursorModel` - Properties for configuring how the cursor should look */ export declare function DefaultXRInputSourceRayPointer(props: DefaultXRInputSourceRayPointerOptions): import("react/jsx-runtime").JSX.Element; /** * Touch pointer for the XRHand * * @param {DefaultXRHandTouchPointerOptions} props * #### `clickThresholdMs` - Time in milliseconds between `pointerdown` and `pointerup` to trigger a click event * #### `dblClickThresholdMs` - Time in milliseconds between the first click and the second click to trigger a `dblclick` event * #### `contextMenuButton` - The button that triggers context menu events * #### `makeDefault` - Used the set the default pointer inside a combined pointer * #### `cursorModel` - Properties for configuring how the cursor should look * #### `hoverRadius` - The size of the intersection sphere * #### `downRadius` - The distance to the touch center to trigger a `pointerdown` event * #### `button` - The id of the button that is triggered when touching */ export declare function DefaultXRHandTouchPointer(props: DefaultXRHandTouchPointerOptions): import("react/jsx-runtime").JSX.Element; /** * Default controller implementation with grab and ray pointers * * @param {DefaultXRControllerOptions} props * #### `model` - Options for configuring the controller apperance * #### `grabPointer` - Options for configuring the grab pointer * #### `rayPointer` - Options for configuring the ray pointer */ export declare function DefaultXRController(props: DefaultXRControllerOptions): import("react/jsx-runtime").JSX.Element; /** * Default hand implementation with touch, grab and ray pointers * * @param {DefaultXRHandOptions} props * #### `model` - Options for configuring the hand appearance * #### `grabPointer` - Options for configuring the grab pointer * #### `rayPointer` - Options for configuring the ray pointer * #### `touchPointer` - Options for configuring the touch pointer */ export declare function DefaultXRHand(props: DefaultXRHandOptions): import("react/jsx-runtime").JSX.Element; /** * Default transient-pointer implementation with ray pointer * * @param {DefaultXRTransientPointerOptions} props * #### `clickThresholdMs` - Time in milliseconds between `pointerdown` and `pointerup` to trigger a click event * #### `dblClickThresholdMs` - Time in milliseconds between the first click and the second click to trigger a `dblclick` event * #### `contextMenuButton` - The button that triggers context menu events * #### `minDistance` - Minimal distance to trigger interactions * #### `linePoints` - The points thay make up the shape of the ray if undefined the ray goes in a straight line * #### `direction` - The direction of the ray * #### `cursorModel` - Properties for configuring how the cursor should look */ export declare function DefaultXRTransientPointer(props: DefaultXRTransientPointerOptions): import("react/jsx-runtime").JSX.Element; /** * Default gaze implementation with ray pointer * * @param {DefaultXRGazeOptions} props * #### `clickThresholdMs` - Time in milliseconds between `pointerdown` and `pointerup` to trigger a click event * #### `dblClickThresholdMs` - Time in milliseconds between the first click and the second click to trigger a `dblclick` event * #### `contextMenuButton` - The button that triggers context menu events * #### `minDistance` - Minimal distance to trigger interactions * #### `linePoints` - The points thay make up the shape of the ray if undefined the ray goes in a straight line * #### `direction` - The direction of the ray * #### `cursorModel` - Properties for configuring how the cursor should look */ export declare function DefaultXRGaze(props: DefaultXRGazeOptions): import("react/jsx-runtime").JSX.Element; /** * Default screen-input implementation with ray pointer * * @param {DefaultXRScreenInputOptions} props * #### `clickThresholdMs` - Time in milliseconds between `pointerdown` and `pointerup` to trigger a click event * #### `dblClickThresholdMs` - Time in milliseconds between the first click and the second click to trigger a `dblclick` event * #### `contextMenuButton` - The button that triggers context menu events * #### `minDistance` - Minimal distance to trigger interactions * #### `linePoints` - The points thay make up the shape of the ray if undefined the ray goes in a straight line * #### `direction` - The direction of the ray */ export declare function DefaultXRScreenInput(props: DefaultXRScreenInputOptions): import("react/jsx-runtime").JSX.Element; /** * Telport pointer for the XRInputSource. * Emits a downward bend ray that only interesects with meshes marked as teleportable * * @param {DefaultXRInputSourceTeleportPointerOptions} props * #### `clickThresholdMs` - Time in milliseconds between `pointerdown` and `pointerup` to trigger a click event * #### `dblClickThresholdMs` - Time in milliseconds between the first click and the second click to trigger a `dblclick` event * #### `contextMenuButton` - The button that triggers context menu events * #### `makeDefault` - Used the set the default pointer inside a combined pointer * #### `radius` - The size of the intersection sphere * #### `minDistance` - Minimal distance to trigger interactions * #### `direction` - The direction of the ray * #### `rayModel` - Properties for configuring how the ray should look * #### `cursorModel` - Properties for configuring how the cursor should look */ export declare function DefaultXRInputSourceTeleportPointer(props: DefaultXRInputSourceTeleportPointerOptions): import("react/jsx-runtime").JSX.Element;