Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > DynamicMesh > Operations > FGroupTopologyDeformer

Light Theme

Dark Theme

FGroupTopologyDeformer

[FGroupTopologyDeformer](API\Plugins\DynamicMesh\Operations\FGroupTopologyDeformer) supports deforming a Mesh based on an overlaid [FGroupTopology](API\Plugins\DynamicMesh\FGroupTopology).

Windows

MacOS

Linux

Inheritance Hierarchy

FGroupTopologyDeformer

FGroupTopologyLaplacianDeformer

References

Module	DynamicMesh
Header	/Engine/Plugins/Experimental/GeometryProcessing/Source/DynamicMesh/Public/Operations/GroupTopologyDeformer.h
Include	#include "Operations/GroupTopologyDeformer.h"

Syntax

class FGroupTopologyDeformer

Remarks

FGroupTopologyDeformer supports deforming a Mesh based on an overlaid FGroupTopology. First the client defines a set of "Handle" elements (Faces/Corners/Edges) using SetActiveHandleX(). The client will provide new vertex positions for the vertices of these elements via the HandleVertexDeformFunc argument to UpdateSolution(). Once the Handle vertices have been updated, the deformer solves for updated vertex positions in the GroupTopology Faces that are adjacent to the handles. This region is referred to as the "ROI" (Region-of-Interest)

The default deformation is to first solve for the updated edges, and then solve for updated faces. This is done via linear encoding of the edge and face vertices relative to their boundaries (edge boundary is endpoint corners, face boundary is edges).

Various functions can be overrided to customize behavior.

Variables

		Name	Description
	TArray< FEdgeEn...	EdgeEncodings
	TSet< int >	FaceBoundaryVertsTemp
	TArray< FFaceEn...	FaceEncodings
	TSet< int >	FaceVertsTemp
	TSet< int >	FixedBoundaryVertices
	TSet< int >	HandleBoundaryVertices
	TSet< int >	HandleVertices
	FVertexPosition...	InitialPositions
	const FDynamicM...	Mesh
	TSet< int >	ModifiedOverlayNormals
	TSet< int >	ModifiedVertices
	TArray< FROIEdg...	ROIEdges
	TSet< int >	ROIEdgeVertices
	TArray< FROIFac...	ROIFaces
	const FGroupTop...	Topology

Destructors

	Name	Description
	~FGroupTopologyDeformer()

Functions

	Name	Description
void	CalculateROI ( const TArray< int >& HandleGroups, const TArray< int >& ROIGroups )	Populate the internal ROI data structures based on the given HandleGroups and ROIGroups.
void	ClearSolution ( FDynamicMesh3* TargetMesh )	Restore the Handle and ROI vertex positions to their initial state
void	ComputeEncoding()	Precompute the representation of the ROI vertices at the initial positions.
const TSet< ...	GetHandleVertices()
const FDynam...	GetMesh()
const TSet< ...	GetModifiedOverlayNormals()
const TSet< ...	GetModifiedVertices()
const FGroup...	GetTopology()
void	Initialize ( const FDynamicMesh3* Mesh, const FGroupTopology* Topology )	Set the Mesh and Topology to use for the deformation
void	Reset()	These are functions that subclasses may wish to overridereset all internal data structures, eg when changing handle
void	SaveInitialPositions()	Save the positions of all vertices that will be modified
void	SetActiveHandleCorners ( const TArray< int >& TopologyCorne... )	Set the active handle to the given Corners
void	SetActiveHandleEdges ( const TArray< int >& TopologyEdgeI... )	Set the active handle to the given Edges
void	SetActiveHandleFaces ( const TArray< int >& FaceGroupIDs )	Handle setup/configuraiton Set the active handle to the given Faces
void	UpdateSolution ( FDynamicMesh3* TargetMesh, const TFunction< FVector3d... )	Solving Update TargetMesh by first calling HandleVertexDeformFunc() to get new handle vertex positions, then solving for new ROI vertex positions.

Classes

	Name	Description
	FEdgeEncoding
	FEdgeVertexEncoding	Deformation strategy (should be in subclass?)
	FFaceEncoding
	FFaceVertexEncoding
	FROIEdge
	FROIFace

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss