1. Epic GamesDeveloper
  3. FMeshDescription

FMeshDescription

Unreal Engine C++ API Reference > Runtime > MeshDescription

References

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

Syntax

struct FMeshDescription

Constructors

  Type Name Description
Public function   Mesh description should be a moveable type.
Public function    
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void

Compact ( FElementIDRemappings& OutRemappings
)

 Compacts the data held in the mesh description, and returns an object describing how the IDs have been remapped.
Public function Const FBox  
Public function void Generates triangles and internal edges for the given polygon
Public function FEdgeID

CreateEdge ( const FVertexID VertexID0,
const FVertexID VertexID1
)

 Adds a new edge to the mesh and returns its ID
Public function void

CreateEdgeWithID ( const FEdgeID EdgeID,
const FVertexID VertexID0,
const FVertexID VertexID1
)

 Adds a new edge to the mesh with the given ID
Public function FPolygonID

CreatePolygon ( const FPolygonGroupID PolygonGroupID,
TArrayView< const FVertexInstanceID > VertexInstanceIDs,
TArray< FEdgeID >* OutEdgeIDs
)

 Adds a new polygon to the mesh and returns its ID.
Public function FPolygonGroupID Adds a new polygon group to the mesh and returns its ID
Public function void

CreatePolygonGroupWithID ( const FPolygonGroupID PolygonGroupID
)

 Adds a new polygon group to the mesh with the given ID
Public function void

CreatePolygonWithID ( const FPolygonID PolygonID,
const FPolygonGroupID PolygonGroupID,
TArrayView< const FVertexInstanceID > VertexInstanceIDs,
TArray< FEdgeID >* OutEdgeIDs
)

 Adds a new polygon to the mesh with the given ID.
Public function FTriangleID

CreateTriangle ( const FPolygonGroupID PolygonGroupID,
TArrayView< const FVertexInstanceID > VertexInstanceIDs,
TArray< FEdgeID >* OutEdgeIDs
)

 Adds a new triangle to the mesh and returns its ID.
Public function void

CreateTriangleWithID ( const FTriangleID TriangleID,
const FPolygonGroupID PolygonGroupID,
TArrayView< const FVertexInstanceID > VertexInstanceIDs,
TArray< FEdgeID >* OutEdgeIDs
)

 Adds a new triangle to the mesh with the given ID.
Public function FUVID

CreateUV ( const int32 UVChannel
)

 Adds a new UV to the mesh and returns its ID
Public function void

CreateUVWithID ( const FUVID UVID,
const int32 UVChannel
)

 Adds a new UV to the mesh with the given ID
Public function FVertexID Adds a new vertex to the mesh and returns its ID
Public function FVertexInstanceID

CreateVertexInstance ( const FVertexID VertexID
)

 Adds a new vertex instance to the mesh and returns its ID
Public function void

CreateVertexInstanceWithID ( const FVertexInstanceID VertexInstanceID,
const FVertexID VertexID
)

 Adds a new vertex instance to the mesh with the given ID
Public function void

CreateVertexWithID ( const FVertexID VertexID
)

 Adds a new vertex to the mesh with the given ID
Public function void

DeleteEdge ( const FEdgeID EdgeID,
TArray< FVertexID >* InOutOrphanedVerticesPtr
)

 Deletes an edge from the mesh
Public function void

DeletePolygon ( const FPolygonID PolygonID,
TArray< FEdgeID >* InOutOrphanedEdgesPtr,
TArray< FVertexInstanceID >* InOutOrphanedVertexInstancesPtr,
TArray< FPolygonGroupID >* InOutOrphanedPolygonGroupsPtr
)

 Deletes a polygon from the mesh
Public function void

DeletePolygonGroup ( const FPolygonGroupID PolygonGroupID
)

 Deletes a polygon group from the mesh
Public function void

DeletePolygons ( const TArray< FPolygonID >& Polygons
)

 Deletes polygons from the mesh and remove all orphaned polygon groups, vertex instances, edges and vertices.
Public function void

DeleteTriangle ( const FTriangleID TriangleID,
TArray< FEdgeID >* InOutOrphanedEdgesPtr,
TArray< FVertexInstanceID >* InOutOrphanedVertexInstancesPtr,
TArray< FPolygonGroupID >* InOutOrphanedPolygonGroupsPtr
)

 Deletes a triangle from the mesh
Public function void

DeleteTriangles ( const TArray< FTriangleID >& Triangles
)

 Deletes triangles from the mesh and remove all orphaned polygon groups, vertex instances, edges and vertices.
Public function void

DeleteUV ( const FUVID UVID,
const int32 UVChannel
)

 Deletes a UV from the mesh
Public function void

DeleteVertex ( const FVertexID VertexID
)

 Deletes a vertex from the mesh
Public function void

DeleteVertexInstance ( const FVertexInstanceID VertexInstanceID,
TArray< FVertexID >* InOutOrphanedVerticesPtr
)

 Deletes a vertex instance from a mesh
Public function Const const TAttributesSet< FEdgeID > &  
Public function TAttributesSet< FEdgeID > &  
Public function FEdgeArray &

Edges ()

  
Public function Const const FEdgeArray &

Edges ()

  
Public function void

Empty ()

 Empty the meshdescription.
Public function Const void

FindPolygonPerimeter ( const FPolygonID PolygonID,
TArrayView< FEdgeID > Edges
)

  
Public function Const void

FindPolygonPerimeter ( TArrayView< const FTriangleID > Triangles,
TArrayView< TTuple< int32, int32 > > Result
)

 Determines the vertex instances which form the perimeter of a polygon
Public function Const FBoxSphereBounds Returns bounds of vertices
Public function Const TArray< FPolygonID, Alloc > Returns the polygons connected to this edge as an array with the specified allocator template type.
Public function Const TArray< FPolygonID > Returns the polygons connected to this edge
Public function Const void

GetEdgeConnectedPolygons ( const FEdgeID EdgeID,
TArray< FPolygonID, Alloc >& OutPolygonIDs
)

 Populates the passed array with polygon IDs connected to this edge
Public function Const TArrayView< const FTriangleID > Returns reference to an array of triangle IDs connected to this edge
Public function Const TArray< FTriangleID >  
Public function Const FVertexID

GetEdgeVertex ( const FEdgeID EdgeID,
int32 VertexNumber
)

 Returns the vertex ID corresponding to one of the edge endpoints
Public function Const TArrayView< const FVertexID >

GetEdgeVertices ( const FEdgeID EdgeID
)

 Returns a pair of vertex IDs defining the edge
Public function Const const TMap< FName, FMeshElementTypeWrapper > &  
Public function TMap< FName, FMeshElementTypeWrapper > &  
Public function Const int32 Returns the number of polygons connected to this edge
Public function Const int32  
Public function Const int32

GetNumPolygonGroupPolygons ( const FPolygonGroupID PolygonGroupID
)

 Returns the number of polygons in this polygon group
Public function Const int32

GetNumPolygonGroupTriangles ( const FPolygonGroupID PolygonGroupID
)

 Returns the number of triangles in this polygon group
Public function Const int32 Return the number of internal edges in this polygon
Public function Const int32

GetNumPolygonTriangles ( const FPolygonID PolygonID
)

 Return the number of triangles which comprise this polygon
Public function Const int32

GetNumPolygonVertices ( const FPolygonID PolygonID
)

 Returns the number of vertices this polygon has
Public function Const int32 Gets the number of UV element channels
Public function Const int32 Returns number of edges connected to this vertex
Public function Const int32 Returns the number of polygons connected to this vertex
Public function Const int32 Returns number of triangles connected to this vertex
Public function Const int32 Returns the number of polygons connected to this vertex instance.
Public function Const int32 Returns the number of triangles connected to this vertex instance
Public function Const int32 Returns number of vertex instances created from this vertex
Public function Const TArray< FPolygonID, Alloc > Return adjacent polygons into a TArray with the specified allocator
Public function Const TArray< FPolygonID > Return adjacent polygons to this polygon
Public function Const void

GetPolygonAdjacentPolygons ( const FPolygonID PolygonID,
TArray< FPolygonID, Alloc >& OutPolygonIDs
)

 Populates the passed array with adjacent polygons
Public function Const float

GetPolygonCornerAngleForVertex ( const FPolygonID PolygonID,
const FVertexID VertexID
)

  
Public function Const TArrayView< const FPolygonID >

GetPolygonGroupPolygonIDs ( const FPolygonGroupID PolygonGroupID
)

 Returns the polygons associated with the given polygon group
Public function Const TArray< FPolygonID >

GetPolygonGroupPolygons ( const FPolygonGroupID PolygonGroupID
)

  
Public function Const TArrayView< const FTriangleID >

GetPolygonGroupTriangles ( const FPolygonGroupID PolygonGroupID
)

 Returns the triangles associated with the given polygon group
Public function Const TArray< FEdgeID >

GetPolygonInternalEdges ( const FPolygonID PolygonID
)

 Return the internal edges of this polygon, i.e. those which separate constituent triangles
Public function Const void

GetPolygonInternalEdges ( const FPolygonID PolygonID,
TArray< FEdgeID, Alloc >& OutEdgeIDs
)

 Populate the provided array with a list of edges which are internal to the polygon, i.e. those which separate constituent triangles.
Public function Const TArray< FEdgeID, Alloc >

GetPolygonInternalEdges ( const FPolygonID PolygonID
)

 Return the internal edges of this polygon, i.e. those which separate constituent triangles
Public function Const void

GetPolygonPerimeterEdges ( const FPolygonID PolygonID,
TArray< FEdgeID, Alloc >& OutEdgeIDs
)

 Populates the passed array with the edges which form the polygon perimeter
Public function Const TArray< FEdgeID, Alloc >

GetPolygonPerimeterEdges ( const FPolygonID PolygonID
)

 Returns the vertices which form the polygon perimeter as an array templated on the given allocator
Public function Const TArray< FEdgeID >

GetPolygonPerimeterEdges ( const FPolygonID PolygonID
)

 Returns the vertices which form the polygon perimeter
Public function Const FPolygonGroupID

GetPolygonPolygonGroup ( const FPolygonID PolygonID
)

 Return the polygon group associated with a polygon
Public function Const TArray< FTriangleID >

GetPolygonTriangleIDs ( const FPolygonID PolygonID
)

  
Public function Const TArrayView< const FTriangleID >

GetPolygonTriangles ( const FPolygonID PolygonID
)

 Return reference to an array of triangle IDs which comprise this polygon
Public function Const TArray< FVertexInstanceID, Alloc >  
Public function Const void

GetPolygonVertexInstances ( const FPolygonID PolygonID,
TArray< FVertexInstanceID, Alloc >& OutVertexInstanceIDs
)

 Returns reference to an array of VertexInstance IDs forming the perimeter of this polygon
Public function Const TArray< FVertexInstanceID >  
Public function Const TArray< FVertexID >

GetPolygonVertices ( const FPolygonID PolygonID
)

 Returns the vertices which form the polygon perimeter
Public function Const void

GetPolygonVertices ( const FPolygonID PolygonID,
TArray< FVertexID, Alloc >& OutVertexIDs
)

 Populates the passed array of VertexIDs with the vertices which form the polygon perimeter
Public function Const TArray< FVertexID, Alloc >

GetPolygonVertices ( const FPolygonID PolygonID
)

 Returns the vertices which form the polygon perimeter as an array templated on the given allocator
Public function Const void

GetTriangleAdjacentTriangles ( const FTriangleID TriangleID,
TArray< FTriangleID, Alloc >& OutTriangleIDs
)

 Populates the passed array with adjacent triangles
Public function Const TArray< FTriangleID > Return adjacent triangles to this triangle
Public function Const TArray< FTriangleID, Alloc > Return adjacent triangles into a TArray with the specified allocator
Public function Const float

GetTriangleCornerAngleForVertex ( const FTriangleID TriangleID,
const FVertexID VertexID
)

  
Public function Const void

GetTriangleEdges ( const FTriangleID TriangleID,
TArrayView< FEdgeID > OutEdgeIDs
)

 Populates the passed array with the edges which define this triangle
Public function Const TArrayView< FEdgeID >

GetTriangleEdges ( const FTriangleID TriangleID
)

 Return the edges which form this triangle
Public function Const FPolygonID

GetTrianglePolygon ( const FTriangleID TriangleID
)

 Get the polygon which contains this triangle
Public function Const FPolygonGroupID

GetTrianglePolygonGroup ( const FTriangleID TriangleID
)

 Get the polygon group which contains this triangle
Public function Const TArrayView< FUVID >

GetTriangleUVIndices ( const FTriangleID TriangleID,
int32 UVChannel
)

 Return UV indices for this triangle for the given channel
Public function Const FVertexInstanceID

GetTriangleVertexInstance ( const FTriangleID TriangleID,
const int32 Index
)

 Get the specified vertex instance by index
Public function Const TArrayView< const FVertexInstanceID > Get the vertex instances which define this triangle
Public function Const void

GetTriangleVertices ( const FTriangleID TriangleID,
TArrayView< FVertexID > OutVertexIDs
)

 Populates the passed array with the vertices which define this triangle
Public function Const TArrayView< const FVertexID >

GetTriangleVertices ( const FTriangleID TriangleID
)

 Return the vertices which define this triangle
Public function Const TArray< FVertexID > Returns the vertices adjacent to this vertex
Public function Const TArray< FVertexID, Alloc > Returns the vertices adjacent to this vertex as an array with the specified allocator template type.
Public function Const void

GetVertexAdjacentVertices ( const FVertexID VertexID,
TArray< FVertexID, Alloc >& OutAdjacentVertexIDs
)

 Populates the passed array of VertexIDs with the vertices adjacent to this vertex
Public function Const TArrayView< const FEdgeID > Returns reference to an array of Edge IDs connected to this vertex
Public function Const TArray< FEdgeID >

GetVertexConnectedEdges ( const FVertexID VertexID
)

  
Public function Const TArray< FPolygonID, Alloc > Returns the polygons connected to this vertex as an array with the specified allocator template type.
Public function Const TArray< FPolygonID > Returns the polygons connected to this vertex
Public function Const void

GetVertexConnectedPolygons ( const FVertexID VertexID,
TArray< FPolygonID, Alloc >& OutConnectedPolygonIDs
)

 Populates the passed array of PolygonIDs with the polygons connected to this vertex
Public function Const TArray< FTriangleID, Alloc > Returns the triangles connected to this vertex as an array with the specified allocator template type.
Public function Const TArray< FTriangleID > Returns the triangles connected to this vertex
Public function Const void

GetVertexConnectedTriangles ( const FVertexID VertexID,
TArray< FTriangleID, Alloc >& OutConnectedTriangleIDs
)

 Populates the passed array of TriangleIDs with the triangles connected to this vertex
Public function Const void

GetVertexInstanceConnectedPolygons ( const FVertexInstanceID VertexInstanceID,
TArray< FPolygonID, Alloc >& OutPolygonIDs
)

 Populates the passed array with the polygons connected to this vertex instance
Public function Const TArray< FPolygonID > Returns the polygons connected to this vertex instance
Public function Const TArray< FPolygonID, Alloc > Returns the polygons connected to this vertex instance as an array with the specified allocator template type.
Public function Const TArrayView< const FTriangleID > Returns reference to an array of Triangle IDs connected to this vertex instance
Public function Const TArray< FTriangleID >  
Public function Const FVertexInstanceID

GetVertexInstanceForPolygonVertex ( const FPolygonID PolygonID,
const FVertexID VertexID
)

 Return the vertex instance which corresponds to the given vertex on the given polygon, or INDEX_NONE
Public function Const FVertexInstanceID

GetVertexInstanceForTriangleVertex ( const FTriangleID TriangleID,
const FVertexID VertexID
)

 Return the vertex instance which corresponds to the given vertex on the given triangle, or INDEX_NONE
Public function Const FEdgeID

GetVertexInstancePairEdge ( const FVertexInstanceID VertexInstanceID0,
const FVertexInstanceID VertexInstanceID1
)

 Returns the edge ID defined by the two given vertex instance IDs, if there is one; otherwise INDEX_NONE
Public function Const FVertexID

GetVertexInstanceVertex ( const FVertexInstanceID VertexInstanceID
)

 Returns the vertex ID associated with the given vertex instance
Public function Const FEdgeID

GetVertexPairEdge ( const FVertexID VertexID0,
const FVertexID VertexID1
)

 Returns the edge ID defined by the two given vertex IDs, if there is one; otherwise INDEX_NONE
Public function Const FVector3f

GetVertexPosition ( const FVertexID VertexID
)

 Returns the position of this vertex
Public function Const TVertexAttributesRef< const FVector3f >  
Public function TVertexAttributesRef< FVector3f >  
Public function Const TArrayView< const FVertexInstanceID > Returns reference to an array of VertexInstance IDs instanced from this vertex
Public function Const TArray< FVertexInstanceID >

GetVertexVertexInstances ( const FVertexID VertexID
)

  
Public function Const bool

IsEdgeInternal ( const FEdgeID EdgeID
)

 Determine whether a given edge is an internal edge between triangles of a polygon
Public function Const bool

IsEdgeInternalToPolygon ( const FEdgeID EdgeID,
const FPolygonID PolygonID
)

 Determine whether a given edge is an internal edge between triangles of a specific polygon
Public function Const bool

IsEdgeValid ( const FEdgeID EdgeID
)

 Returns whether the passed edge ID is valid
Public function Const bool

IsEmpty ()

 Return whether the mesh description is empty.
Public function Const bool

IsPolygonGroupValid ( const FPolygonGroupID PolygonGroupID
)

 Returns whether the passed polygon group ID is valid
Public function Const bool

IsPolygonValid ( const FPolygonID PolygonID
)

 Returns whether the passed polygon ID is valid
Public function Const bool

IsTrianglePartOfNgon ( const FTriangleID TriangleID
)

 Determines if this triangle is part of an n-gon
Public function Const bool

IsTriangleValid ( const FTriangleID TriangleID
)

 Returns whether the passed triangle ID is valid
Public function Const bool

IsUVValid ( const FUVID UVID,
const int32 UVChannel
)

 Returns whether the passed UV ID is valid
Public function Const bool

IsVertexInstanceValid ( const FVertexInstanceID VertexInstanceID
)

 Returns whether the passed vertex instance ID is valid
Public function Const bool

IsVertexOrphaned ( const FVertexID VertexID
)

 Returns whether a given vertex is orphaned, i.e. it doesn't form part of any polygon
Public function Const bool

IsVertexValid ( const FVertexID VertexID
)

 Returns whether the passed vertex ID is valid
Public function Const bool Determines if calling Compact() would perform actual compaction or not.
Public function Const const TAttributesSet< FPolygonID > &  
Public function TAttributesSet< FPolygonID > &  
Public function Const const TAttributesSet< FPolygonGroupID > &  
Public function TAttributesSet< FPolygonGroupID > &  
Public function Const const FPolygonGroupArray &  
Public function FPolygonGroupArray &  
Public function Const const FPolygonArray &  
Public function FPolygonArray &  
Public function void  
Public function void

Remap ( const FElementIDRemappings& Remappings
)

 Remaps the element IDs in the mesh description according to the passed in object
Public function void Remaps polygon groups according to the supplied map
Public function void

ReserveNewEdges ( const int32 NumEdges
)

 Reserves space for this number of new edges
Public function void

ReserveNewPolygonGroups ( const int32 NumPolygonGroups
)

 Reserves space for this number of new polygon groups
Public function void

ReserveNewPolygons ( const int32 NumPolygons
)

 Reserves space for this number of new polygons
Public function void

ReserveNewTriangles ( const int32 NumTriangles
)

 Reserves space for this number of new triangles
Public function void

ReserveNewUVs ( const int32 NumUVs,
const int32 UVChannel
)

 Reserves space for this number of new UVs
Public function void

ReserveNewVertexInstances ( const int32 NumVertexInstances
)

 Reserves space for this number of new vertex instances
Public function void

ReserveNewVertices ( const int32 NumVertices
)

 Reserves space for this number of new vertices
Public function void Operations on all the indexers.
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void Reverses the winding order of all polygons in the mesh
Public function void

ReversePolygonFacing ( const FPolygonID PolygonID
)

 Reverse the winding order of the vertices of this polygon
Public function void

ReverseTriangleFacing ( const FTriangleID TriangleID
)

 Reverse the winding order of the vertices of this triangle
Public function void Serialize the mesh description.
Public function void Legacy serialization for old assets.
Public function void

SetNumUVChannels ( const int32 NumUVChannels
)

 Sets the specified number of UV channels
Public function void

SetPolygonPolygonGroup ( const FPolygonID PolygonID,
const FPolygonGroupID PolygonGroupID
)

 Sets the polygon group associated with a polygon
Public function void

SetPolygonVertexInstance ( const FPolygonID PolygonID,
const int32 PerimeterIndex,
const FVertexInstanceID VertexInstanceID
)

 Set the vertex instance at the given index around the polygon to the new value
Public function void

SetPolygonVertexInstances ( const FPolygonID PolygonID,
TArrayView< const FVertexInstanceID > VertexInstanceIDs
)

  
Public function void

SetTriangleUVIndices ( const FTriangleID TriangleID,
TArrayView< const FUVID > UVIDs,
int32 UVChannel
)

 Set the UV indices for this triangle
Public function void

SplitPolygon ( FPolygonID PolygonID
)

  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void Transfer the source polygon group data to the destination polygon group.
Public function TAttributesSet< FTriangleID > &  
Public function Const const TAttributesSet< FTriangleID > &  
Public function FTriangleArray &  
Public function Const const FTriangleArray &  
Public function void Retriangulates the entire mesh
Public function TAttributesSet< FUVID > &

UVAttributes ( int32 Index
)

  
Public function Const const TAttributesSet< FUVID > &

UVAttributes ( int32 Index
)

  
Public function Const const FUVArray &

UVs ( int32 Index
)

  
Public function FUVArray &

UVs ( int32 Index
)

  
Public function TAttributesSet< FVertexID > &  
Public function Const const TAttributesSet< FVertexID > &  
Public function TAttributesSet< FVertexInstanceID > &  
Public function Const const TAttributesSet< FVertexInstanceID > &  
Public function FVertexInstanceArray &  
Public function Const const FVertexInstanceArray &  
Public function FVertexArray &  
Public function Const const FVertexArray &  

Operators

  Type Name Description
Public function FMeshDescription &  
Public function FMeshDescription &  

Constants

Name Description
EdgesName  
PolygonGroupsName  
PolygonsName  
TrianglesName  
UVsName  
VertexInstancesName  
VerticesName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page