1. Epic GamesDeveloper
  3. UGeometryScriptLibrary_MeshPrimitiveFunctions

UGeometryScriptLibrary_MeshPrimitiveFunctions

API > API/Plugins > API/Plugins/GeometryScriptingCore > API/Plugins/GeometryScriptingCore/GeometryScript

Inheritance Hierarchy

References

   
Module GeometryScriptingCore
Header /Engine/Plugins/Experimental/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshPrimitiveFunctions.h
Include #include "GeometryScript/MeshPrimitiveFunctions.h"

Syntax

UCLASS&40;Meta&61;&40;ScriptName&61;"GeometryScript_Primitives"&41;&41;  
class UGeometryScriptLibrary_MeshPrimitiveFunctions : public UBlueprintFunctionLibrary

Functions

  Type Name Description
Public function Static UDynamicMesh *

AppendBoundingBox ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
FBox Box,
int32 StepsX,
int32 StepsY,
int32 StepsZ,
UGeometryScriptDebug* Debug
)

 Appends a 3D box to the Target Mesh with dimensions and origin taken from the input Box
Public function Static UDynamicMesh *

AppendBox ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float DimensionX,
float DimensionY,
float DimensionZ,
int32 StepsX,
int32 StepsY,
int32 StepsZ,
EGeometryScriptPrimitiveOriginMode Origin,
UGeometryScriptDebug* Debug
)

 Appends a 3D box to the Target Mesh.
Public function Static UDynamicMesh *

AppendCapsule ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float Radius,
float LineLength,
int32 HemisphereSteps,
int32 CircleSteps,
EGeometryScriptPrimitiveOriginMode Origin,
UGeometryScriptDebug* Debug
)

 Appends a 3D Capsule to the Target Mesh.
Public function Static UDynamicMesh *

AppendCone ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float BaseRadius,
float TopRadius,
float Height,
int32 RadialSteps,
int32 HeightSteps,
bool bCapped,
EGeometryScriptPrimitiveOriginMode Origin,
UGeometryScriptDebug* Debug
)

 Appends a 3D cone to the Target Mesh.
Public function Static UDynamicMesh *

AppendCurvedStairs ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float StepWidth,
float StepHeight,
float InnerRadius,
float CurveAngle,
int NumSteps,
bool bFloating,
UGeometryScriptDebug* Debug
)

 Appends a rising circular staircase to the Target Mesh.
Public function Static UDynamicMesh *

AppendCylinder ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float Radius,
float Height,
int32 RadialSteps,
int32 HeightSteps,
bool bCapped,
EGeometryScriptPrimitiveOriginMode Origin,
UGeometryScriptDebug* Debug
)

 Appends a 3D Cylinder (with optional end caps) to the Target Mesh.
Public function Static UDynamicMesh *

AppendDelaunayTriangulation2D ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
const TArray< FVector2D >& VertexPositions,
const TArray< FIntPoint >& ConstrainedEdges,
FGeometryScriptConstrainedDelaunayTriangulationOptions TriangulationOptions,
TArray< int32 >& PositionsToVertexIDs,
bool& bHasDuplicateVertices,
UGeometryScriptDebug* Debug
)

 Generates a Delaunay Triangulation of the provided vertices, and appends it to the Target Mesh.
Public function Static UDynamicMesh *

AppendDisc ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float Radius,
int32 AngleSteps,
int32 SpokeSteps,
float StartAngle,
float EndAngle,
float HoleRadius,
UGeometryScriptDebug* Debug
)

 Appends a planar disc to the Target Mesh.
Public function Static UDynamicMesh *

AppendLinearStairs ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float StepWidth,
float StepHeight,
float StepDepth,
int NumSteps,
bool bFloating,
UGeometryScriptDebug* Debug
)

 Appends a linear staircase to the Target Mesh.
Public function Static UDynamicMesh *

AppendPolygonListTriangulation ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
FGeometryScriptGeneralPolygonList PolygonList,
FGeometryScriptPolygonsTriangulationOptions TriangulationOptions,
bool& bTriangulationError,
UGeometryScriptDebug* Debug
)

 Generates a Delaunay Triangulation of the provided Polygon List, and appends it to the Target Mesh.
Public function Static UDynamicMesh *

[AppendRectangle_Compatibility_50](API\Plugins\GeometryScriptingCore\GeometryScript\UGeometryScriptL-_16\AppendRectangle-) ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float DimensionX,
float DimensionY,
int32 StepsWidth,
int32 StepsHeight,
UGeometryScriptDebug* Debug
)

 Backwards-Compatibility implementations.
Public function Static UDynamicMesh *

AppendRectangleXY ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float DimensionX,
float DimensionY,
int32 StepsWidth,
int32 StepsHeight,
UGeometryScriptDebug* Debug
)

 Appends a planar Rectangle to a Dynamic Mesh.
Public function Static UDynamicMesh *

AppendRevolvePath ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
const TArray< FVector2D >& PathVertices,
FGeometryScriptRevolveOptions RevolveOptions,
int32 Steps,
bool bCapped,
UGeometryScriptDebug* Debug
)

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

AppendRevolvePolygon ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
const TArray< FVector2D >& PolygonVertices,
FGeometryScriptRevolveOptions RevolveOptions,
float Radius,
int32 Steps,
UGeometryScriptDebug* Debug
)

 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.
Public function Static UDynamicMesh *

AppendRoundRectangle_Compatibility_5_0 ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float DimensionX,
float DimensionY,
float CornerRadius,
int32 StepsWidth,
int32 StepsHeight,
int32 StepsRound,
UGeometryScriptDebug* Debug
)

 5.0 Preview 1 Compatibility version of AppendRoundRectangleXY.
Public function Static UDynamicMesh *

AppendRoundRectangleXY ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float DimensionX,
float DimensionY,
float CornerRadius,
int32 StepsWidth,
int32 StepsHeight,
int32 StepsRound,
UGeometryScriptDebug* Debug
)

 Appends a planar Rectangle with Rounded Corners (RoundRect) to the Target Mesh.
Public function Static UDynamicMesh *

AppendSimpleExtrudePolygon ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
const TArray< FVector2D >& PolygonVertices,
float Height,
int32 HeightSteps,
bool bCapped,
EGeometryScriptPrimitiveOriginMode Origin,
UGeometryScriptDebug* Debug
)

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

AppendSimpleSweptPolygon ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
const TArray< FVector2D >& PolygonVertices,
const TArray< FVector >& SweepPath,
bool bLoop,
bool bCapped,
float StartScale,
float EndScale,
UGeometryScriptDebug* Debug
)

 Sweeps a 2D polygon along an arbitrary 3D path, appending the result to the Target Mesh.
Public function Static UDynamicMesh *

AppendSphereBox ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float Radius,
int32 StepsX,
int32 StepsY,
int32 StepsZ,
EGeometryScriptPrimitiveOriginMode Origin,
UGeometryScriptDebug* Debug
)

 Appends a 3D sphere triangulated using box topology to the Target Mesh.
Public function Static UDynamicMesh *

AppendSphereLatLong ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
float Radius,
int32 StepsPhi,
int32 StepsTheta,
EGeometryScriptPrimitiveOriginMode Origin,
UGeometryScriptDebug* Debug
)

 Appends a 3D Sphere triangulated using latitude/longitude topology to the Target Mesh.
Public function Static UDynamicMesh *

AppendSpiralRevolvePolygon ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
const TArray< FVector2D >& PolygonVertices,
FGeometryScriptRevolveOptions RevolveOptions,
float Radius,
int Steps,
float RisePerRevolution,
UGeometryScriptDebug* Debug
)

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

AppendSweepPolygon ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
const TArray< FVector2D >& PolygonVertices,
const TArray< FTransform >& SweepPath,
bool bLoop,
bool bCapped,
float StartScale,
float EndScale,
float RotationAngleDeg,
UGeometryScriptDebug* Debug
)

 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).
Public function Static UDynamicMesh *

AppendSweepPolyline ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
const TArray< FVector2D >& PolylineVertices,
const TArray< FTransform >& SweepPath,
const TArray< float >& PolylineTexParamU,
const TArray< float >& SweepPathTexParamV,
bool bLoop,
float StartScale,
float EndScale,
float RotationAngleDeg,
UGeometryScriptDebug* Debug
)

 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).
Public function Static UDynamicMesh *

AppendTorus ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
FGeometryScriptRevolveOptions RevolveOptions,
float MajorRadius,
float MinorRadius,
int32 MajorSteps,
int32 MinorSteps,
EGeometryScriptPrimitiveOriginMode Origin,
UGeometryScriptDebug* Debug
)

 Appends a 3D torus (donut) or partial torus to the Target Mesh.
Public function Static UDynamicMesh *

AppendTriangulatedPolygon ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
const TArray< FVector2D >& PolygonVertices,
bool bAllowSelfIntersections,
UGeometryScriptDebug* Debug
)

 Appends a Triangulated Polygon to the Target Mesh.
Public function Static UDynamicMesh *

AppendVoronoiDiagram2D ( UDynamicMesh* TargetMesh,
FGeometryScriptPrimitiveOptions PrimitiveOptions,
FTransform Transform,
const TArray< FVector2D >& VoronoiSites,
FGeometryScriptVoronoiOptions VoronoiOptions,
UGeometryScriptDebug* Debug
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page