SpatialInterfaces.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
// Port of geometry3cpp SpatialInterfaces
 
#pragma once
 
#include "Math/Ray.h"
#include "VectorTypes.h"
 
namespace MeshIntersection
{
    struct FHitIntersectionResult
    {
        int TriangleId;
        double Distance;
        FVector3d BaryCoords;
    };
}
 
namespace UE
{
namespace Geometry
{
 
 
class ISpatial
{
public:
    virtual ~ISpatial() = default;
 
    virtual bool SupportsPointContainment() const = 0;
 
    virtual bool IsInside(const FVector3d & Point) const = 0;
};
 
 
 
class IMeshSpatial : public ISpatial
{
public:
    virtual ~IMeshSpatial() = default;
 
    // standard shared options for all mesh spatial queries
    struct FQueryOptions
    {
        double MaxDistance = TNumericLimits<double>::Max();
 
        TFunction<bool(int)> TriangleFilterF = nullptr;
 
        // If true, then the IMeshSpatial may allow queries even when the underlying mesh has been
        // modified without updating the queried structure. This may be useful, for instance, to 
        // run queries against a mesh as it is being interactively modified, but it requires the 
        // caller to pass an appropriate TriangleFilterF to make sure that modified triangles do
        // not affect the query.
        bool bAllowUnsafeModifiedMeshQueries = false;
 
        FQueryOptions() {}
        FQueryOptions(TFunction<bool(int)> TriangleFilterF) : TriangleFilterF(TriangleFilterF) {}
        FQueryOptions(double MaxDistance, TFunction<bool(int)> TriangleFilterF = nullptr) : MaxDistance(MaxDistance), TriangleFilterF(TriangleFilterF) {}
    };
 
    virtual bool SupportsNearestTriangle() const = 0;
 
    virtual int FindNearestTriangle(const FVector3d& Point, double& NearestDistSqrOut, const FQueryOptions& Options = FQueryOptions()) const = 0;
 
 
    virtual bool SupportsTriangleRayIntersection() const = 0;
 
    virtual int FindNearestHitTriangle(const FRay3d& Ray, const FQueryOptions& Options = FQueryOptions()) const
    {
        double NearestT;
        int TID;
        FindNearestHitTriangle(Ray, NearestT, TID, Options);
        return TID;
    }
 
    virtual bool FindNearestHitTriangle(const FRay3d& Ray, double& NearestT, int& TID, const FQueryOptions& Options = FQueryOptions()) const
    {
        FVector3d BaryCoords;
        return FindNearestHitTriangle(Ray, NearestT, TID, BaryCoords, Options);
    }
 
    virtual bool FindNearestHitTriangle(const FRay3d& Ray, double& NearestT, int& TID, FVector3d& BaryCoords, const FQueryOptions& Options = FQueryOptions()) const = 0;
 
    virtual bool FindAllHitTriangles(const FRay3d& Ray, TArray<MeshIntersection::FHitIntersectionResult>& OutHits, const FQueryOptions& Options = FQueryOptions()) const = 0;
};
 
 
 
class IProjectionTarget
{
public:
    virtual ~IProjectionTarget() {}
 
    virtual FVector3d Project(const FVector3d& Point, int Identifier = -1) = 0;
};
 
 
 
class IOrientedProjectionTarget : public IProjectionTarget
{
public:
    virtual ~IOrientedProjectionTarget() {}
 
    virtual FVector3d Project(const FVector3d& Point, int Identifier = -1) override = 0;
 
    virtual FVector3d Project(const FVector3d& Point, FVector3d& ProjectNormalOut, int Identifier = -1) = 0;
};
 
 
 
class IIntersectionTarget
{
public:
    virtual ~IIntersectionTarget() {}
 
    virtual bool HasNormal() = 0;
 
    virtual bool RayIntersect(const FRay3d& Ray, FVector3d& HitOut, FVector3d& HitNormalOut) = 0;
};
 
 
} // end namespace UE::Geometry
} // end namespace UE