DialogueEditorUtilities.h

Go to the documentation of this file.

// Copyright Csaba Molnar, Daniel Butum. All Rights Reserved.
#pragma once
 
#include "ConnectionDrawingPolicy.h"
#include "PropertyHandle.h"
#include "Toolkits/AssetEditorManager.h"
#include "EdGraphNode_Comment.h"
 
#include "DialogueEditor/Graph/DialogueGraph.h"
#include "Nodes/DlgNode.h"
 
enum class EDialogueBlueprintOpenType : uint8
{
    None = 0,
    Function,
    Event
};
 
// FDialogueEditorUtilities
 
class UDlgDialogue;
class UEdGraphSchema;
class UDlgNode;
class UEdGraph;
class FSlateRect;
class UK2Node_Event;
 
class FDialogueEditorUtilities
{
public:
    template <typename GraphNodeType>
    static GraphNodeType* SpawnGraphNodeFromTemplate(UEdGraph* ParentGraph, const FIntPoint& Location, bool bSelectNewNode = true)
    {
        FGraphNodeCreator<GraphNodeType> NodeCreator(*ParentGraph);
        GraphNodeType* GraphNode = NodeCreator.CreateUserInvokedNode(bSelectNewNode);
        NodeCreator.Finalize(); // Calls on the node: CreateNewGuid, PostPlacedNewNode, AllocateDefaultPins
        GraphNode->NodePosX = Location.X;
        GraphNode->NodePosY = Location.Y;
        GraphNode->SetFlags(RF_Transactional);
 
        return GraphNode;
    }
 
    // Loads all dialogues into memory and checks the GUIDs for duplicates
    static void LoadAllDialoguesAndCheckGUIDs();
 
    static const TSet<UObject*> GetSelectedNodes(const UEdGraph* Graph);
 
    static bool GetBoundsForSelectedNodes(const UEdGraph* Graph, FSlateRect& Rect, float Padding = 0.0f);
 
    static void RefreshDetailsView(const UEdGraph* Graph, bool bRestorePreviousSelection);
 
    // Refresh the viewport and property/details pane
    static void Refresh(const UEdGraph* Graph, bool bRestorePreviousSelection);
 
    static UDialogueGraphNode_Edge* GetLastTargetGraphEdgeBeforeDrag(const UEdGraph* Graph);
    static void SetLastTargetGraphEdgeBeforeDrag(const UEdGraph* Graph, UDialogueGraphNode_Edge* InEdge);
 
    static bool RemoveNode(UEdGraphNode* NodeToRemove);
 
    static UEdGraph* CreateNewGraph(
        UObject* ParentScope,
        FName GraphName,
        TSubclassOf<UEdGraph> GraphClass,
        TSubclassOf<UEdGraphSchema> SchemaClass
    );
 
    static bool CheckAndTryToFixDialogue(UDlgDialogue* Dialogue, bool bDisplayWarning = true);
 
    static void TryToCreateDefaultGraph(UDlgDialogue* Dialogue, bool bPrompt = true);
 
    static bool AreDialogueNodesInSyncWithGraphNodes(const UDlgDialogue* Dialogue);
 
    // Tries to get the closest UDlgNode for a  UEdGraphNode
    static UDlgNode* GetClosestNodeFromGraphNode(UEdGraphNode* GraphNode);
 
    static UDlgDialogue* GetDialogueForGraph(const UEdGraph* Graph)
    {
        return CastChecked<UDialogueGraph>(Graph)->GetDialogue();
    }
 
    static void AutoPositionGraphNodes(
        UDialogueGraphNode* RootNode,
        const TArray<UDialogueGraphNode*>& GraphNodes,
        int32 OffsetBetweenColumnsX,
        int32 OffsetBetweenRowsY,
        bool bIsDirectionVertical
    );
 
    static bool CanConvertSpeechNodesToSpeechSequence(
        const TSet<UObject*>& SelectedNodes,
        TArray<UDialogueGraphNode*>& OutSelectedGraphNodes
    );
 
    static bool CanConvertSpeechNodesToSpeechSequence(const TSet<UObject*>& SelectedNodes)
    {
        TArray<UDialogueGraphNode*> OutSelectedGraphNodes;
        return CanConvertSpeechNodesToSpeechSequence(SelectedNodes, OutSelectedGraphNodes);
    }
 
    static bool CanConvertSpeechSequenceNodeToSpeechNodes(const TSet<UObject*>& SelectedNodes);
 
    static void CloseOtherEditors(UObject* Asset, IAssetEditorInstance* OnlyEditor);
 
    static bool OpenEditorForAsset(const UObject* Asset);
 
    static IAssetEditorInstance* FindEditorForAsset(UObject* Asset, bool bFocusIfOpen);
 
    static bool OpenEditorAndJumpToGraphNode(const UEdGraphNode* GraphNode, bool bFocusIfOpen = false);
 
    // Just jumps to that graph node without trying to open any Dialogue Editor
    // If you want that just call OpenEditorAndJumpToGraphNode
    static bool JumpToGraphNode(const UEdGraphNode* GraphNode);
    static bool JumpToGraphNodeIndex(const UDlgDialogue* Dialogue, int32 NodeIndex);
 
    static void CopyNodeChildren(const UDialogueGraphNode* FromNode, UDialogueGraphNode* ToNode);
 
    static void ReplaceParentConnectionsToNode(const UDialogueGraphNode* OldNode, const UDialogueGraphNode* NewNode);
 
    // Wrapper over standard message box that that also logs to the console
    static EAppReturnType::Type ShowMessageBox(EAppMsgType::Type MsgType, const FString& Text, const FString& Caption);
 
    // Returns true if the TestPoint is inside the Geometry.
    static bool IsPointInsideGeometry(const FVector2D& TestPoint, const FGeometry& Geometry)
    {
        TArray<FVector2D> GeometryPoints;
        FGeometryHelper::ConvertToPoints(Geometry, GeometryPoints);
        return FBox2D(GeometryPoints).IsInside(TestPoint);
    }
 
    static void RemapOldIndicesWithNewAndUpdateGUID(
        const TArray<UDialogueGraphNode*>& GraphNodes,
        const TMap<int32, int32>& OldToNewIndexMap
    );
 
    // Gets the Dialogue for the provided UEdGraphNode
    static UDlgDialogue* GetDialogueFromGraphNode(const UEdGraphNode* GraphNode);
 
    // Save all the dialogues.
    // @return True on success or false on failure.
    static bool SaveAllDialogues();
 
    // Deletes all teh dialogues text files
    // @return True on success or false on failure.
    static bool DeleteAllDialoguesTextFiles();
 
    /***
    * Pops up a class picker dialog to choose the class that is a child of the Classprovided.
    *
    * @param    TitleText       The title of the class picker dialog
    * @param    OutChosenClass  The class chosen (if this function returns false, this will be null) by the the user
    * @param    Class           The children of this class we are displaying and prompting the user to choose from.
    *
    * @return true if OK was pressed, false otherwise
    */
    static bool PickChildrenOfClass(const FText& TitleText, UClass*& OutChosenClass, UClass* Class);
 
    // Opens the specified Blueprint at the last edited graph by default
    // or if the OpenType is set to Function or Event it opens that with the FunctionNameToOpen
    static bool OpenBlueprintEditor(
        UBlueprint* Blueprint,
        EDialogueBlueprintOpenType OpenType = EDialogueBlueprintOpenType::None,
        FName FunctionNameToOpen = NAME_None,
        bool bForceFullEditor = true,
        bool bAddBlueprintFunctionIfItDoesNotExist = false
    );
 
    // Adds the function if it does not exist
    // Return the Function Graph of the existing function or the newly created one
    static UEdGraph* BlueprintGetOrAddFunction(UBlueprint* Blueprint, FName FunctionName, UClass* FunctionClassSignature);
 
    // Same as BlueprintGetOrAddFunction but does not add it
    static UEdGraph* BlueprintGetFunction(UBlueprint* Blueprint, FName FunctionName, UClass* FunctionClassSignature);
 
    // Same as BlueprintGetOrAddFunction but only for an overriden event
    static UK2Node_Event* BlueprintGetOrAddEvent(UBlueprint* Blueprint, FName EventName, UClass* EventClassSignature);
 
    // Same as BlueprintGetOrAddEvent but does not add it
    static UK2Node_Event* BlueprintGetEvent(UBlueprint* Blueprint, FName EventName, UClass* EventClassSignature);
 
    // Adds a comment to the Blueprint
    static UEdGraphNode_Comment* BlueprintAddComment(UBlueprint* Blueprint, const FString& CommentString, FVector2D Location = FVector2D::ZeroVector);
 
private:
    // Get the DialogueEditor for given object, if it exists
    static TSharedPtr<class IDialogueEditor> GetDialogueEditorForGraph(const UEdGraph* Graph);
 
    FDialogueEditorUtilities() = delete;
};