UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Geometry::FCompactMaps Class Reference

#include <CompactMaps.h>

Public Member Functions

void SetIdentity (int32 NumVertMappings, int32 NumTriMappings)
 
void SetIdentityVertexMap (int32 NumVertMappings)
 
void SetIdentityTriangleMap (int32 NumTriMappings)
 
void Reset (int32 NumVertMappings, int32 NumTriMappings, bool bInitializeWithInvalidID)
 
void ResetVertexMap (int32 NumVertMappings, bool bInitializeWithInvalidID)
 
void ResetTriangleMap (int32 NumTriMappings, bool bInitializeWithInvalidID)
 
void Reset ()
 
bool VertexMapIsSet () const
 
bool TriangleMapIsSet () const
 
int32 NumVertexMappings () const
 
int32 NumTriangleMappings () const
 
void SetVertexMapping (int32 FromID, int32 ToID)
 
void SetTriangleMapping (int32 FromID, int32 ToID)
 
int32 GetVertexMapping (int32 FromID) const
 
FIndex3i GetVertexMapping (FIndex3i FromIDs) const
 
int32 GetTriangleMapping (int32 FromID) const
 
bool Validate () const
 

Static Public Attributes

static constexpr int32 InvalidID = IndexConstants::InvalidID
 

Detailed Description

Stores index remapping for vertices and triangles. Should only be used for compacting, and should maintain invariant that *Map[Idx] <= Idx for all maps

Member Function Documentation

◆ GetTriangleMapping()

int32 UE::Geometry::FCompactMaps::GetTriangleMapping ( int32  FromID) const
inline

Get mapping for a triangle

◆ GetVertexMapping() [1/2]

FIndex3i UE::Geometry::FCompactMaps::GetVertexMapping ( FIndex3i  FromIDs) const
inline

Get mapping for three vertices, e.g. a triangle

◆ GetVertexMapping() [2/2]

int32 UE::Geometry::FCompactMaps::GetVertexMapping ( int32  FromID) const
inline

Get mapping for a vertex

◆ NumTriangleMappings()

int32 UE::Geometry::FCompactMaps::NumTriangleMappings ( ) const
inline

Get number of triangle mappings

◆ NumVertexMappings()

int32 UE::Geometry::FCompactMaps::NumVertexMappings ( ) const
inline

Get number of vertex mappings

◆ Reset() [1/2]

void UE::Geometry::FCompactMaps::Reset ( )
inline

Reset all maps, leaving them empty

◆ Reset() [2/2]

void UE::Geometry::FCompactMaps::Reset ( int32  NumVertMappings,
int32  NumTriMappings,
bool  bInitializeWithInvalidID 
)
inline

Resize vertex and triangle maps, and initialize with InvalidID.

Parameters
NumVertMappingsSize of post-reset vertex map
NumTriMappingsSize of post-reset triangle map
bInitializeWithInvalidIDIf true, initializes maps with InvalidID

◆ ResetTriangleMap()

void UE::Geometry::FCompactMaps::ResetTriangleMap ( int32  NumTriMappings,
bool  bInitializeWithInvalidID 
)
inline

Resize triangle map, and optionally initialize with InvalidID.

Parameters
NumTriMappingsSize of post-reset triangle map
bInitializeWithInvalidIDIf true, initializes map with InvalidID

◆ ResetVertexMap()

void UE::Geometry::FCompactMaps::ResetVertexMap ( int32  NumVertMappings,
bool  bInitializeWithInvalidID 
)
inline

Resize vertex map, and optionally initialize with InvalidID.

Parameters
NumVertMappingsSize of post-reset vertex map
bInitializeWithInvalidIDIf true, initializes map with InvalidID

◆ SetIdentity()

void UE::Geometry::FCompactMaps::SetIdentity ( int32  NumVertMappings,
int32  NumTriMappings 
)
inline

Set up maps as identity maps.

Parameters
NumVertMappingsVertex map will be created from 0 to NumVertMappings - 1
NumTriMappingsTriangle map will be created from 0 to NumTriMappings - 1

◆ SetIdentityTriangleMap()

void UE::Geometry::FCompactMaps::SetIdentityTriangleMap ( int32  NumTriMappings)
inline

Set up triangle map as identity map.

Parameters
NumTriMappingsVertex map will be created from 0 to NumTriMappings - 1

◆ SetIdentityVertexMap()

void UE::Geometry::FCompactMaps::SetIdentityVertexMap ( int32  NumVertMappings)
inline

Set up vertex map as identity map.

Parameters
NumVertMappingsVertex map will be created from 0 to NumVertMappings - 1

◆ SetTriangleMapping()

void UE::Geometry::FCompactMaps::SetTriangleMapping ( int32  FromID,
int32  ToID 
)
inline

Set mapping for a triangle

◆ SetVertexMapping()

void UE::Geometry::FCompactMaps::SetVertexMapping ( int32  FromID,
int32  ToID 
)
inline

Set mapping for a vertex

◆ TriangleMapIsSet()

bool UE::Geometry::FCompactMaps::TriangleMapIsSet ( ) const
inline

Returns true if there are triangle mappings.

◆ Validate()

bool UE::Geometry::FCompactMaps::Validate ( ) const
inline

Check data for validity; for testing

◆ VertexMapIsSet()

bool UE::Geometry::FCompactMaps::VertexMapIsSet ( ) const
inline

Returns true if there are vertex mappings.

Member Data Documentation

◆ InvalidID

constexpr int32 UE::Geometry::FCompactMaps::InvalidID = IndexConstants::InvalidID
staticconstexpr

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