SceneSnappingManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/Object.h"
#include "Misc/Optional.h"
#include "Math/Vector.h"
#include "Math/Ray.h"
#include "Engine/HitResult.h"
#include "ToolContextInterfaces.h"
 
#include "SceneSnappingManager.generated.h"
 
class ISnappingPolicy;
class AActor;
class UActorComponent;
class UPrimitiveComponent;
class UInteractiveToolManager;
class UInteractiveGizmoManager;
 
struct FSceneQueryVisibilityFilter
{
    const TArray<const UPrimitiveComponent*>* ComponentsToIgnore = nullptr;
 
    const TArray<const UPrimitiveComponent*>* InvisibleComponentsToInclude = nullptr;
 
    INTERACTIVETOOLSFRAMEWORK_API bool IsVisible(const UPrimitiveComponent* Component) const;
};
 
 
struct FSceneHitQueryRequest
{
    FRay3d WorldRay;
 
    bool bWantHitGeometryInfo = false;
 
    FSceneQueryVisibilityFilter VisibilityFilter;
};
 
 
struct FSceneHitQueryResult
{
    AActor* TargetActor = nullptr;
    UPrimitiveComponent* TargetComponent = nullptr;
 
    FVector3d Position = FVector3d::Zero();
    FVector3d Normal = FVector3d::UnitZ();
 
    int HitTriIndex = -1;
    FVector3d TriVertices[3];
 
    FHitResult HitResult;
 
    INTERACTIVETOOLSFRAMEWORK_API void InitializeHitResult(const FSceneHitQueryRequest& FromRequest);
};
 
 
 
 
UENUM()
enum class ESceneSnapQueryType : uint8
{
    Position = 1,
    Rotation = 2,
    RotationAngle = 3,
    Scale = 4,
    Transform = 5
};
 
 
UENUM()
enum class ESceneSnapQueryTargetType : uint8
{
    None = 0,
    MeshVertex = 1,
    MeshEdge = 2,
    Grid = 4,
    ObjectTransform = 8,
    Custom = 16,
 
    All = MeshVertex | MeshEdge | Grid | ObjectTransform | Custom
};
ENUM_CLASS_FLAGS(ESceneSnapQueryTargetType);
 
UENUM()
enum class ESceneSnapQueryTargetResult : uint8
{
    NotSnapped,
 
    Snapped,
 
    Disabled,
 
    Unsupported
};
 
struct FSceneSnapQueryRequest
{
    EToolContextCoordinateSystem RequestCoordinateSpace;
 
    TOptional<EToolContextCoordinateSystem> ResultCoordinateSpace;
 
    ESceneSnapQueryType RequestType = ESceneSnapQueryType::Position;
 
    ESceneSnapQueryTargetType TargetTypes = ESceneSnapQueryTargetType::Grid;
 
    TSet<FName> CustomTargetTypes;
 
    TOptional<FVector> GridSize{};
 
    TOptional<FRotator> RotGridSize{};
 
    TOptional<FVector> ScaleGridSize{};
 
    FVector Position = FVector::ZeroVector;
 
    float VisualAngleThresholdDegrees = 15.0;
 
    FQuat DeltaRotation = FQuat(EForceInit::ForceInitToZero);
 
    double RotationAngle = 0.0;
 
    EAxisList::Type AxisList;
 
    FVector Scale = FVector::OneVector;
 
    const TArray<const UPrimitiveComponent*>* ComponentsToIgnore = nullptr;
 
    const TArray<const UPrimitiveComponent*>* InvisibleComponentsToInclude = nullptr;
 
    INTERACTIVETOOLSFRAMEWORK_API EToolContextCoordinateSystem GetResultCoordinateSpace() const;
};
 
 
struct FSceneSnapQueryResult
{
    TOptional<EToolContextCoordinateSystem> CoordinateSpace;
 
    AActor* TargetActor = nullptr;
    UActorComponent* TargetComponent = nullptr;
    ESceneSnapQueryTargetType TargetType = ESceneSnapQueryTargetType::None;
 
    FVector Position;
    FVector Normal;
    FQuat   DeltaRotation;
    double  RotationAngle;
    FVector Scale;
 
    FVector TriVertices[3];
    int TriSnapIndex;
 
    INTERACTIVETOOLSFRAMEWORK_API EToolContextCoordinateSystem GetCoordinateSpace(const FSceneSnapQueryRequest& InFromRequest) const;
};
 
 
UCLASS(MinimalAPI)
class USceneSnappingManager : public UObject
{
    GENERATED_BODY()
public:
 
    virtual bool ExecuteSceneHitQuery(const FSceneHitQueryRequest& Request, FSceneHitQueryResult& ResultOut) const
    {
        return false;
    }
 
    virtual bool ExecuteSceneSnapQuery(const FSceneSnapQueryRequest& Request, TArray<FSceneSnapQueryResult>& ResultsOut) const
    {
        return false;
    }
 
 
public:
    static INTERACTIVETOOLSFRAMEWORK_API USceneSnappingManager* Find(UInteractiveToolManager* ToolManager);
 
    static INTERACTIVETOOLSFRAMEWORK_API USceneSnappingManager* Find(UInteractiveGizmoManager* GizmoManager);
};