1. Epic GamesDeveloper
  3. UMeshDescriptionBase

UMeshDescriptionBase

Unreal Engine C++ API Reference > Runtime > MeshDescription

Inheritance Hierarchy

References

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

Syntax

class UMeshDescriptionBase : public UObject

Variables

  Type Name Description
Protected variable FMeshDescription OwnedMeshDescription  
Protected variable TUniquePtr< FMeshAttributes > RequiredAttributes  

Functions

  Type Name Description
Public function void Generates triangles and internal edges for the given polygon
Public function FEdgeID

CreateEdge ( FVertexID VertexID0,
FVertexID VertexID1
)

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

CreateEdgeWithID ( FEdgeID EdgeID,
FVertexID VertexID0,
FVertexID VertexID1
)

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

CreatePolygon ( FPolygonGroupID PolygonGroupID,
TArray< FVertexInstanceID >& VertexInstanceIDs,
TArray< FEdgeID >& NewEdgeIDs
)

 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 Adds a new polygon group to the mesh with the given ID
Public function void

CreatePolygonWithID ( FPolygonID PolygonID,
FPolygonGroupID PolygonGroupID,
TArray< FVertexInstanceID >& VertexInstanceIDs,
TArray< FEdgeID >& NewEdgeIDs
)

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

CreateTriangle ( FPolygonGroupID PolygonGroupID,
const TArray< FVertexInstanceID >& VertexInstanceIDs,
TArray< FEdgeID >& NewEdgeIDs
)

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

CreateTriangleWithID ( FTriangleID TriangleID,
FPolygonGroupID PolygonGroupID,
const TArray< FVertexInstanceID >& VertexInstanceIDs,
TArray< FEdgeID >& NewEdgeIDs
)

 Adds a new triangle to the mesh with the given ID.
Public function FVertexID Adds a new vertex to the mesh and returns its ID
Public function FVertexInstanceID Adds a new vertex instance to the mesh and returns its ID
Public function void

CreateVertexInstanceWithID ( FVertexInstanceID VertexInstanceID,
FVertexID VertexID
)

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

DeleteEdge ( FEdgeID EdgeID,
TArray< FVertexID >& OrphanedVertices
)

 Deletes an edge from a mesh
Public function void

DeletePolygon ( FPolygonID PolygonID,
TArray< FEdgeID >& OrphanedEdges,
TArray< FVertexInstanceID >& OrphanedVertexInstances,
TArray< FPolygonGroupID >& OrphanedPolygonGroups
)

 Deletes a polygon from the mesh
Public function void

DeletePolygonGroup ( FPolygonGroupID PolygonGroupID
)

 Deletes a polygon group from the mesh
Public function void

DeleteTriangle ( FTriangleID TriangleID,
TArray< FEdgeID >& OrphanedEdges,
TArray< FVertexInstanceID >& OrphanedVertexInstances,
TArray< FPolygonGroupID >& OrphanedPolygonGroupsPtr
)

 Deletes a triangle from the mesh
Public function void

DeleteVertex ( FVertexID VertexID
)

 Deletes a vertex from the mesh
Public function void

DeleteVertexInstance ( FVertexInstanceID VertexInstanceID,
TArray< FVertexID >& OrphanedVertices
)

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

Edges ()

  
Public function FEdgeArray &

Edges ()

  
Public function void

Empty ()

 Empty the mesh description
Public function Const void

GetEdgeConnectedPolygons ( FEdgeID EdgeID,
TArray< FPolygonID >& OutConnectedPolygonIDs
)

 Returns the polygons connected to this edge
Public function Const void

GetEdgeConnectedTriangles ( FEdgeID EdgeID,
TArray< FTriangleID >& OutConnectedTriangleIDs
)

 Returns reference to an array of triangle IDs connected to this edge
Public function Const int32 Returns the number of edges
Public function Const FVertexID

GetEdgeVertex ( FEdgeID EdgeID,
int32 VertexNumber
)

 Returns the vertex ID corresponding to one of the edge endpoints
Public function Const void

GetEdgeVertices ( const FEdgeID EdgeID,
TArray< FVertexID >& OutVertexIDs
)

 Returns a pair of vertex IDs defining the edge
Public function Const const FMeshDescription &  
Public function FMeshDescription & Get a reference to the actual mesh description
Public function Const int32 Returns the number of polygons connected to this edge
Public function Const int32 Returns the number of triangles connected to this edge
Public function Const int32 Returns the number of polygons in this polygon group
Public function Const int32 Return the number of internal edges in this polygon
Public function Const int32 Return the number of triangles which comprise this polygon
Public function Const int32 Returns the number of vertices this polygon has
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 void

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

 Populates the passed array with adjacent polygons
Public function Const int32 Returns the number of polygons
Public function Const int32 Returns the number of polygon groups
Public function Const void

GetPolygonGroupPolygons ( FPolygonGroupID PolygonGroupID,
TArray< FPolygonID >& OutPolygonIDs
)

 Returns the polygons associated with the given polygon group
Public function Const 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.
Public function Const void

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

 Returns the edges which form the polygon perimeter
Public function Const FPolygonGroupID Return the polygon group associated with a polygon
Public function Const void

GetPolygonTriangles ( FPolygonID PolygonID,
TArray< FTriangleID >& OutTriangleIDs
)

 Return reference to an array of triangle IDs which comprise this polygon
Public function Const void

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

 Returns reference to an array of VertexInstance IDs forming the perimeter of this polygon
Public function Const void

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

 Returns the vertices which form the polygon perimeter
Public function Virtual FMeshAttributes &  
Public function Virtual Const const FMeshAttributes &  
Public function Const void

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

 Returns the adjacent triangles to this triangle
Public function Const int32 Returns the number of triangles
Public function Const void

GetTriangleEdges ( FTriangleID TriangleID,
TArray< FEdgeID >& OutEdgeIDs
)

 Returns the edges which define this triangle
Public function Const FPolygonID Get the polygon which contains this triangle
Public function Const FPolygonGroupID Get the polygon group which contains this triangle
Public function Const FVertexInstanceID

GetTriangleVertexInstance ( FTriangleID TriangleID,
int32 Index
)

 Get the specified vertex instance by index
Public function Const void

GetTriangleVertexInstances ( FTriangleID TriangleID,
TArray< FVertexInstanceID >& OutVertexInstanceIDs
)

 Get the vertex instances which define this triangle
Public function Const void

GetTriangleVertices ( FTriangleID TriangleID,
TArray< FVertexID >& OutVertexIDs
)

 Returns the vertices which define this triangle
Public function Const void

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

 Returns the vertices adjacent to this vertex
Public function Const void

GetVertexConnectedEdges ( FVertexID VertexID,
TArray< FEdgeID >& OutEdgeIDs
)

 Returns reference to an array of Edge IDs connected to this vertex
Public function Const void

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

 Returns the polygons connected to this vertex
Public function Const void

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

 Returns the triangles connected to this vertex
Public function Const int32 Returns the number of vertices
Public function Const void

GetVertexInstanceConnectedPolygons ( FVertexInstanceID VertexInstanceID,
TArray< FPolygonID >& OutConnectedPolygonIDs
)

 Returns the polygons connected to this vertex instance
Public function Const void

GetVertexInstanceConnectedTriangles ( FVertexInstanceID VertexInstanceID,
TArray< FTriangleID >& OutConnectedTriangleIDs
)

 Returns reference to an array of Triangle IDs connected to this vertex instance
Public function Const int32 Returns the number of vertex instances
Public function Const FVertexInstanceID Return the vertex instance which corresponds to the given vertex on the given polygon, or INDEX_NONE
Public function Const FVertexInstanceID Return the vertex instance which corresponds to the given vertex on the given triangle, or INDEX_NONE
Public function Const FEdgeID

GetVertexInstancePairEdge ( FVertexInstanceID VertexInstanceID0,
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 Returns the vertex ID associated with the given vertex instance
Public function Const FEdgeID

GetVertexPairEdge ( FVertexID VertexID0,
FVertexID VertexID1
)

 Returns the edge ID defined by the two given vertex IDs, if there is one; otherwise INDEX_NONE
Public function Const FVector Gets a vertex position
Public function Const TVertexAttributesConstRef< FVector3f >  
Public function TVertexAttributesRef< FVector3f > Accessors for cached vertex position array
Public function Const void

GetVertexVertexInstances ( FVertexID VertexID,
TArray< FVertexInstanceID >& OutVertexInstanceIDs
)

 Returns reference to an array of VertexInstance IDs instanced from this vertex
Public function Const bool

IsEdgeInternal ( FEdgeID EdgeID
)

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

IsEdgeValid ( 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 Returns whether the passed polygon group ID is valid
Public function Const bool

IsPolygonValid ( FPolygonID PolygonID
)

 Returns whether the passed polygon ID is valid
Public function Const bool 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 Returns whether the passed vertex instance ID is valid
Public function Const bool Returns whether a given vertex is orphaned, i.e. it doesn't form part of any polygon
Public function Const bool

IsVertexValid ( FVertexID VertexID
)

 Returns whether the passed vertex ID is valid
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 FPolygonArray &  
Public function Const const FPolygonArray &  
Public function Virtual void  
Public function void

ReserveNewEdges ( int32 NumberOfNewEdges
)

 Reserves space for this number of new edges
Public function void

ReserveNewPolygonGroups ( int32 NumberOfNewPolygonGroups
)

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

ReserveNewPolygons ( const int32 NumberOfNewPolygons
)

 Reserves space for this number of new polygons
Public function void

ReserveNewTriangles ( int32 NumberOfNewTriangles
)

 Reserves space for this number of new triangles
Public function void

ReserveNewVertexInstances ( int32 NumberOfNewVertexInstances
)

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

ReserveNewVertices ( int32 NumberOfNewVertices
)

 Reserves space for this number of new vertices
Public function void

Reset ()

 Reset the contained mesh description
Public function void Reverse the winding order of the vertices of this polygon
Public function void

SetMeshDescription ( FMeshDescription InMeshDescription
)

 Set the mesh description
Public function void

SetPolygonPolygonGroup ( FPolygonID PolygonID,
FPolygonGroupID PolygonGroupID
)

 Sets the polygon group associated with a polygon
Public function void

SetPolygonVertexInstances ( FPolygonID PolygonID,
const TArray< FVertexInstanceID >& VertexInstanceIDs
)

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

SetVertexPosition ( FVertexID VertexID,
const FVector& Position
)

 Sets a vertex position
Public function TAttributesSet< FTriangleID > &  
Public function Const const TAttributesSet< FTriangleID > &  
Public function FTriangleArray &  
Public function Const const FTriangleArray &  
Public function TAttributesSet< FVertexID > & Accessors for mesh element attributes
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 & Accessors for mesh element arrays
Public function Const const FVertexArray &  

Overridden from UObject

  Type Name Description
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page