1. Epic GamesDeveloper
  3. TMeshAABBTree3

TMeshAABBTree3

API > API/Runtime > API/Runtime/GeometryCore > API/Runtime/GeometryCore/Spatial

Inheritance Hierarchy

References

   
Module GeometryCore
Header /Engine/Source/Runtime/GeometryCore/Public/Spatial/MeshAABBTree3.h
Include #include "Spatial/MeshAABBTree3.h"

Syntax

template<class TriangleMeshType>  
class TMeshAABBTree3 : public UE::Geometry::IMeshSpatial

Variables

  Type Name Description
Public variable TDynamicVector< FVector3d > BoxCenters  
Protected variable double BoxEps TODO: move BoxEps to IMeshSpatial::FQueryOptions.
Public variable TDynamicVector< FVector3d > BoxExtents  
Public variable TDynamicVector< int > BoxToIndex Storage for Box Nodes.
Protected variable GetSplitAxisFunc GetSplitAxis  
Public variable TDynamicVector< int > IndexList List of indices for a given Box.
Protected variable const TriangleMeshType * Mesh  
Protected variable uint64 MeshChangeStamp  
Public variable int RootIndex BoxToIndex[RootIndex] is the root node of the tree.
Protected variable int TopDownLeafMaxTriCount  
Public variable int TrianglesEnd IndexList[i] for i < TrianglesEnd is a triangle-index list, otherwise Box-index pair/single.

Constructors

  Type Name Description
Public function    
Public function  

TMeshAABBTree3 ( const TriangleMeshType* SourceMesh,
bool bAutoBuild
)

  

Functions

  Type Name Description
Public function Static void Helper to add a triangle-triangle intersection result from to a intersection result struct
Public function Const double

box_box_distsqr ( int iBox,
const FAxisAlignedBox3d& testBox
)

  
Public function Const bool

box_box_intersect ( int IBox,
const FAxisAlignedBox3d& TestBox
)

  
Public function Const bool

box_contains ( int IBox,
const FVector3d& P
)

  
Public function Const double

box_ray_intersect_t ( int IBox,
const FRay3d& Ray
)

  
Public function Const double

BoxDistanceSqr ( int IBox,
const FVector3d& V
)

  
Public function void

Build ( const TArray< int32 >& TriangleList
)

  
Public function void

Build ()

  
Public function void

BuildTopDown ( bool bSorted,
TriIndexEnumerable TriangleList,
int32 NumTriangles
)

  
Public function void

BuildTopDown ( bool bSorted
)

  
Public function void

BuildTopDown ( TArray< int >& Triangles,
TArray< FVector3d >& Centers,
int32 NumTriangles
)

  
Public function Virtual Const void

DoTraversal ( FTreeTraversal& Traversal,
const FQueryOptions& Options
)

 Hierarchically descend through the tree Nodes, calling the FTreeTraversal functions at each level
Public function Const int

find_any_intersection ( int iBox,
const FTriangle3d& Triangle,
const FAxisAlignedBox3d& triBounds,
TFunctionRef< bool(const FTriangle3d&A, const FTriangle3d&B)> TriangleIntersectionTest,
const FQueryOptions& Options
)

  
Public function Const bool

find_any_intersection ( int iBox,
const TMeshAABBTree3& OtherTree,
const TFunction< FVector3d(const FVector3d&)>& TransformF,
int oBox,
int depth,
TFunctionRef< bool(const FTriangle3d&A, const FTriangle3d&B)> TriangleIntersectionTest,
const FQueryOptions& Options,
const FQueryOptions& OtherTreeOptions
)

  
Public function Const void

find_intersections ( int iBox,
const TMeshAABBTree3& OtherTree,
const TFunction< FVector3d(const FVector3d&)>& TransformF,
int oBox,
int depth,
MeshIntersection::FIntersectionsQueryResult& result,
TFunctionRef< bool(FIntrTriangle3Triangle3d&)> IntersectFn,
const FQueryOptions& Options,
const FQueryOptions& OtherTreeOptions
)

  
Protected function Const bool

find_nearest_tri ( int IBox,
const FVector3d& P,
double& NearestDistSqr,
int& TID,
const FQueryOptions& Options
)

 BEarlyStop causes the traversal to stop as soon as any triangle closer than NearestDistSqr is found
Public function Const void

find_nearest_triangles ( int iBox,
TMeshAABBTree3& OtherTree,
const TFunction< FVector3d(const FVector3d&)>& TransformF,
int oBox,
int depth,
double& nearest_sqr,
FIndex2i& nearest_pair,
const FQueryOptions& Options,
const FQueryOptions& OtherTreeOptions
)

  
Protected function void

find_nearest_vertex ( int IBox,
const FVector3d& P,
double& NearestDistSqr,
int& NearestVertexID,
const FQueryOptions& Options
)

  
Public function Const bool

find_self_intersections ( MeshIntersection::FIntersectionsQueryResult* Result,
bool bIgnoreTopoConnected,
TFunctionRef< bool(FIntrTriangle3Triangle3d&)> IntersectFn,
const FQueryOptions& Options
)

  
Public function Const bool

find_self_intersections_acrossboxes ( int Box1,
int Box2,
MeshIntersection::FIntersectionsQueryResult* Result,
bool bIgnoreTopoConnected,
int depth,
TFunctionRef< bool(FIntrTriangle3Triangle3d&)> IntersectFn,
const FQueryOptions& Options
)

 Helper for find_self_intersections that checks intersections between triangles from separate boxes
Public function Const bool

find_tri_tri_intersections ( int TID_A,
int IdxRangeStart,
int IdxRangeEnd,
MeshIntersection::FIntersectionsQueryResult* Result,
bool bIgnoreTopoConnected,
TFunctionRef< bool(FIntrTriangle3Triangle3d&)> IntersectFn,
const FQueryOptions& Options
)

 Helper for find_self_intersections that intersects a single triangle vs a range of triangles
Public function Virtual Const MeshIntersection::FIntersectionsQueryResult

FindAllIntersections ( const TMeshAABBTree3& OtherTree,
const TFunction< FVector3d(const FVector3d&)>& TransformF,
const FQueryOptions& Options,
const FQueryOptions& OtherTreeOptions,
TFunction< bool(FIntrTriangle3Triangle3d&)> IntersectionFn
)

 Compute all intersections between two meshes.
Public function Virtual Const MeshIntersection::FIntersectionsQueryResult

FindAllSelfIntersections ( bool bIgnoreTopoConnected,
const FQueryOptions& Options,
TFunction< bool(FIntrTriangle3Triangle3d&)> IntersectionFn
)

 Compute self intersections on our mesh.
Protected function Const void

FindHitTriangle ( int IBox,
const FRay3d& Ray,
double& NearestT,
int& TID,
FVector3d& BaryCoords,
const FQueryOptions& Options
)

  
Protected function Const void

FindHitTriangles ( int IBox,
const FRay3d& Ray,
TArray< MeshIntersection::FHitIntersectionResult >& Intersections,
const FQueryOptions& Options
)

  
Public function Virtual Const FVector3d

FindNearestPoint ( const FVector3d& Point,
const FQueryOptions& Options
)

 Convenience function that calls FindNearestTriangle and then finds nearest point
Public function Virtual FIndex2i

FindNearestTriangles ( TMeshAABBTree3& OtherTree,
const TFunction< FVector3d(const FVector3d&)>& TransformF,
double& Distance,
const FQueryOptions& Options,
const FQueryOptions& OtherTreeOptions
)

 Find nearest pair of triangles on this tree with OtherTree, within Options.MaxDistance.
Public function Virtual int

FindNearestVertex ( const FVector3d& P,
double& NearestDistSqr,
double MaxDist,
const FQueryOptions& Options
)

 Find the Vertex closest to P, and distance to it, within distance MaxDist, or return InvalidID
Public function Const FAxisAlignedBox3d Get the overall bounding box of the whole tree
Protected function Const FAxisAlignedBox3d

GetBox ( int IBox
)

 Internals - data structures, construction, etc
Protected function Const FAxisAlignedBox3d

GetBox ( int iBox,
const TFunction< FVector3d(const FVector3d&)>& TransformF
)

  
Protected function Const FAxisAlignedBox3d

GetBoxEps ( int IBox,
double Epsilon
)

  
Public function Const const TriangleMeshType *

GetMesh ()

  
Public function Const bool

IsValid ( bool bAllowUnsafeModifiedMeshQueries
)

  
Public function Virtual Const bool

IsWithinDistanceSquared ( const FVector3d& Point,
double ThresholdDistanceSqr,
int& OutTriangleID,
const FQueryOptions& Options
)

 Test whether there is any triangle closer than sqrt(ThresholdDistanceSqr) to Point Note that FQueryOptions::MaxDistance is ignored by this query, as ThresholdDistanceSqr controls the query distance instead
Protected function Static GetSplitAxisFunc  
Public function void

SetBuildOptions ( int32 MaxBoxTriCount,
GetSplitAxisFunc&& GetSplitAxisIn
)

  
Public function void

SetMesh ( const TriangleMeshType* SourceMesh,
bool bAutoBuild
)

  
Public function void

SetTolerance ( double Tolerance
)

 Sets the box intersection tolerance TODO: move into the IMeshSpatial::FQueryOptions and delete this function
Public function int

SplitTriSetMidpoint ( TArray< int >& Triangles,
TArray< FVector3d >& Centers,
int IStart,
int ICount,
int Depth,
int MinTriCount,
FBoxesSet& Tris,
FBoxesSet& Nodes,
FAxisAlignedBox3d& Box
)

  
Protected function Const bool

TestAnyHitTriangle ( int IBox,
const FRay3d& Ray,
int32& HitTIDOut,
double MaxDistance,
const FQueryOptions& Options
)

  
Public function Virtual Const bool

TestAnyHitTriangle ( const FRay3d& Ray,
const FQueryOptions& Options
)

  
Public function void 1) make sure we can reach every Tri in Mesh through tree (also demo of how to traverse tree...) 2) make sure that Triangles are contained in parent boxes
Public function Virtual Const bool

TestIntersection ( const TMeshAABBTree3& OtherTree,
const TFunction< FVector3d(const FVector3d&)>& TransformF,
const FQueryOptions& Options,
const FQueryOptions& OtherTreeOptions
)

 Returns true if there is any intersection between our mesh and 'other' mesh.
Public function Virtual Const bool

TestIntersection ( const TriangleMeshType* TestMesh,
FAxisAlignedBox3d TestMeshBounds,
const TFunction< FVector3d(const FVector3d&)>& TransformF,
const FQueryOptions& Options
)

 Return true if any triangle of TestMesh intersects with our tree.
Public function Virtual Const bool

TestIntersection ( const FTriangle3d& Triangle,
const FQueryOptions& Options
)

 Returns true if triangle intersects any triangle of our mesh
Public function Virtual Const bool

TestSelfIntersection ( bool bIgnoreTopoConnected,
const FQueryOptions& Options
)

  
Public function double Total sum of volumes of all boxes in the tree. Mainly useful to evaluate tree quality.
Protected function Virtual Const void

TreeTraversalImpl ( int IBox,
int Depth,
FTreeTraversal& Traversal,
const FQueryOptions& Options
)

 Traversal implementation. you can override to customize this if necessary.
Public function Static bool Standard tri tri intersection test (with computing intersection geometry)
Public function Static bool Standard tri tri intersection test (without computing intersection geometry)

Overridden from IMeshSpatial

  Type Name Description
Public function Virtual Const bool

FindAllHitTriangles ( const FRay3d& Ray,
TArray< MeshIntersection::FHitIntersectionResult >& OutHits,
const FQueryOptions& Options
)

 Find all triangles intersected by the given ray sorted by distance
Public function Virtual Const bool

FindNearestHitTriangle ( const FRay3d& Ray,
double& NearestT,
int& TID,
const FQueryOptions& Options
)

 Find nearest triangle from the given ray
Public function Virtual Const int

FindNearestHitTriangle ( const FRay3d& Ray,
const FQueryOptions& Options
)

  
Public function Virtual Const bool

FindNearestHitTriangle ( const FRay3d& Ray,
double& NearestT,
int& TID,
FVector3d& BaryCoords,
const FQueryOptions& Options
)

 Find nearest triangle from the given ray
Public function Virtual Const int

FindNearestTriangle ( const FVector3d& P,
double& NearestDistSqr,
const FQueryOptions& Options
)

 Find the triangle closest to P, and distance to it, within distance MaxDist, or return InvalidID Use MeshQueries.TriangleDistance() to get more information
Public function Virtual Const bool  
Public function Virtual Const bool  

Overridden from ISpatial

  Type Name Description
Public function Virtual Const bool

IsInside ( const FVector3d& Point
)

  
Public function Virtual Const bool  

Classes

  Type Name Description
Public struct FBoxesSet    
Public class FTreeTraversal    

Typedefs

Name Description
GetSplitAxisFunc  
MeshType  

Constants

Name Description
DOUBLE_MAX  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page