AUxtPinchSliderActor
A simple HoloLens 2 style slider that can be moved by grabbing / pinching a slider thumb. The class is extensible to support additional functionality.
class AUxtPinchSliderActor;
Header
#include <Controls/UxtPinchSliderActor.h>
Inheritance
Inherits from AActor
Public Functions
| Name | |
|---|---|
| AUxtPinchSliderActor() | |
| float | GetValue() const |
| void | SetValue(float NewValue) |
| float | GetMinValue() const |
| void | SetMinValue(float NewMinValue) |
| float | GetMaxValue() const |
| void | SetMaxValue(float NewMaxValue) |
| float | GetTrackLength() const |
| void | SetTrackLength(float NewTrackLength) |
| bool | GetStepWithTickMarks() const |
| void | SetStepWithTickMarks(bool bNewStepWithTickMarks) |
| FText | GetTitle() const |
| void | SetTitle(FText NewTitle) |
| int | GetValueTextDecimalPlaces() const |
| void | SetValueTextDecimalPlaces(int NewValueTextDecimalPlaces) |
| bool | GetAlignTextWithZ() const |
| void | SetAlignTextWithZ(bool bNewAlignTextWithZ) |
| bool | GetMoveTextWithThumb() const |
| void | SetMoveTextWithThumb(bool bNewMoveWithThumb) |
| int | GetNumTickMarks() const |
| void | SetNumTickMarks(int NewNumTickMarks) |
| bool | GetShowTickMarks() const |
| void | SetShowTickMarks(bool bNewShowTickMarks) |
| FVector | GetTickMarkScale() const |
| void | SetTickMarkScale(FVector NewTickMarkScale) |
| bool | GetInstanceTickMarks() const |
| void | SetInstanceTickMarks(bool InstanceTickMarks) |
| FLinearColor | GetDefaultThumbColor() const |
| void | SetDefaultThumbColor(FLinearColor NewDefaultThumbColor) |
| FLinearColor | GetFocusedThumbColor() const |
| void | SetFocusedThumbColor(FLinearColor NewFocusedThumbColor) |
| FLinearColor | GetGrabbedThumbColor() const |
| void | SetGrabbedThumbColor(FLinearColor NewGrabbedThumbColor) |
| FLinearColor | GetDisabledThumbColor() const |
| void | SetDisabledThumbColor(FLinearColor NewDisabledThumbColor) |
| USoundCue * | GetGrabSound() const |
| void | SetGrabSound(USoundCue * NewGrabSound) |
| USoundCue * | GetReleaseSound() const |
| void | SetReleaseSound(USoundCue * NewReleaseSound) |
| USoundCue * | GetTickSound() const |
| void | SetTickSound(USoundCue * NewTickSound) |
| float | GetDefaultThumbScale() const |
| void | SetDefaultThumbScale(float NewDefaultThumbScale) |
| float | GetFocusedThumbScale() const |
| void | SetFocusedThumbScale(float NewFocusedThumbScale) |
| UCurveFloat * | GetThumbScaleCurve() const |
| void | SetThumbScaleCurve(UCurveFloat * NewThumbScaleCurve) |
Protected Functions
| Name | |
|---|---|
| virtual void | OnConstruction(const FTransform & Transform) override |
| virtual void | OnUpdateState(UUxtPinchSliderComponent * Slider, EUxtSliderState NewState) |
| virtual void | OnBeginGrab(UUxtPinchSliderComponent * Slider, UUxtPointerComponent * Pointer) |
| virtual void | OnUpdateValue(UUxtPinchSliderComponent * Slider, float NewValue) |
| virtual void | OnEndGrab(UUxtPinchSliderComponent * Slider, UUxtPointerComponent * Pointer) |
| void | OnUpdateTimeline(float Scale) |
Public Attributes
| Name | |
|---|---|
| FUxtPinchSliderValueUpdatedDelegate | OnValueUpdated |
Protected Attributes
| Name | |
|---|---|
| UUxtPinchSliderComponent * | PinchSlider |
| UStaticMeshComponent * | Thumb |
| UStaticMeshComponent * | Track |
| class UInstancedStaticMeshComponent * | TickMarks |
| TArray< UStaticMeshComponent * > | TickMarksNonInstanced |
| USceneComponent * | TextRoot |
| class UTextRenderComponent * | TitleText |
| class UTextRenderComponent * | ValueText |
| class UAudioComponent * | Audio |
| UTimelineComponent * | ScaleTimeline |
Public Functions Documentation
function AUxtPinchSliderActor
AUxtPinchSliderActor()
function GetValue
inline float GetValue() const
function SetValue
void SetValue(
float NewValue
)
function GetMinValue
inline float GetMinValue() const
function SetMinValue
void SetMinValue(
float NewMinValue
)
function GetMaxValue
inline float GetMaxValue() const
function SetMaxValue
void SetMaxValue(
float NewMaxValue
)
function GetTrackLength
inline float GetTrackLength() const
function SetTrackLength
void SetTrackLength(
float NewTrackLength
)
function GetStepWithTickMarks
inline bool GetStepWithTickMarks() const
function SetStepWithTickMarks
void SetStepWithTickMarks(
bool bNewStepWithTickMarks
)
function GetTitle
inline FText GetTitle() const
function SetTitle
void SetTitle(
FText NewTitle
)
function GetValueTextDecimalPlaces
inline int GetValueTextDecimalPlaces() const
function SetValueTextDecimalPlaces
void SetValueTextDecimalPlaces(
int NewValueTextDecimalPlaces
)
function GetAlignTextWithZ
inline bool GetAlignTextWithZ() const
function SetAlignTextWithZ
void SetAlignTextWithZ(
bool bNewAlignTextWithZ
)
function GetMoveTextWithThumb
inline bool GetMoveTextWithThumb() const
function SetMoveTextWithThumb
void SetMoveTextWithThumb(
bool bNewMoveWithThumb
)
function GetNumTickMarks
inline int GetNumTickMarks() const
function SetNumTickMarks
void SetNumTickMarks(
int NewNumTickMarks
)
function GetShowTickMarks
inline bool GetShowTickMarks() const
function SetShowTickMarks
void SetShowTickMarks(
bool bNewShowTickMarks
)
function GetTickMarkScale
inline FVector GetTickMarkScale() const
function SetTickMarkScale
void SetTickMarkScale(
FVector NewTickMarkScale
)
function GetInstanceTickMarks
inline bool GetInstanceTickMarks() const
function SetInstanceTickMarks
void SetInstanceTickMarks(
bool InstanceTickMarks
)
function GetDefaultThumbColor
inline FLinearColor GetDefaultThumbColor() const
function SetDefaultThumbColor
void SetDefaultThumbColor(
FLinearColor NewDefaultThumbColor
)
function GetFocusedThumbColor
inline FLinearColor GetFocusedThumbColor() const
function SetFocusedThumbColor
void SetFocusedThumbColor(
FLinearColor NewFocusedThumbColor
)
function GetGrabbedThumbColor
inline FLinearColor GetGrabbedThumbColor() const
function SetGrabbedThumbColor
void SetGrabbedThumbColor(
FLinearColor NewGrabbedThumbColor
)
function GetDisabledThumbColor
inline FLinearColor GetDisabledThumbColor() const
function SetDisabledThumbColor
void SetDisabledThumbColor(
FLinearColor NewDisabledThumbColor
)
function GetGrabSound
inline USoundCue * GetGrabSound() const
function SetGrabSound
void SetGrabSound(
USoundCue * NewGrabSound
)
function GetReleaseSound
inline USoundCue * GetReleaseSound() const
function SetReleaseSound
void SetReleaseSound(
USoundCue * NewReleaseSound
)
function GetTickSound
inline USoundCue * GetTickSound() const
function SetTickSound
void SetTickSound(
USoundCue * NewTickSound
)
function GetDefaultThumbScale
inline float GetDefaultThumbScale() const
function SetDefaultThumbScale
void SetDefaultThumbScale(
float NewDefaultThumbScale
)
function GetFocusedThumbScale
inline float GetFocusedThumbScale() const
function SetFocusedThumbScale
void SetFocusedThumbScale(
float NewFocusedThumbScale
)
function GetThumbScaleCurve
inline UCurveFloat * GetThumbScaleCurve() const
function SetThumbScaleCurve
void SetThumbScaleCurve(
UCurveFloat * NewThumbScaleCurve
)
Protected Functions Documentation
function OnConstruction
virtual void OnConstruction(
const FTransform & Transform
) override
function OnUpdateState
virtual void OnUpdateState(
UUxtPinchSliderComponent * Slider,
EUxtSliderState NewState
)
function OnBeginGrab
virtual void OnBeginGrab(
UUxtPinchSliderComponent * Slider,
UUxtPointerComponent * Pointer
)
function OnUpdateValue
virtual void OnUpdateValue(
UUxtPinchSliderComponent * Slider,
float NewValue
)
function OnEndGrab
virtual void OnEndGrab(
UUxtPinchSliderComponent * Slider,
UUxtPointerComponent * Pointer
)
function OnUpdateTimeline
void OnUpdateTimeline(
float Scale
)
Public Attributes Documentation
variable OnValueUpdated
FUxtPinchSliderValueUpdatedDelegate OnValueUpdated;
Event raised when the slider's value changes.
Protected Attributes Documentation
variable PinchSlider
UUxtPinchSliderComponent * PinchSlider;
The slider functionality.
variable Thumb
UStaticMeshComponent * Thumb;
The thumb visuals.
variable Track
UStaticMeshComponent * Track;
The track visuals.
variable TickMarks
class UInstancedStaticMeshComponent * TickMarks;
The tick mark visuals if bInstanceTickMarks is true.
variable TickMarksNonInstanced
TArray< UStaticMeshComponent * > TickMarksNonInstanced;
The tick mark visuals if bInstanceTickMarks is false.
variable TextRoot
USceneComponent * TextRoot;
Root text component to allow text to move as a block.
variable TitleText
class UTextRenderComponent * TitleText;
The title text, configure using the 'Title' property.
variable ValueText
class UTextRenderComponent * ValueText;
The value text. TODO configure
variable Audio
class UAudioComponent * Audio;
The audio cues, configure using the 'Slider Sounds' properties.
variable ScaleTimeline
UTimelineComponent * ScaleTimeline;
The timeline for scaling the thumb, configuring using the 'Slider Thumb Scaling' properties.
Updated on 19 August 2021 at 17:42:51 Coordinated Universal Time