SRotatorInputBox.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Layout/Margin.h"
#include "Misc/AxisDisplayInfo.h"
#include "Fonts/SlateFontInfo.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SWidget.h"
#include "Widgets/SCompoundWidget.h"
#include "Styling/CoreStyle.h"
#include "Framework/SlateDelegates.h"
#include "Widgets/Input/NumericTypeInterface.h"
#include "Widgets/Input/SNumericEntryBox.h"
 
class FArrangedChildren;
 
template<typename NumericType>
class SNumericRotatorInputBox : public SCompoundWidget
{
    using ThisClass = SNumericRotatorInputBox<NumericType>;
    static constexpr int32 ComponentNum = 3;
public:
    DECLARE_DELEGATE_OneParam(FOnNumericValueChanged, NumericType);
 
    DECLARE_DELEGATE_TwoParams(FOnNumericValueCommitted, NumericType, ETextCommit::Type);
    
    SLATE_BEGIN_ARGS( SNumericRotatorInputBox<NumericType> )
        : _RollDisplayName(AxisDisplayInfo::GetRotationAxisNameShort(EAxisList::X))
        , _PitchDisplayName(AxisDisplayInfo::GetRotationAxisNameShort(EAxisList::Y))
        , _YawDisplayName(AxisDisplayInfo::GetRotationAxisNameShort(EAxisList::Z))
        , _bColorAxisLabels(false)
        , _Swizzle(FIntVector4(0, 1, 2, 3))
        , _Font(FAppStyle::Get().GetFontStyle("NormalFont"))
        , _AllowSpin(true)
        , _SpinDelta(1.f)
        , _LinearDeltaSensitivity(1)
        , _MinSliderValue(TOptional<NumericType>())
        , _MaxSliderValue(TOptional<NumericType>())
        , _DisplayToggle( false )
        , _TogglePitchChecked( ECheckBoxState::Checked )
        , _ToggleYawChecked( ECheckBoxState::Checked )
        , _ToggleRollChecked( ECheckBoxState::Checked )
        , _TogglePadding( FMargin( 1.f,0.f,1.f,0.f ) )
        , _PreventThrottling(false)
        {}
 
        SLATE_ATTRIBUTE( TOptional<NumericType>, Roll )
 
        
        SLATE_ATTRIBUTE( TOptional<NumericType>, Pitch )
 
        
        SLATE_ATTRIBUTE( TOptional<NumericType>, Yaw )
 
        SLATE_ATTRIBUTE( FText, RollDisplayName )
        
        SLATE_ATTRIBUTE( FText, PitchDisplayName )
        
        SLATE_ATTRIBUTE( FText, YawDisplayName )
 
        
        SLATE_ARGUMENT( bool, bColorAxisLabels )
 
        
        SLATE_ARGUMENT( FIntVector4, Swizzle)
 
        
        SLATE_ATTRIBUTE( FSlateFontInfo, Font )
 
        
        SLATE_ARGUMENT( bool, AllowSpin )
 
        
        SLATE_ATTRIBUTE(NumericType, SpinDelta)
 
        
        SLATE_ATTRIBUTE(int32, LinearDeltaSensitivity)
 
        
        SLATE_ATTRIBUTE( TOptional<NumericType>, MinSliderValue )
 
        
        SLATE_ATTRIBUTE( TOptional<NumericType>, MaxSliderValue )
 
        
        SLATE_EVENT( FOnNumericValueChanged, OnPitchChanged )
 
        
        SLATE_EVENT( FOnNumericValueChanged, OnYawChanged )
 
        
        SLATE_EVENT( FOnNumericValueChanged, OnRollChanged )
 
        
        SLATE_EVENT( FOnNumericValueCommitted, OnPitchCommitted )
 
        
        SLATE_EVENT( FOnNumericValueCommitted, OnYawCommitted )
 
        
        SLATE_EVENT( FOnNumericValueCommitted, OnRollCommitted )
 
        
        SLATE_EVENT(FSimpleDelegate, OnBeginSliderMovement)
 
        
        SLATE_EVENT(FOnNumericValueChanged, OnEndSliderMovement)
    
        
        SLATE_EVENT( FSimpleDelegate, OnPitchBeginSliderMovement )
 
        
        SLATE_EVENT( FSimpleDelegate, OnYawBeginSliderMovement )
 
        
        SLATE_EVENT( FSimpleDelegate, OnRollBeginSliderMovement )
 
        
        SLATE_EVENT( FOnNumericValueChanged, OnPitchEndSliderMovement )
 
        
        SLATE_EVENT( FOnNumericValueChanged, OnYawEndSliderMovement )
 
        
        SLATE_EVENT( FOnNumericValueChanged, OnRollEndSliderMovement )
 
        
        SLATE_ARGUMENT( TSharedPtr< INumericTypeInterface<NumericType> >, TypeInterface )
 
        
        SLATE_ARGUMENT( bool, DisplayToggle )
            
        
        SLATE_ATTRIBUTE( ECheckBoxState, TogglePitchChecked )
 
        
        SLATE_ATTRIBUTE( ECheckBoxState, ToggleYawChecked )
 
        
        SLATE_ATTRIBUTE( ECheckBoxState, ToggleRollChecked )
 
        
        SLATE_EVENT( FOnCheckStateChanged, OnTogglePitchChanged )
 
        
        SLATE_EVENT( FOnCheckStateChanged, OnToggleYawChanged )
 
        
        SLATE_EVENT( FOnCheckStateChanged, OnToggleRollChanged )
 
        
        SLATE_ARGUMENT( FMargin, TogglePadding )
        
        
        SLATE_ARGUMENT(bool, PreventThrottling)
 
    SLATE_END_ARGS()
 
private:
 
    TAttribute<TOptional<FTextFormat>> BuildToolTipTextFormatString(FStringView DisplayNameString)
    {
        TStringBuilder<32> ToolTipTextFormatString;
        ToolTipTextFormatString.Append(DisplayNameString);
        ToolTipTextFormatString.Append(TEXT(": {0}"));
        TAttribute<TOptional<FTextFormat>> Attribute(FText::FromString(ToolTipTextFormatString.ToString()));
        return Attribute;
    }
 
    TSharedRef<SWidget> ConstructRoll(const FArguments& InArgs)
    {
        TSharedRef<SWidget> Widget =
            SNew(SNumericEntryBox<NumericType>)
            .AllowSpin(InArgs._AllowSpin)
            .Delta(InArgs._SpinDelta)
            .LinearDeltaSensitivity(InArgs._LinearDeltaSensitivity)
            .MinValue(InArgs._MinSliderValue)
            .MaxValue(InArgs._MaxSliderValue)
            .MinSliderValue(InArgs._MinSliderValue)
            .MaxSliderValue(InArgs._MaxSliderValue)
            .LabelPadding(FMargin(3.0f))
            .LabelLocation(SNumericEntryBox<NumericType>::ELabelLocation::Inside)
            .Label()
            [
                InArgs._bColorAxisLabels ? SNumericEntryBox<NumericType>::BuildNarrowColorLabel(AxisDisplayInfo::GetAxisColor(EAxisList::X)) : SNullWidget::NullWidget
            ]
            .Font( InArgs._Font )
            .Value( InArgs._Roll )
            .OnValueChanged( InArgs._OnRollChanged )
            .OnValueCommitted( InArgs._OnRollCommitted )
            .OnBeginSliderMovement( CreatePerComponentSliderMovementEvent(InArgs._OnBeginSliderMovement, InArgs._OnRollBeginSliderMovement) )
            .OnEndSliderMovement( CreatePerComponentSliderMovementEvent< FOnNumericValueChanged, NumericType >(InArgs._OnEndSliderMovement, InArgs._OnRollEndSliderMovement) )
            .UndeterminedString( NSLOCTEXT("SRotatorInputBox", "MultipleValues", "Multiple Values") )
            .ToolTipTextFormat(BuildToolTipTextFormatString(InArgs._RollDisplayName.Get().ToString()))
            .TypeInterface(InArgs._TypeInterface)
            .MinFractionalDigits(InArgs._TypeInterface ? InArgs._TypeInterface->GetMinFractionalDigits() : TOptional<int32>())
            .MaxFractionalDigits(InArgs._TypeInterface ? InArgs._TypeInterface->GetMaxFractionalDigits() : TOptional<int32>())
            .DisplayToggle(InArgs._DisplayToggle)
            .ToggleChecked(InArgs._ToggleRollChecked)
            .OnToggleChanged(InArgs._OnToggleRollChanged)
            .TogglePadding(InArgs._TogglePadding)
            .PreventThrottling(InArgs._PreventThrottling);
        return Widget;
    };
    
    TSharedRef<SWidget> ConstructPitch(const FArguments& InArgs)
    {
        TSharedRef<SWidget> Widget =
            SNew(SNumericEntryBox<NumericType>)
            .AllowSpin(InArgs._AllowSpin)
            .Delta(InArgs._SpinDelta)
            .LinearDeltaSensitivity(InArgs._LinearDeltaSensitivity)
            .MinValue(InArgs._MinSliderValue)
            .MaxValue(InArgs._MaxSliderValue)
            .MinSliderValue(InArgs._MinSliderValue)
            .MaxSliderValue(InArgs._MaxSliderValue)
            .LabelPadding(FMargin(3.0f))
            .LabelLocation(SNumericEntryBox<NumericType>::ELabelLocation::Inside)
            .Label()
            [
                InArgs._bColorAxisLabels ? SNumericEntryBox<NumericType>::BuildNarrowColorLabel(AxisDisplayInfo::GetAxisColor(EAxisList::Y)) : SNullWidget::NullWidget
            ]
            .Font( InArgs._Font )
            .Value( InArgs._Pitch )
            .OnValueChanged( InArgs._OnPitchChanged )
            .OnValueCommitted( InArgs._OnPitchCommitted )
            .OnBeginSliderMovement( CreatePerComponentSliderMovementEvent( InArgs._OnBeginSliderMovement, InArgs._OnPitchBeginSliderMovement ) )
            .OnEndSliderMovement( CreatePerComponentSliderMovementEvent< FOnNumericValueChanged, NumericType >( InArgs._OnEndSliderMovement, InArgs._OnPitchEndSliderMovement ) )
            .UndeterminedString( NSLOCTEXT("SRotatorInputBox", "MultipleValues", "Multiple Values") )
            .ToolTipTextFormat(BuildToolTipTextFormatString(InArgs._PitchDisplayName.Get().ToString()))
            .TypeInterface(InArgs._TypeInterface)
            .MinFractionalDigits(InArgs._TypeInterface ? InArgs._TypeInterface->GetMinFractionalDigits() : TOptional<int32>())
            .MaxFractionalDigits(InArgs._TypeInterface ? InArgs._TypeInterface->GetMaxFractionalDigits() : TOptional<int32>())
            .DisplayToggle(InArgs._DisplayToggle)
            .ToggleChecked(InArgs._TogglePitchChecked)
            .OnToggleChanged(InArgs._OnTogglePitchChanged)
            .TogglePadding(InArgs._TogglePadding)
            .PreventThrottling(InArgs._PreventThrottling);
        return Widget;
    };
 
    TSharedRef<SWidget> ConstructYaw(const FArguments& InArgs)
    {
        TSharedRef<SWidget> Widget =
            SNew(SNumericEntryBox<NumericType>)
            .AllowSpin(InArgs._AllowSpin)
            .Delta(InArgs._SpinDelta)
            .LinearDeltaSensitivity(InArgs._LinearDeltaSensitivity)
            .MinValue(InArgs._MinSliderValue)
            .MaxValue(InArgs._MaxSliderValue)
            .MinSliderValue(InArgs._MinSliderValue)
            .MaxSliderValue(InArgs._MaxSliderValue)
            .LabelPadding(FMargin(3.0f))
            .LabelLocation(SNumericEntryBox<NumericType>::ELabelLocation::Inside)
            .Label()
            [
                InArgs._bColorAxisLabels ? SNumericEntryBox<NumericType>::BuildNarrowColorLabel(AxisDisplayInfo::GetAxisColor(EAxisList::Z)) : SNullWidget::NullWidget
            ]
            .Font( InArgs._Font )
            .Value( InArgs._Yaw )
            .OnValueChanged( InArgs._OnYawChanged )
            .OnValueCommitted( InArgs._OnYawCommitted )
            .OnBeginSliderMovement( CreatePerComponentSliderMovementEvent(InArgs._OnBeginSliderMovement, InArgs._OnYawBeginSliderMovement) )
            .OnEndSliderMovement( CreatePerComponentSliderMovementEvent< FOnNumericValueChanged, NumericType >(InArgs._OnEndSliderMovement, InArgs._OnYawEndSliderMovement) )
            .UndeterminedString( NSLOCTEXT("SRotatorInputBox", "MultipleValues", "Multiple Values") )
            .ToolTipTextFormat(BuildToolTipTextFormatString(InArgs._YawDisplayName.Get().ToString()))
            .TypeInterface(InArgs._TypeInterface)
            .MinFractionalDigits(InArgs._TypeInterface ? InArgs._TypeInterface->GetMinFractionalDigits() : TOptional<int32>())
            .MaxFractionalDigits(InArgs._TypeInterface ? InArgs._TypeInterface->GetMaxFractionalDigits() : TOptional<int32>())
            .DisplayToggle(InArgs._DisplayToggle)
            .ToggleChecked(InArgs._ToggleYawChecked)
            .OnToggleChanged(InArgs._OnToggleYawChanged)
            .TogglePadding(InArgs._TogglePadding)
            .PreventThrottling(InArgs._PreventThrottling);
        return Widget;
    };
    
public:
 
    void Construct( const FArguments& InArgs )
    {
        using WidgetConstructorFn = TSharedRef<SWidget> (ThisClass::*)(const FArguments&);
        constexpr TStaticArray<WidgetConstructorFn, ComponentNum> Constructors =
        {
            &ThisClass::ConstructRoll,
            &ThisClass::ConstructPitch,
            &ThisClass::ConstructYaw
        };
 
        TSharedRef<SHorizontalBox> HorizontalBox = SNew(SHorizontalBox);
 
        for (int32 SwizzleIndex = 0; SwizzleIndex < ComponentNum; SwizzleIndex++)
        {
            TSharedPtr<SWidget> Widget = SNullWidget::NullWidget;
            const auto& Swizzle = InArgs._Swizzle;
            int32 SwizzleValue = Swizzle[SwizzleIndex];
            if (ensureMsgf(SwizzleValue < 3 && SwizzleValue >= 0, TEXT("Invalid Swizzle Value")))
            {
                Widget = (this->*Constructors[SwizzleValue])(InArgs);
            }
 
            TSharedRef<SWidget> WidgetRef = Widget.ToSharedRef();
            
            HorizontalBox->AddSlot()
            [
                WidgetRef
            ];
        }
 
        ChildSlot
        [
            HorizontalBox
        ];
    }
 
    template<typename EventType, typename... ArgsType>
    EventType CreatePerComponentSliderMovementEvent(
        const EventType OnSliderMovement,
        const EventType OnComponentSliderMovement)
    {
        if(OnSliderMovement.IsBound())
        {
            return EventType::CreateLambda(
                [OnSliderMovement, OnComponentSliderMovement](ArgsType... Args)
                {
                    OnSliderMovement.ExecuteIfBound(Args...);
                    OnComponentSliderMovement.ExecuteIfBound(Args...);
                });
        }
        return OnComponentSliderMovement;
    }
};
 
using SRotatorInputBox = SNumericRotatorInputBox<float>;