UUxtPinchSliderComponent
A slider that can be moved by grabbing / pinching a slider thumb.
The thumb visuals must be set using the 'Visuals' property.
class UUxtPinchSliderComponent;
Header
#include <Controls/UxtPinchSliderComponent.h>
Inheritance
Inherits from UUxtUIElementComponent, IUxtGrabTarget, IUxtGrabHandler, IUxtFarTarget, IUxtFarHandler, USceneComponent
Public Functions
Name | |
---|---|
EUxtSliderState | GetState() const |
void | SetEnabled(bool bEnabled) |
UStaticMeshComponent * | GetVisuals() const |
void | SetVisuals(UStaticMeshComponent * NewVisuals) |
void | SetVisuals(const FComponentReference & NewVisuals) |
float | GetValue() const |
void | SetValue(float NewValue) |
float | GetTrackLength() const |
void | SetTrackLength(float NewTrackLength) |
float | GetValueLowerBound() const |
void | SetValueLowerBound(float NewLowerBound) |
float | GetValueUpperBound() const |
void | SetValueUpperBound(float NewUpperBound) |
bool | GetUseSteppedMovement() const |
void | SetUseSteppedMovement(bool bNewUseSteppedMovement) |
int | GetNumSteps() const |
void | SetNumSteps(int NewNumSteps) |
float | GetLerpTime() const |
void | SetLerpTime(float NewLerpTime) |
FName | GetCollisionProfile() const |
void | SetCollisionProfile(FName NewCollisionProfile) |
Protected Functions
Public Attributes
Name | |
---|---|
FUxtPinchSliderUpdateStateDelegate | OnUpdateState |
FUxtPinchSliderBeginFocusDelegate | OnBeginFocus |
FUxtPinchSliderUpdateFocusDelegate | OnUpdateFocus |
FUxtPinchSliderEndFocusDelegate | OnEndFocus |
FUxtPinchSliderBeginGrabDelegate | OnBeginGrab |
FUxtPinchSliderUpdateValueDelegate | OnUpdateValue |
FUxtPinchSliderEndGrabDelegate | OnEndGrab |
FUxtPinchSliderEnableDelegate | OnEnable |
FUxtPinchSliderDisableDelegate | OnDisable |
Additional inherited members
Public Functions inherited from UUxtUIElementComponent
Name | |
---|---|
UUxtUIElementComponent() =default | |
EUxtUIElementVisibility | GetUIVisibilitySelf() const |
EUxtUIElementVisibility | GetUIVisibilityInHierarchy() const |
void | SetUIVisibility(EUxtUIElementVisibility NewVisibility) |
void | RefreshUIElement() |
Protected Functions inherited from UUxtUIElementComponent
Name | |
---|---|
virtual void | OnAttachmentChanged() override |
Public Attributes inherited from UUxtUIElementComponent
Name | |
---|---|
FUxtUIElementShowDelegate | OnShowElement |
FUxtUIElementHideDelegate | OnHideElement |
Public Functions inherited from IUxtGrabTarget
Name | |
---|---|
bool | IsGrabFocusable(const UPrimitiveComponent * Primitive) const |
Public Functions inherited from IUxtGrabHandler
Name | |
---|---|
bool | CanHandleGrab(UPrimitiveComponent * Primitive) const |
void | OnEnterGrabFocus(UUxtNearPointerComponent * Pointer) |
void | OnUpdateGrabFocus(UUxtNearPointerComponent * Pointer) |
void | OnExitGrabFocus(UUxtNearPointerComponent * Pointer) |
void | OnUpdateGrab(UUxtNearPointerComponent * Pointer) |
Public Functions inherited from IUxtFarTarget
Name | |
---|---|
bool | IsFarFocusable(const UPrimitiveComponent * Primitive) const |
Public Functions inherited from IUxtFarHandler
Name | |
---|---|
bool | CanHandleFar(UPrimitiveComponent * Primitive) const |
void | OnEnterFarFocus(UUxtFarPointerComponent * Pointer) |
void | OnUpdatedFarFocus(UUxtFarPointerComponent * Pointer) |
void | OnExitFarFocus(UUxtFarPointerComponent * Pointer) |
void | OnFarPressed(UUxtFarPointerComponent * Pointer) |
void | OnFarDragged(UUxtFarPointerComponent * Pointer) |
void | OnFarReleased(UUxtFarPointerComponent * Pointer) |
Public Functions Documentation
function GetState
inline EUxtSliderState GetState() const
Get the current state of the slider.
function SetEnabled
void SetEnabled(
bool bEnabled
)
Set if the slider is enabled.
function GetVisuals
inline UStaticMeshComponent * GetVisuals() const
Get the static mesh representing the thumb visuals.
function SetVisuals
void SetVisuals(
UStaticMeshComponent * NewVisuals
)
Set the static mesh representing the thumb visuals.
function SetVisuals
void SetVisuals(
const FComponentReference & NewVisuals
)
Set the thumb visuals using a component reference, this is necessary if the visuals will be serialized.
function GetValue
inline float GetValue() const
function SetValue
void SetValue(
float NewValue
)
function GetTrackLength
inline float GetTrackLength() const
function SetTrackLength
void SetTrackLength(
float NewTrackLength
)
function GetValueLowerBound
inline float GetValueLowerBound() const
function SetValueLowerBound
void SetValueLowerBound(
float NewLowerBound
)
function GetValueUpperBound
inline float GetValueUpperBound() const
function SetValueUpperBound
void SetValueUpperBound(
float NewUpperBound
)
function GetUseSteppedMovement
inline bool GetUseSteppedMovement() const
function SetUseSteppedMovement
void SetUseSteppedMovement(
bool bNewUseSteppedMovement
)
function GetNumSteps
inline int GetNumSteps() const
function SetNumSteps
void SetNumSteps(
int NewNumSteps
)
function GetLerpTime
inline float GetLerpTime() const
function SetLerpTime
void SetLerpTime(
float NewLerpTime
)
function GetCollisionProfile
inline FName GetCollisionProfile() const
function SetCollisionProfile
void SetCollisionProfile(
FName NewCollisionProfile
)
Protected Functions Documentation
function BeginPlay
virtual void BeginPlay() override
Reimplements: UUxtUIElementComponent::BeginPlay
function IsGrabFocusable_Implementation
virtual bool IsGrabFocusable_Implementation(
const UPrimitiveComponent * Primitive
) const override
function CanHandleGrab_Implementation
virtual bool CanHandleGrab_Implementation(
UPrimitiveComponent * Primitive
) const override
function OnEnterGrabFocus_Implementation
virtual void OnEnterGrabFocus_Implementation(
UUxtNearPointerComponent * Pointer
) override
function OnUpdateGrabFocus_Implementation
virtual void OnUpdateGrabFocus_Implementation(
UUxtNearPointerComponent * Pointer
) override
function OnExitGrabFocus_Implementation
virtual void OnExitGrabFocus_Implementation(
UUxtNearPointerComponent * Pointer
) override
function OnBeginGrab_Implementation
virtual void OnBeginGrab_Implementation(
UUxtNearPointerComponent * Pointer
) override
function OnUpdateGrab_Implementation
virtual void OnUpdateGrab_Implementation(
UUxtNearPointerComponent * Pointer
) override
function OnEndGrab_Implementation
virtual void OnEndGrab_Implementation(
UUxtNearPointerComponent * Pointer
) override
function IsFarFocusable_Implementation
virtual bool IsFarFocusable_Implementation(
const UPrimitiveComponent * Primitive
) const override
function CanHandleFar_Implementation
virtual bool CanHandleFar_Implementation(
UPrimitiveComponent * Primitive
) const override
function OnEnterFarFocus_Implementation
virtual void OnEnterFarFocus_Implementation(
UUxtFarPointerComponent * Pointer
) override
function OnUpdatedFarFocus_Implementation
virtual void OnUpdatedFarFocus_Implementation(
UUxtFarPointerComponent * Pointer
) override
function OnExitFarFocus_Implementation
virtual void OnExitFarFocus_Implementation(
UUxtFarPointerComponent * Pointer
) override
function OnFarPressed_Implementation
virtual void OnFarPressed_Implementation(
UUxtFarPointerComponent * Pointer
) override
function OnFarDragged_Implementation
virtual void OnFarDragged_Implementation(
UUxtFarPointerComponent * Pointer
) override
function OnFarReleased_Implementation
virtual void OnFarReleased_Implementation(
UUxtFarPointerComponent * Pointer
) override
Public Attributes Documentation
variable OnUpdateState
FUxtPinchSliderUpdateStateDelegate OnUpdateState;
Event raised when slider changes state.
variable OnBeginFocus
FUxtPinchSliderBeginFocusDelegate OnBeginFocus;
Event raised when a pointer starts focusing the slider.
variable OnUpdateFocus
FUxtPinchSliderUpdateFocusDelegate OnUpdateFocus;
Event raised when a focusing pointer updates.
variable OnEndFocus
FUxtPinchSliderEndFocusDelegate OnEndFocus;
Event raised when a pointer stops focusing the slider.
variable OnBeginGrab
FUxtPinchSliderBeginGrabDelegate OnBeginGrab;
Event raised when slider is grabbed.
variable OnUpdateValue
FUxtPinchSliderUpdateValueDelegate OnUpdateValue;
Event raised when slider's value changes.
variable OnEndGrab
FUxtPinchSliderEndGrabDelegate OnEndGrab;
Event raised when slider is released.
variable OnEnable
FUxtPinchSliderEnableDelegate OnEnable;
Event raised when slider is enabled.
variable OnDisable
FUxtPinchSliderDisableDelegate OnDisable;
Event raised when slider is disabled.
Updated on 19 August 2021 at 17:42:52 Coordinated Universal Time