InteractiveToolQueryInterfaces.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "InteractiveTool.h" // EToolShutdownType, EToolShutdownReason
#include "UObject/Interface.h"
#include "InteractiveToolQueryInterfaces.generated.h"
 
 
//
// Below are various interfaces that a UInteractiveTool can implement to allow
// higher-level code (eg like an EdMode) to query into the Tool.
//
 
 
 
// UInterface for IInteractiveToolCameraFocusAPI
UINTERFACE(MinimalAPI)
class UInteractiveToolCameraFocusAPI : public UInterface
{
    GENERATED_BODY()
};
 
class IInteractiveToolCameraFocusAPI
{
    GENERATED_BODY()
public:
 
    virtual bool SupportsWorldSpaceFocusBox() { return false; }
    
    virtual FBox GetWorldSpaceFocusBox() { return FBox(); }
 
    virtual bool SupportsWorldSpaceFocusPoint() { return false; }
 
    virtual bool GetWorldSpaceFocusPoint(const FRay& WorldRay, FVector& PointOut) { return false; }
 
 
};
 
 
 
 
 
 
 
// UInterface for IInteractiveToolNestedAcceptCancelAPI
UINTERFACE(MinimalAPI)
class UInteractiveToolNestedAcceptCancelAPI : public UInterface
{
    GENERATED_BODY()
};
 
class IInteractiveToolNestedAcceptCancelAPI
{
    GENERATED_BODY()
public:
 
    virtual bool SupportsNestedCancelCommand() { return false; }
 
    virtual bool CanCurrentlyNestedCancel() { return false; }
 
    virtual bool ExecuteNestedCancelCommand() { return false; }
 
 
 
    virtual bool SupportsNestedAcceptCommand() { return false; }
 
    virtual bool CanCurrentlyNestedAccept() { return false; }
 
    virtual bool ExecuteNestedAcceptCommand() { return false; }
 
 
};
 
// UInterface for IInteractiveToolShutdownQueryAPI
UINTERFACE(MinimalAPI)
class UInteractiveToolShutdownQueryAPI : public UInterface
{
    GENERATED_BODY()
};
 
class IInteractiveToolShutdownQueryAPI
{
    GENERATED_BODY()
public:
 
    enum class UE_DEPRECATED(5.7, "EShutdownReason has moved to InteractiveTool.h (under the name EToolShutdownReason).") EShutdownReason
    {
        // Another tool is being activated without the user having explicitly shut down this one.
        SwitchTool
    };
 
    UE_DEPRECATED(5.7, "Prefer the GetPreferredShutdownType variant which uses EToolShutdownReason.")
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    virtual EToolShutdownType GetPreferredShutdownType(EShutdownReason ShutdownReason, EToolShutdownType StandardShutdownType) const
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
    {
        return StandardShutdownType;
    }
    
    virtual EToolShutdownType GetPreferredShutdownType(EToolShutdownReason ShutdownReason, EToolShutdownType StandardShutdownType) const
    {
        if (ShutdownReason == EToolShutdownReason::SwitchTool)
        {
            // todo: remove this special case when removing the deprecated variant of GetPreferredShutdownType.
            PRAGMA_DISABLE_DEPRECATION_WARNINGS
            return GetPreferredShutdownType(EShutdownReason::SwitchTool, StandardShutdownType);
            PRAGMA_ENABLE_DEPRECATION_WARNINGS
        }
    
        return StandardShutdownType;
    }
 
    //~ Not currently supported, but someday we might let tools query the user with an "are you sure"
    //~ type of message, and allow the tool to ask to NOT be shut down after all. This is one way
    //~ we might implement the ability for tools to ask for this:
    //~ struct FShutdownUserQuery
    //~ {
    //~     FString MessageToUser;
    //~     EAppMsgType::Type QueryType;
    //~     TFunction<void(EAppReturnType::Type UserResponse, bool& bStillShutdownOut, EToolShutdownType& ShutdownTypeOut)> ResponseHandler;
    //~ };
    //~ TOptional<FShutdownUserQuery> GetShutdownUserQuery() { return TOptional<FShutdownUserQuery>(); }
};
 
 
// UInterface for IInteractiveToolExclusiveToolAPI
UINTERFACE(MinimalAPI)
class UInteractiveToolExclusiveToolAPI : public UInterface
{
    GENERATED_BODY()
};
 
class IInteractiveToolExclusiveToolAPI
{
    GENERATED_BODY()
};
 
 
 
// UInterface for IInteractiveToolEditorGizmoAPI
UINTERFACE(MinimalAPI)
class UInteractiveToolEditorGizmoAPI : public UInterface
{
    GENERATED_BODY()
};
 
class IInteractiveToolEditorGizmoAPI
{
    GENERATED_BODY()
public:
 
    virtual bool GetAllowStandardEditorGizmos() { return false; }
};
 
 
 
// UInterface for IInteractiveToolManageGeometrySelectionAPI
UINTERFACE(MinimalAPI)
class UInteractiveToolManageGeometrySelectionAPI : public UInterface
{
    GENERATED_BODY()
};
 
class IInteractiveToolManageGeometrySelectionAPI
{
    GENERATED_BODY()
public:
 
    virtual bool IsInputSelectionValidOnOutput() { return false; }
};