InteractiveGizmoManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/Object.h"
#include "InteractiveGizmo.h"
#include "InteractiveGizmoBuilder.h"
#include "InputRouter.h"
#include "InteractiveToolChange.h"
#include "ToolContextInterfaces.h"
#include "InteractiveGizmoManager.generated.h"
 
class FCombinedTransformGizmoActorFactory;
class UCombinedTransformGizmo;
class UCombinedTransformGizmoBuilder;
class UContextObjectStore;
 
USTRUCT()
struct FActiveGizmo
{
    GENERATED_BODY()
 
    UPROPERTY()
    TObjectPtr<UInteractiveGizmo> Gizmo = nullptr;
    FString BuilderIdentifier;
    FString InstanceIdentifier;
    void* Owner = nullptr;
};
 
 
UCLASS(Transient, MinimalAPI)
class UInteractiveGizmoManager : public UObject, public IToolContextTransactionProvider
{
    GENERATED_BODY()
 
protected:
    friend class UInteractiveToolsContext;      // to call Initialize/Shutdown
 
    INTERACTIVETOOLSFRAMEWORK_API UInteractiveGizmoManager();
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void Initialize(IToolsContextQueriesAPI* QueriesAPI, IToolsContextTransactionsAPI* TransactionsAPI, UInputRouter* InputRouter);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void Shutdown();
 
public:
 
    //
    // GizmoBuilder Registration and Gizmo Creation/Shutdown
    //
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void RegisterGizmoType(const FString& BuilderIdentifier, UInteractiveGizmoBuilder* Builder);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual bool DeregisterGizmoType(const FString& BuilderIdentifier);
 
 
 
    INTERACTIVETOOLSFRAMEWORK_API virtual UInteractiveGizmo* CreateGizmo(const FString& BuilderIdentifier, const FString& InstanceIdentifier = FString(), void* Owner = nullptr);
 
 
    template<typename GizmoType>
    GizmoType* CreateGizmo(const FString& BuilderIdentifier, const FString& InstanceIdentifier = FString(), void* Owner = nullptr)
    {
        UInteractiveGizmo* NewGizmo = CreateGizmo(BuilderIdentifier, InstanceIdentifier, Owner);
        return CastChecked<GizmoType>(NewGizmo);
    }
 
 
    INTERACTIVETOOLSFRAMEWORK_API virtual bool DestroyGizmo(UInteractiveGizmo* Gizmo);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void DestroyAllGizmosOfType(const FString& BuilderIdentifier);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void DestroyAllGizmosByOwner(void* Owner);
 
 
    INTERACTIVETOOLSFRAMEWORK_API virtual TArray<UInteractiveGizmo*> FindAllGizmosOfType(const FString& BuilderIdentifier);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual UInteractiveGizmo* FindGizmoByInstanceIdentifier(const FString& Identifier) const;
 
 
 
 
    //
    // Functions that Gizmos can call to interact with Transactions API
    //
    
    INTERACTIVETOOLSFRAMEWORK_API virtual void DisplayMessage(const FText& Message, EToolMessageLevel Level);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void PostInvalidation();
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void BeginUndoTransaction(const FText& Description);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void EndUndoTransaction();
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void EmitObjectChange(UObject* TargetObject, TUniquePtr<FToolCommandChange> Change, const FText& Description );
 
 
    //
    // State control  (@todo: have the Context call these? not safe for anyone to call)
    //
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void Tick(float DeltaTime);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void Render(IToolsContextRenderAPI* RenderAPI);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void DrawHUD( FCanvas* Canvas, IToolsContextRenderAPI* RenderAPI );
 
    //
    // access to APIs, etc
    //
 
    virtual IToolsContextQueriesAPI* GetContextQueriesAPI() { return QueriesAPI; }
 
    INTERACTIVETOOLSFRAMEWORK_API UContextObjectStore* GetContextObjectStore() const;
 
 
 
public:
    //
    // Standard Gizmos
    // 
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void RegisterDefaultGizmos();
 
    INTERACTIVETOOLSFRAMEWORK_API virtual UCombinedTransformGizmo* Create3AxisTransformGizmo(void* Owner = nullptr, const FString& InstanceIdentifier = FString());
 
    INTERACTIVETOOLSFRAMEWORK_API virtual UCombinedTransformGizmo* CreateCustomTransformGizmo(ETransformGizmoSubElements Elements, void* Owner = nullptr, const FString& InstanceIdentifier = FString());
 
    INTERACTIVETOOLSFRAMEWORK_API virtual UCombinedTransformGizmo* CreateCustomRepositionableTransformGizmo(ETransformGizmoSubElements Elements, void* Owner = nullptr, const FString& InstanceIdentifier = FString());
 
public:
    // builder identifiers for default gizmo types. Perhaps should have an API for this...
    static INTERACTIVETOOLSFRAMEWORK_API FString DefaultAxisPositionBuilderIdentifier;
    static INTERACTIVETOOLSFRAMEWORK_API FString DefaultPlanePositionBuilderIdentifier;
    static INTERACTIVETOOLSFRAMEWORK_API FString DefaultAxisAngleBuilderIdentifier;
    static INTERACTIVETOOLSFRAMEWORK_API FString DefaultThreeAxisTransformBuilderIdentifier;
    static INTERACTIVETOOLSFRAMEWORK_API const FString CustomThreeAxisTransformBuilderIdentifier;
    static INTERACTIVETOOLSFRAMEWORK_API const FString CustomRepositionableThreeAxisTransformBuilderIdentifier;
    static INTERACTIVETOOLSFRAMEWORK_API FString DefaultScalableSphereBuilderIdentifier;
 
protected:
    UPROPERTY()
    TArray<FActiveGizmo> ActiveGizmos;
 
 
protected:
    IToolsContextQueriesAPI* QueriesAPI;
    IToolsContextTransactionsAPI* TransactionsAPI;
 
    UInputRouter* InputRouter;
 
    UPROPERTY()
    TMap<FString, TObjectPtr<UInteractiveGizmoBuilder>> GizmoBuilders;
 
    bool bDefaultGizmosRegistered = false;
    TSharedPtr<FCombinedTransformGizmoActorFactory> GizmoActorBuilder;
};