BaseBrushTool.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "BaseTools/MeshSurfacePointTool.h"
#include "InteractiveTool.h"
#include "Engine/HitResult.h"
#include "BaseBrushTool.generated.h"
 
class UBrushStampIndicator;
class ULocalTwoAxisPropertyEditInputBehavior;
 
UCLASS(MinimalAPI)
class UBrushBaseProperties : public UInteractiveToolPropertySet
{
    GENERATED_BODY()
 
public:
    INTERACTIVETOOLSFRAMEWORK_API UBrushBaseProperties();
 
    UPROPERTY(EditAnywhere, Category = Brush, meta = (DisplayName = "Size", UIMin = "0.0", UIMax = "1.0", ClampMin = "0.0", ClampMax = "10.0", DisplayPriority = 1, HideEditConditionToggle, EditCondition = "bSpecifyRadius == false", ModelingQuickSettings = 100))
    float BrushSize;
 
    UPROPERTY(EditAnywhere, Category = Brush, AdvancedDisplay)
    bool bSpecifyRadius;
 
    UPROPERTY(EditAnywhere, Category = Brush, AdvancedDisplay, meta = (EditCondition = "bSpecifyRadius",
        DisplayName = "Radius", UIMin = "1.0", UIMax = "1000.0", ClampMin = "0.1", ClampMax = "50000.0"))
    float BrushRadius;
 
    //~Set by tool and determines whether the bEnablePressureSensitivity flag below is shown and used.
    //~ All that a subclass of UBaseBrushTool needs to do to support pressure sensitivity is to call
    //~ the super OnTick, use the provided radius getters where relevant, and set this to true in setup. 
    //~ Its StylusAPI also should be set via its builder.
    UPROPERTY()
    bool bToolSupportsPressureSensitivity = false;
 
    UPROPERTY(EditAnywhere, Category = Brush, meta = (EditCondition = "bToolSupportsPressureSensitivity", EditConditionHides))
    bool bEnablePressureSensitivity = false;
 
    UPROPERTY(EditAnywhere, Category = Brush, meta = (DisplayName = "Strength",
        UIMin = "0.0", UIMax = "1.0", ClampMin = "0.0", ClampMax = "1.0", 
        HideEditConditionToggle, EditConditionHides, EditCondition = "bShowStrength", DisplayPriority = 2,
        ModelingQuickEdit, ModelingQuickSettings = 200))
    float BrushStrength;
 
    UPROPERTY(EditAnywhere, Category = Brush, meta = (DisplayName = "Falloff", 
        UIMin = "0.0", UIMax = "1.0", ClampMin = "0.0", ClampMax = "1.0", 
        HideEditConditionToggle, EditConditionHides, EditCondition="bShowFalloff", DisplayPriority = 3,
        ModelingQuickEdit, ModelingQuickSettings = 300))
    float BrushFalloffAmount;
 
 
    UPROPERTY(EditAnywhere, Category = Brush, meta = (DisplayPriority = 6, HideEditConditionToggle, EditConditionHides, EditCondition = "bShowHitBackFaces"))
    bool bHitBackFaces = false;
 
    UPROPERTY( meta = (TransientToolProperty))
    bool bShowStrength = true;
 
    UPROPERTY(meta = (TransientToolProperty))
    bool bShowFalloff = true;
 
    UPROPERTY(meta = (TransientToolProperty))
    bool bShowHitBackFaces = false;
};
 
 
USTRUCT()
struct FBrushStampData
{
    GENERATED_BODY();
    float Radius;
    FVector WorldPosition;
    FVector WorldNormal;
 
    FHitResult HitResult;
 
    float Falloff;
};
 
UCLASS()
class UE_DEPRECATED(5.5, "UBrushAdjusterInputBehavior is deprecated, use UTwoAxisPropertyEditInputBehavior instead.") UBrushAdjusterInputBehavior : public UAnyButtonInputBehavior
{
    GENERATED_BODY()
 
public:
    
    void Initialize(UBaseBrushTool* InBrushTool);
 
    void DrawHUD(FCanvas* Canvas, IToolsContextRenderAPI* RenderAPI);
    
    void SetStrengthAdjustSpeed(float InStrengthSpeed) { StrengthAdjustSpeed = InStrengthSpeed; };
    void SetSizeAdjustSpeed(float InSizeSpeed) { SizeAdjustSpeed = InSizeSpeed; };
    
    void OnDragStart(FVector2D InScreenPosition);
    void OnDragUpdate(FVector2D InScreenPosition);
    
    bool IsBrushBeingAdjusted() const { return bAdjustingBrush; };
 
    // UAnyButtonInputBehavior
    virtual EInputDevices GetSupportedDevices() override;
    virtual bool IsPressed(const FInputDeviceState& Input) override;
    virtual bool IsReleased(const FInputDeviceState& Input) override;
    virtual FInputCaptureRequest WantsCapture(const FInputDeviceState& Input) override;
    virtual FInputCaptureUpdate BeginCapture(const FInputDeviceState& Input, EInputCaptureSide eSide) override;
    virtual FInputCaptureUpdate UpdateCapture(const FInputDeviceState& Input, const FInputCaptureData& data) override;
    virtual void ForceEndCapture(const FInputCaptureData& data) override;
    // UAnyButtonInputBehavior end
 
private:
 
    void ResetAdjustmentOrigin(FVector2D InScreenPosition, bool bHorizontalAdjust);
 
    // true for the duration of the behavior (while hotkey is down)
    bool bAdjustingBrush = false;
    // screen coordinate when hotkey pressed (or when re-centered if changing direction)
    FVector2D BrushOrigin;
    // screen coordinate when hotkey pressed (or when re-centered if changing direction)
    FVector2D AdjustmentOrigin;
    // the radius of the brush when we started a drag
    float StartBrushRadius;
    // the strength of the brush when we started a drag
    float StartBrushStrength;
    // supports separate horizontal / vertical adjustments (switching dynamically based on magnitude)
    bool bAdjustingHorizontally = true;
 
    // the speed (centimeters per unit of screen coordinate) to adjust brush size when dragging
    float SizeAdjustSpeed = 0.002f; // sensible default
    // the speed (in strength per unit of screen coordinate) to adjust brush strength when dragging
    float StrengthAdjustSpeed = 0.005f; // sensible default
 
    // the target brush tool to adjust
    UBaseBrushTool* BrushTool;
};
 
UCLASS(MinimalAPI)
class UBaseBrushTool : public UMeshSurfacePointTool
{
    GENERATED_BODY()
 
public:
    INTERACTIVETOOLSFRAMEWORK_API UBaseBrushTool();
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void RegisterActions(FInteractiveToolActionSet& ActionSet) override;
 
    // UInteractiveTool
    INTERACTIVETOOLSFRAMEWORK_API virtual void Setup() override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void Shutdown(EToolShutdownType ShutdownType) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnTick(float DeltaTime) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void Render(IToolsContextRenderAPI* RenderAPI) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void DrawHUD( FCanvas* Canvas, IToolsContextRenderAPI* RenderAPI ) override;
    
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnPropertyModified(UObject* PropertySet, FProperty* Property) override;
    
    // IClickDragBehaviorTarget implementation
    INTERACTIVETOOLSFRAMEWORK_API virtual FInputRayHit CanBeginClickDragSequence(const FInputDeviceRay& PressPos) override;
    
    // UMeshSurfacePointTool implementation
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnBeginDrag(const FRay& Ray) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnUpdateDrag(const FRay& Ray) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnEndDrag(const FRay& Ray) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnCancelDrag() override;
    INTERACTIVETOOLSFRAMEWORK_API virtual bool OnUpdateHover(const FInputDeviceRay& DevicePos) override;
 
public:
 
    UPROPERTY()
    TObjectPtr<UBrushBaseProperties> BrushProperties;
 
    UE_DEPRECATED(5.5, "The bInBrushStroke property is deprecated. This will now always be true in OnBeginDrag/OnUpdateDrag/OnEndDrag.")
    UPROPERTY()
    bool bInBrushStroke = false;
 
    UPROPERTY()
    float WorldToLocalScale = 1.0f;
 
    UPROPERTY()
    FBrushStampData LastBrushStamp;
 
public:
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void IncreaseBrushSizeAction();
    INTERACTIVETOOLSFRAMEWORK_API virtual void DecreaseBrushSizeAction();
    INTERACTIVETOOLSFRAMEWORK_API virtual void IncreaseBrushStrengthAction();
    INTERACTIVETOOLSFRAMEWORK_API virtual void DecreaseBrushStrengthAction();
    INTERACTIVETOOLSFRAMEWORK_API virtual void IncreaseBrushFalloffAction();
    INTERACTIVETOOLSFRAMEWORK_API virtual void DecreaseBrushFalloffAction();
 
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    UE_DEPRECATED(5.5, "The IsInBrushStroke function is deprecated. This will now always be true in OnBeginDrag/OnUpdateDrag/OnEndDrag.")
    virtual bool IsInBrushStroke() const { return bInBrushStroke; }
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    INTERACTIVETOOLSFRAMEWORK_API virtual double GetCurrentBrushRadius() const;
    virtual double GetCurrentBrushRadiusLocal() const { return GetCurrentBrushRadius() * WorldToLocalScale; }
 
    INTERACTIVETOOLSFRAMEWORK_API void SetBrushEnabled(bool bIsEnabled);
 
    // return false to disable the hotkey for adjusting the brush radius and strength in the viewport
    virtual bool SupportsBrushAdjustmentInput() { return true; }; 
 
protected:
 
    virtual double EstimateMaximumTargetDimension() { return 100.0; }
 
    virtual double GetActivePressure() const { return ActivePressure; }
protected:
    TInterval<float> BrushRelativeSizeRange;
    double CurrentBrushRadius;
    INTERACTIVETOOLSFRAMEWORK_API void RecalculateBrushRadius();
 
    UPROPERTY()
    TSoftClassPtr<UBrushBaseProperties> PropertyClass;
 
    //
    // Brush Indicator support
    //
protected:
 
    UPROPERTY()
    TObjectPtr<UBrushStampIndicator> BrushStampIndicator;
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void SetupBrushStampIndicator();
    INTERACTIVETOOLSFRAMEWORK_API virtual void UpdateBrushStampIndicator();
    INTERACTIVETOOLSFRAMEWORK_API virtual void ShutdownBrushStampIndicator();
 
    // adjusts size and strength properties while holding hotkey during click/drag
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    UE_DEPRECATED(5.5, "BrushAdjusterBehavior is deprecated, use BrushEditBehavior instead.")
    TWeakObjectPtr<UBrushAdjusterInputBehavior> BrushAdjusterBehavior;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
    
    TWeakObjectPtr<ULocalTwoAxisPropertyEditInputBehavior> BrushEditBehavior;
 
private:
    double ActivePressure = 1.0;
    bool bEnabled = true;
};