public/0.8.xpublic/0.9.xpublic/0.10.xpublic/0.11.x
  • Features
  • API Documentation
  • API Documentation
  • AUxtPressableSwitchButtonActor

    Show / Hide Table of Contents
    • AUxtBasePressableButtonActor
    • AUxtHandInteractionActor
    • AUxtPinchSliderActor
    • AUxtPressableButtonActor
    • AUxtPressableCheckButtonActor
    • AUxtPressableRadioButtonActor
    • AUxtPressableSwitchButtonActor
    • AUxtPressableToggleButtonActor
    • AUxtTextRenderActor
    • AXRSimulationActor
    • FDummyHandTracker
    • FScrollingCollectionProperties
    • FUXToolsEditorModule
    • FUXToolsInputModule
    • FUXToolsModule
    • FUXToolsShadersModule
    • FUxtAffordanceConfig
    • FUxtAffordanceInstance
    • FUxtButtonAudioBrush
    • FUxtButtonBrush
    • FUxtButtonVisualsBrush
    • FUxtDefaultHandTracker
    • FUxtFontCharacter
    • FUxtGrabPointerData
    • FUxtGrabPointerFocus
    • FUxtHandProximityMeshData
    • FUxtIconBrush
    • FUxtIconBrushCustomization
    • FUxtInteractionUtils
    • FUxtManipulatorComponentCustomization
    • FUxtPointerFocus
    • FUxtPointerFocusSearchResult
    • FUxtPokePointerFocus
    • FUxtPressableButtonComponentVisualizer
    • FUxtTextBrush
    • FUxtTooltipSpawnerComponentVisualizer
    • FUxtXRSimulationViewExtension
    • FXRInputAnimationUtils
    • FXRSimulationEditorModule
    • FXRSimulationHMD
    • FXRSimulationHandPoseKeyMapping
    • FXRSimulationHandState
    • FXRSimulationInputDevice
    • FXRSimulationKeys
    • FXRSimulationState
    • IUxtCollectionObject
    • IUxtFarHandler
    • IUxtFarTarget
    • IUxtGrabHandler
    • IUxtGrabTarget
    • IUxtHandTracker
    • IUxtPokeHandler
    • IUxtPokeTarget
    • UUxtBaseObjectCollection
    • UUxtBoundsControlComponent
    • UUxtBoundsControlConfig
    • UUxtCollectionObject
    • UUxtConstraintPickerWidget
    • UUxtDefaultHandTrackerSubsystem
    • UUxtFaceUserConstraint
    • UUxtFarBeamComponent
    • UUxtFarCursorComponent
    • UUxtFarHandler
    • UUxtFarPointerComponent
    • UUxtFarTarget
    • UUxtFingerCursorComponent
    • UUxtFixedDistanceConstraint
    • UUxtFixedRotationToUserConstraint
    • UUxtFixedRotationToWorldConstraint
    • UUxtFollowComponent
    • UUxtFunctionLibrary
    • UUxtGrabHandler
    • UUxtGrabPointerDataFunctionLibrary
    • UUxtGrabTarget
    • UUxtGrabTargetComponent
    • UUxtHandConstraintComponent
    • UUxtHandMeshCollisionDeactivationComponent
    • UUxtIconBrushEditorUtilityWidget
    • UUxtInputSubsystem
    • UUxtInternalFunctionLibrary
    • UUxtMaintainApparentSizeConstraint
    • UUxtManipulatorComponent
    • UUxtManipulatorComponentBase
    • UUxtMathUtilsFunctionLibrary
    • UUxtMoveAxisConstraint
    • UUxtNearPointerComponent
    • UUxtPalmUpConstraintComponent
    • UUxtPinchSliderComponent
    • UUxtPointerComponent
    • UUxtPokeHandler
    • UUxtPokeTarget
    • UUxtPressableButtonComponent
    • UUxtRotationAxisConstraint
    • UUxtTapToPlaceComponent
    • UUxtTextRenderComponent
    • UUxtToggleGroupComponent
    • UUxtTouchBasedHandTrackerComponent
    • UUxtTouchBasedHandTrackerSubsystem
    • UUxtTouchableVolumeComponent
    • UUxtTransformConstraint
    • UUxtUIElementComponent
    • UUxtWidgetComponent
    • UUxtXRSimulationSubsystem
    • UXRSimulationHeadMovementComponent
    • UXRSimulationRuntimeSettings
    • UXTools
    • UXToolsEditor
    • UXToolsInput
    • UXToolsShaders
    • UxtAffordanceInteractionCache
    • UxtManipulationMoveLogic
    • UxtTwoHandManipulationRotateLogic
    • UxtTwoHandManipulationScaleLogic
    • XRSimulation
    • XRSimulationEditor
    • XRSimulationInput

    AUxtPressableSwitchButtonActor

    A derived actor of AUxtPressableRadioButtonActor which represents the toggle state with a switch that animates left and right.

    class AUxtPressableSwitchButtonActor;
    

    Header

    #include <Controls/UxtPressableSwitchButtonActor.h>

    Inheritance

    Inherits from AUxtPressableRadioButtonActor, AUxtPressableToggleButtonActor, AUxtPressableButtonActor, AUxtBasePressableButtonActor, AActor, IUxtCollectionObject

    Public Functions

    Name
    AUxtPressableSwitchButtonActor()
    virtual void UpdateToggleVisuals() override
    const FUxtIconBrush & GetSwitchedOffIconBrush() const
    void SetSwitchedOffIconBrush(const FUxtIconBrush & Brush)
    const FUxtIconBrush & GetSwitchedOnIconBrush() const
    void SetSwitchedOnIconBrush(const FUxtIconBrush & Brush)

    Protected Attributes

    Name
    FUxtIconBrush SwitchedOffIconBrush
    FUxtIconBrush SwitchedOnIconBrush

    Additional inherited members

    Public Functions inherited from AUxtPressableRadioButtonActor

    Name
    AUxtPressableRadioButtonActor()
    virtual void ConstructIcon() override

    Protected Attributes inherited from AUxtPressableRadioButtonActor

    Name
    UTextRenderComponent * CenterIconComponent

    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 AUxtPressableSwitchButtonActor

    AUxtPressableSwitchButtonActor()
    

    function UpdateToggleVisuals

    virtual void UpdateToggleVisuals() override
    

    Reimplements: AUxtPressableRadioButtonActor::UpdateToggleVisuals

    Alters the toggle visuals when the toggle state changes.

    function GetSwitchedOffIconBrush

    inline const FUxtIconBrush & GetSwitchedOffIconBrush() const
    

    Accessor to the button's switched off icon brush.

    function SetSwitchedOffIconBrush

    void SetSwitchedOffIconBrush(
        const FUxtIconBrush & Brush
    )
    

    Applies a new switched off icon brush.

    function GetSwitchedOnIconBrush

    inline const FUxtIconBrush & GetSwitchedOnIconBrush() const
    

    Accessor to the button's switched on icon brush.

    function SetSwitchedOnIconBrush

    void SetSwitchedOnIconBrush(
        const FUxtIconBrush & Brush
    )
    

    Applies a new switched on icon brush.

    Protected Attributes Documentation

    variable SwitchedOffIconBrush

    UPROPERTY(EditAnywhere, Category="Uxt Pressable Button", BlueprintGetter="GetSwitchedOffIconBrush", BlueprintSetter="SetSwitchedOffIconBrush")
    FUxtIconBrush SwitchedOffIconBrush;
    

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

    variable SwitchedOnIconBrush

    UPROPERTY(EditAnywhere, Category="Uxt Pressable Button", BlueprintGetter="GetSwitchedOnIconBrush", BlueprintSetter="SetSwitchedOnIconBrush")
    FUxtIconBrush SwitchedOnIconBrush;
    

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


    Updated on 19 August 2021 at 17:42:51 Coordinated Universal Time

    • Improve this Doc
    In This Article
    • Header
    • Inheritance
    • Public Functions
    • Protected Attributes
    • Additional inherited members
    • Public Functions Documentation
      • function AUxtPressableSwitchButtonActor
      • function UpdateToggleVisuals
      • function GetSwitchedOffIconBrush
      • function SetSwitchedOffIconBrush
      • function GetSwitchedOnIconBrush
      • function SetSwitchedOnIconBrush
    • Protected Attributes Documentation
      • variable SwitchedOffIconBrush
      • variable SwitchedOnIconBrush
    Back to top Generated by DocFX