Class: UISlider<TEventMap>
Defined in: src/ui/components/UISlider.ts:23
A horizontal slider with one exclusive captured interaction.
Extends
UIElement<TEventMap>
Type Parameters
TEventMap
TEventMap extends THREE.Object3DEventMap = THREE.Object3DEventMap
Constructors
Constructor
new UISlider<
TEventMap>(__namedParameters):UISlider<TEventMap>
Defined in: src/ui/components/UISlider.ts:39
Parameters
__namedParameters
Returns
UISlider<TEventMap>
Overrides
Properties
ariaLabel
readonlyariaLabel:string
Defined in: src/ui/components/UISlider.ts:27
isUI
readonlyisUI:true=true
Defined in: src/ui/UIElement.ts:299
Inherited from
isXRScript
isXRScript:
boolean=true
Defined in: src/core/Script.ts:99
Inherited from
name
name:
string='UISlider'
Defined in: src/ui/components/UISlider.ts:26
Optional name of the object
Remarks
(doesn't need to be unique).
Default Value
""
Overrides
UIElement.name
onChange()?
optionalonChange: (value) =>void
Defined in: src/ui/components/UISlider.ts:29
Parameters
value
number
Returns
void
onInput()?
optionalonInput: (value) =>void
Defined in: src/ui/components/UISlider.ts:28
Parameters
value
number
Returns
void
xb?
optionalxb:XBObjectOptions
Defined in: src/interaction/InteractionTypes.ts:34
Inherited from
Accessors
disabled
Get Signature
get disabled():
boolean
Defined in: src/ui/components/UISlider.ts:115
Returns
boolean
Set Signature
set disabled(
value):void
Defined in: src/ui/components/UISlider.ts:119
Parameters
value
boolean
Returns
void
max
Get Signature
get max():
number
Defined in: src/ui/components/UISlider.ts:87
Returns
number
Set Signature
set max(
value):void
Defined in: src/ui/components/UISlider.ts:91
Parameters
value
number
Returns
void
min
Get Signature
get min():
number
Defined in: src/ui/components/UISlider.ts:77
Returns
number
Set Signature
set min(
value):void
Defined in: src/ui/components/UISlider.ts:81
Parameters
value
number
Returns
void
step
Get Signature
get step():
number
Defined in: src/ui/components/UISlider.ts:97
Returns
number
Set Signature
set step(
value):void
Defined in: src/ui/components/UISlider.ts:101
Parameters
value
number
Returns
void
style
Get Signature
get style():
UIStyle
Defined in: src/ui/UIElement.ts:349
Returns
Set Signature
set style(
style):void
Defined in: src/ui/UIElement.ts:353
Parameters
style
Returns
void
Inherited from
value
Get Signature
get value():
number
Defined in: src/ui/components/UISlider.ts:107
Returns
number
Set Signature
set value(
value):void
Defined in: src/ui/components/UISlider.ts:111
Parameters
value
number
Returns
void
Methods
add()
add(...
objects):this
Defined in: src/ui/UIElement.ts:331
Adds another Object3D as child of this Object3D.
Parameters
objects
...Object3D<Object3DEventMap>[]
Returns
this
Remarks
An arbitrary number of objects may be added Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.
See
- attach
- THREE.Group | Group for info on manually grouping objects.
Inherited from
attach()
attach(
object):this
Defined in: src/ui/UIElement.ts:337
Adds a Object3D as a child of this, while maintaining the object's world transform.
Parameters
object
Returns
this
Remarks
Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).
See
Inherited from
dispose()
dispose():
void
Defined in: src/core/Script.ts:263
Called when the script is removed from the scene. Opposite of init.
Returns
void
Inherited from
getWorldPosition()
getWorldPosition(
target):Vector3
Defined in: src/ui/UIElement.ts:342
Returns a vector representing the position of the object in world space.
Parameters
target
The result will be copied into this Vector3.
Returns
Inherited from
init()
init(
_?):void|Promise<void>
Defined in: src/core/Script.ts:108
Initializes an instance with XR controllers, grips, hands, and default options. We allow all scripts to quickly access its user (e.g., user.isSelecting(), user.hands), world (e.g., physical depth mesh, lighting estimation, and recognized objects), and scene (the root of three.js's scene graph). If this returns a promise, we will wait for it.
Parameters
_?
object
Returns
void | Promise<void>
Inherited from
initPhysics()
initPhysics(
_physics):void|Promise<void>
Defined in: src/core/Script.ts:118
Enables depth-aware interactions with physics. See /samples/advanced/ballpit
Parameters
_physics
Returns
void | Promise<void>
Inherited from
markUIContentDirty()
protectedmarkUIContentDirty():void
Defined in: src/ui/UIElement.ts:369
Marks durable content for the next renderer commit.
Returns
void
Inherited from
markUIDirty()
protectedmarkUIDirty():void
Defined in: src/ui/UIElement.ts:363
Returns
void
Inherited from
markUIStructureDirty()
protectedmarkUIStructureDirty():void
Defined in: src/ui/UIElement.ts:373
Returns
void
Inherited from
UIElement.markUIStructureDirty
onHoverEnter()
onHoverEnter(
_event):void
Defined in: src/core/Script.ts:215
Called when a source starts hovering over this object.
Parameters
_event
The hover source, target, surface, and intersection.
Call event.stopPropagation() to stop bubbling to ancestor Scripts.
Returns
void
Inherited from
onHoverExit()
onHoverExit(
_event):void
Defined in: src/core/Script.ts:221
Called when a source stops hovering over this object.
Parameters
_event
The hover source, target, surface, and intersection.
Call event.stopPropagation() to stop bubbling to ancestor Scripts.
Returns
void
Inherited from
onHovering()
onHovering(
_event):void
Defined in: src/core/Script.ts:227
Called while a source hovers over this object.
Parameters
_event
The hover source, target, surface, and intersection.
Call event.stopPropagation() to stop bubbling to ancestor Scripts.
Returns
void
Inherited from
onKeyDown()
onKeyDown(
_event):void
Defined in: src/core/Script.ts:158
Called on keyboard keypress.
Parameters
_event
Event containing .code to read the keyboard key.
Returns
void
Inherited from
onKeyUp()
onKeyUp(
_event):void
Defined in: src/core/Script.ts:159
Parameters
_event
Returns
void
Inherited from
onLongSelect()
onLongSelect(
_event):void
Defined in: src/core/Script.ts:152
Called when an object selection reaches the long-select delay.
Parameters
_event
Returns
void
Inherited from
onObjectGrabbing()
onObjectGrabbing(
_event):void
Defined in: src/core/Script.ts:253
Called every frame a hand is grabbing this object.
Parameters
_event
Returns
void
Inherited from
onObjectGrabEnd()
onObjectGrabEnd(
_event):void
Defined in: src/core/Script.ts:258
Called when a hand stops grabbing this object. This ends built-in direct-touch manipulation without ending contact.
Parameters
_event
Returns
void
Inherited from
onObjectGrabStart()
onObjectGrabStart(
_event):void
Defined in: src/core/Script.ts:249
Called when a hand starts grabbing this object (touching + pinching). A grab starts built-in direct-touch manipulation when enabled.
Parameters
_event
Returns
void
Inherited from
onObjectLongSelect()
onObjectLongSelect(
_event):void
Defined in: src/core/Script.ts:203
Called once when a captured selection is held for the long-select delay. Manipulation captures do not emit this callback.
Parameters
_event
The controller and completed hold duration.
Call event.stopPropagation() to stop bubbling to ancestor Scripts.
Returns
void
Inherited from
onObjectManipulate()
onObjectManipulate(
_event):void
Defined in: src/core/Script.ts:209
Called for each phase of an automatic object manipulation. Call
event.stopPropagation() to stop bubbling. Calling preventDefault()
on a start event suppresses the automatic action.
Parameters
_event
Returns
void
Inherited from
onObjectSelectEnd()
onObjectSelectEnd(
event):void
Defined in: src/ui/components/UISlider.ts:132
Called when a source stops selecting the object this Script represents.
Parameters
event
Returns
void
Overrides
onObjectSelectStart()
onObjectSelectStart(
event):void
Defined in: src/ui/components/UISlider.ts:128
Called when a source starts selecting the object this Script represents.
Parameters
event
Returns
void
Overrides
onObjectTouchEnd()
onObjectTouchEnd(
_event):void
Defined in: src/core/Script.ts:244
Called when a hand's index finger stops touching this object. This ends the default selection lifecycle after the touch callback.
Parameters
_event
Returns
void
Inherited from
onObjectTouching()
onObjectTouching(
_event):void
Defined in: src/core/Script.ts:239
Called every frame that a hand's index finger is touching this object. The object remains selected during these frames unless touch selection was prevented when contact started.
Parameters
_event
Returns
void
Inherited from
onObjectTouchStart()
onObjectTouchStart(
_event):void
Defined in: src/core/Script.ts:233
Called when a hand's index finger starts touching this object.
Direct touch starts the object's selection lifecycle by default. Call
event.preventDefault() to handle contact without selecting.
Parameters
_event
Returns
void
Inherited from
onSelect()
onSelect(
_event):void
Defined in: src/core/Script.ts:144
Called whenever pinch / mouse click successfully completes, globally.
Parameters
_event
The interaction source and completed target.
Returns
void
Inherited from
onSelectEnd()
onSelectEnd(
_event):void
Defined in: src/core/Script.ts:138
Called whenever pinch / mouse click discontinues, globally.
Parameters
_event
The completed state and end reason.
Returns
void
Inherited from
onSelecting()
onSelecting(
_event):void
Defined in: src/core/Script.ts:149
Called whenever pinch / mouse click is happening, globally.
Parameters
_event
Returns
void
Inherited from
onSelectStart()
onSelectStart(
_event):void
Defined in: src/core/Script.ts:132
Called whenever pinch / mouse click starts, globally.
Parameters
_event
The interaction source and optional captured target.
Returns
void
Inherited from
onSimulatorStarted()
onSimulatorStarted():
void
Defined in: src/core/Script.ts:124
Returns
void
Inherited from
onSqueeze()
onSqueeze(
_event):void
Defined in: src/core/Script.ts:181
Called whenever gamepad trigger successfully completes, globally.
Parameters
_event
event.source.controller identifies the controller.
Returns
void
Inherited from
onSqueezeEnd()
onSqueezeEnd(
_event):void
Defined in: src/core/Script.ts:170
Called whenever gamepad trigger stops, globally.
Parameters
_event
event.source.controller identifies the controller.
Returns
void
Inherited from
onSqueezeStart()
onSqueezeStart(
_event):void
Defined in: src/core/Script.ts:165
Called whenever gamepad trigger starts, globally.
Parameters
_event
event.source.controller identifies the controller.
Returns
void
Inherited from
onSqueezing()
onSqueezing(
_event):void
Defined in: src/core/Script.ts:175
Called whenever gamepad is being triggered, globally.
Parameters
_event
Returns
void
Inherited from
onXRSessionEnded()
onXRSessionEnded():
void
Defined in: src/core/Script.ts:122
Returns
void
Inherited from
onXRSessionStarted()
onXRSessionStarted(
_session?):void
Defined in: src/core/Script.ts:121
Parameters
_session?
Returns
void
Inherited from
physicsStep()
physicsStep():
void
Defined in: src/core/Script.ts:119
Returns
void
Inherited from
update()
update(
_time?,_frame?):void
Defined in: src/core/Script.ts:113
Runs per frame.
Parameters
_time?
number
_frame?
Returns
void