public abstract class BaseSlider<TValue, TScalar> : ExVisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IContextOverrideElement, IAdditionalDataHolder, IInputElement<TValue>, IValidatableElement<TValue>, INotifyValueChanging<TValue>, INotifyValueChanged<TValue>, IFormattable<TScalar> where TScalar : unmanaged

Type Parameters

Name	Description
TValue	A value type for the slider.
TScalar	A value type for a single thumb of the slider.

Constructors

BaseSlider()

Default constructor.

Declaration

protected BaseSlider()

Fields

m_CurrentDirection

The current direction of the layout.

Declaration

protected Dir m_CurrentDirection

Field Value

Type	Description
Dir

m_DraggedThumbIndex

The current thumb index that is being dragged.

Declaration

protected int m_DraggedThumbIndex

Field Value

Type	Description
int

m_DraggerManipulator

The dragger manipulator used to move the slider.

Declaration

protected Draggable m_DraggerManipulator

Field Value

Type	Description
Draggable

m_FormatFunc

The format function used to display the value of the slider.

Declaration

protected FormatFunction<TScalar> m_FormatFunc

Field Value

Type	Description
FormatFunction<TScalar>

m_FormatString

The format string used to display the value of the slider.

Declaration

protected string m_FormatString

Field Value

Type	Description
string

m_HighValue

Slider max value.

Declaration

protected TScalar m_HighValue

Field Value

Type	Description
TScalar

m_LowValue

Slider min value.

Declaration

protected TScalar m_LowValue

Field Value

Type	Description
TScalar

m_Orientation

The orientation of the slider.

Declaration

protected Direction m_Orientation

Field Value

Type	Description
Direction

m_PreviousValue

The previous value of the slider before the user started interacting with it.

Declaration

protected TValue m_PreviousValue

Field Value

Type	Description
TValue

m_ShiftStep

The shift step value of the slider.

Declaration

protected TScalar m_ShiftStep

Field Value

Type	Description
TScalar

m_Step

The step value of the slider.

Declaration

protected TScalar m_Step

Field Value

Type	Description
TScalar

m_SwapThumbs

Whether the thumbs can be swapped if the low value is greater than the high value. If false, each thumb will be clamped to its respective value.

Declaration

protected bool m_SwapThumbs

Field Value

Type	Description
bool

m_ValidateValue

The validation function used to validate the value of the slider.

Declaration

protected Func<TValue, bool> m_ValidateValue

Field Value

Type	Description
Func<TValue, bool>

m_Value

The current value of the slider.

Declaration

protected TValue m_Value

Field Value

Type	Description
TValue

Properties

comparer

The comparer used to compare the values of the slider.

Declaration

public IComparer<TValue> comparer { get; set; }

Property Value

Type	Description
IComparer<TValue>

formatFunction

The format function used to display the value of the slider.

Declaration

public FormatFunction<TScalar> formatFunction { get; set; }

Property Value

Type	Description
FormatFunction<TScalar>

formatString

The format string used to display the value of the slider.

Declaration

public string formatString { get; set; }

Property Value

Type	Description
string

highValue

Specify the maximum value in the range of this slider.

Declaration

public TScalar highValue { get; set; }

Property Value

Type	Description
TScalar

invalid

The invalid state of the slider.

Declaration

public bool invalid { get; set; }

Property Value

Type	Description
bool

lowValue

Specify the minimum value in the range of this slider.

Declaration

public TScalar lowValue { get; set; }

Property Value

Type	Description
TScalar

orientation

The orientation of the slider. It can be horizontal or vertical. In vertical orientation, the slider will be drawn from bottom to top. In horizontal orientation, the slider will be drawn from left to right in LTR context and from right to left in RTL context.

Declaration

public Direction orientation { get; set; }

Property Value

Type	Description
Direction

shiftStep

The step value of the slider when the shift key is pressed.

Declaration

public TScalar shiftStep { get; set; }

Property Value

Type	Description
TScalar

step

The step value of the slider.

Declaration

public TScalar step { get; set; }

Property Value

Type	Description
TScalar

swapThumbs

Whether the thumbs can be swapped a thumb value becomes greater than the next one or when it becomes smaller than the previous one.

Declaration

public bool swapThumbs { get; set; }

Property Value

Type	Description
bool

thumbComparer

The comparer used to compare the thumb values of the slider.

Declaration

public IComparer<TScalar> thumbComparer { get; set; }

Property Value

Type	Description
IComparer<TScalar>

thumbCount

Get the number of thumbs for this slider.

Declaration

protected abstract int thumbCount { get; }

Property Value

Type	Description
int

validateValue

The validation function used to validate the value of the slider.

Declaration

public Func<TValue, bool> validateValue { get; set; }

Property Value

Type	Description
Func<TValue, bool>

value

The current value of the slider.

Declaration

public TValue value { get; set; }

Property Value

Type	Description
TValue

Methods

Clamp(TValue, TScalar, TScalar)

Utility method to clamp a TValue value between specified bounds.

Declaration

protected virtual TValue Clamp(TValue v, TScalar lowBound, TScalar highBound)

Parameters

Type	Name	Description
TValue	v	The value to clamp.
TScalar	lowBound	Minimum
TScalar	highBound	Maximum

Returns

Type	Description
TValue	The clamped value.

ClampThumb(TScalar, TScalar, TScalar)

Clamp the thumb value.

Declaration

protected abstract TScalar ClampThumb(TScalar x, TScalar min, TScalar max)

Parameters

Type	Name	Description
TScalar	x	The value to clamp.
TScalar	min	The minimum value.
TScalar	max	The maximum value.

Returns

Type	Description
TScalar	The clamped values.

ComputeValueFromDrag(Draggable)

Returns the value to set as slider value based on a given dragger position.

Declaration

protected virtual TValue ComputeValueFromDrag(Draggable dragger)

Parameters

Type	Name	Description
Draggable	dragger	The dragger manipulator.

Returns

Type	Description
TValue	The value to set as slider value based on a given dragger position.

FindClosestThumbValue(Draggable, ReadOnlySpan<TScalar>, out int)

Find the closest thumb value to the given dragger position.

Declaration

protected TScalar FindClosestThumbValue(Draggable dragger, ReadOnlySpan<TScalar> values, out int index)

Parameters

Type	Name	Description
Draggable	dragger	The dragger manipulator.
ReadOnlySpan<TScalar>	values	The values of the thumbs.
int	index	The index of the closest thumb value.

Returns

Type	Description
TScalar	The closest thumb value to the given dragger position.

FindClosestThumbValue(TScalar, int, Func<int, TScalar>, out int)

Find the closest thumb value to the given value.

Declaration

protected TScalar FindClosestThumbValue(TScalar v, int count, Func<int, TScalar> predicate, out int index)

Parameters

Type	Name	Description
TScalar	v	The value to find the closest thumb value to.
int	count	The number of thumbs.
Func<int, TScalar>	predicate	The predicate to get the thumb value at a specific index.
int	index	The index of the closest thumb value.

Returns

Type	Description
TScalar	The closest thumb value to the given value.

FindClosestThumbValue(TScalar, ReadOnlySpan<TScalar>, out int)

Find the closest thumb value to the given value.

Declaration

protected TScalar FindClosestThumbValue(TScalar v, ReadOnlySpan<TScalar> values, out int index)

Parameters

Type	Name	Description
TScalar	v	The value to find the closest thumb value to.
ReadOnlySpan<TScalar>	values	The values of the thumbs.
int	index	The index of the closest thumb value.

Returns

Type	Description
TScalar	The closest thumb value to the given value.

GetClampedValue(TValue)

Return the clamped value using current lowValue and highValue values.

Declaration

protected virtual TValue GetClampedValue(TValue newValue)

Parameters

Type	Name	Description
TValue	newValue	The value to clamp.

Returns

Type	Description
TValue	The clamped value.

Remarks

The method also checks if low and high values are inverted.

GetNormalizedValueFromDrag(Draggable)

Get a normalized value from a dragger position.

Declaration

protected float GetNormalizedValueFromDrag(Draggable dragger)

Parameters

Type	Name	Description
Draggable	dragger	The dragger manipulator.

Returns

Type	Description
float	The normalized value from a dragger position.

GetScalarValuesFromValue(TValue, Span<TScalar>)

Get the list of thumb values from the TValue value. This must be sorted.

Declaration

protected abstract void GetScalarValuesFromValue(TValue value, Span<TScalar> values)

Parameters

Type	Name	Description
TValue	value	The TValue value.
Span<TScalar>	values	The list of thumb values.

GetStepCount(TScalar)

Get the number of possible steps between the lowValue and highValue.

Declaration

protected abstract int GetStepCount(TScalar stepValue)

Parameters

Type	Name	Description
TScalar	stepValue	The step value.

Returns

Type	Description
int	The number of possible steps.

GetTrackElement()

Get the element that represent the entire track of the slider.

Declaration

protected virtual VisualElement GetTrackElement()

Returns

Type	Description
VisualElement	The element that represent the entire track of the slider.

GetValueFromScalarValues(Span<TScalar>)

Get the TValue value from the list of thumb values.

Declaration

protected abstract TValue GetValueFromScalarValues(Span<TScalar> values)

Parameters

Type	Name	Description
Span<TScalar>	values	The list of thumb values.

Returns

Type	Description
TValue	The TValue value.

InvokeValueChangedCallbacks()

Called when the value of the slider has changed via the value property.

Declaration

protected virtual void InvokeValueChangedCallbacks()

KeyDecrement(TScalar, TScalar, KeyDownEvent)

Decrement the value of the slider on a specific thumb.

Declaration

protected virtual TScalar KeyDecrement(TScalar baseValue, TScalar stepValue, KeyDownEvent evt)

Parameters

Type	Name	Description
TScalar	baseValue	The base value to decrement.
TScalar	stepValue	The decrement step value.
KeyDownEvent	evt	The key down event.

Returns

Type	Description
TScalar	The decremented value.

KeyIncrement(TScalar, TScalar, KeyDownEvent)

Increment the value of the slider on a specific thumb.

Declaration

protected virtual TScalar KeyIncrement(TScalar baseValue, TScalar stepValue, KeyDownEvent evt)

Parameters

Type	Name	Description
TScalar	baseValue	The base value to increment.
TScalar	stepValue	The increment step value.
KeyDownEvent	evt	The key down event.

Returns

Type	Description
TScalar	The incremented value.

Mad(int, TScalar, TScalar)

Performs an arithmetic multiply/add operation.

Declaration

protected abstract TScalar Mad(int m, TScalar a, TScalar b)

Parameters

Type	Name	Description
int	m	The number of times to multiply the a value.
TScalar	a	The value that will be multiplied N times and then added to the base value.
TScalar	b	The addition value.

Returns

Type	Description
TScalar	The incremented value.

OnDirectionChanged(ContextChangedEvent<DirContext>)

Event callback called when the direction of the layout has changed.

Declaration

protected virtual void OnDirectionChanged(ContextChangedEvent<DirContext> evt)

Parameters

Type	Name	Description
ContextChangedEvent<DirContext>	evt	The direction context changed event

OnGeometryChanged(GeometryChangedEvent)

Event callback called when the geometry of the slider has changed in the layout.

Declaration

protected virtual void OnGeometryChanged(GeometryChangedEvent evt)

Parameters

Type	Name	Description
GeometryChangedEvent	evt	The geometry changed event.

OnKeyDown(KeyDownEvent)

Base implementation of KeyDown event handler.

Declaration

protected virtual void OnKeyDown(KeyDownEvent evt)

Parameters

Type	Name	Description
KeyDownEvent	evt	The key down event.

OnSliderRangeChanged()

Called when the low or high value of Slider has changed.

Declaration

protected virtual void OnSliderRangeChanged()

OnStyleResolved(CustomStyleResolvedEvent)

Event callback called when the style of the slider has been resolved.

Declaration

protected virtual void OnStyleResolved(CustomStyleResolvedEvent evt)

Parameters

Type	Name	Description
CustomStyleResolvedEvent	evt	The custom style resolved event.

OnTrackClicked()

Called when the track has received a click event.

Declaration

protected virtual void OnTrackClicked()

Remarks

Always check if the mouse has moved using hasMoved.

OnTrackDown(Draggable)

Event callback called when a pointer down event is received.

Declaration

protected virtual void OnTrackDown(Draggable dragger)

Parameters

Type	Name	Description
Draggable	dragger	The dragger manipulator.

OnTrackDragged(Draggable)

Event callback called when the dragger is dragged.

Declaration

protected virtual void OnTrackDragged(Draggable dragger)

Parameters

Type	Name	Description
Draggable	dragger	The dragger manipulator.

OnTrackUp(Draggable)

Event callback called when a pointer up event is received.

Declaration

protected virtual void OnTrackUp(Draggable dragger)

Parameters

Type	Name	Description
Draggable	dragger	The dragger manipulator.

ParseRawValueToString(TValue)

Method to implement to resolve a TValue value into a string value.

Declaration

protected virtual string ParseRawValueToString(TValue val)

Parameters

Type	Name	Description
TValue	val	The `TValue` value to convert.

Returns

Type	Description
string	The converted value.

Remarks

This method is used to convert the value to a string when the user is editing the value in the input field. This must not use the formatString property.

ParseStringToValue(string, out TValue)

Method to implement to resolve a string value into a TValue value.

You can use TryParse(string, out float) for floating point value types for example.

Declaration

protected abstract bool ParseStringToValue(string strValue, out TValue value)

Parameters

Type	Name	Description
string	strValue	The string value to convert.
TValue	value	The stringThe converted value.

Returns

Type	Description
bool	True if can be parsed, False otherwise.

ParseSubValueToString(TScalar)

Method to implement to resolve a TValue value into a string value.

You can use ToString() for floating point value types for example.

You can also round the value if you want a specific number of decimals.

Declaration

protected virtual string ParseSubValueToString(TScalar val)

Parameters

Type	Name	Description
TScalar	val	The `TValue` value to convert.

Returns

Type	Description
string	The converted value.

ParseValueToString(TValue)

Method to implement to resolve a TValue value into a string value.

You can use ToString() for floating point value types for example.

You can also round the value if you want a specific number of decimals.

Declaration

protected virtual string ParseValueToString(TValue val)

Parameters

Type	Name	Description
TValue	val	The `TValue` value to convert.

Returns

Type	Description
string	The converted value.

SetOrientation(Direction)

Called when the orientation of the slider has changed.

Declaration

protected virtual void SetOrientation(Direction newValue)

Parameters

Type	Name	Description
Direction	newValue	The new orientation value.

SetShiftStep(TScalar)

Set the shift step value of the slider.

Declaration

protected virtual void SetShiftStep(TScalar newShiftStep)

Parameters

Type	Name	Description
TScalar	newShiftStep	The new shift step value.

SetStep(TScalar)

Set the step value of the slider.

Declaration

protected virtual void SetStep(TScalar newStep)

Parameters

Type	Name	Description
TScalar	newStep	The new step value.

SetSwapThumbs(bool)

Set the swap thumbs value of the slider.

Declaration

protected virtual void SetSwapThumbs(bool newSwapThumbs)

Parameters

Type	Name	Description
bool	newSwapThumbs	The new swap thumbs value.

SetValueWithoutNotify(TValue)

Set the value of the slider without sending any event.

Declaration

public abstract void SetValueWithoutNotify(TValue newValue)

Parameters

Type	Name	Description
TValue	newValue	The new value of the slider.

SliderLerpUnclamped(TScalar, TScalar, float)

Method to implement which returns a value based on the linear interpolation of a given interpolant between a specific range.

Usually, you can use directly LerpUnclamped(float, float, float) for floating point value types.

Declaration

protected abstract TScalar SliderLerpUnclamped(TScalar a, TScalar b, float interpolant)

Parameters

Type	Name	Description
TScalar	a	The lowest value in the range.
TScalar	b	The highest value in the range.
float	interpolant	The normalized value to process.

Returns

Type	Description
TScalar	The interpolated value.

SliderNormalizeValue(TScalar, TScalar, TScalar)

Method to implement which returns the normalized value of a given value in a specific range.

Usually, you can use directly an InverseLerp(float, float, float) for floating point value types.

Declaration

protected abstract float SliderNormalizeValue(TScalar currentValue, TScalar lowerValue, TScalar higherValue)

Parameters

Type	Name	Description
TScalar	currentValue	The value to normalize.
TScalar	lowerValue	The lowest value in the range.
TScalar	higherValue	The highest value in the range.

Returns

Type	Description
float	The normalized value.

Implements

IEventHandler

ITransform

ITransitionAnimations

IExperimentalFeatures

IVisualElementScheduler

IResolvedStyle

IContextOverrideElement

IAdditionalDataHolder

IInputElement<TValue>

IValidatableElement<TValue>

INotifyValueChanging<TValue>

INotifyValueChanged<T>

IFormattable<TValue>

Extension Methods

NotifyValueChangingExtensions.RegisterValueChangingCallback<TValue>(INotifyValueChanging<TValue>, EventCallback<ChangingEvent<TValue>>)

NotifyValueChangingExtensions.UnregisterValueChangingCallback<TValue>(INotifyValueChanging<TValue>, EventCallback<ChangingEvent<TValue>>)

VisualElementExtensions.FindNavController(VisualElement)

RegisterUpdateCallbackExtensions.RegisterUpdateCallback(VisualElement, EventCallback<UpdateEvent>)

RegisterUpdateCallbackExtensions.UnregisterUpdateCallback(VisualElement, EventCallback<UpdateEvent>)

VisualElementExtensions.EnableDynamicTransform(VisualElement, bool)

VisualElementExtensions.EnablePicking(VisualElement, bool)

VisualElementExtensions.GetChildren<T>(VisualElement, bool)

VisualElementExtensions.GetContextProvider<T>(VisualElement)

VisualElementExtensions.GetContextProvider<T>(VisualElement, string)

VisualElementExtensions.GetContext<T>(VisualElement)

VisualElementExtensions.GetContext<T>(VisualElement, string)

VisualElementExtensions.GetExclusiveRootElement(VisualElement)

VisualElementExtensions.GetLastAncestorOfType<T>(VisualElement)

VisualElementExtensions.GetPreferredTooltipPlacement(VisualElement)

VisualElementExtensions.GetSelfContext<T>(VisualElement)

VisualElementExtensions.GetSelfContext<T>(VisualElement, string)

VisualElementExtensions.GetTooltipContent(VisualElement)

VisualElementExtensions.GetTooltipTemplate(VisualElement)

VisualElementExtensions.HasAncestorsOfType<T>(VisualElement)

VisualElementExtensions.IsContextProvider<T>(VisualElement)

VisualElementExtensions.IsContextProvider<T>(VisualElement, string)

VisualElementExtensions.IsInvisible(VisualElement)

VisualElementExtensions.IsOnScreen(VisualElement)

VisualElementExtensions.ProvideContext<T>(VisualElement, string, T)

VisualElementExtensions.ProvideContext<T>(VisualElement, T)

VisualElementExtensions.RegisterContextChangedCallback<T>(VisualElement, string, EventCallback<ContextChangedEvent<T>>)

VisualElementExtensions.RegisterContextChangedCallback<T>(VisualElement, EventCallback<ContextChangedEvent<T>>)

VisualElementExtensions.SetPreferredTooltipPlacement(VisualElement, OptionalEnum<PopoverPlacement>)

VisualElementExtensions.SetTooltipContent(VisualElement, VisualElementExtensions.TooltipContentCallback)

VisualElementExtensions.SetTooltipTemplate(VisualElement, VisualElement)

VisualElementExtensions.UnregisterContextChangedCallback<T>(VisualElement, string, EventCallback<ContextChangedEvent<T>>)

VisualElementExtensions.UnregisterContextChangedCallback<T>(VisualElement, EventCallback<ContextChangedEvent<T>>)

Class BaseSlider<TValue, TScalar>

Inheritance

Implements

Inherited Members

Namespace: Unity.AppUI.UI

Assembly: Unity.AppUI.dll

Syntax

Type Parameters

Constructors

BaseSlider()

Declaration

See Also

Fields

m_CurrentDirection

Declaration

Field Value

See Also

m_DraggedThumbIndex

Declaration

Field Value

See Also

m_DraggerManipulator

Declaration

Field Value

See Also

m_FormatFunc

Declaration

Field Value

See Also

m_FormatString

Declaration

Field Value

See Also

m_HighValue

Declaration

Field Value

See Also

m_LowValue

Declaration

Field Value

See Also

m_Orientation

Declaration

Field Value

See Also

m_PreviousValue

Declaration

Field Value

See Also

m_ShiftStep

Declaration

Field Value

See Also

m_Step

Declaration

Field Value

See Also

m_SwapThumbs

Declaration

Field Value

See Also

m_ValidateValue

Declaration

Field Value

See Also

m_Value

Declaration

Field Value

See Also

Properties

comparer

Declaration

Property Value

See Also

formatFunction

Declaration

Property Value

See Also

formatString

Declaration