ToolContextInterfaces.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "ComponentSourceInterfaces.h"
#include "Containers/Array.h"
#include "CoreMinimal.h"
#include "Elements/Framework/TypedElementSelectionSet.h" // For deprecated FToolBuilderState::TypedElementSelectionSet member
#include "Math/Quat.h"
#include "Math/Rotator.h"
#include "Math/UnrealMathSSE.h"
#include "Math/Vector.h"
#include "Misc/EnumClassFlags.h"
#include "Templates/UniquePtr.h"
#include "UObject/Interface.h"
#include "UObject/ObjectMacros.h"
#include "UObject/WeakObjectPtr.h"
#include "UObject/WeakObjectPtr.h"
#include "UObject/WeakObjectPtrTemplates.h"
#include "GenericPlatform/ICursor.h"
 
#include "ToolContextInterfaces.generated.h"
 
// predeclarations so we don't have to include these in all tools
class AActor;
class FPrimitiveDrawInterface;
class FSceneView;
class FText;
class FToolCommandChange;
class FViewport;
class SWidget;
class UActorComponent;
class UInteractiveGizmoManager;
class UInteractiveToolManager;
class UMaterialInterface;
class UObject;
class UToolTargetManager;
class UTypedElementSelectionSet;
 
class UWorld;
struct FMeshDescription;
struct FTypedElementHandle;
 
struct FToolBuilderState
{
    UWorld* World = nullptr;
    UInteractiveToolManager* ToolManager = nullptr;
    UToolTargetManager* TargetManager = nullptr;
    UInteractiveGizmoManager* GizmoManager = nullptr;
 
    TArray<AActor*> SelectedActors;
    TArray<UActorComponent*> SelectedComponents;
 
    UE_DEPRECATED(5.1, "This has moved to a context object. See IAssetEditorContextInterface")
    TWeakObjectPtr<UTypedElementSelectionSet> TypedElementSelectionSet;
 
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    FToolBuilderState() = default;
    FToolBuilderState(FToolBuilderState&&) = default;
    FToolBuilderState(const FToolBuilderState&) = default;
    FToolBuilderState& operator=(FToolBuilderState&&) = default;
    FToolBuilderState& operator=(const FToolBuilderState&) = default;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
};
 
 
struct FViewCameraState
{
    FVector Position = FVector(EForceInit::ForceInit);
    FQuat Orientation = FQuat(EForceInit::ForceInit);
    float HorizontalFOVDegrees = 90;
    float OrthoWorldCoordinateWidth = 100;
    float AspectRatio = 1;
    bool bIsOrthographic = false;
    bool bIsVR = false;
    double DPIScale = 1.0;
 
    FVector Right() const { return Orientation.GetAxisY(); }
    FVector Up() const { return Orientation.GetAxisZ(); }
    FVector Forward() const { return Orientation.GetAxisX(); }
 
    float GetPDIScalingFactor() const { return HorizontalFOVDegrees / 90.0f; }
 
    float GetFOVAngleNormalizationFactor() const { return HorizontalFOVDegrees / 90.0f; }
 
};
 
 
 
UENUM()
enum class EStandardToolContextMaterials
{
    VertexColorMaterial = 1
};
 
 
UENUM()
enum class EToolContextCoordinateSystem : uint8
{
    World = 0,
    Local = 1,
    Screen = 2
};
 
 
UENUM()
enum class EToolContextTransformGizmoMode : uint8
{
    NoGizmo = 0,
    Translation = 1,
    Rotation = 2,
    Scale = 3,
    Combined = 8
};
 
 
 
struct FToolContextSnappingConfiguration
{
    bool bEnablePositionGridSnapping = false;
    FVector PositionGridDimensions = FVector::Zero();
 
    bool bEnableRotationGridSnapping = false;
    FRotator RotationGridAngles = FRotator::ZeroRotator;
 
    bool bEnableScaleGridSnapping = false;
    float ScaleGridSize = 1.0f;
 
    bool bEnableAbsoluteWorldSnapping = false;
};
 
 
UCLASS(MinimalAPI)
class UToolsContextCursorAPI : public UObject
{
    GENERATED_BODY()
 
private:
    EMouseCursor::Type CursorOverrideShape;
    TSharedPtr<SWidget> CursorOverrideWidget;
    bool bIsCursorOverridden;
 
public:
 
    UToolsContextCursorAPI()
    {
        CursorOverrideShape = EMouseCursor::Default;
        CursorOverrideWidget = nullptr;
        bIsCursorOverridden = false;
    }
 
    virtual ~UToolsContextCursorAPI() override = default;
 
    virtual EMouseCursor::Type GetCurrentCursorOverride() const 
    {
        return CursorOverrideShape;
    }
 
    virtual TSharedPtr<SWidget> GetCurrentCursorOverrideWidget() const 
    {
        return CursorOverrideWidget;
    }
 
    virtual bool IsCursorOverridden() const
    {
        return bIsCursorOverridden;
    }
 
    virtual void SetCursorOverride(EMouseCursor::Type CursorOverride)
    {
        bIsCursorOverridden = true;
        CursorOverrideShape = CursorOverride;
    }
 
    virtual void SetCursorOverrideWidget(const TSharedRef<SWidget>& InCursorOverrideWidget)
    {
        bIsCursorOverridden = true;
        CursorOverrideShape = EMouseCursor::Custom;
        CursorOverrideWidget = InCursorOverrideWidget;
    }
 
    virtual void ClearCursorOverride() 
    {
        bIsCursorOverridden = false;
        CursorOverrideShape = EMouseCursor::Default;
        CursorOverrideWidget = nullptr;
    }
};
 
class IToolsContextQueriesAPI
{
public:
    virtual ~IToolsContextQueriesAPI() {}
 
    virtual UWorld* GetCurrentEditingWorld() const = 0;
 
    virtual void GetCurrentSelectionState(FToolBuilderState& StateOut) const = 0;
 
    virtual void GetCurrentViewState(FViewCameraState& StateOut) const = 0;
 
    virtual EToolContextCoordinateSystem GetCurrentCoordinateSystem() const { return EToolContextCoordinateSystem::World; }
 
    virtual EToolContextTransformGizmoMode GetCurrentTransformGizmoMode() const { return EToolContextTransformGizmoMode::Combined; }
 
    virtual FToolContextSnappingConfiguration GetCurrentSnappingSettings() const { return FToolContextSnappingConfiguration(); }
 
    virtual UMaterialInterface* GetStandardMaterial(EStandardToolContextMaterials MaterialType) const = 0;
 
    virtual FViewport* GetHoveredViewport() const = 0;
 
    virtual FViewport* GetFocusedViewport() const = 0;
};
 
 
 
 
UENUM()
enum class EToolMessageLevel
{
    Internal = 0,
    UserMessage = 1,
    UserNotification = 2,
    UserWarning = 3,
    UserError = 4
};
 
 
UENUM()
enum class ESelectedObjectsModificationType
{
    Replace = 0,
    Add = 1,
    Remove = 2,
    Clear = 3
};
 
 
struct FSelectedObjectsChangeList
{
    ESelectedObjectsModificationType ModificationType;
    TArray<AActor*> Actors;
    TArray<UActorComponent*> Components;
};
 
UE_DEPRECATED(5.4, "Use FSelectedObjectsChangeList instead")
typedef FSelectedObjectsChangeList FSelectedOjectsChangeList;
 
 
class IToolsContextTransactionsAPI
{
public:
    virtual ~IToolsContextTransactionsAPI() {}
 
    virtual void DisplayMessage(const FText& Message, EToolMessageLevel Level) = 0;
 
    virtual void PostInvalidation() = 0;
    
    virtual void BeginUndoTransaction(const FText& Description) = 0;
 
    virtual void EndUndoTransaction() = 0;
 
    virtual void AppendChange(UObject* TargetObject, TUniquePtr<FToolCommandChange> Change, const FText& Description) = 0;
 
 
 
    virtual bool RequestSelectionChange(const FSelectedObjectsChangeList& SelectionChange) = 0;
 
};
 
UENUM()
enum class EViewInteractionState {
    None = 0,
    Hovered = 1,
    Focused = 2
};
ENUM_CLASS_FLAGS(EViewInteractionState);
 
class IToolsContextRenderAPI
{
public:
    virtual ~IToolsContextRenderAPI() {}
 
    virtual FPrimitiveDrawInterface* GetPrimitiveDrawInterface() = 0;
 
    virtual const FSceneView* GetSceneView() = 0;
 
    virtual FViewCameraState GetCameraState() = 0;
 
    virtual EViewInteractionState GetViewInteractionState() = 0;
};