UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::FSegmentMesh Class Reference

#include <SegmentMesh.h>

Public Member Functions

 FSegmentMesh ()
 
CHAOS_API FSegmentMesh (TArray< TVec2< int32 > > &&Elements)
 
 FSegmentMesh (const FSegmentMesh &Other)=delete
 
 FSegmentMesh (FSegmentMesh &&Other)
 
CHAOS_API ~FSegmentMesh ()
 
CHAOS_API void Init (const TArray< TVec2< int32 > > &Elements)
 
CHAOS_API void Init (TArray< TVec2< int32 > > &&Elements)
 
int32 GetNumElements () const
 
const TArray< TVec2< int32 > > & GetElements () const
 
const TSet< int32 > * GetNeighbors (const int32 index) const
 
CHAOS_API const TMap< int32, TSet< int32 > > & GetPointToNeighborsMap () const
 
CHAOS_API const TMap< int32, TArray< int32 > > & GetPointToEdges () const
 
CHAOS_API TArray< FRealGetEdgeLengths (const TParticles< FReal, 3 > &InParticles, const bool lengthSquared=false) const
 

Detailed Description

Mesh structure of connected particles via edges.

Constructor & Destructor Documentation

◆ FSegmentMesh() [1/4]

Chaos::FSegmentMesh::FSegmentMesh ( )
inline

◆ FSegmentMesh() [2/4]

Chaos::FSegmentMesh::FSegmentMesh ( TArray< TVec2< int32 > > &&  Elements)

◆ FSegmentMesh() [3/4]

Chaos::FSegmentMesh::FSegmentMesh ( const FSegmentMesh Other)
delete

◆ FSegmentMesh() [4/4]

Chaos::FSegmentMesh::FSegmentMesh ( FSegmentMesh &&  Other)
inline

◆ ~FSegmentMesh()

Chaos::FSegmentMesh::~FSegmentMesh ( )

Member Function Documentation

◆ GetEdgeLengths()

TArray< FReal > Chaos::FSegmentMesh::GetEdgeLengths ( const TParticles< FReal, 3 > &  InParticles,
const bool  lengthSquared = false 
) const

@ret Lengths (or lengths squared) of all edges.

Parameters
InParticles- The particle positions to use. This routine assumes it's sized appropriately.
lengthSquared- If true, the squared length is returned, which is faster.

◆ GetElements()

const TArray< TVec2< int32 > > & Chaos::FSegmentMesh::GetElements ( ) const
inline

◆ GetNeighbors()

const TSet< int32 > * Chaos::FSegmentMesh::GetNeighbors ( const int32  index) const
inline

@ret The set of neighbor nodes, or nullptr if index is not found.

◆ GetNumElements()

int32 Chaos::FSegmentMesh::GetNumElements ( ) const
inline

◆ GetPointToEdges()

const TMap< int32, TArray< int32 > > & Chaos::FSegmentMesh::GetPointToEdges ( ) const

@ret A map of each point index to the list of connected edges.

◆ GetPointToNeighborsMap()

const TMap< int32, TSet< int32 > > & Chaos::FSegmentMesh::GetPointToNeighborsMap ( ) const

@ret A map of each point index to the list of connected points.

◆ Init() [1/2]

void Chaos::FSegmentMesh::Init ( const TArray< TVec2< int32 > > &  Elements)

◆ Init() [2/2]

void Chaos::FSegmentMesh::Init ( TArray< TVec2< int32 > > &&  Elements)

The documentation for this class was generated from the following files: