GizmoUtil.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "GizmoElementBase.h"
#include "InteractiveGizmoBuilder.h"
#include "Templates/Function.h"
#include "Templates/SubclassOf.h"
 
#include "GizmoUtil.generated.h"
 
class FString;
class UGizmoElementCircleBase;
class UInteractiveGizmo;
class UInteractiveGizmoManager;
 
class FGizmoElementAccessor
{
public:
    INTERACTIVETOOLSFRAMEWORK_API static TConstArrayView<TObjectPtr<UGizmoElementBase>> GetSubElements(const UGizmoElementBase& InGizmoElement);
    INTERACTIVETOOLSFRAMEWORK_API static void GetSubElementsRecursive(const UGizmoElementBase& InGizmoElement, TArray<TObjectPtr<UGizmoElementBase>>& OutElements);
    INTERACTIVETOOLSFRAMEWORK_API static bool GetSubElementsRecursive(const UGizmoElementBase& InGizmoElement, TArray<TObjectPtr<UGizmoElementBase>>& OutElements, const uint32 InPartId);
 
    INTERACTIVETOOLSFRAMEWORK_API bool UpdateRenderState(UGizmoElementBase& InGizmoElement, IToolsContextRenderAPI* InRenderAPI, const FVector& InLocalCenter, UGizmoElementBase::FRenderTraversalState& InOutRenderState) const;
 
    INTERACTIVETOOLSFRAMEWORK_API bool UpdateRenderState(UGizmoElementBase& InGizmoElement, IToolsContextRenderAPI* InRenderAPI, const FVector& InLocalCenter, UGizmoElementBase::FRenderTraversalState& InOutRenderState, bool& bOutHasAlignRot, FQuat& OutAlignRot) const;
 
    INTERACTIVETOOLSFRAMEWORK_API static bool IsEnabledForInteractionState(const UGizmoElementBase& InGizmoElement, const TOptional<EGizmoElementInteractionState>& InInteractionState = {});
 
    INTERACTIVETOOLSFRAMEWORK_API static bool IsPartial(
        UGizmoElementCircleBase& InGizmoElement,
        const FVector& InWorldCenter,
        const FVector& InWorldNormal,
        const FVector& InViewLocation,
        const FVector& InViewDirection,
        const bool bIsPerspectiveProjection);
};
 
UCLASS(MinimalAPI)
class USimpleLambdaInteractiveGizmoBuilder : public UInteractiveGizmoBuilder
{
    GENERATED_BODY()
 
public:
 
    virtual UInteractiveGizmo* BuildGizmo(const FToolBuilderState& SceneState) const override
    {
        if (BuilderFunc)
        {
            return BuilderFunc(SceneState);
        }
        return nullptr;
    }
 
    TUniqueFunction<UInteractiveGizmo* (const FToolBuilderState& SceneState)> BuilderFunc;
};
 
namespace UE::GizmoUtil
{
    INTERACTIVETOOLSFRAMEWORK_API UInteractiveGizmo* CreateGizmoViaSimpleBuilder(UInteractiveGizmoManager* GizmoManager,
        TSubclassOf<UInteractiveGizmo> GizmoClass, const FString& InstanceIdentifier, void* Owner);
 
    template <typename GizmoClass>
    GizmoClass* CreateGizmoViaSimpleBuilder(UInteractiveGizmoManager* GizmoManager,
        const FString& InstanceIdentifier, void* GizmoOwner)
    {
        return Cast<GizmoClass>(CreateGizmoViaSimpleBuilder(GizmoManager, GizmoClass::StaticClass(), InstanceIdentifier, GizmoOwner));
    }
}