AUxtPressableToggleButtonActor
A derived actor of AUxtPressableButtonActor with a UUxtToggleStateComponent component to track state and visuals for a button can which can be toggled on or off (checked or unchecked).
class AUxtPressableToggleButtonActor;
Header
#include <Controls/UxtPressableToggleButtonActor.h>
Inheritance
Inherits from AUxtPressableButtonActor, AUxtBasePressableButtonActor, AActor, IUxtCollectionObject
Inherited by AUxtPressableCheckButtonActor, AUxtPressableRadioButtonActor
Public Functions
| Name | |
|---|---|
| AUxtPressableToggleButtonActor() | |
| virtual void | OnConstruction(const FTransform & Transform) override |
| virtual void | BeginPlay() override |
| virtual void | ConstructVisuals() override |
| virtual void | UpdateToggleVisuals() |
| bool | IsInitiallyChecked() const |
| void | SetIsInitiallyChecked(bool InitiallyChecked) |
| void | RemoveTogglePlate() |
Protected Functions
| Name | |
|---|---|
| virtual void | OnButtonPressed(UUxtPressableButtonComponent * Button, UUxtPointerComponent * Pointer) override |
| virtual void | OnButtonReleased(UUxtPressableButtonComponent * Button, UUxtPointerComponent * Pointer) override |
| virtual void | OnButtonToggled(UUxtToggleStateComponent * ToggleState) |
Protected Attributes
| Name | |
|---|---|
| bool | bToggleOnRelease |
| UUxtToggleStateComponent * | ToggleStateComponent |
| UUxtBackPlateComponent * | TogglePlateComponent |
| bool | bIsInitiallyChecked |
Additional inherited members
Public Functions inherited from AUxtPressableButtonActor
| Name | |
|---|---|
| AUxtPressableButtonActor() | |
| virtual void | Tick(float DeltaTime) override |
| 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 | 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 AUxtPressableToggleButtonActor
AUxtPressableToggleButtonActor()
function OnConstruction
virtual void OnConstruction(
const FTransform & Transform
) override
Reimplements: AUxtPressableButtonActor::OnConstruction
Ensures the toggle visuals get updated when constructed.
function BeginPlay
virtual void BeginPlay() override
Subscribes to toggle events and sets the initial toggle state.
function ConstructVisuals
virtual void ConstructVisuals() override
Reimplements: AUxtPressableButtonActor::ConstructVisuals
Adds toggle visuals and components.
function UpdateToggleVisuals
virtual void UpdateToggleVisuals()
Reimplemented by: AUxtPressableCheckButtonActor::UpdateToggleVisuals, AUxtPressableRadioButtonActor::UpdateToggleVisuals, AUxtPressableSwitchButtonActor::UpdateToggleVisuals
Alters the toggle visuals when the toggle state changes.
function IsInitiallyChecked
inline bool IsInitiallyChecked() const
Gets if the button was toggled on at BeginPlay.
function SetIsInitiallyChecked
void SetIsInitiallyChecked(
bool InitiallyChecked
)
Sets if the button was toggled on at BeginPlay. This method has no function after BeginPlay.
function RemoveTogglePlate
void RemoveTogglePlate()
Option to remove the toggle plate if it is not needed for this button (for example in derived classes).
Protected Functions Documentation
function OnButtonPressed
virtual void OnButtonPressed(
UUxtPressableButtonComponent * Button,
UUxtPointerComponent * Pointer
) override
Reimplements: AUxtPressableButtonActor::OnButtonPressed
Button pressed event delegate.
function OnButtonReleased
virtual void OnButtonReleased(
UUxtPressableButtonComponent * Button,
UUxtPointerComponent * Pointer
) override
Reimplements: AUxtPressableButtonActor::OnButtonReleased
Button released event delegate.
function OnButtonToggled
virtual void OnButtonToggled(
UUxtToggleStateComponent * ToggleState
)
Updates the toggle visuals when the toggles state changes.
Protected Attributes Documentation
variable bToggleOnRelease
bool bToggleOnRelease = false;
Should the button toggle on press or release?
variable ToggleStateComponent
UUxtToggleStateComponent * ToggleStateComponent = nullptr;
Component which keeps track of the toggled state.
variable TogglePlateComponent
UUxtBackPlateComponent * TogglePlateComponent = nullptr;
Visual component to indicate the toggled state.
variable bIsInitiallyChecked
UPROPERTY(EditAnywhere, Category="Uxt Pressable Button", BlueprintGetter="IsInitiallyChecked", BlueprintSetter="SetIsInitiallyChecked")
bool bIsInitiallyChecked;
Should the button be toggled on or off at BeginPlay?
Updated on 19 August 2021 at 17:42:51 Coordinated Universal Time