1. Epic GamesDeveloper
  3. UPARAM

UPARAM

Function Overloads

API > API/Plugins > API/Plugins/GeometryScriptingCore > API/Plugins/GeometryScriptingCore/UGeometryScriptLibrary_MeshPrimi-

Overloads

Name Remarks Include Path Unreal Specifiers

static static UPARAM ( DisplayName
)

 Appends a 3D box to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a 3D box to the Target Mesh Also creates matching simple collision GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a 3D box to the Target Mesh with dimensions and origin taken from the input Box GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a 3D box to the Target Mesh with dimensions and origin taken from the input Box Also creates matching simple collision GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a 3D Sphere triangulated using latitude/longitude topology to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a 3D Sphere triangulated using latitude/longitude topology to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a 3D sphere triangulated using box topology to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a 3D sphere triangulated using box topology to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a 3D Capsule to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a 3D Capsule to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a 3D Cylinder (with optional end caps) to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a 3D cone to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a 3D torus (donut) or partial torus to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 In the coordinate system of the revolve polygon, +X is towards the "outside" of the revolve donut, and +Y is "up" (ie +Z in local space) Polygon should be oriented counter-clockwise to produce a correctly-oriented shape, otherwise it will be inside-out Polygon endpoint is not repeated. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Revolves a 2D polygon on a helical path, like one used to create a vertical spiral, appending the result to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Revolves an open 2D path, with optional top and bottom end caps, appending the result to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Sweep the given 2D PolylineVertices along the SweepPath specified as a set of FTransforms If the 2D vertices are (U,V), then in the coordinate space of the FTransform, X points "along" the path, Y points "right" (U) and Z points "up" (V). GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod, AutoCreateRefTerm="PolylineTexParamU, SweepPathTexParamV")

static static UPARAM ( DisplayName
)

 Polygon should be oriented counter-clockwise to produce a correctly-oriented shape, otherwise it will be inside-out Polygon endpoint is not repeated. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Sweeps a 2D polygon along an arbitrary 3D path, appending the result to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Sweep the given 2D PolygonVertices along the SweepPath specified as a set of FTransforms If the 2D vertices are (U,V), then in the coordinate space of the FTransform, X points "along" the path, Y points "right" (U) and Z points "up" (V). GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a planar Rectangle to a Dynamic Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a planar Rectangle with Rounded Corners (RoundRect) to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a planar disc to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a Triangulated Polygon to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a Triangulated Polygon (with vertices specified in 3D) to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a linear staircase to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Appends a rising circular staircase to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Generates triangulated Voronoi Cells from the provided Voronoi Sites, identifying each with PolyGroups, and appends to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Generates a Delaunay Triangulation of the provided vertices, and appends it to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"
  • Meta=(ScriptMethod, AutoCreateRefTerm="ConstrainedEdges")

static static UPARAM ( DisplayName
)

 Generates a Delaunay Triangulation of the provided Polygon List, and appends it to the Target Mesh. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"

static static UPARAM ( DisplayName
)

 Appends Simple Collision shapes to the Target Mesh, triangulated as specified by Triangulation Options GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • DisplayName="Append Simple Collision Shapes to Mesh"
  • Category="GeometryScript|Primitives"

static static UPARAM ( DisplayName
)

 Appends the spheres in the Sphere Covering to the Target Mesh GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Primitives"

static static UPARAM ( DisplayName
)

 Backwards-Compatibility implementations. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Compatibility"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 5.0 Preview 1 Compatibility version of AppendRoundRectangleXY. GeometryScript/MeshPrimitiveFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Compatibility"
  • Meta=(ScriptMethod)

UPARAM(DisplayName)

Description

Appends a 3D box to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a 3D box to the Target Mesh Also creates matching simple collision

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a 3D box to the Target Mesh with dimensions and origin taken from the input Box

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a 3D box to the Target Mesh with dimensions and origin taken from the input Box Also creates matching simple collision

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a 3D Sphere triangulated using latitude/longitude topology to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a 3D Sphere triangulated using latitude/longitude topology to the Target Mesh. Also creates matching simple collision. Note: If transform has non-uniform scale, collision shape will be a uniform-scale approximation matching the behavior of the physics system specifically, it will scale the sphere radius by the smallest axis scale.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a 3D sphere triangulated using box topology to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a 3D sphere triangulated using box topology to the Target Mesh. Also creates matching simple collision. Note: If transform has non-uniform scale, collision shape will be a uniform-scale approximation matching the behavior of the physics system specifically, it will scale the sphere radius by the smallest axis scale.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a 3D Capsule to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a 3D Capsule to the Target Mesh. Also creates matching simple collision. Note: If transform has non-uniform scale, collision shape will be a uniform-scale approximation matching the behavior of the physics system specifically, it will scale the radius by the larger of the X, Y axis scales, and the length by the Z axis scale

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a 3D Cylinder (with optional end caps) to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a 3D cone to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a 3D torus (donut) or partial torus to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

In the coordinate system of the revolve polygon, +X is towards the "outside" of the revolve donut, and +Y is "up" (ie +Z in local space) Polygon should be oriented counter-clockwise to produce a correctly-oriented shape, otherwise it will be inside-out Polygon endpoint is not repeated.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Revolves a 2D polygon on a helical path, like one used to create a vertical spiral, appending the result to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Revolves an open 2D path, with optional top and bottom end caps, appending the result to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Sweep the given 2D PolylineVertices along the SweepPath specified as a set of FTransforms If the 2D vertices are (U,V), then in the coordinate space of the FTransform, X points "along" the path, Y points "right" (U) and Z points "up" (V).

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives",  
          Meta=(ScriptMethod, AutoCreateRefTerm="PolylineTexParamU, SweepPathTexParamV"))  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
PolylineVertices vertices of the open 2D path that will be swept along the SweepPath
SweepPath defines the 3D sweep path curve as a 3D poly-path, with rotation and scaling at each polypath vertex taken from the Transform
PolylineTexParamU defines U coordinate value for each element in PolylineVertices. Must be same length as PolylineVertices (ignored if length=0).
SweepPathTexParamV defines V coordinate value for each element in SweepPath. Must be same length as SweepPath if bLoop=false, length+1 if bLoop=true, and ignored if length=0.
bLoop if true, SweepPath is considered to be a Loop and a section connecting the end and start of the path is added (bCapped is ignored)
StartScale uniform scaling applied to the 2D polygon at the start of the path. Interpolated via arc length to EndScale at the end of the path.
EndScale uniform scaling applied to the 2D polygon at the end of the path
RotationAngleDeg Rotation applied to the 2D Polygon. Positive rotation rotates clockwise, ie Up/+Z/+V towards Right/+Y/+U. This Rotation is applied before any rotation in the SweepPath Transforms.
MiterLimit If > 1, maximum scaling to apply at sharp turns in the curve path to keep the apparent swept profile from shrinking, and sweep path frames will be aligned to the path direction

UPARAM(DisplayName)

Description

Polygon should be oriented counter-clockwise to produce a correctly-oriented shape, otherwise it will be inside-out Polygon endpoint is not repeated.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Sweeps a 2D polygon along an arbitrary 3D path, appending the result to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
PolygonVertices vertices of the closed 2D polyon that will be swept along the SweepPath
SweepPath defines the 3D sweep path curve
bLoop if true, SweepPath is considered to be a Loop and a section connecting the end and start of the path is added (bCapped is ignored)
bCapped if true the open ends of the swept generalized cylinder are triangulated
StartScale uniform scaling applied to the 2D polygon at the start of the path. Interpolated via arc length to EndScale at the end of the path.
EndScale uniform scaling applied to the 2D polygon at the end of the path
RotationAngleDeg Rotation applied to the 2D Polygon. Positive rotation rotates clockwise, ie Up/+Z/+V towards Right/+Y/+U
MiterLimit If > 1, maximum scaling to apply at sharp turns in the curve path to keep the apparent swept profile from shrinking

UPARAM(DisplayName)

Description

Sweep the given 2D PolygonVertices along the SweepPath specified as a set of FTransforms If the 2D vertices are (U,V), then in the coordinate space of the FTransform, X points "along" the path, Y points "right" (U) and Z points "up" (V).

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
PolygonVertices vertices of the closed 2D polyon that will be swept along the SweepPath
SweepPath defines the 3D sweep path curve as a 3D poly-path, with rotation and scaling at each polypath vertex taken from the Transform
bLoop if true, SweepPath is considered to be a Loop and a section connecting the end and start of the path is added (bCapped is ignored)
bCapped if true the open ends of the swept generalized cylinder are triangulated
StartScale uniform scaling applied to the 2D polygon at the start of the path. Interpolated via arc length to EndScale at the end of the path.
EndScale uniform scaling applied to the 2D polygon at the end of the path
RotationAngleDeg Rotation applied to the 2D Polygon. Positive rotation rotates clockwise, ie Up/+Z/+V towards Right/+Y/+U. This Rotation is applied before any rotation in the SweepPath Transforms.
MiterLimit If > 1, maximum scaling to apply at sharp turns in the curve path to keep the apparent swept profile from shrinking, and sweep path frames will be aligned to the path direction

UPARAM(DisplayName)

Description

Appends a planar Rectangle to a Dynamic Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a planar Rectangle with Rounded Corners (RoundRect) to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a planar disc to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a Triangulated Polygon to the Target Mesh. Polygon should be oriented counter-clockwise to produce a correctly-oriented shape, otherwise it will be inside-out Polygon endpoint is not repeated.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a Triangulated Polygon (with vertices specified in 3D) to the Target Mesh. Uses Ear Clipping-based triangulation. Output vertices will always be 1:1 with input vertices. Polygon endpoint is not repeated.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a linear staircase to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Appends a rising circular staircase to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Generates triangulated Voronoi Cells from the provided Voronoi Sites, identifying each with PolyGroups, and appends to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Generates a Delaunay Triangulation of the provided vertices, and appends it to the Target Mesh. If optional Constrained Edges are provided, will generate a Constrained Delaunay Triangulation which connects the specified vertices with edges. On success, all vertices are always appended to the output mesh, though duplicate vertices will not be used in any triangles and may optionally be removed. Use PositionsToVertexIDs to map indices in the input VertexPositions array to vertex IDs in the Dynamic Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives",  
          Meta=(ScriptMethod, AutoCreateRefTerm="ConstrainedEdges"))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Generates a Delaunay Triangulation of the provided Polygon List, and appends it to the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives")  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
bTriangulationError Reports whether the triangulation contains errors, typically due to intersecting edges in the input. Consider pre-processing the PolygonsList with PolygonsUnion to resolve intersections and prevent this error.
bStillAppendOnError Whether to still append a best-effort triangulation in error cases. Often this will be a triangulation that does not quite match the polygon shape near intersecting edges in the input, but otherwise is as-expected.

UPARAM(DisplayName)

Description

Appends Simple Collision shapes to the Target Mesh, triangulated as specified by Triangulation Options

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, DisplayName="Append Simple Collision Shapes to Mesh",  
          Category="GeometryScript|Primitives")  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
Transform Transform to be applied to simple collision shapes, following the method by which simple collision shapes are transformed so, e.g., spheres will not be non-uniformly scaled

UPARAM(DisplayName)

Description

Appends the spheres in the Sphere Covering to the Target Mesh

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Primitives")  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Warnings * It is strongly recommended that callers of this function update to the current AppendRectangleXY function!

Description

These are versions/variants of the above functions that were released in previous UE 5.x versions, that have since been updated. To avoid breaking user scripts, these previous versions are currently kept and called via redirectors registered in GeometryScriptingCoreModule.cpp.

These functions may be deprecated in future UE releases. 5.0 Preview 1 Compatibility version of AppendRectangleXY. Incorrectly interprets the input dimensions. Incorrectly divides the input DimensionX and DimensionY by 2.

It is strongly recommended that callers of this function update to the current AppendRectangleXY function!

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Compatibility", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Warnings * It is strongly recommended that callers of this function update to the current AppendRoundRectangleXY function!

Description

5.0 Preview 1 Compatibility version of AppendRoundRectangleXY. Incorrectly divides the input DimensionX and DimensionY by 2.

It is strongly recommended that callers of this function update to the current AppendRoundRectangleXY function!

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include Path #include "GeometryScript/MeshPrimitiveFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Compatibility", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page