1. Epic GamesDeveloper
  3. FColliderMesh

FColliderMesh

[FColliderMesh](API\Runtime\GeometryCore\DynamicMesh\FColliderMesh) is a minimal representation of an Indexed Triangle Mesh suitable to use with a [TMeshAABBTree3](API\Runtime\GeometryCore\Spatial\TMeshAABBTree3).

API > API/Runtime > API/Runtime/GeometryCore > API/Runtime/GeometryCore/DynamicMesh

References

   
Module GeometryCore
Header /Engine/Source/Runtime/GeometryCore/Public/DynamicMesh/ColliderMesh.h
Include #include "DynamicMesh/ColliderMesh.h"

Syntax

class FColliderMesh

Remarks

FColliderMesh is a minimal representation of an Indexed Triangle Mesh suitable to use with a TMeshAABBTree3. This class is intended to be used in situations where a copy of a FDynamicMesh3 would be created/kept only to use with an AABBTree or FWNTree. In such situations, the FDynamicMesh3 copy is (relatively) heavy memory-wise, particularly if a large number of small mesh/AABBTree pairs are stored. In those cases a FColliderMesh can be used instead.

If FBuildOptions.bBuildAABBTree is true (default), then an AABBTree will automatically be built and available via GetAABBTree()

If the source FDynamicMesh3 is not compact, it will be compacted. ID mappings can optionally be stored if the FBuildOptions are configured to request it (default false), allowing hit-triangle/vertex IDs to be mapped back to IDs on the source mesh.

Currently there is no support for UVs or Vertex Normals.

FColliderMesh (effectively) implements the TTriangleMeshAdapter interface, and so can be used anywhere a TTriangleMeshAdapter could be used (eg with TMeshQueries functions).

Variables

  Type Name Description
Protected variable TMeshAABBTree3< FColliderMesh > AABBTree  
Protected variable bool bSourceWasCompactT  
Protected variable bool bSourceWasCompactV  
Protected variable TArray< int32 > SourceTriangleIDs  
Protected variable TArray< int32 > SourceVertexIDs  
Protected variable TArray< FIndex3i > Triangles  
Protected variable TArray< FVector3d > Vertices For large meshes it might be better to optionally use TDynamicVector here (but keeping the TArray for small meshes is still also desirable due to minimum-size).

Constructors

  Type Name Description
Public function    
Public function  

FColliderMesh ( const FDynamicMesh3& SourceMesh,
const FBuildOptions& BuildOptions
)

  

Functions

  Type Name Description
Public function Const bool

FindNearestHitTriangle ( const FRay3d& Ray,
double& RayParameterOut,
int& HitTriangleIDOut,
FVector3d& BaryCoordsOut
)

  
Public function Const int

FindNearestTriangle ( const FVector3d& Point,
double& NearestDistSqrOut,
const IMeshSpatial::FQueryOptions& Options
)

 Find the TriangleID closest to P on the collider mesh, and distance to it, within distance MaxDist, or return InvalidID.
Public function Const uint64  
Public function TMeshAABBTree3< FColliderMesh > * Direct access to the AABBTree pointer inside the ColliderMesh.
Public function Const int32

GetSourceTriangleID ( int32 TriangleID
)

  
Public function Const int32

GetSourceVertexID ( int32 VertexID
)

  
Public function Const FIndex3i

GetTriangle ( int32 TriangleID
)

  
Public function Const FVector3d

GetTriNormal ( int32 TriangleID
)

  
Public function Const void

GetTriVertices ( int32 TriangleID,
FVector3d& V0,
FVector3d& V1,
FVector3d& V2
)

  
Public function Const FVector3d

GetVertex ( int32 VertexID
)

  
Public function Const bool  
Public function Const bool  
Public function void

Initialize ( const FDynamicMesh3& SourceMesh,
const FBuildOptions& BuildOptions
)

  
Public function Const bool

IsTriangle ( int32 TriangleID
)

 Mesh API required for TMeshAABBTree3
Public function Const bool

IsVertex ( int32 VertexID
)

  
Public function Const int32  
Public function Const int32  
Public function void

Reset ( bool bReleaseMemory
)

  
Public function Const bool  
Public function Const bool  
Public function Const int32  
Public function Const int32  

Classes

  Type Name Description
Public struct FBuildOptions    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page