RadialSlider.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
 
#include "Components/Slider.h"
#include "Components/Widget.h"
#include "Curves/CurveFloat.h"
#include "Styling/SlateTypes.h"
#include "UObject/ObjectMacros.h"
#include "Widgets/SWidget.h"
 
#include "RadialSlider.generated.h"
 
 
// Forward Declarations
class SRadialSlider;
 
 
UCLASS(MinimalAPI)
class URadialSlider : public UWidget
{
    GENERATED_UCLASS_BODY()
 
public:
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Appearance, BlueprintSetter = SetValue,  meta = (UIMin="0", UIMax="1"))
    float Value;
 
    UPROPERTY()
    FGetFloat ValueDelegate;
    
    UPROPERTY(EditAnywhere, Category = Appearance)
    bool bUseCustomDefaultValue;
 
    UPROPERTY(EditAnywhere, Category = Appearance, meta = (EditCondition = "bUseCustomDefaultValue", UIMin = "0", UIMax = "1"))
    float CustomDefaultValue;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Appearance)
    FRuntimeFloatCurve SliderRange;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Appearance)
    TArray<float> ValueTags;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, meta=(ClampMin = "0", ClampMax = "360"), Category = Appearance)
    float SliderHandleStartAngle;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, meta=(ClampMin = "0", ClampMax = "360"), Category = Appearance)
    float SliderHandleEndAngle;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, meta=(ClampMin = "0", ClampMax = "360"), Category = Appearance)
    float AngularOffset;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Appearance)
    FVector2D HandStartEndRatio;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Style", meta=( DisplayName="Style" ))
    FSliderStyle WidgetStyle;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Appearance)
    FLinearColor SliderBarColor;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Appearance)
    FLinearColor SliderProgressColor;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Appearance)
    FLinearColor SliderHandleColor;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Appearance)
    FLinearColor CenterBackgroundColor;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Appearance, AdvancedDisplay)
    bool Locked;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Appearance, AdvancedDisplay)
    bool MouseUsesStep;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Appearance, AdvancedDisplay)
    bool RequiresControllerLock;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Appearance, meta=(UIMin="0", UIMax="1"))
    float StepSize;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Interaction")
    bool IsFocusable;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Behavior")
    bool UseVerticalDrag;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Appearance")
    bool ShowSliderHandle;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Appearance")
    bool ShowSliderHand;
 
    UPROPERTY(BlueprintAssignable, Category="Widget Event")
    FOnMouseCaptureBeginEvent OnMouseCaptureBegin;
 
    UPROPERTY(BlueprintAssignable, Category="Widget Event")
    FOnMouseCaptureEndEvent OnMouseCaptureEnd;
 
    UPROPERTY(BlueprintAssignable, Category = "Widget Event")
    FOnControllerCaptureBeginEvent OnControllerCaptureBegin;
 
    UPROPERTY(BlueprintAssignable, Category = "Widget Event")
    FOnControllerCaptureEndEvent OnControllerCaptureEnd;
 
    UPROPERTY(BlueprintAssignable, Category="Widget Event")
    FOnFloatValueChangedEvent OnValueChanged;
 
    UFUNCTION(BlueprintCallable, Category="Behavior")
    ADVANCEDWIDGETS_API float GetValue() const;
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    ADVANCEDWIDGETS_API float GetCustomDefaultValue() const;
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    ADVANCEDWIDGETS_API float GetNormalizedSliderHandlePosition() const;
 
    UFUNCTION(BlueprintCallable, Category="Behavior")
    ADVANCEDWIDGETS_API void SetValue(float InValue);
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    ADVANCEDWIDGETS_API void SetCustomDefaultValue(float InValue);
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    ADVANCEDWIDGETS_API void SetSliderRange(const FRuntimeFloatCurve& InSliderRange);
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    ADVANCEDWIDGETS_API void SetValueTags(const TArray<float>& InValueTags);
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    ADVANCEDWIDGETS_API void SetSliderHandleStartAngle(float InValue);
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    ADVANCEDWIDGETS_API void SetSliderHandleEndAngle(float InValue);
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    ADVANCEDWIDGETS_API void SetAngularOffset(float InValue);
 
    UFUNCTION(BlueprintCallable, Category = "Appearance")
    ADVANCEDWIDGETS_API void SetHandStartEndRatio(FVector2D InValue);
 
    UFUNCTION(BlueprintCallable, Category="Behavior")
    ADVANCEDWIDGETS_API void SetLocked(bool InValue);
 
    UFUNCTION(BlueprintCallable, Category="Behavior")
    ADVANCEDWIDGETS_API void SetStepSize(float InValue);
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    ADVANCEDWIDGETS_API void SetSliderBarColor(FLinearColor InValue);
 
    UFUNCTION(BlueprintCallable, Category = "Appearance")
    ADVANCEDWIDGETS_API void SetSliderProgressColor(FLinearColor InValue);
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    ADVANCEDWIDGETS_API void SetSliderHandleColor(FLinearColor InValue);
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    ADVANCEDWIDGETS_API void SetCenterBackgroundColor(FLinearColor InValue);
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    ADVANCEDWIDGETS_API void SetUseVerticalDrag(bool InUseVerticalDrag);
 
    UFUNCTION(BlueprintCallable, Category = "Appearance")
    ADVANCEDWIDGETS_API void SetShowSliderHandle(bool InShowSliderHandle);
 
    UFUNCTION(BlueprintCallable, Category = "Appearance")
    ADVANCEDWIDGETS_API void SetShowSliderHand(bool InShowSliderHand);
    
    // UWidget interface
    ADVANCEDWIDGETS_API virtual void SynchronizeProperties() override;
    // End of UWidget interface
 
    // UVisual interface
    ADVANCEDWIDGETS_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
    // End of UVisual interface
 
#if WITH_EDITOR
    ADVANCEDWIDGETS_API virtual const FText GetPaletteCategory() override;
#endif
 
protected:
    TSharedPtr<SRadialSlider> MyRadialSlider;
 
    // UWidget interface
    ADVANCEDWIDGETS_API virtual TSharedRef<SWidget> RebuildWidget() override;
    // End of UWidget interface
 
    ADVANCEDWIDGETS_API void HandleOnValueChanged(float InValue);
    ADVANCEDWIDGETS_API void HandleOnMouseCaptureBegin();
    ADVANCEDWIDGETS_API void HandleOnMouseCaptureEnd();
    ADVANCEDWIDGETS_API void HandleOnControllerCaptureBegin();
    ADVANCEDWIDGETS_API void HandleOnControllerCaptureEnd();
 
#if WITH_ACCESSIBILITY
    ADVANCEDWIDGETS_API virtual TSharedPtr<SWidget> GetAccessibleWidget() const override;
#endif
 
    PROPERTY_BINDING_IMPLEMENTATION(float, Value);
};