Navigation
API > API/Runtime > API/Runtime/GeometryCore
Much like FGeneralizedCylinderGenerator, but allows an arbitrary profile curve to be swept, and gives control over the frames of the sweep curve. A mesh will be properly oriented if the profile curve is oriented counterclockwise when facing down the direction in which it is being swept.
Because it supports open profile curves, as well as welded points (for welding points on an axis of rotation), it cannot actually use the utility function from FSweepGeneratorBase, and so it doesn't inherit from that class.
| Name | FProfileSweepGenerator |
| Type | class |
| Header File | /Engine/Source/Runtime/GeometryCore/Public/Generators/SweepGenerator.h |
| Include Path | #include "Generators/SweepGenerator.h" |
Syntax
class FProfileSweepGenerator : public UE::Geometry::FMeshShapeGenerator
Inheritance Hierarchy
- FMeshShapeGenerator → FProfileSweepGenerator
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bProfileCurveIsClosed | bool | If true, the last point of the profile curve is considered to be connected to the first. | Generators/SweepGenerator.h | |
| bSharpNormals | bool | If true, each triangle will have its own normals at each vertex, rather than sharing averaged ones with nearby triangles. | Generators/SweepGenerator.h | |
| bSweepCurveIsClosed | bool | If true, the last point of the sweep curve is considered to be connected to the first. | Generators/SweepGenerator.h | |
| bUVScaleRelativeWorld | bool | When true, the generator attempts to scale UV's in a way that preserves scaling across different mesh results, aiming for 1.0 in UV space to be equal to UnitUVInWorldCoordinates in world space. | Generators/SweepGenerator.h | |
| bUVsSkipFullyWeldedEdges | bool | If true, welded-to-welded connections in the profile curve (which can't result in triangles) do not affect the UV layout. | Generators/SweepGenerator.h | |
| DiagonalTolerance | double | When QuadSplitMode is ShortestDiagonal, biases one of the diagonals so that symmetric quads are split uniformly. | Generators/SweepGenerator.h | |
| EndProfiles | TArray< int32 > | If the sweep curve is not closed, this will store the vertex ids of the first and last instances of the profile curve. | Generators/SweepGenerator.h | |
| PolygonGroupingMode | EProfileSweepPolygonGrouping | Generators/SweepGenerator.h | ||
| ProfileCurve | TArray< FVector3d > | Curve that will be swept along the curve, given in coordinates of the frames used in the sweep curve. | Generators/SweepGenerator.h | |
| Progress | FProgressCancel * | If not null, this pointer is intermittently used to check whether the current operation should stop early. | Generators/SweepGenerator.h | |
| QuadSplitMethod | EProfileSweepQuadSplit | Generators/SweepGenerator.h | ||
| SweepCurve | TArray< FFrame3d > | Curve along which to sweep the profile curve. | Generators/SweepGenerator.h | |
| SweepScaleCurve | TArray< FVector3d > | (Optional) Curve along which to scale the profile curve, corresponding to each frame in SweepCurve. | Generators/SweepGenerator.h | |
| UnitUVInWorldCoordinates | float | Only relevant if bUVScaleRelativeWorld is true (see that description) | Generators/SweepGenerator.h | |
| UVOffset | FVector2d | These values will be added to the generated UV coordinates after applying UVScale. | Generators/SweepGenerator.h | |
| UVScale | FVector2d | Generated UV coordinates will be multiplied by these values. | Generators/SweepGenerator.h | |
| WeldedVertices | TSet< int32 > | Indices into ProfileCurve that should not be swept along the curve, instead being instantiated just once. | Generators/SweepGenerator.h |
Functions
Public
Overridden from FMeshShapeGenerator
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FMeshShapeGenerator & Generate () |
TODO: We could allow the user to dissallow bowtie vertex creation, which currently could happen depending on which vertices are welded. | Generators/SweepGenerator.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AdjustNormalsForTriangle
(
int32 TriIndex, |
Utility function for calculating the triangle normal contributions to average normals. | Generators/SweepGenerator.h | |
void AdjustNormalsForTriangle
(
int32 TriIndex, |
Utility function for calculating the contribution of triangle normals to average normals. | Generators/SweepGenerator.h | |
void InitializeUvBuffer
(
const TArray< int32 >& VertPositionOffsets, |
TODO: We could output other boundaries too, but that's probably only worth doing once we find a case where we would actually use them. | Generators/SweepGenerator.h |