Show / Hide Table of Contents

    AUxtPressableCheckButtonActor

    A derived actor of AUxtPressableToggleButtonActor which represents the toggle state with a check icon.

    class AUxtPressableCheckButtonActor;
    

    Header

    #include <Controls/UxtPressableCheckButtonActor.h>

    Inheritance

    Inherits from AUxtPressableToggleButtonActor, AUxtPressableButtonActor, AUxtBasePressableButtonActor, AActor, IUxtCollectionObject

    Public Functions

    Name
    AUxtPressableCheckButtonActor()
    virtual void UpdateToggleVisuals() override
    const FUxtIconBrush & GetUncheckedIconBrush() const
    void SetUncheckedIconBrush(const FUxtIconBrush & Brush)
    const FUxtIconBrush & GetCheckedIconBrush() const
    void SetCheckedIconBrush(const FUxtIconBrush & Brush)

    Protected Attributes

    Name
    FUxtIconBrush UncheckedIconBrush
    FUxtIconBrush CheckedIconBrush

    Additional inherited members

    Public Functions inherited from AUxtPressableToggleButtonActor

    Name
    AUxtPressableToggleButtonActor()
    virtual void OnConstruction(const FTransform & Transform) override
    virtual void BeginPlay() override
    virtual void ConstructVisuals() override
    bool IsInitiallyChecked() const
    void SetIsInitiallyChecked(bool InitiallyChecked)
    void RemoveTogglePlate()

    Protected Functions inherited from AUxtPressableToggleButtonActor

    Name
    virtual void OnButtonPressed(UUxtPressableButtonComponent * Button, UUxtPointerComponent * Pointer) override
    virtual void OnButtonReleased(UUxtPressableButtonComponent * Button, UUxtPointerComponent * Pointer) override
    virtual void OnButtonToggled(UUxtToggleStateComponent * ToggleState)

    Protected Attributes inherited from AUxtPressableToggleButtonActor

    Name
    bool bToggleOnRelease
    UUxtToggleStateComponent * ToggleStateComponent
    UUxtBackPlateComponent * TogglePlateComponent
    bool bIsInitiallyChecked

    Public Functions inherited from AUxtPressableButtonActor

    Name
    AUxtPressableButtonActor()
    virtual void OnConstruction(const FTransform & Transform) override
    virtual void Tick(float DeltaTime) override
    virtual void ConstructVisuals()
    virtual void ConstructIcon()
    virtual void ConstructLabel()
    bool BeginPulse(const UUxtPointerComponent * Pointer)
    bool IsPulsing() const
    FVector GetMillimeterSize() const
    void SetMillimeterSize(FVector Size)
    FVector GetSize() const
    void SetSize(FVector Size)
    bool IsPlated() const
    void SetIsPlated(bool IsPlated)
    const FUxtIconBrush & GetIconBrush() const
    void SetIconBrush(const FUxtIconBrush & Brush)
    const FText & GetLabel() const
    void SetLabel(const FText & NewLabel)
    const FUxtTextBrush & GetLabelTextBrush() const
    void SetLabelTextBrush(const FUxtTextBrush & Brush)
    const FUxtButtonBrush & GetButtonBrush() const
    void SetButtonBrush(const FUxtButtonBrush & Brush)

    Protected Functions inherited from AUxtPressableButtonActor

    Name
    virtual void OnButtonPressed(UUxtPressableButtonComponent * Button, UUxtPointerComponent * Pointer)
    virtual void OnButtonReleased(UUxtPressableButtonComponent * Button, UUxtPointerComponent * Pointer)
    virtual void OnBeginFocus(UUxtPressableButtonComponent * Button, UUxtPointerComponent * Pointer, bool WasAlreadyFocused)
    virtual void OnButtonEnabled(UUxtPressableButtonComponent * Button)
    virtual void OnButtonDisabled(UUxtPressableButtonComponent * Button)
    virtual bool AnimatePulse(float DeltaTime)
    virtual bool AnimateFocus(float DeltaTime)
    template <class T >
    T *
    CreateAndAttachComponent(FName Name, USceneComponent * Parent)

    Protected Attributes inherited from AUxtPressableButtonActor

    Name
    FVector MillimeterSize
    bool bIsPlated
    FText Label
    FUxtTextBrush LabelTextBrush
    FUxtButtonBrush ButtonBrush
    USceneComponent * BackPlatePivotComponent
    UUxtBackPlateComponent * BackPlateMeshComponent
    USceneComponent * FrontPlatePivotComponent
    USceneComponent * FrontPlateCenterComponent
    UStaticMeshComponent * FrontPlateMeshComponent
    UTextRenderComponent * IconComponent
    UTextRenderComponent * LabelComponent
    UAudioComponent * AudioComponent
    float PulseTimer
    float PulseFadeTimer
    UMaterialInterface * PrePulseMaterial
    UMaterialInstanceDynamic * PulseMaterialInstance
    uint32 MaterialIndex
    float FocusTimer
    bool bCanEditIconBrush
    FUxtIconBrush IconBrush

    Public Functions inherited from AUxtBasePressableButtonActor

    Name
    AUxtBasePressableButtonActor()
    TScriptInterface< IUxtPokeTarget > GetPokeTarget()
    virtual TScriptInterface< IUxtPokeTarget > GetPokeTarget_Implementation() override
    TScriptInterface< IUxtFarTarget > GetFarTarget()
    virtual TScriptInterface< IUxtFarTarget > GetFarTarget_Implementation() override
    UUxtPressableButtonComponent * GetButtonComponent() const

    Protected Attributes inherited from AUxtBasePressableButtonActor

    Name
    UUxtPressableButtonComponent * ButtonComponent

    Public Functions inherited from IUxtCollectionObject

    Name
    TScriptInterface< IUxtPokeTarget > GetPokeTarget()
    TScriptInterface< IUxtFarTarget > GetFarTarget()

    Public Functions Documentation

    function AUxtPressableCheckButtonActor

    AUxtPressableCheckButtonActor()
    

    function UpdateToggleVisuals

    virtual void UpdateToggleVisuals() override
    

    Reimplements: AUxtPressableToggleButtonActor::UpdateToggleVisuals

    Alters the toggle visuals when the toggle state changes.

    function GetUncheckedIconBrush

    inline const FUxtIconBrush & GetUncheckedIconBrush() const
    

    Accessor to the button's unchecked icon brush.

    function SetUncheckedIconBrush

    void SetUncheckedIconBrush(
        const FUxtIconBrush & Brush
    )
    

    Applies a new unchecked icon brush.

    function GetCheckedIconBrush

    inline const FUxtIconBrush & GetCheckedIconBrush() const
    

    Accessor to the button's checked icon brush.

    function SetCheckedIconBrush

    void SetCheckedIconBrush(
        const FUxtIconBrush & Brush
    )
    

    Applies a new checked icon brush.

    Protected Attributes Documentation

    variable UncheckedIconBrush

    UPROPERTY(EditAnywhere, Category="Uxt Pressable Button", BlueprintGetter="GetUncheckedIconBrush", BlueprintSetter="SetUncheckedIconBrush")
    FUxtIconBrush UncheckedIconBrush;
    

    Structure which contains properties for the button's icon when unchecked.

    variable CheckedIconBrush

    UPROPERTY(EditAnywhere, Category="Uxt Pressable Button", BlueprintGetter="GetCheckedIconBrush", BlueprintSetter="SetCheckedIconBrush")
    FUxtIconBrush CheckedIconBrush;
    

    Structure which contains properties for the button's icon when checked.


    Updated on 2 November 2021 at 11:40:25 Coordinated Universal Time

    • Improve this Doc
    Back to top Generated by DocFX