Slider Class

Definition

Namespace:

MixedReality.Toolkit.UX

Assembly:

MixedReality.Toolkit.UXCore.dll

A slider that can be moved by grabbing / pinching a slider thumb

C#

[UnityEngine.AddComponentMenu("MRTK/UX/Slider")]
[UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/ux-building-blocks/sliders")]
public class Slider : MixedReality.Toolkit.StatefulInteractable, MixedReality.Toolkit.ISnapInteractable

Inheritance

UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable

MRTKBaseInteractable

StatefulInteractable

Slider

Attributes

UnityEngine.AddComponentMenuAttribute UnityEngine.HelpURLAttribute

Implements

ISnapInteractable

Constructors

Slider()

Properties

AllowSelectByVoice	Does the interactable allow triggering select via a voice command? If true, voice command can be used to trigger "select" on the interactable (Inherited from StatefulInteractable)
DeselectThreshold	The threshold of selection progress at which the interactable will be deselected. (Inherited from StatefulInteractable)
FarDwellTime	Time required for far ray dwell (Inherited from StatefulInteractable)
GazeDwellTime	Time required for gaze dwell (Inherited from StatefulInteractable)
HandleTransform	Called by interactors to query which exact transform on an interactable should be considered the snappable affordance.
HoveringGazeInteractors	(Read Only) The list of IGazeInteractor components currently gazing this object. (Inherited from MRTKBaseInteractable)
HoveringGazePinchInteractors	(Read Only) The list of IGazePinchInteractor components currently hovering this object. (Inherited from MRTKBaseInteractable)
HoveringGrabInteractors	(Read Only) The list of IGrabInteractor components currently hovering this object. (Inherited from MRTKBaseInteractable)
HoveringPokeInteractors	(Read Only) The list of IPokeInteractor components currently hovering this object. (Inherited from MRTKBaseInteractable)
HoveringRayInteractors	(Read Only) The list of IRayInteractor components currently hovering this object. (Inherited from MRTKBaseInteractable)
IsActiveHovered	Is this object hovered by any interactor other than passive targeting interactors? (Inherited from MRTKBaseInteractable)
IsGazeHovered	Is this object hovered by any gaze interactor? (Inherited from MRTKBaseInteractable)
IsGazePinchHovered	Is this object hovered by a gaze-pinch interactor? (Inherited from MRTKBaseInteractable)
IsGazePinchSelected	Is this object selected by a gaze-pinch interactor? (Inherited from MRTKBaseInteractable)
IsGrabHovered	Is this object hovered by a grab interactor? (Inherited from MRTKBaseInteractable)
IsGrabSelected	Is this object selected by a grab interactor? (Inherited from MRTKBaseInteractable)
IsPokeHovered	Is this object hovered by a near touch/poke interactor? (Inherited from MRTKBaseInteractable)
IsPokeSelected	Is this object selected by a poke interactor? (Inherited from MRTKBaseInteractable)
IsRayHovered	Is this object hovered by a non-gaze ray interactor? (Inherited from MRTKBaseInteractable)
IsRaySelected	Is this object selected by a non-gaze ray interactor? (Inherited from MRTKBaseInteractable)
IsToggled	Is the interactable toggled? (Inherited from StatefulInteractable)
IsTouchable	Whether or not this slider is manipulatable by IPokeInteractors. If true, IGrabInteractors will have no effect.
MaxValue	The maximum value that the slider can take on
MinValue	The minimum value that the slider can take on
NormalizedValue	The slider's normalized value calculated using the MinValue and MaxValue properties.
OnClicked	Fired when the interactable is fully clicked (select + deselect) (Inherited from StatefulInteractable)
OnDisabled	Fired when the interactable is disabled (Inherited from StatefulInteractable)
OnEnabled	Fired when the interactable is enabled (Inherited from StatefulInteractable)
OnValueUpdated	A Unity event that is invoked when Value changes.
SelectingGazePinchInteractors	(Read Only) The list of IGazePinchInteractor components currently selecting this object. (Inherited from MRTKBaseInteractable)
SelectingGrabInteractors	(Read Only) The list of IGrabInteractor components currently selecting this object. (Inherited from MRTKBaseInteractable)
SelectRequiresHover	Does the interactable require the interactor to hover over it? If true, then the OnClick event will only get fired while this Interactable is being hovered. (Inherited from StatefulInteractable)
SelectThreshold	The threshold of selection progress at which the interactable will be selected. (Inherited from StatefulInteractable)
SliderEnd	A transform marking the end point of the slider track.
SliderStart	A transform marking the starting point of the slider track.
SliderStepDivisions	Property accessor of sliderStepDivisions, it holds the number of subdivisions the slider is split into.
SliderTrackDirection	Returns the vector from the slider start to end positions
SliderValue	Obsolete. The current value of the slider.
SnapToPosition	Determines whether or not this slider snaps to the designated position on the slider. Grab interactions will not snap, regardless of the value of this property.
SpeechRecognitionKeyword	Speech keyword required for triggering "select" on the interactable (Inherited from StatefulInteractable)
StartInteractionPoint	The interaction point at the beginning of an interaction.
StartSliderValue	Float value that holds the starting value of the slider.
ToggleMode	The toggle behavior of the interactable. Set OneWayToggle for radio buttons. (Inherited from StatefulInteractable)
TrackCollider	Collider that covers the entire slider track area.
TriggerOnRelease	Should the user be required to fully select and deselect the interactable for Click and Toggle to fire? (Inherited from StatefulInteractable)
UseFarDwell	Should hovering the object with a far ray for a certain amount of time select it? (Inherited from StatefulInteractable)
UseGazeDwell	Should gazing at the object for a certain amount of time select it? (Inherited from StatefulInteractable)
UseSliderStepDivisions	Property accessor of useSliderStepDivisions, it determines whether the slider steps according to subdivisions or continuously.
Value	The current value of the slider
VoiceRequiresFocus	Does the voice command require this to have focus? If true, then the voice command will only respond to voice commands while this Interactable has focus. (Inherited from StatefulInteractable)

Methods

ApplyRequiredSettings()	Invoked on Start(), Awake(), and Reset() to apply required settings to this Slider instance.
Awake()	A Unity event function that is called when an enabled script instance is being loaded.
CanClickOnFirstSelectEntered(SelectEnterEventArgs)	This function determines whether the interactable should fire a click event at a given select event. Subclasses can override this to add additional requirements for full click/toggle activation, such as roll-off prevention. (Inherited from StatefulInteractable)
CanClickOnLastSelectExited(SelectExitEventArgs)	This function determines whether the interactable should fire a click event at a given deselect event. Subclasses can override this to add additional requirements for full click/toggle activation, such as roll-off prevention. (Inherited from StatefulInteractable)
DisableInteractorType(SystemInterfaceType)	Adds the specified type to the set of interactors which cannot select this interactable (Inherited from MRTKBaseInteractable)
EnableInteractorType(SystemInterfaceType)	Removes the specified type to the set of interactors which cannot select this interactable (Inherited from MRTKBaseInteractable)
ForceSetToggled(Boolean, Boolean)	Forcibly toggle the interactable. (Inherited from StatefulInteractable)
ForceSetToggled(Boolean)	Forcibly toggle the interactable and fire the relevant events. This is a single-arg overload for ForceSetToggled for use with UnityEvents. Consider using ForceSetToggled(bool, bool) instead, especially if you'd like to suppress the resulting toggle events. (Inherited from StatefulInteractable)
GetSelectionProgress()	Get the current selection progress of this StatefulInteractable. (Inherited from StatefulInteractable)
IsHoverableBy(IXRHoverInteractor)	(Inherited from MRTKBaseInteractable)
IsInteractorTypeValid(IXRInteractor)	Is the given type of interactor permitted to interact with this interactable? (Inherited from MRTKBaseInteractable)
IsSelectableBy(IXRSelectInteractor)	UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable.IsSelectableBy(UnityEngine.XR.Interaction.Toolkit.IXRSelectInteractor)
OnDestroy()	A Unity event function that is called when the script component has been destroyed. (Inherited from StatefulInteractable)
OnDisable()	A Unity event function that is called when the script component has been disabled. (Inherited from StatefulInteractable)
OnEnable()	A Unity event function that is called when the script component has been enabled. (Inherited from StatefulInteractable)
OnFirstSelectEntered(SelectEnterEventArgs)	(Inherited from StatefulInteractable)
OnHoverEntering(HoverEnterEventArgs)	(Inherited from MRTKBaseInteractable)
OnHoverExiting(HoverExitEventArgs)	(Inherited from MRTKBaseInteractable)
OnLastSelectExited(SelectExitEventArgs)	(Inherited from StatefulInteractable)
OnSelectEntered(SelectEnterEventArgs)	UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable.OnSelectEntered(UnityEngine.XR.Interaction.Toolkit.SelectEnterEventArgs)
OnSelectEntering(SelectEnterEventArgs)	(Inherited from MRTKBaseInteractable)
OnSelectExiting(SelectExitEventArgs)	(Inherited from MRTKBaseInteractable)
ProcessInteractable(XRInteractionUpdateOrder+UpdatePhase)	UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable.ProcessInteractable(UnityEngine.XR.Interaction.Toolkit.XRInteractionUpdateOrder.UpdatePhase)
Reset()	A Unity event function that is called when the script should reset it's default values
Start()	A Unity event function that is called on the frame when a script is enabled just before any of the update methods are called the first time.

Applies to