1. Epic GamesDeveloper
  3. FDynamicMeshUVEditor

FDynamicMeshUVEditor

[FDynamicMeshUVEditor](API\Plugins\DynamicMesh\FDynamicMeshUVEditor) implements various UV overlay editing operations.

API > API/Plugins > API/Plugins/DynamicMesh

FDynamicMeshUVEditor implements various UV overlay editing operations.

   
Name FDynamicMeshUVEditor
Type class
Header File /Engine/Plugins/Runtime/GeometryProcessing/Source/DynamicMesh/Public/Parameterization/DynamicMeshUVEditor.h
Include Path #include "Parameterization/DynamicMeshUVEditor.h"

Syntax

class FDynamicMeshUVEditor

Constructors

Name Remarks Include Path Unreal Specifiers

FDynamicMeshUVEditor ( FDynamicMesh3* MeshIn,
int32 UVLayerIndex,
bool bCreateIfMissing
)

 Construct UV Editor for a UV Overlay of the given Mesh. Parameterization/DynamicMeshUVEditor.h  

FDynamicMeshUVEditor ( FDynamicMesh3* MeshIn,
FDynamicMeshUVOverlay* UVOverlayIn
)

 Construct UV Editor for a UV Overlay of the given Mesh. Parameterization/DynamicMeshUVEditor.h  

Structs

Name Remarks
FExpMapOptions FExpMapOptions provides additional control over ExpMap UV generation below
FSetUVsFromConformalOptions  
FTransferFromMeshViaProjectionSettings  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Mesh FDynamicMesh3 * The mesh we will be editing Parameterization/DynamicMeshUVEditor.h  
UVOverlay FDynamicMeshUVOverlay * The UV Overlay we will be editing Parameterization/DynamicMeshUVEditor.h  
UVOverlayIndex int32 The index of the UV Overlay we will be editing Parameterization/DynamicMeshUVEditor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddUVLayer()

 Append new UV layer to the end of the array, returning the newly added index, or -1 if at max layers already Parameterization/DynamicMeshUVEditor.h  

bool AutoOrientUVArea ( const TArray< int32 >& Triangles
)

 Compute an oriented UV-space bounding box for the given Triangles, and then rotate the UVs such that the box is aligned with the X axis. Parameterization/DynamicMeshUVEditor.h  

bool CopyUVLayer ( FDynamicMeshUVOverlay* FromUVOverlay
)

 Copy UVs from another overlay Parameterization/DynamicMeshUVEditor.h  

bool CreateSeamsAtEdges ( const TSet< int32 >& EidsToMakeIntoSeams,
FUVEditResult* Result
)

 Cut existing UV topology with a set of edges. Parameterization/DynamicMeshUVEditor.h  

void CreateUVLayer ( int32 UVLayerIndex
)

 Create specified UVLayer if it does not exist Parameterization/DynamicMeshUVEditor.h  
  Parameterization/DynamicMeshUVEditor.h  

const FDynamicMesh3 * GetMesh ()

   Parameterization/DynamicMeshUVEditor.h  

FDynamicMeshUVOverlay * GetOverlay ()

   Parameterization/DynamicMeshUVEditor.h  

const FDynamicMeshUVOverlay * GetOverlay ()

   Parameterization/DynamicMeshUVEditor.h  

bool MakeIsland ( const TSet< int32 >& TidsToMakeIntoIsland,
FUVEditResult* Result,
TSet< int32 >* ChangedTrianglesOut
)

 Takes the currently selected triangles and makes a separate UV island out of them, i.e. any interior seams are removed, and seams are added around the boundary of the selection. Parameterization/DynamicMeshUVEditor.h  

void MakeSureUVsAreSet ( const TSet< int32 >& Triangles,
FUVEditResult* Result,
TSet< int32 >* ChangedTrianglesOut
)

 Initializes any uninitialized triangles in the set to per-vertex (0,0) UVs. Parameterization/DynamicMeshUVEditor.h  

bool QuickPack ( int32 TargetTextureResolution,
float GutterSize
)

 Pack UVs into unit rectangle Parameterization/DynamicMeshUVEditor.h  

bool RemoveSeamsAtEdges ( const TSet< int32 >& EidsToRemoveAsSeams
)

 Merge existing UV topology with a set of edges, removing seams at edges if they exist within the UV topology. Parameterization/DynamicMeshUVEditor.h  

int32 RemoveUVLayer ()

 Remove active layer, setting active layer to highest, preceeding layer. Parameterization/DynamicMeshUVEditor.h  

void ResetUVs ()

 Clear UVs for all triangles on active layer Parameterization/DynamicMeshUVEditor.h  

void ResetUVs ( const TArray< int32 >& Triangles
)

 Clear UVs for given triangles on active layer Parameterization/DynamicMeshUVEditor.h  

bool ScaleUVAreaTo3DArea ( const TArray< int32 >& Triangles,
bool bRecenterAtOrigin,
float ScaleFactor
)

 Compute the UV-space and 3D area of the given Triangles, and then scale the UV area to be equvalent to the 3D area. Parameterization/DynamicMeshUVEditor.h  

bool ScaleUVAreaToBoundingBox ( const TArray< int32 >& Triangles,
const FAxisAlignedBox2f& BoundingBox,
bool bPreserveAspectRatio,
bool bRecenterAtBoundingBox
)

 Scale UVs of the given triangles to fit within the provided provided bounding box. Parameterization/DynamicMeshUVEditor.h  

void SetPerTriangleUVs ( double ScaleFactor,
FUVEditResult* Result
)

 Create new UV island for given Triangles, and set UVs by planar projection to ProjectionFrame. Parameterization/DynamicMeshUVEditor.h  

void SetPerTriangleUVs ( const TArray< int32 >& Triangles,
double ScaleFactor,
FUVEditResult* Result
)

 Create new UV island for each Triangle, by planar projection onto plane of Triangle. Parameterization/DynamicMeshUVEditor.h  

void SetToPerVertexUVs ( TArray< int32 >& VertexToUVOut,
bool& bIsIdentityMapOut,
FUVEditResult* Result
)

 Initialize UV topology to be one UV per vertex. UVs are initialized to (0,0) Parameterization/DynamicMeshUVEditor.h  

void SetTriangleUVsFromBoxProjection ( const TArray< int32 >& Triangles,
TFunctionRef< FVector3d(const FVector3d&)> PointTransform,
const FFrame3d& BoxFrame,
const FVector3d& BoxDimensions,
int32 MinIslandTriCount,
FUVEditResult* Result
)

 Set UVs by box projection. Parameterization/DynamicMeshUVEditor.h  

void SetTriangleUVsFromCylinderProjection ( const TArray< int32 >& Triangles,
TFunctionRef< FVector3d(const FVector3d&)> PointTransform,
const FFrame3d& CylFrame,
const FVector3d& CylDimensions,
float CylinderSplitAngle,
FUVEditResult* Result
)

 Set UVs by cylinder projection. Parameterization/DynamicMeshUVEditor.h  

bool SetTriangleUVsFromExpMap ( const TArray< int32 >& Triangles,
const FExpMapOptions& Options,
FUVEditResult* Result
)

 Create new UV island for given Triangles, and set UVs for that island using Discrete Exponential Map. Parameterization/DynamicMeshUVEditor.h  

bool SetTriangleUVsFromExpMap ( const TArray< int32 >& Triangles,
TFunctionRef< FVector3d(const FVector3d&)> PointTransform,
const FFrame3d& ProjectionFrame,
const FVector2d& Dimensions,
int32 NormalSmoothingRounds,
double NormalSmoothingAlpha,
double FrameNormalBlendWeight,
FUVEditResult* Result
)

 Create new UV island for given Triangles, and set UVs for that island using Discrete Exponential Map. Parameterization/DynamicMeshUVEditor.h  

bool SetTriangleUVsFromFreeBoundaryConformal ( const TArray< int32 >& Triangles,
FUVEditResult* Result
)

 Create new UV island for given Triangles, and set UVs for that island using Discrete Natural Conformal Map (equivalent to Least-Squares Conformal Map) Parameterization/DynamicMeshUVEditor.h  

bool SetTriangleUVsFromFreeBoundaryConformal ( const TArray< int32 >& Triangles,
const TSet< int32 >& PinnedElementIDs,
FUVEditResult* Result
)

 Create new UV island for given Triangles, and set UVs for that island using Discrete Natural Conformal Map (equivalent to Least-Squares Conformal Map). Parameterization/DynamicMeshUVEditor.h  

bool SetTriangleUVsFromFreeBoundaryConformal ( const TArray< int32 >& Triangles,
bool bUseExistingUVTopology,
FUVEditResult* Result
)

 Create new UV island for given Triangles, and set UVs for that island using Discrete Natural Conformal Map (equivalent to Least-Squares Conformal Map) Parameterization/DynamicMeshUVEditor.h  

bool SetTriangleUVsFromFreeBoundarySpectralConformal ( const TArray< int32 >& Triangles,
bool bUseExistingUVTopology,
bool bPreserveIrregularity,
FUVEditResult* Result
)

 Create new UV island for given Triangles, and set UVs for that island using Spectral Conformal Map. Parameterization/DynamicMeshUVEditor.h  

void SetTriangleUVsFromPlanarProjection ( const TArray< int32 >& Triangles,
TFunctionRef< FVector3d(const FVector3d&)> PointTransform,
const FFrame3d& ProjectionFrame,
const FVector2d& Dimensions,
FUVEditResult* Result
)

 Create new UV island for given Triangles, and set UVs by planar projection to ProjectionFrame. Parameterization/DynamicMeshUVEditor.h  

void SetTriangleUVsFromProjection ( const TArray< int32 >& Triangles,
const FFrame3d& ProjectionFrame,
FUVEditResult* Result
)

 Create new UV island for given Triangles, and set UVs by planar projection to ProjectionFrame. Parameterization/DynamicMeshUVEditor.h  

void SwitchActiveLayer ( int32 UVLayerIndex
)

 Switch to new layer Parameterization/DynamicMeshUVEditor.h  

void TransferTriangleUVsFromMeshViaDirectionProjection ( TArrayView< const int32 > Triangles,
TFunctionRef< FVector3d(const FVector3d&)> TransformTargetToSourceSpacePosition,
const FVector3d& ProjectionDirection,
double ProjectionOffset,
TFunctionRef< FVector3d(const FVector3d&)> TransformProjectionToSourceSpaceVector,
const FDynamicMeshAABBTree3& SourceMeshSpatial,
int32 SourceMeshUVChannel,
const FTransferFromMeshViaProjectionSettings& Settings,
FUVEditResult* Result
)

 Transfer UVs from a source mesh by projecting along the specified direction Parameterization/DynamicMeshUVEditor.h  

void TransformUVElements ( const TArray< int32 >& ElementIDs,
TFunctionRef< FVector2f(const FVector2f&)> TransformFunc
)

 Apply arbitrary transform to UV elements Parameterization/DynamicMeshUVEditor.h  

bool UDIMPack ( int32 TargetTextureResolution,
float GutterSize,
const FVector2i& UDIMCoordsIn,
const TArray< int32 >* Triangles
)

 Pack specific UVs triangles into the specific unit rectangle at the specified index Parameterization/DynamicMeshUVEditor.h  

Static

Name Remarks Include Path Unreal Specifiers

static double DetermineAreaFromUVs ( const FDynamicMeshUVOverlay& UVOverlay,
const TArray< int32 >& Triangles,
FAxisAlignedBox2f* BoundingBox
)

 Compute the occupied 2D area for the UVs for the specified triangles and channel. Parameterization/DynamicMeshUVEditor.h  

static bool EstimateGeodesicCenterFrameVertex ( const FDynamicMesh3& Mesh,
const TArray< int32 >& Triangles,
FFrame3d& FrameOut,
int32& VertexIDOut,
bool bAlignToUnitAxes
)

 Compute geodesic center of given Mesh triangles (assumes they are connected) Parameterization/DynamicMeshUVEditor.h  

static bool EstimateGeodesicCenterFrameVertex ( const FDynamicMesh3& Mesh,
FFrame3d& FrameOut,
int32& VertexIDOut,
bool bAlignToUnitAxes
)

 Utility functions that could maybe go elsewhere but are mainly useful in parameterization context Compute geodesic center of given Mesh Parameterization/DynamicMeshUVEditor.h  

static void TransformTriangleSelectionUVs ( FDynamicMeshUVOverlay& UVOverlay,
TConstArrayView< int32 > Triangles,
TFunctionRef< FVector2f(const FVector2f&)> TransformFunc
)

 Transform UVs of the specified triangles Parameterization/DynamicMeshUVEditor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page