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 > UMeshDescriptionBase

Light Theme

Dark Theme

UMeshDescriptionBase

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMeshDescriptionBase

UStaticMeshDescription

References

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

Syntax

class UMeshDescriptionBase : public UObject

Variables

		Name	Description
	FMeshDescriptio...	MeshDescription
	TUniquePtr< FMe...	RequiredAttributes

Functions

	Name	Description
void	ComputePolygonTriangulation ( FPolygonID PolygonID )	Generates triangles and internal edges for the given polygon
FEdgeID	CreateEdge ( FVertexID VertexID0, FVertexID VertexID1 )	Adds a new edge to the mesh and returns its ID
void	CreateEdgeWithID ( FEdgeID EdgeID, FVertexID VertexID0, FVertexID VertexID1 )	Adds a new edge to the mesh with the given ID
FPolygonID	CreatePolygon ( FPolygonGroupID PolygonGroupID, TArray< FVertexInstanceID >& Verte..., TArray< FEdgeID >& NewEdgeIDs )	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 ( FPolygonGroupID PolygonGroupID )	Adds a new polygon group to the mesh with the given ID
void	CreatePolygonWithID ( FPolygonID PolygonID, FPolygonGroupID PolygonGroupID, TArray< FVertexInstanceID >& Verte..., TArray< FEdgeID >& NewEdgeIDs )	Adds a new polygon to the mesh with the given ID.
FTriangleID	CreateTriangle ( FPolygonGroupID PolygonGroupID, const TArray< FVertexInstanceID >&..., TArray< FEdgeID >& NewEdgeIDs )	Adds a new triangle to the mesh and returns its ID.
void	CreateTriangleWithID ( FTriangleID TriangleID, FPolygonGroupID PolygonGroupID, const TArray< FVertexInstanceID >&..., TArray< FEdgeID >& NewEdgeIDs )	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 ( FVertexID VertexID )	Adds a new vertex instance to the mesh and returns its ID
void	CreateVertexInstanceWithID ( FVertexInstanceID VertexInstanceID, FVertexID VertexID )	Adds a new vertex instance to the mesh with the given ID
void	CreateVertexWithID ( FVertexID VertexID )	Adds a new vertex to the mesh with the given ID
void	DeleteEdge ( FEdgeID EdgeID, TArray< FVertexID >& OrphanedVerti... )	Deletes an edge from a mesh
void	DeletePolygon ( FPolygonID PolygonID, TArray< FEdgeID >& OrphanedEdges, TArray< FVertexInstanceID >& Orpha..., TArray< FPolygonGroupID >& Orphane... )	Deletes a polygon from the mesh
void	DeletePolygonGroup ( FPolygonGroupID PolygonGroupID )	Deletes a polygon group from the mesh
void	DeleteTriangle ( FTriangleID TriangleID, TArray< FEdgeID >& OrphanedEdges, TArray< FVertexInstanceID >& Orpha..., TArray< FPolygonGroupID >& Orphane... )	Deletes a triangle from the mesh
void	DeleteVertex ( FVertexID VertexID )	Deletes a vertex from the mesh
void	DeleteVertexInstance ( FVertexInstanceID VertexInstanceID, TArray< FVertexID >& OrphanedVerti... )	Deletes a vertex instance from a mesh
const TAttri...	EdgeAttributes()
TAttributesS...	EdgeAttributes()
const FEdgeA...	Edges()
FEdgeArray &	Edges()
void	Empty()	Empty the mesh description
void	GetEdgeConnectedPolygons ( FEdgeID EdgeID, TArray< FPolygonID >& OutConnected... )	Returns the polygons connected to this edge
void	GetEdgeConnectedTriangles ( FEdgeID EdgeID, TArray< FTriangleID >& OutConnecte... )	Returns reference to an array of triangle IDs connected to this edge
FVertexID	GetEdgeVertex ( FEdgeID EdgeID, int32 VertexNumber )	Returns the vertex ID corresponding to one of the edge endpoints
void	GetEdgeVertices ( const FEdgeID EdgeID, TArray< FVertexID >& OutVertexIDs )	Returns a pair of vertex IDs defining the edge
const FMeshD...	GetMeshDescription()
FMeshDescrip...	GetMeshDescription()	Get a reference to the actual mesh description
int32	GetNumEdgeConnectedPolygons ( FEdgeID EdgeID )	Returns the number of polygons connected to this edge
int32	GetNumEdgeConnectedTriangles ( FEdgeID EdgeID )	Returns the number of triangles connected to this edge
int32	GetNumPolygonGroupPolygons ( FPolygonGroupID PolygonGroupID )	Returns the number of polygons in this polygon group
int32	GetNumPolygonInternalEdges ( FPolygonID PolygonID )	Return the number of internal edges in this polygon
int32	GetNumPolygonTriangles ( FPolygonID PolygonID )	Return the number of triangles which comprise this polygon
int32	GetNumPolygonVertices ( FPolygonID PolygonID )	Returns the number of vertices this polygon has
int32	GetNumVertexConnectedEdges ( FVertexID VertexID )	Returns number of edges connected to this vertex
int32	GetNumVertexConnectedPolygons ( FVertexID VertexID )	Returns the number of polygons connected to this vertex
int32	GetNumVertexConnectedTriangles ( FVertexID VertexID )	Returns number of triangles connected to this vertex
int32	GetNumVertexInstanceConnectedPolygons ( FVertexInstanceID VertexInstanceID )	Returns the number of polygons connected to this vertex instance.
int32	GetNumVertexInstanceConnectedTriangles ( FVertexInstanceID VertexInstanceID )	Returns the number of triangles connected to this vertex instance
int32	GetNumVertexVertexInstances ( FVertexID VertexID )	Returns number of vertex instances created from this vertex
void	GetPolygonAdjacentPolygons ( FPolygonID PolygonID, TArray< FPolygonID >& OutPolygonID... )	Populates the passed array with adjacent polygons
void	GetPolygonGroupPolygons ( FPolygonGroupID PolygonGroupID, TArray< FPolygonID >& OutPolygonID... )	Returns the polygons associated with the given polygon group
void	GetPolygonInternalEdges ( FPolygonID PolygonID, TArray< FEdgeID >& OutEdgeIDs )	Populate the provided array with a list of edges which are internal to the polygon, i.e. those which separate constituent triangles.
void	GetPolygonPerimeterEdges ( FPolygonID PolygonID, TArray< FEdgeID >& OutEdgeIDs )	Returns the edges which form the polygon perimeter
FPolygonGrou...	GetPolygonPolygonGroup ( FPolygonID PolygonID )	Return the polygon group associated with a polygon
void	GetPolygonTriangles ( FPolygonID PolygonID, TArray< FTriangleID >& OutTriangle... )	Return reference to an array of triangle IDs which comprise this polygon
void	GetPolygonVertexInstances ( FPolygonID PolygonID, TArray< FVertexInstanceID >& OutVe... )	Returns reference to an array of VertexInstance IDs forming the perimeter of this polygon
void	GetPolygonVertices ( FPolygonID PolygonID, TArray< FVertexID >& OutVertexIDs )	Returns the vertices which form the polygon perimeter
const FMeshA...	GetRequiredAttributes()
FMeshAttribu...	GetRequiredAttributes()
void	GetTriangleAdjacentTriangles ( FTriangleID TriangleID, TArray< FTriangleID >& OutTriangle... )	Returns the adjacent triangles to this triangle
void	GetTriangleEdges ( FTriangleID TriangleID, TArray< FEdgeID >& OutEdgeIDs )	Returns the edges which define this triangle
FPolygonID	GetTrianglePolygon ( FTriangleID TriangleID )	Get the polygon which contains this triangle
FPolygonGrou...	GetTrianglePolygonGroup ( FTriangleID TriangleID )	Get the polygon group which contains this triangle
FVertexInsta...	GetTriangleVertexInstance ( FTriangleID TriangleID, int32 Index )	Get the specified vertex instance by index
void	GetTriangleVertexInstances ( FTriangleID TriangleID, TArray< FVertexInstanceID >& OutVe... )	Get the vertex instances which define this triangle
void	GetTriangleVertices ( FTriangleID TriangleID, TArray< FVertexID >& OutVertexIDs )	Returns the vertices which define this triangle
void	GetVertexAdjacentVertices ( FVertexID VertexID, TArray< FVertexID >& OutAdjacentVe... )	Returns the vertices adjacent to this vertex
void	GetVertexConnectedEdges ( FVertexID VertexID, TArray< FEdgeID >& OutEdgeIDs )	Returns reference to an array of Edge IDs connected to this vertex
void	GetVertexConnectedPolygons ( FVertexID VertexID, TArray< FPolygonID >& OutConnected... )	Returns the polygons connected to this vertex
void	GetVertexConnectedTriangles ( FVertexID VertexID, TArray< FTriangleID >& OutConnecte... )	Returns the triangles connected to this vertex
void	GetVertexInstanceConnectedPolygons ( FVertexInstanceID VertexInstanceID, TArray< FPolygonID >& OutConnected... )	Returns the polygons connected to this vertex instance
void	GetVertexInstanceConnectedTriangles ( FVertexInstanceID VertexInstanceID, TArray< FTriangleID >& OutConnecte... )	Returns reference to an array of Triangle IDs connected to this vertex instance
FVertexInsta...	GetVertexInstanceForPolygonVertex ( FPolygonID PolygonID, FVertexID VertexID )	Return the vertex instance which corresponds to the given vertex on the given polygon, or FVertexInstanceID::Invalid
FVertexInsta...	GetVertexInstanceForTriangleVertex ( FTriangleID TriangleID, FVertexID VertexID )	Return the vertex instance which corresponds to the given vertex on the given triangle, or FVertexInstanceID::Invalid
FEdgeID	GetVertexInstancePairEdge ( FVertexInstanceID VertexInstanceID0, FVertexInstanceID VertexInstanceID1 )	Returns the edge ID defined by the two given vertex instance IDs, if there is one; otherwise FEdgeID::Invalid
FVertexID	GetVertexInstanceVertex ( FVertexInstanceID VertexInstanceID )	Returns the vertex ID associated with the given vertex instance
FEdgeID	GetVertexPairEdge ( FVertexID VertexID0, FVertexID VertexID1 )	Returns the edge ID defined by the two given vertex IDs, if there is one; otherwise FEdgeID::Invalid
FVector	GetVertexPosition ( FVertexID VertexID )	Gets a vertex position
TVertexAttri...	GetVertexPositions()
TVertexAttri...	GetVertexPositions()	Accessors for cached vertex position array
void	GetVertexVertexInstances ( FVertexID VertexID, TArray< FVertexInstanceID >& OutVe... )	Returns reference to an array of VertexInstance IDs instanced from this vertex
bool	IsEdgeInternal ( FEdgeID EdgeID )	Determine whether a given edge is an internal edge between triangles of a polygon
bool	IsEdgeInternalToPolygon ( FEdgeID EdgeID, FPolygonID PolygonID )	Determine whether a given edge is an internal edge between triangles of a specific polygon
bool	IsEdgeValid ( FEdgeID EdgeID )	Returns whether the passed edge ID is valid
bool	IsEmpty()	Return whether the mesh description is empty
bool	IsPolygonGroupValid ( FPolygonGroupID PolygonGroupID )	Returns whether the passed polygon group ID is valid
bool	IsPolygonValid ( FPolygonID PolygonID )	Returns whether the passed polygon ID is valid
bool	IsTrianglePartOfNgon ( 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 ( FVertexInstanceID VertexInstanceID )	Returns whether the passed vertex instance ID is valid
bool	IsVertexOrphaned ( FVertexID VertexID )	Returns whether a given vertex is orphaned, i.e. it doesn't form part of any polygon
bool	IsVertexValid ( 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()
FPolygonArra...	Polygons()
const FPolyg...	Polygons()
void	RegisterAttributes()
void	ReserveNewEdges ( int32 NumberOfNewEdges )	Reserves space for this number of new edges
void	ReserveNewPolygonGroups ( int32 NumberOfNewPolygonGroups )	Reserves space for this number of new polygon groups
void	ReserveNewPolygons ( const int32 NumberOfNewPolygons )	Reserves space for this number of new polygons
void	ReserveNewTriangles ( int32 NumberOfNewTriangles )	Reserves space for this number of new triangles
void	ReserveNewVertexInstances ( int32 NumberOfNewVertexInstances )	Reserves space for this number of new vertex instances
void	ReserveNewVertices ( int32 NumberOfNewVertices )	Reserves space for this number of new vertices
void	Reset()	Reset the contained mesh description
void	ReversePolygonFacing ( FPolygonID PolygonID )	Reverse the winding order of the vertices of this polygon
void	SetMeshDescription ( FMeshDescription InMeshDescription )	Set the mesh description
void	SetPolygonPolygonGroup ( FPolygonID PolygonID, FPolygonGroupID PolygonGroupID )	Sets the polygon group associated with a polygon
void	SetPolygonVertexInstance ( FPolygonID PolygonID, int32 PerimeterIndex, FVertexInstanceID VertexInstanceID )	Set the vertex instance at the given index around the polygon to the new value
void	SetVertexPosition ( FVertexID VertexID, const FVector& Position )	Sets a vertex position
const TAttri...	TriangleAttributes()
TAttributesS...	TriangleAttributes()
FTriangleArr...	Triangles()
const FTrian...	Triangles()
TAttributesS...	VertexAttributes()	Accessors for mesh element attributes
const TAttri...	VertexAttributes()
TAttributesS...	VertexInstanceAttributes()
const TAttri...	VertexInstanceAttributes()
FVertexInsta...	VertexInstances()
const FVerte...	VertexInstances()
FVertexArray...	Vertices()	Accessors for mesh element arrays
const FVerte...	Vertices()

Overridden from UObject

		Name	Description
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

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

Take our survey

Dismiss