Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MeshDescription > FMeshDescription

Light Theme

Dark Theme

FMeshDescription

USTRUCT()

Windows

MacOS

Linux

References

Module	MeshDescription
Header	/Engine/Source/Runtime/MeshDescription/Public/MeshDescription.h
Include	#include "MeshDescription.h"

Syntax

struct FMeshDescription

Remarks

USTRUCT()

Constructors

	Name	Description
	FMeshDescription()	Mesh description should be a moveable type.
	FMeshDescription ( const FMeshDescription& )
	FMeshDescription ( FMeshDescription&& )

Destructors

	Name	Description
	~FMeshDescription()

Functions

	Name	Description
void	Compact ( FElementIDRemappings& OutRemapping... )	Compacts the data held in the mesh description, and returns an object describing how the IDs have been remapped.
FBox	ComputeBoundingBox()
void	ComputePolygonTriangulation ( const FPolygonID PolygonID )	Generates triangles and internal edges for the given polygon
FEdgeID	CreateEdge ( const FVertexID VertexID0, const FVertexID VertexID1 )	Adds a new edge to the mesh and returns its ID
void	CreateEdgeWithID ( const FEdgeID EdgeID, const FVertexID VertexID0, const FVertexID VertexID1 )	Adds a new edge to the mesh with the given ID
FPolygonID	CreatePolygon ( const FPolygonGroupID PolygonGroupI..., TArrayView< const FVertexInstanceID..., TArray< FEdgeID >* OutEdgeIDs )	Adds a new polygon to the mesh and returns its ID.
FPolygonGrou...	CreatePolygonGroup()	Adds a new polygon group to the mesh and returns its ID
void	CreatePolygonGroupWithID ( const FPolygonGroupID PolygonGroupI... )	Adds a new polygon group to the mesh with the given ID
void	CreatePolygonWithID ( const FPolygonID PolygonID, const FPolygonGroupID PolygonGroupI..., TArrayView< const FVertexInstanceID..., TArray< FEdgeID >* OutEdgeIDs )	Adds a new polygon to the mesh with the given ID.
FTriangleID	CreateTriangle ( const FPolygonGroupID PolygonGroupI..., TArrayView< const FVertexInstanceID..., TArray< FEdgeID >* OutEdgeIDs )	Adds a new triangle to the mesh and returns its ID.
void	CreateTriangleWithID ( const FTriangleID TriangleID, const FPolygonGroupID PolygonGroupI..., TArrayView< const FVertexInstanceID..., TArray< FEdgeID >* OutEdgeIDs )	Adds a new triangle to the mesh with the given ID.
FVertexID	CreateVertex()	Adds a new vertex to the mesh and returns its ID
FVertexInsta...	CreateVertexInstance ( const FVertexID VertexID )	Adds a new vertex instance to the mesh and returns its ID
void	CreateVertexInstanceWithID ( const FVertexInstanceID VertexInsta..., const FVertexID VertexID )	Adds a new vertex instance to the mesh with the given ID
void	CreateVertexWithID ( const FVertexID VertexID )	Adds a new vertex to the mesh with the given ID
void	DeleteEdge ( const FEdgeID EdgeID, TArray< FVertexID >* InOutOrph... )	Deletes an edge from the mesh
void	DeletePolygon ( const FPolygonID PolygonID, TArray< FEdgeID >* InOutOrphan..., TArray< FVertexInstanceID >* I..., TArray< FPolygonGroupID >* InO... )	Deletes a polygon from the mesh
void	DeletePolygonGroup ( const FPolygonGroupID PolygonGroupI... )	Deletes a polygon group from the mesh
void	DeletePolygons ( const TArray< FPolygonID >& Polygo... )	Deletes polygons from the mesh and remove all orphaned polygon groups, vertex instances, edges and vertices.
void	DeleteTriangle ( const FTriangleID TriangleID, TArray< FEdgeID >* InOutOrphan..., TArray< FVertexInstanceID >* I..., TArray< FPolygonGroupID >* InO... )	Deletes a triangle from the mesh
void	DeleteTriangles ( const TArray< FTriangleID >& Trian... )	Deletes triangles from the mesh and remove all orphaned polygon groups, vertex instances, edges and vertices.
void	DeleteVertex ( const FVertexID VertexID )	Deletes a vertex from the mesh
void	DeleteVertexInstance ( const FVertexInstanceID VertexInsta..., TArray< FVertexID >* InOutOrph... )	Deletes a vertex instance from a mesh
const TAttri...	EdgeAttributes()
TAttributesS...	EdgeAttributes()
const FEdgeA...	Edges()
FEdgeArray &	Edges()
void	Empty()	Empty the meshdescription.
FBoxSphereBo...	GetBounds()	Returns bounds of vertices
void	GetEdgeConnectedPolygons ( const FEdgeID EdgeID, TArray< FPolygonID, Alloc >& OutPo... )	Populates the passed array with polygon IDs connected to this edge
TArray< FPol...	GetEdgeConnectedPolygons ( const FEdgeID EdgeID )	Returns the polygons connected to this edge
TArray< FPol...	GetEdgeConnectedPolygons ( const FEdgeID EdgeID )	Returns the polygons connected to this edge as an array with the specified allocator template type.
const TArray...	GetEdgeConnectedTriangles ( const FEdgeID EdgeID )	Returns reference to an array of triangle IDs connected to this edge
FVertexID	GetEdgeVertex ( const FEdgeID EdgeID, int32 VertexNumber )	Returns the vertex ID corresponding to one of the edge endpoints
TArrayView< ...	GetEdgeVertices ( const FEdgeID EdgeID )	Returns a pair of vertex IDs defining the edge
int32	GetNumEdgeConnectedPolygons ( const FEdgeID EdgeID )	Returns the number of polygons connected to this edge
int32	GetNumEdgeConnectedTriangles ( const FEdgeID EdgeID )
int32	GetNumPolygonGroupPolygons ( const FPolygonGroupID PolygonGroupI... )	Returns the number of polygons in this polygon group
int32	GetNumPolygonInternalEdges ( const FPolygonID PolygonID )	Return the number of internal edges in this polygon
int32	GetNumPolygonTriangles ( const FPolygonID PolygonID )	Return the number of triangles which comprise this polygon
int32	GetNumPolygonVertices ( const FPolygonID PolygonID )	Returns the number of vertices this polygon has
int32	GetNumVertexConnectedEdges ( const FVertexID VertexID )	Returns number of edges connected to this vertex
int32	GetNumVertexConnectedPolygons ( const FVertexID VertexID )	Returns the number of polygons connected to this vertex
int32	GetNumVertexConnectedTriangles ( const FVertexID VertexID )	Returns number of triangles connected to this vertex
int32	GetNumVertexInstanceConnectedPolygons ( const FVertexInstanceID VertexInsta... )	Returns the number of polygons connected to this vertex instance.
int32	GetNumVertexInstanceConnectedTriangles ( const FVertexInstanceID VertexInsta... )	Returns the number of triangles connected to this vertex instance
int32	GetNumVertexVertexInstances ( const FVertexID VertexID )	Returns number of vertex instances created from this vertex
TArray< FPol...	GetPolygonAdjacentPolygons ( const FPolygonID PolygonID )	Return adjacent polygons into a TArray with the specified allocator
TArray< FPol...	GetPolygonAdjacentPolygons ( const FPolygonID PolygonID )	Return adjacent polygons to this polygon
void	GetPolygonAdjacentPolygons ( const FPolygonID PolygonID, TArray< FPolygonID, Alloc >& OutPo... )	Populates the passed array with adjacent polygons
float	GetPolygonCornerAngleForVertex ( const FPolygonID PolygonID, const FVertexID VertexID )
const TArray...	GetPolygonGroupPolygons ( const FPolygonGroupID PolygonGroupI... )	Returns the polygons associated with the given polygon group
TArray< FEdg...	GetPolygonInternalEdges ( const FPolygonID PolygonID )	Return the internal edges of this polygon, i.e. those which separate constituent triangles
TArray< FEdg...	GetPolygonInternalEdges ( const FPolygonID PolygonID )	Return the internal edges of this polygon, i.e. those which separate constituent triangles
void	GetPolygonInternalEdges ( const FPolygonID PolygonID, TArray< FEdgeID, Alloc >& OutEdgeI... )	Populate the provided array with a list of edges which are internal to the polygon, i.e. those which separate constituent triangles.
void	GetPolygonPerimeterEdges ( const FPolygonID PolygonID, TArray< FEdgeID, Alloc >& OutEdgeI... )	Populates the passed array with the edges which form the polygon perimeter
TArray< FEdg...	GetPolygonPerimeterEdges ( const FPolygonID PolygonID )	Returns the vertices which form the polygon perimeter
TArray< FEdg...	GetPolygonPerimeterEdges ( const FPolygonID PolygonID )	Returns the vertices which form the polygon perimeter as an array templated on the given allocator
FPolygonGrou...	GetPolygonPolygonGroup ( const FPolygonID PolygonID )	Return the polygon group associated with a polygon
const TArray...	GetPolygonTriangleIDs ( const FPolygonID PolygonID )	Return reference to an array of triangle IDs which comprise this polygon
const TArray...	GetPolygonVertexInstances ( const FPolygonID PolygonID )	Returns reference to an array of VertexInstance IDs forming the perimeter of this polygon
void	GetPolygonVertices ( const FPolygonID PolygonID, TArray< FVertexID, Alloc >& OutVer... )	Populates the passed array of VertexIDs with the vertices which form the polygon perimeter
TArray< FVer...	GetPolygonVertices ( const FPolygonID PolygonID )	Returns the vertices which form the polygon perimeter
TArray< FVer...	GetPolygonVertices ( const FPolygonID PolygonID )	Returns the vertices which form the polygon perimeter as an array templated on the given allocator
void	GetTriangleAdjacentTriangles ( const FTriangleID TriangleID, TArray< FTriangleID, Alloc >& OutT... )	Populates the passed array with adjacent triangles
TArray< FTri...	GetTriangleAdjacentTriangles ( const FTriangleID TriangleID )	Return adjacent triangles to this triangle
TArray< FTri...	GetTriangleAdjacentTriangles ( const FTriangleID TriangleID )	Return adjacent triangles into a TArray with the specified allocator
void	GetTriangleEdges ( const FTriangleID TriangleID, TArrayView< FEdgeID > OutEdgeIDs )	Populates the passed array with the edges which define this triangle
TStaticArray...	GetTriangleEdges ( const FTriangleID TriangleID )	Return the edges which form this triangle
FPolygonID	GetTrianglePolygon ( const FTriangleID TriangleID )	Get the polygon which contains this triangle
FPolygonGrou...	GetTrianglePolygonGroup ( const FTriangleID TriangleID )	Get the polygon group which contains this triangle
FVertexInsta...	GetTriangleVertexInstance ( const FTriangleID TriangleID, const int32 Index )	Get the specified vertex instance by index
TArrayView< ...	GetTriangleVertexInstances ( const FTriangleID TriangleID )	Get the vertex instances which define this triangle
void	GetTriangleVertices ( const FTriangleID TriangleID, TArrayView< FVertexID > OutVertexID... )	Populates the passed array with the vertices which define this triangle
TStaticArray...	GetTriangleVertices ( const FTriangleID TriangleID )	Return the vertices which define this triangle
void	GetVertexAdjacentVertices ( const FVertexID VertexID, TArray< FVertexID, Alloc >& OutAdj... )	Populates the passed array of VertexIDs with the vertices adjacent to this vertex
TArray< FVer...	GetVertexAdjacentVertices ( const FVertexID VertexID )	Returns the vertices adjacent to this vertex
TArray< FVer...	GetVertexAdjacentVertices ( const FVertexID VertexID )	Returns the vertices adjacent to this vertex as an array with the specified allocator template type.
const TArray...	GetVertexConnectedEdges ( const FVertexID VertexID )	Returns reference to an array of Edge IDs connected to this vertex
TArray< FPol...	GetVertexConnectedPolygons ( const FVertexID VertexID )	Returns the polygons connected to this vertex as an array with the specified allocator template type.
void	GetVertexConnectedPolygons ( const FVertexID VertexID, TArray< FPolygonID, Alloc >& OutCo... )	Populates the passed array of PolygonIDs with the polygons connected to this vertex
TArray< FPol...	GetVertexConnectedPolygons ( const FVertexID VertexID )	Returns the polygons connected to this vertex
TArray< FTri...	GetVertexConnectedTriangles ( const FVertexID VertexID )	Returns the triangles connected to this vertex as an array with the specified allocator template type.
TArray< FTri...	GetVertexConnectedTriangles ( const FVertexID VertexID )	Returns the triangles connected to this vertex
void	GetVertexConnectedTriangles ( const FVertexID VertexID, TArray< FTriangleID, Alloc >& OutC... )	Populates the passed array of TriangleIDs with the triangles connected to this vertex
TArray< FPol...	GetVertexInstanceConnectedPolygons ( const FVertexInstanceID VertexInsta... )	Returns the polygons connected to this vertex instance
TArray< FPol...	GetVertexInstanceConnectedPolygons ( const FVertexInstanceID VertexInsta... )	Returns the polygons connected to this vertex instance as an array with the specified allocator template type.
void	GetVertexInstanceConnectedPolygons ( const FVertexInstanceID VertexInsta..., TArray< FPolygonID, Alloc >& OutPo... )	Populates the passed array with the polygons connected to this vertex instance
const TArray...	GetVertexInstanceConnectedTriangles ( const FVertexInstanceID VertexInsta... )	Returns reference to an array of Triangle IDs connected to this vertex instance
FVertexInsta...	GetVertexInstanceForPolygonVertex ( const FPolygonID PolygonID, const FVertexID VertexID )	Return the vertex instance which corresponds to the given vertex on the given polygon, or FVertexInstanceID::Invalid
FVertexInsta...	GetVertexInstanceForTriangleVertex ( const FTriangleID TriangleID, const FVertexID VertexID )	Return the vertex instance which corresponds to the given vertex on the given triangle, or FVertexInstanceID::Invalid
FEdgeID	GetVertexInstancePairEdge ( const FVertexInstanceID VertexInsta..., const FVertexInstanceID VertexInsta... )	Returns the edge ID defined by the two given vertex instance IDs, if there is one; otherwise FEdgeID::Invalid
FVertexID	GetVertexInstanceVertex ( const FVertexInstanceID VertexInsta... )	Returns the vertex ID associated with the given vertex instance
FEdgeID	GetVertexPairEdge ( const FVertexID VertexID0, const FVertexID VertexID1 )	Returns the edge ID defined by the two given vertex IDs, if there is one; otherwise FEdgeID::Invalid
const TArray...	GetVertexVertexInstances ( const FVertexID VertexID )	Returns reference to an array of VertexInstance IDs instanced from this vertex
bool	IsEdgeInternal ( const FEdgeID EdgeID )	Determine whether a given edge is an internal edge between triangles of a polygon
bool	IsEdgeInternalToPolygon ( const FEdgeID EdgeID, const FPolygonID PolygonID )	Determine whether a given edge is an internal edge between triangles of a specific polygon
bool	IsEdgeValid ( const FEdgeID EdgeID )	Returns whether the passed edge ID is valid
bool	IsEmpty()	Return whether the mesh description is empty.
bool	IsPolygonGroupValid ( const FPolygonGroupID PolygonGroupI... )	Returns whether the passed polygon group ID is valid
bool	IsPolygonValid ( const FPolygonID PolygonID )	Returns whether the passed polygon ID is valid
bool	IsTrianglePartOfNgon ( const FTriangleID TriangleID )	Determines if this triangle is part of an n-gon
bool	IsTriangleValid ( const FTriangleID TriangleID )	Returns whether the passed triangle ID is valid
bool	IsVertexInstanceValid ( const FVertexInstanceID VertexInsta... )	Returns whether the passed vertex instance ID is valid
bool	IsVertexOrphaned ( const FVertexID VertexID )	Returns whether a given vertex is orphaned, i.e. it doesn't form part of any polygon
bool	IsVertexValid ( const FVertexID VertexID )	Returns whether the passed vertex ID is valid
const TAttri...	PolygonAttributes()
TAttributesS...	PolygonAttributes()
const TAttri...	PolygonGroupAttributes()
TAttributesS...	PolygonGroupAttributes()
const FPolyg...	PolygonGroups()
FPolygonGrou...	PolygonGroups()
const FPolyg...	Polygons()
FPolygonArra...	Polygons()
void	Remap ( const FElementIDRemappings& Remapp... )	Remaps the element IDs in the mesh description according to the passed in object
void	RemapPolygonGroups ( const TMap< FPolygonGroupID, FPolyg... )	Remaps polygon groups according to the supplied map
void	ReserveNewEdges ( const int32 NumEdges )	Reserves space for this number of new edges
void	ReserveNewPolygonGroups ( const int32 NumPolygonGroups )	Reserves space for this number of new polygon groups
void	ReserveNewPolygons ( const int32 NumPolygons )	Reserves space for this number of new polygons
void	ReserveNewTriangles ( const int32 NumTriangles )	Reserves space for this number of new triangles
void	ReserveNewVertexInstances ( const int32 NumVertexInstances )	Reserves space for this number of new vertex instances
void	ReserveNewVertices ( const int32 NumVertices )	Reserves space for this number of new vertices
void	ReverseAllPolygonFacing()	Reverses the winding order of all polygons in the mesh
void	ReversePolygonFacing ( const FPolygonID PolygonID )	Reverse the winding order of the vertices of this polygon
void	Serialize ( FArchive& Ar )	Serialize the mesh description.
void	SetPolygonPolygonGroup ( const FPolygonID PolygonID, const FPolygonGroupID PolygonGroupI... )	Sets the polygon group associated with a polygon
void	SetPolygonVertexInstance ( const FPolygonID PolygonID, const int32 PerimeterIndex, const FVertexInstanceID VertexInsta... )	Set the vertex instance at the given index around the polygon to the new value
const TAttri...	TriangleAttributes()
TAttributesS...	TriangleAttributes()
FTriangleArr...	Triangles()
const FTrian...	Triangles()
void	TriangulateMesh()	Retriangulates the entire mesh
TAttributesS...	VertexAttributes()
const TAttri...	VertexAttributes()
TAttributesS...	VertexInstanceAttributes()
const TAttri...	VertexInstanceAttributes()
FVertexInsta...	VertexInstances()
const FVerte...	VertexInstances()
FVertexArray...	Vertices()
const FVerte...	Vertices()

Operators

		Name	Description
	FMeshDescrip...	operator= ( FMeshDescription&& )
	FMeshDescrip...	operator= ( const FMeshDescription& )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss