Class UUxtPressableButtonComponent

Component that turns the actor it is attached to into a pressable rectangular button.

Inheritance
System::Object
USceneComponent
UUxtUIElementComponent
UUxtPressableButtonComponent
Inherited Members
Namespace:
Assembly: .dll
Syntax
public: class UUxtPressableButtonComponent : public xtUIElementComponent, public xtPokeTarget, public xtPokeHandler, public xtFarTarget, public xtFarHandler, public xtCollectionObject

Constructors

| Improve this Doc View Source

UUxtPressableButtonComponent()

Declaration
public: UUxtPressableButtonComponent()

Fields

| Improve this Doc View Source

OnBeginFocus

Event raised when a pointer starts focusing the button. WasFocused indicates if the button was already focused by another pointer.

Declaration
public: FUxtButtonBeginFocusDelegate OnBeginFocus
Field Value
Type Description
FUxtButtonBeginFocusDelegate
| Improve this Doc View Source

OnBeginPoke

Event raised when a pointer starts poking the Pressable Button.

Declaration
public: FUxtButtonBeginPokeDelegate OnBeginPoke
Field Value
Type Description
FUxtButtonBeginPokeDelegate
| Improve this Doc View Source

OnButtonDisabled

Event raised when the button is disabled.

Declaration
public: FUxtButtonDisabledDelegate OnButtonDisabled
Field Value
Type Description
FUxtButtonDisabledDelegate
| Improve this Doc View Source

OnButtonEnabled

Event raised when the button is enabled.

Declaration
public: FUxtButtonEnabledDelegate OnButtonEnabled
Field Value
Type Description
FUxtButtonEnabledDelegate
| Improve this Doc View Source

OnButtonPressed

Event raised when the button reaches the pressed distance.

Declaration
public: FUxtButtonPressedDelegate OnButtonPressed
Field Value
Type Description
FUxtButtonPressedDelegate
| Improve this Doc View Source

OnButtonReleased

Event raised when the a pressed button reaches the released distance.

Declaration
public: FUxtButtonReleasedDelegate OnButtonReleased
Field Value
Type Description
FUxtButtonReleasedDelegate
| Improve this Doc View Source

OnEndFocus

Event raised when a pointer ends focusing the Pressable Button. IsFocused indicates if the Pressable Button is still focused by another pointer.

Declaration
public: FUxtButtonEndFocusDelegate OnEndFocus
Field Value
Type Description
FUxtButtonEndFocusDelegate
| Improve this Doc View Source

OnEndPoke

Event raised when a pointer ends poking the Pressable Button.

Declaration
public: FUxtButtonEndPokeDelegate OnEndPoke
Field Value
Type Description
FUxtButtonEndPokeDelegate
| Improve this Doc View Source

OnUpdateFocus

Event raised when a focusing pointer updates.

Declaration
public: FUxtButtonUpdateFocusDelegate OnUpdateFocus
Field Value
Type Description
FUxtButtonUpdateFocusDelegate
| Improve this Doc View Source

OnUpdatePoke

Event raised while a pointer is poking the Pressable Button.

Declaration
public: FUxtButtonUpdatePokeDelegate OnUpdatePoke
Field Value
Type Description
FUxtButtonUpdatePokeDelegate
| Improve this Doc View Source

PressedFraction

Fraction of the maximum travel distance at which the button will raise the pressed event.

Declaration
public: float PressedFraction= 0.5f
Field Value
Type Description
float
| Improve this Doc View Source

RecoverySpeed

Button movement speed while recovering

Declaration
public: float RecoverySpeed= 50
Field Value
Type Description
float
| Improve this Doc View Source

ReleasedFraction

Fraction of the maximum travel distance at which a pressed button will raise the released event.

Declaration
public: float ReleasedFraction= 0.2f
Field Value
Type Description
float

Methods

| Improve this Doc View Source

BeginPlay()

Declaration
protected: virtual void BeginPlay() override
Overrides
| Improve this Doc View Source

CanHandleFar_Implementation(UPrimitiveComponent *Primitive)

Declaration
protected: virtual bool CanHandleFar_Implementation(UPrimitiveComponent *Primitive) const override
Parameters
Type Name Description
UPrimitiveComponent * Primitive
Returns
Type Description
bool
| Improve this Doc View Source

CanHandlePoke_Implementation(UPrimitiveComponent *Primitive)

Declaration
protected: virtual bool CanHandlePoke_Implementation(UPrimitiveComponent *Primitive) const override
Parameters
Type Name Description
UPrimitiveComponent * Primitive
Returns
Type Description
bool
| Improve this Doc View Source

GetClosestPoint_Implementation(const UPrimitiveComponent *Primitive, const FVector &Point, FVector &OutClosestPoint, FVector &OutNormal)

Declaration
protected: virtual bool GetClosestPoint_Implementation(const UPrimitiveComponent *Primitive, const FVector &Point, FVector &OutClosestPoint, FVector &OutNormal) const override
Parameters
Type Name Description
const UPrimitiveComponent * Primitive
const FVector & Point
FVector & OutClosestPoint
FVector & OutNormal
Returns
Type Description
bool
| Improve this Doc View Source

GetFrontFaceCollisionFraction()

Get the distance from the visuals front face to the collider front face.

Declaration
public: float GetFrontFaceCollisionFraction() const
Returns
Type Description
float
| Improve this Doc View Source

GetMaxPushDistance()

Gets the maximum distance the button can be pushed

Declaration
public: float GetMaxPushDistance() const
Returns
Type Description
float
| Improve this Doc View Source

GetPokeBehaviour_Implementation()

Declaration
protected: virtual EUxtPokeBehaviour GetPokeBehaviour_Implementation() const override
Returns
Type Description
EUxtPokeBehaviour
| Improve this Doc View Source

GetPushBehavior()

Gets the button behavior when pushed

Declaration
public: EUxtPushBehavior GetPushBehavior() const
Returns
Type Description
EUxtPushBehavior
| Improve this Doc View Source

GetScaleAdjustedMaxPushDistance()

Gets the maximum distance the button can be pushed scaled by the transform's 'x' scale.

Declaration
public: float GetScaleAdjustedMaxPushDistance() const
Returns
Type Description
float
| Improve this Doc View Source

GetState()

Get the current state of the button

Declaration
public: EUxtButtonState GetState() const
Returns
Type Description
EUxtButtonState
| Improve this Doc View Source

GetVisuals()

Get scene component used for the moving visuals

Declaration
public: USceneComponent * GetVisuals() const
Returns
Type Description
USceneComponent *
| Improve this Doc View Source

IsFarFocusable_Implementation(const UPrimitiveComponent *Primitive)

Declaration
protected: virtual bool IsFarFocusable_Implementation(const UPrimitiveComponent *Primitive) const override
Parameters
Type Name Description
const UPrimitiveComponent * Primitive
Returns
Type Description
bool
| Improve this Doc View Source

IsPokeFocusable_Implementation(const UPrimitiveComponent *Primitive)

Declaration
protected: virtual bool IsPokeFocusable_Implementation(const UPrimitiveComponent *Primitive) const override
Parameters
Type Name Description
const UPrimitiveComponent * Primitive
Returns
Type Description
bool
| Improve this Doc View Source

OnBeginPoke_Implementation(UUxtNearPointerComponent *Pointer)

Declaration
protected: virtual void OnBeginPoke_Implementation(UUxtNearPointerComponent *Pointer) override
Parameters
Type Name Description
UUxtNearPointerComponent * Pointer
| Improve this Doc View Source

OnEndPoke_Implementation(UUxtNearPointerComponent *Pointer)

Declaration
protected: virtual void OnEndPoke_Implementation(UUxtNearPointerComponent *Pointer) override
Parameters
Type Name Description
UUxtNearPointerComponent * Pointer
| Improve this Doc View Source

OnEnterFarFocus_Implementation(UUxtFarPointerComponent *Pointer)

Declaration
protected: virtual void OnEnterFarFocus_Implementation(UUxtFarPointerComponent *Pointer) override
Parameters
Type Name Description
UUxtFarPointerComponent * Pointer
| Improve this Doc View Source

OnEnterPokeFocus_Implementation(UUxtNearPointerComponent *Pointer)

Declaration
protected: virtual void OnEnterPokeFocus_Implementation(UUxtNearPointerComponent *Pointer) override
Parameters
Type Name Description
UUxtNearPointerComponent * Pointer
| Improve this Doc View Source

OnExitFarFocus_Implementation(UUxtFarPointerComponent *Pointer)

Declaration
protected: virtual void OnExitFarFocus_Implementation(UUxtFarPointerComponent *Pointer) override
Parameters
Type Name Description
UUxtFarPointerComponent * Pointer
| Improve this Doc View Source

OnExitPokeFocus_Implementation(UUxtNearPointerComponent *Pointer)

Declaration
protected: virtual void OnExitPokeFocus_Implementation(UUxtNearPointerComponent *Pointer) override
Parameters
Type Name Description
UUxtNearPointerComponent * Pointer
| Improve this Doc View Source

OnFarPressed_Implementation(UUxtFarPointerComponent *Pointer)

Declaration
protected: virtual void OnFarPressed_Implementation(UUxtFarPointerComponent *Pointer) override
Parameters
Type Name Description
UUxtFarPointerComponent * Pointer
| Improve this Doc View Source

OnFarReleased_Implementation(UUxtFarPointerComponent *Pointer)

Declaration
protected: virtual void OnFarReleased_Implementation(UUxtFarPointerComponent *Pointer) override
Parameters
Type Name Description
UUxtFarPointerComponent * Pointer
| Improve this Doc View Source

OnUpdatedFarFocus_Implementation(UUxtFarPointerComponent *Pointer)

Declaration
protected: virtual void OnUpdatedFarFocus_Implementation(UUxtFarPointerComponent *Pointer) override
Parameters
Type Name Description
UUxtFarPointerComponent * Pointer
| Improve this Doc View Source

OnUpdatePoke_Implementation(UUxtNearPointerComponent *Pointer)

Declaration
protected: virtual void OnUpdatePoke_Implementation(UUxtNearPointerComponent *Pointer) override
Parameters
Type Name Description
UUxtNearPointerComponent * Pointer
| Improve this Doc View Source

OnUpdatePokeFocus_Implementation(UUxtNearPointerComponent *Pointer)

Declaration
protected: virtual void OnUpdatePokeFocus_Implementation(UUxtNearPointerComponent *Pointer) override
Parameters
Type Name Description
UUxtNearPointerComponent * Pointer
| Improve this Doc View Source

SetCollisionProfile(FName Profile)

Set collision profile used by the button collider

Declaration
public: void SetCollisionProfile(FName Profile)
Parameters
Type Name Description
FName Profile
| Improve this Doc View Source

SetEnabled(bool Enabled)

Set if the button is enabled

Declaration
public: void SetEnabled(bool Enabled)
Parameters
Type Name Description
bool Enabled
| Improve this Doc View Source

SetFrontFaceCollisionFraction(float Distance)

Set the distance from the visuals front face to the collider front face.

Declaration
public: void SetFrontFaceCollisionFraction(float Distance)
Parameters
Type Name Description
float Distance
| Improve this Doc View Source

SetMaxPushDistance(float Distance)

Sets the maximum distance the button can be pushed, does nothing when the push behavior is set to compress because the maximum distance is auto calculated

Declaration
public: void SetMaxPushDistance(float Distance)
Parameters
Type Name Description
float Distance
| Improve this Doc View Source

SetPushBehavior(EUxtPushBehavior Behavior)

Sets the button behavior when pushed

Declaration
public: void SetPushBehavior(EUxtPushBehavior Behavior)
Parameters
Type Name Description
EUxtPushBehavior Behavior
| Improve this Doc View Source

SetUseAbsolutePushDistance(bool bAbsolute)

Switch between world and local space for button distances

Declaration
public: void SetUseAbsolutePushDistance(bool bAbsolute)
Parameters
Type Name Description
bool bAbsolute
| Improve this Doc View Source

SetVisuals(const FComponentReference &ComponentReference)

Set scene component reference to be used for the moving visuals. This method should be called if the visual reference should be serialized.

Declaration
public: void SetVisuals(const FComponentReference &ComponentReference)
Parameters
Type Name Description
const FComponentReference & ComponentReference
| Improve this Doc View Source

SetVisuals(USceneComponent *Visuals)

Set scene component to be used for the moving visuals

Declaration
public: void SetVisuals(USceneComponent *Visuals)
Parameters
Type Name Description
USceneComponent * Visuals
| Improve this Doc View Source

TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction)

Declaration
protected: virtual void TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override
Parameters
Type Name Description
float DeltaTime
ELevelTick TickType
FActorComponentTickFunction * ThisTickFunction
| Improve this Doc View Source

VisualBoundsFilter(const USceneComponent *Component)

Filter function used by the button when calculating the hierarchy bounds of the visuals

Declaration
public: static bool VisualBoundsFilter(const USceneComponent *Component)
Parameters
Type Name Description
const USceneComponent * Component
Returns
Type Description
bool