1. Epic GamesDeveloper
  3. UGeometryScriptLibrary_SimplePolygonFunctions

UGeometryScriptLibrary_SimplePolygonFunctions

API > API/Plugins > API/Plugins/GeometryScriptingCore

   
Name UGeometryScriptLibrary_SimplePolygonFunctions
Type class
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/PolygonFunctions.h
Include Path #include "GeometryScript/PolygonFunctions.h"

Syntax

UCLASS (MinimalAPI, Meta=(ScriptName="GeometryScript_SimplePolygon"))  
class UGeometryScriptLibrary_SimplePolygonFunctions : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Position FVector2D   GeometryScript/PolygonFunctions.h  

Functions

Static

Name Remarks Include Path Unreal Specifiers

static FGeometryScriptSimplePolygon Conv_ArrayOfVector2DToGeometryScriptSimplePolygon ( const TArray< FVector2D >& PathVertices
)

 Returns a Polygon created from an array of 2D position vectors. GeometryScript/PolygonFunctions.h
  • BlueprintPure
  • Meta=(DisplayName="Array Of Vector2D To Simple Polygon", CompactNodeTitle="->", BlueprintAutocast)
  • Category="GeometryScript|SimplePolygon"

static FGeometryScriptSimplePolygon Conv_ArrayToGeometryScriptSimplePolygon ( const TArray< FVector >& PathVertices
)

 Returns a Polygon created from an array of 3D position vectors, ignoring the Z coordinate. GeometryScript/PolygonFunctions.h
  • BlueprintPure
  • Meta=(DisplayName="Array Of Vector To Simple Polygon", CompactNodeTitle="->", BlueprintAutocast)
  • Category="GeometryScript|SimplePolygon"

static TArray< FVector > Conv_GeometryScriptSimplePolygonToArray ( FGeometryScriptSimplePolygon Polygon
)

 Returns an array of 3D vectors with the Polygon vertex locations, with Z coordinate set to zero. GeometryScript/PolygonFunctions.h
  • BlueprintPure
  • Meta=(DisplayName="Simple Polygon To Array Of Vector", CompactNodeTitle="->", BlueprintAutocast)
  • Category="GeometryScript|SimplePolygon"

static TArray< FVector2D > Conv_GeometryScriptSimplePolygonToArrayOfVector2D ( FGeometryScriptSimplePolygon Polygon
)

 Returns an array of 2D Vectors with the Polygon vertex locations. GeometryScript/PolygonFunctions.h
  • BlueprintPure
  • Meta=(DisplayName="Simple Polygon To Array Of Vector2D", CompactNodeTitle="->", BlueprintAutocast)
  • Category="GeometryScript|SimplePolygon"

static void ConvertSplineToPolygon ( const USplineComponent* Spline,
FGeometryScriptSimplePolygon& Polygon,
FGeometryScriptSplineSamplingOptions SamplingOptions,
EGeometryScriptAxis DropAxis
)

 Sample positions from a USplineComponent into a Simple Polyon, based on the given SamplingOptions GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SimplePolygon"

static double GetPolygonArcLength ( FGeometryScriptSimplePolygon Polygon
)

 Returns the arc length of a Simple Polygon GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SimplePolygon"
  • Meta=(ScriptMethod)

static double GetPolygonArea ( FGeometryScriptSimplePolygon Polygon
)

 Returns the area enclosed by a Simple Polygon GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SimplePolygon"
  • Meta=(ScriptMethod, DisplayName="Get Simple Polygon Area")

static FBox2D GetPolygonBounds ( FGeometryScriptSimplePolygon Polygon
)

 Returns the bounding box of a Simple Polygon GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SimplePolygon"
  • Meta=(ScriptMethod)

static FVector2D GetPolygonTangent ( FGeometryScriptSimplePolygon Polygon,
int32 VertexIndex,
bool& bPolygonIsEmpty
)

 Returns a vertex's tangent of a Simple Polygon. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SimplePolygon"
  • Meta=(ScriptMethod)

static FVector2D GetPolygonVertex ( FGeometryScriptSimplePolygon Polygon,
int32 VertexIndex,
bool& bPolygonIsEmpty
)

 Returns the specified vertex of a Simple Polygon. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SimplePolygon"
  • Meta=(ScriptMethod)

static int32 GetPolygonVertexCount ( FGeometryScriptSimplePolygon Polygon
)

 Returns the number of vertices in a Simple Polygon GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SimplePolygon"
  • Meta=(ScriptMethod)

static void SetPolygonVertex ( UPARAM(ref) FGeometryScriptSimplePolygon Polygon,
int32 VertexIndex,
FVector2D Position,
bool& bPolygonIsEmpty
)

 Set the specified vertex of a Simple Polygon. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SimplePolygon"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Set the specified vertex of a Simple Polygon. Returns the index of the added vertex. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SimplePolygon"
  • Meta=(ScriptMethod)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page