1. Epic GamesDeveloper
  3. UMeshDescriptionBase

UMeshDescriptionBase

API > API/Runtime > API/Runtime/MeshDescription

   
Name UMeshDescriptionBase
Type class
Header File /Engine/Source/Runtime/MeshDescription/Public/MeshDescriptionBase.h
Include Path #include "MeshDescriptionBase.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UMeshDescriptionBase : public UObject

Inheritance Hierarchy

Derived Classes

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ComputePolygonTriangulation ( FPolygonID PolygonID
)

 Generates triangles and internal edges for the given polygon MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

FEdgeID CreateEdge ( FVertexID VertexID0,
FVertexID VertexID1
)

 Adds a new edge to the mesh and returns its ID MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

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

 Adds a new edge to the mesh with the given ID MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

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

 Adds a new polygon to the mesh and returns its ID. MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

FPolygonGroupID CreatePolygonGroup()

 Adds a new polygon group to the mesh and returns its ID MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void CreatePolygonGroupWithID ( FPolygonGroupID PolygonGroupID
)

 Adds a new polygon group to the mesh with the given ID MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

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

 Adds a new polygon to the mesh with the given ID. MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

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

 Adds a new triangle to the mesh and returns its ID. MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

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

 Adds a new triangle to the mesh with the given ID. MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

FVertexID CreateVertex()

 Adds a new vertex to the mesh and returns its ID MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

FVertexInstanceID CreateVertexInstance ( FVertexID VertexID
)

 Adds a new vertex instance to the mesh and returns its ID MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void CreateVertexInstanceWithID ( FVertexInstanceID VertexInstanceID,
FVertexID VertexID
)

 Adds a new vertex instance to the mesh with the given ID MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void CreateVertexWithID ( FVertexID VertexID
)

 Adds a new vertex to the mesh with the given ID MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

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

 Deletes an edge from a mesh MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

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

 Deletes a polygon from the mesh MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void DeletePolygonGroup ( FPolygonGroupID PolygonGroupID
)

 Deletes a polygon group from the mesh MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

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

 Deletes a triangle from the mesh MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void DeleteVertex ( FVertexID VertexID
)

 Deletes a vertex from the mesh MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

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

 Deletes a vertex instance from a mesh MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"
  MeshDescriptionBase.h  
  MeshDescriptionBase.h  

const FEdgeArray & Edges ()

   MeshDescriptionBase.h  

FEdgeArray & Edges ()

   MeshDescriptionBase.h  

void Empty()

 Empty the mesh description MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

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

 Returns the polygons connected to this edge MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns reference to an array of triangle IDs connected to this edge MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetEdgeCount()

 Returns the number of edges MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

FVertexID GetEdgeVertex ( FEdgeID EdgeID,
int32 VertexNumber
) const

 Returns the vertex ID corresponding to one of the edge endpoints MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns a pair of vertex IDs defining the edge MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"
  MeshDescriptionBase.h  
Get a reference to the actual mesh description MeshDescriptionBase.h  

int32 GetNumEdgeConnectedPolygons ( FEdgeID EdgeID
) const

 Returns the number of polygons connected to this edge MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetNumEdgeConnectedTriangles ( FEdgeID EdgeID
) const

 Returns the number of triangles connected to this edge MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetNumPolygonGroupPolygons ( FPolygonGroupID PolygonGroupID
) const

 Returns the number of polygons in this polygon group MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetNumPolygonInternalEdges ( FPolygonID PolygonID
) const

 Return the number of internal edges in this polygon MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetNumPolygonTriangles ( FPolygonID PolygonID
) const

 Return the number of triangles which comprise this polygon MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetNumPolygonVertices ( FPolygonID PolygonID
) const

 Returns the number of vertices this polygon has MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetNumVertexConnectedEdges ( FVertexID VertexID
) const

 Returns number of edges connected to this vertex MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetNumVertexConnectedPolygons ( FVertexID VertexID
) const

 Returns the number of polygons connected to this vertex MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetNumVertexConnectedTriangles ( FVertexID VertexID
) const

 Returns number of triangles connected to this vertex MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetNumVertexInstanceConnectedPolygons ( FVertexInstanceID VertexInstanceID
) const

 Returns the number of polygons connected to this vertex instance. MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetNumVertexInstanceConnectedTriangles ( FVertexInstanceID VertexInstanceID
) const

 Returns the number of triangles connected to this vertex instance MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetNumVertexVertexInstances ( FVertexID VertexID
) const

 Returns number of vertex instances created from this vertex MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Populates the passed array with adjacent polygons MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetPolygonCount()

 Returns the number of polygons MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetPolygonGroupCount()

 Returns the number of polygon groups MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns the polygons associated with the given polygon group MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Populate the provided array with a list of edges which are internal to the polygon, i.e. those which separate constituent triangles. MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns the edges which form the polygon perimeter MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

FPolygonGroupID GetPolygonPolygonGroup ( FPolygonID PolygonID
) const

 Return the polygon group associated with a polygon MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Return reference to an array of triangle IDs which comprise this polygon MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns reference to an array of VertexInstance IDs forming the perimeter of this polygon MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns the vertices which form the polygon perimeter MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"
  MeshDescriptionBase.h  
  MeshDescriptionBase.h  

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

 Returns the adjacent triangles to this triangle MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetTriangleCount()

 Returns the number of triangles MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns the edges which define this triangle MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

FPolygonID GetTrianglePolygon ( FTriangleID TriangleID
) const

 Get the polygon which contains this triangle MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

FPolygonGroupID GetTrianglePolygonGroup ( FTriangleID TriangleID
) const

 Get the polygon group which contains this triangle MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

FVertexInstanceID GetTriangleVertexInstance ( FTriangleID TriangleID,
int32 Index
) const

 Get the specified vertex instance by index MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Get the vertex instances which define this triangle MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns the vertices which define this triangle MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns the vertices adjacent to this vertex MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns reference to an array of Edge IDs connected to this vertex MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns the polygons connected to this vertex MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns the triangles connected to this vertex MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetVertexCount()

 Returns the number of vertices MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns the polygons connected to this vertex instance MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

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

 Returns reference to an array of Triangle IDs connected to this vertex instance MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

int32 GetVertexInstanceCount()

 Returns the number of vertex instances MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

FVertexInstanceID GetVertexInstanceForPolygonVertex ( FPolygonID PolygonID,
FVertexID VertexID
) const

 Return the vertex instance which corresponds to the given vertex on the given polygon, or INDEX_NONE MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

FVertexInstanceID GetVertexInstanceForTriangleVertex ( FTriangleID TriangleID,
FVertexID VertexID
) const

 Return the vertex instance which corresponds to the given vertex on the given triangle, or INDEX_NONE MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

FEdgeID GetVertexInstancePairEdge ( FVertexInstanceID VertexInstanceID0,
FVertexInstanceID VertexInstanceID1
) const

 Returns the edge ID defined by the two given vertex instance IDs, if there is one; otherwise INDEX_NONE MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

FVertexID GetVertexInstanceVertex ( FVertexInstanceID VertexInstanceID
) const

 Returns the vertex ID associated with the given vertex instance MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

FEdgeID GetVertexPairEdge ( FVertexID VertexID0,
FVertexID VertexID1
) const

 Returns the edge ID defined by the two given vertex IDs, if there is one; otherwise INDEX_NONE MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

FVector GetVertexPosition ( FVertexID VertexID
) const

 Gets a vertex position MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

TVertexAttributesConstRef< FVector3f > GetVertexPositions ()

   MeshDescriptionBase.h  

TVertexAttributesRef< FVector3f > GetVertexPositions ()

 Accessors for cached vertex position array MeshDescriptionBase.h  

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

 Returns reference to an array of VertexInstance IDs instanced from this vertex MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

bool IsEdgeInternal ( FEdgeID EdgeID
) const

 Determine whether a given edge is an internal edge between triangles of a polygon MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

bool IsEdgeInternalToPolygon ( FEdgeID EdgeID,
FPolygonID PolygonID
) const

 Determine whether a given edge is an internal edge between triangles of a specific polygon MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

bool IsEdgeValid ( FEdgeID EdgeID
) const

 Returns whether the passed edge ID is valid MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

bool IsEmpty()

 Return whether the mesh description is empty MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

bool IsPolygonGroupValid ( FPolygonGroupID PolygonGroupID
) const

 Returns whether the passed polygon group ID is valid MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

bool IsPolygonValid ( FPolygonID PolygonID
) const

 Returns whether the passed polygon ID is valid MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

bool IsTrianglePartOfNgon ( FTriangleID TriangleID
) const

 Determines if this triangle is part of an n-gon MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

bool IsTriangleValid ( const FTriangleID TriangleID
) const

 Returns whether the passed triangle ID is valid MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

bool IsVertexInstanceValid ( FVertexInstanceID VertexInstanceID
) const

 Returns whether the passed vertex instance ID is valid MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

bool IsVertexOrphaned ( FVertexID VertexID
) const

 Returns whether a given vertex is orphaned, i.e. it doesn't form part of any polygon MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"

bool IsVertexValid ( FVertexID VertexID
) const

 Returns whether the passed vertex ID is valid MeshDescriptionBase.h
  • BlueprintPure
  • Category="MeshDescription"
  MeshDescriptionBase.h  
  MeshDescriptionBase.h  
  MeshDescriptionBase.h  
  MeshDescriptionBase.h  

const FPolygonGroupArray & PolygonGroups ()

   MeshDescriptionBase.h  

FPolygonGroupArray & PolygonGroups ()

   MeshDescriptionBase.h  

FPolygonArray & Polygons ()

   MeshDescriptionBase.h  

const FPolygonArray & Polygons ()

   MeshDescriptionBase.h  

virtual void RegisterAttributes()

   MeshDescriptionBase.h  

void ReserveNewEdges ( int32 NumberOfNewEdges
)

 Reserves space for this number of new edges MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void ReserveNewPolygonGroups ( int32 NumberOfNewPolygonGroups
)

 Reserves space for this number of new polygon groups MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void ReserveNewPolygons ( const int32 NumberOfNewPolygons
)

 Reserves space for this number of new polygons MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void ReserveNewTriangles ( int32 NumberOfNewTriangles
)

 Reserves space for this number of new triangles MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void ReserveNewVertexInstances ( int32 NumberOfNewVertexInstances
)

 Reserves space for this number of new vertex instances MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void ReserveNewVertices ( int32 NumberOfNewVertices
)

 Reserves space for this number of new vertices MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void Reset()

 Reset the contained mesh description MeshDescriptionBase.h  

void ReversePolygonFacing ( FPolygonID PolygonID
)

 Reverse the winding order of the vertices of this polygon MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void SetMeshDescription ( FMeshDescription InMeshDescription
)

 Set the mesh description MeshDescriptionBase.h  

void SetPolygonPolygonGroup ( FPolygonID PolygonID,
FPolygonGroupID PolygonGroupID
)

 Sets the polygon group associated with a polygon MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

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

 Set the vertex instance at the given index around the polygon to the new value MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"

void SetVertexPosition ( FVertexID VertexID,
const FVector& Position
)

 Sets a vertex position MeshDescriptionBase.h
  • BlueprintCallable
  • Category="MeshDescription"
  MeshDescriptionBase.h  
  MeshDescriptionBase.h  

FTriangleArray & Triangles ()

   MeshDescriptionBase.h  

const FTriangleArray & Triangles ()

   MeshDescriptionBase.h  
Accessors for mesh element attributes MeshDescriptionBase.h  
  MeshDescriptionBase.h  
  MeshDescriptionBase.h  
  MeshDescriptionBase.h  

FVertexInstanceArray & VertexInstances ()

   MeshDescriptionBase.h  

const FVertexInstanceArray & VertexInstances ()

   MeshDescriptionBase.h  

FVertexArray & Vertices ()

 Accessors for mesh element arrays MeshDescriptionBase.h  

const FVertexArray & Vertices ()

   MeshDescriptionBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( FArchive& Ar
)

   MeshDescriptionBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page