1. Epic GamesDeveloper
  3. FMeshNormals

FMeshNormals

[FMeshNormals](API\Runtime\GeometryCore\DynamicMesh\FMeshNormals) is a utility class that can calculate and store various types of normal vectors for a FDynamicMesh.

API > API/Runtime > API/Runtime/GeometryCore > API/Runtime/GeometryCore/DynamicMesh

References

   
Module GeometryCore
Header /Engine/Source/Runtime/GeometryCore/Public/DynamicMesh/MeshNormals.h
Include #include "DynamicMesh/MeshNormals.h"

Syntax

class FMeshNormals

Remarks

FMeshNormals is a utility class that can calculate and store various types of normal vectors for a FDynamicMesh.

Variables

  Type Name Description
Protected variable const FDynamicMesh3 * Mesh Target Mesh
Protected variable TArray< FVector3d > Normals Set of computed normals

Constructors

  Type Name Description
Public function    
Public function  

FMeshNormals ( const FDynamicMesh3* Mesh
)

  

Functions

  Type Name Description
Protected function void

Compute_FaceAvg ( bool bWeightByArea,
bool bWeightByAngle
)

 Compute per-vertex normals using a custom combination of area-weighted and angle-weighted averaging of one-ring triangle normals
Protected function void Compute per-vertex normals using area-weighted averaging of one-ring triangle normals
Protected function void

Compute_Overlay_FaceAvg ( const FDynamicMeshNormalOverlay* NormalOverlay,
bool bWeightByArea,
bool bWeightByAngle
)

 Recompute the element Normals of the given attribute overlay using a custom combination of area-weighted and angle-weighted averaging of one-ring triangle normals
Protected function void Recompute the element Normals of the given attribute overlay using area-weighted averaging of one-ring triangle normals
Protected function void Compute per-triangle normals
Public function Static FVector3d

ComputeOverlayNormal ( const FDynamicMesh3& Mesh,
const FDynamicMeshNormalOverlay* NormalOverlay,
int ElemIdx,
bool bWeightByArea,
bool bWeightByAngle
)

  
Public function void Compute per-triangle normals
Public function Static FVector3d

ComputeVertexNormal ( const FDynamicMesh3& Mesh,
int32 VertIdx,
TFunctionRef< bool(int32)> TriangleFilterFunc,
bool bWeightByArea,
bool bWeightByAngle
)

 Compute normal at mesh vertex by weighted sum of subset of one-ring triangle normals.
Public function Static FVector3d

ComputeVertexNormal ( const FDynamicMesh3& Mesh,
int VertIdx,
bool bWeightByArea,
bool bWeightByAngle
)

 Compute normal at mesh vertex by weighted sum of one-ring triangle normals.
Public function void

ComputeVertexNormals ( bool bWeightByArea,
bool bWeightByAngle
)

 Compute standard per-vertex normals by averaging one-ring face normals
Public function Const void

CopyToOverlay ( FDynamicMeshNormalOverlay* NormalOverlay,
bool bInvert
)

 Copy the current set of normals to the NormalOverlay attribute layer
Public function Const void

CopyToVertexNormals ( FDynamicMesh3* SetMesh,
bool bInvert
)

 Copy the current set of normals to the vertex normals of SetMesh
Public function Const const TArray< FVector3d > &  
Public function Static FVector3d

GetVertexWeightsOnTriangle ( const FDynamicMesh3* Mesh,
int TriID,
double TriArea,
bool bWeightByArea,
bool bWeightByAngle
)

 Retrieve the area and/or angle weights for each vertex of a triangle
Public function Static void Initialize the given Mesh with per-face normals, ie separate overlay element for each vertex of each triangle.
Public function Static void Initialize the given triangles of NormalOverlay with per-vertex normals, ie single overlay element for each mesh vertex.
Public function Static void Initialize the given NormalOverlay with per-face normals, ie separate overlay element for each vertex of each triangle.
Public function Static void

InitializeOverlayToPerVertexNormals ( FDynamicMeshNormalOverlay* NormalOverlay,
bool bUseMeshVertexNormalsIfAvailable
)

 Initialize the given NormalOverlay with per-vertex normals, ie single overlay element for each mesh vertex.
Public function Static void  
Public function Static void

InitializeOverlayTopologyFromOpeningAngle ( const FDynamicMesh3* Mesh,
FDynamicMeshNormalOverlay* NormalOverlay,
double AngleThresholdDeg
)

  
Public function Static void

QuickComputeVertexNormals ( FDynamicMesh3& Mesh,
bool bInvert
)

 Compute per-vertex normals for the given Mesh
Public function Static void

QuickComputeVertexNormalsForTriangles ( FDynamicMesh3& Mesh,
const TArray< int32 >& Triangles,
bool bWeightByArea,
bool bWeightByAngle,
bool bInvert
)

 Compute per-vertex normals for the vertices of a set of triangles of a Mesh
Public function Static bool

QuickRecomputeOverlayNormals ( FDynamicMesh3& Mesh,
bool bInvert,
bool bWeightByArea,
bool bWeightByAngle
)

 Compute overlay normals for the given mesh
Public function Static bool

RecomputeOverlayElementNormals ( FDynamicMesh3& Mesh,
const TArray< int32 >& ElementIDs,
bool bWeightByArea,
bool bWeightByAngle
)

 Compute overlay normals for the given mesh, for the given set of element IDs
Public function void

RecomputeOverlayNormals ( const FDynamicMeshNormalOverlay* NormalOverlay,
bool bWeightByArea,
bool bWeightByAngle
)

 Recompute the per-element normals of the given overlay by averaging one-ring face normals
Public function Static bool

RecomputeOverlayTriNormals ( FDynamicMesh3& Mesh,
const TArray< int32 >& Triangles,
bool bWeightByArea,
bool bWeightByAngle
)

 Compute overlay normals for the given mesh, for the given set of triangles
Public function void

SetCount ( int Count,
bool bClearToZero
)

 Set the size of the Normals array to Count, and optionally clear all values to (0,0,0)
Public function void Assumes that ComputeTriangleNormals() has already been run.
Public function void

SetMesh ( const FDynamicMesh3* MeshIn
)

  
Public function Static void

SmoothVertexNormals ( FDynamicMesh3& Mesh,
int32 SmoothingRounds,
double SmoothingAlpha
)

 Apply rounds of explicit uniform-weighted normal smoothing to the VertexNormals attribute of the given Mesh.

Operators

  Type Name Description
Public function FVector3d &

operator[] ( int i
)

  
Public function Const const FVector3d &

operator[] ( int i
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page