GizmoInterfaces.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "InputState.h"
#include "Math/Transform.h"
#include "Math/UnrealMathSSE.h"
#include "Math/Vector2D.h"
#include "ToolContextInterfaces.h"
#include "UObject/Interface.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
 
#include "GizmoInterfaces.generated.h"
 
class IToolsContextRenderAPI;
class UObject;
struct FFrame;
 
 
//
// UInterfaces for the various UObjects used in the Standard Gizmo Library.
// 
 
 
 
UINTERFACE(MinimalAPI)
class UGizmoTransformSource : public UInterface
{
    GENERATED_BODY()
};
class IGizmoTransformSource
{
    GENERATED_BODY()
public:
    UFUNCTION()
    virtual FTransform GetTransform() const = 0;
 
    UFUNCTION()
    virtual void SetTransform(const FTransform& NewTransform) = 0;
};
 
 
 
 
 
UINTERFACE(MinimalAPI)
class UGizmoAxisSource : public UInterface
{
    GENERATED_BODY()
};
class IGizmoAxisSource
{
    GENERATED_BODY()
public:
    UFUNCTION()
    virtual FVector GetOrigin() const = 0;
 
    UFUNCTION()
    virtual FVector GetDirection() const = 0;
 
    UFUNCTION()
    virtual bool HasTangentVectors() const { return false; }
 
    UFUNCTION()
    virtual void GetTangentVectors(FVector& TangentXOut, FVector& TangentYOut) const { }
 
 
    INTERACTIVETOOLSFRAMEWORK_API void GetAxisFrame(
        FVector& PlaneNormalOut, FVector& PlaneAxis1Out, FVector& PlaneAxis2Out) const;
};
 
 
 
 
 
 
UINTERFACE(MinimalAPI)
class UGizmoClickTarget : public UInterface
{
    GENERATED_BODY()
};
class IGizmoClickTarget
{
    GENERATED_BODY()
public:
    //UFUNCTION()    // FInputDeviceRay is not USTRUCT because FRay is not USTRUCT
    virtual FInputRayHit IsHit(const FInputDeviceRay& ClickPos) const = 0;
 
    /*
     * Updates the hover state indicating whether the input device is currently hovering over the Standard gizmo.
     * This should be be set to false once interaction with the gizmo commences.
     */
    UFUNCTION()
    virtual void UpdateHoverState(bool bHovering) = 0;
 
    /*
     * Updates the interacting state indicating when interaction with the Standard gizmo is actively occurring, 
     * typically upon the input device clicking and dragging the Standard gizmo.
     */
    UFUNCTION()
    virtual void UpdateInteractingState(bool bInteracting) = 0;
 
    /*
     * Updates the selected state, indicating when the gizmo is currently selected,
     * typically upon the input device clicking the Standard gizmo. 
     */
    UFUNCTION()
    virtual void UpdateSelectedState(bool bSelected) = 0;
 
    /*
     * Updates the subdued state, indicating when the element should have a subdued/background appearance, 
     * typically upon interacting with one of a set of gizmos representing 3 axis - the two not interacted with would be subdued. 
     */
    UFUNCTION()
    virtual void UpdateSubdueState(bool bSubdued) = 0;
};
 
UINTERFACE(MinimalAPI)
class UGizmoClickMultiTarget : public UInterface
{
    GENERATED_BODY()
};
class IGizmoClickMultiTarget
{
    GENERATED_BODY()
public:
     //UFUNCTION()    // FInputDeviceRay is not USTRUCT because FRay is not USTRUCT
    virtual FInputRayHit IsHit(const FInputDeviceRay& ClickPos) const = 0;
 
    /*
     * Updates the hover state of the specified gizmo part, indicating whether the input device is currently hovering 
     * over the Standard gizmo.
     */
    UFUNCTION()
    virtual void UpdateHoverState(bool bHovering, uint32 InPartIdentifier) = 0;
 
    /*
     * Updates the interacting state of the specified gizmo part, indicating when interaction with the 
     * Standard gizmo is actively occurring, typically upon the input device clicking and dragging the Standard gizmo. 
     */
    UFUNCTION()
    virtual void UpdateInteractingState(bool bInteracting, uint32 InPartIdentifier) = 0;
 
    /*
     * Updates the selected state of the specified gizmo part, indicating when the gizmo part is currently selected,
     * typically upon the input device clicking the Standard gizmo.
     */
    UFUNCTION()
    virtual void UpdateSelectedState(bool bSelected, uint32 InPartIdentifier) = 0;
 
    /*
     * Updates the subdued state of the specified gizmo part, indicating when the element should have a subdued/background appearance, 
     * typically upon interacting with one of a set of gizmos representing 3 axis - the two not interacted with would be subdued.
     */
    UFUNCTION()
    virtual void UpdateSubdueState(bool bSubdued, uint32 InPartIdentifier) = 0;
 
    /*
     * Updates the hittable state of the specified gizmo part. 
     */
    UFUNCTION()
    virtual void UpdateHittableState(bool bHittable, uint32 InPartIdentifier) = 0;
};
 
 
 
 
UINTERFACE(MinimalAPI)
class UGizmoRenderTarget : public UInterface
{
    GENERATED_BODY()
};
 
class IGizmoRenderTarget
{
    GENERATED_BODY()
public:
    virtual void Render(IToolsContextRenderAPI* RenderAPI) const = 0;
};
 
 
 
 
UINTERFACE(MinimalAPI)
class UGizmoRenderMultiTarget : public UInterface
{
    GENERATED_BODY()
};
 
class IGizmoRenderMultiTarget
{
    GENERATED_BODY()
public:
    virtual void Render(IToolsContextRenderAPI* RenderAPI) const = 0;
 
    /*
     * Updates the visibility state of the specified gizmo part.
     */
    UFUNCTION()
    virtual void UpdateVisibilityState(bool bVisible, uint32 InPartIdentifier) = 0;
};
 
 
UINTERFACE(MinimalAPI)
class UGizmoStateTarget : public UInterface
{
    GENERATED_BODY()
};
class IGizmoStateTarget
{
    GENERATED_BODY()
public:
    UFUNCTION()
    virtual void BeginUpdate() = 0;
 
    UFUNCTION()
    virtual void EndUpdate() = 0;
};
 
 
 
 
 
UINTERFACE(MinimalAPI)
class UGizmoFloatParameterSource : public UInterface
{
    GENERATED_BODY()
};
class IGizmoFloatParameterSource
{
    GENERATED_BODY()
public:
 
    UFUNCTION()
    virtual float GetParameter() const = 0;
 
    UFUNCTION()
    virtual void BeginModify() = 0;
 
    UFUNCTION()
    virtual void SetParameter(float NewValue) = 0;
 
    UFUNCTION()
    virtual void EndModify() = 0;
};
 
 
 
 
UINTERFACE(MinimalAPI)
class UGizmoVec2ParameterSource : public UInterface
{
    GENERATED_BODY()
};
class IGizmoVec2ParameterSource
{
    GENERATED_BODY()
public:
 
    UFUNCTION()
    virtual FVector2D GetParameter() const = 0;
 
    UFUNCTION()
    virtual void BeginModify() = 0;
 
    UFUNCTION()
    virtual void SetParameter(const FVector2D& NewValue) = 0;
 
    UFUNCTION()
    virtual void EndModify() = 0;
};