1. Epic GamesDeveloper
  3. UGeometryScriptLibrary_PolygonListFunctions

UGeometryScriptLibrary_PolygonListFunctions

API > API/Plugins > API/Plugins/GeometryScriptingCore

   
Name UGeometryScriptLibrary_PolygonListFunctions
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_PolygonList"))  
class UGeometryScriptLibrary_PolygonListFunctions : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bFixHoleOrientations const TArray< FGeometryScriptSimplePolygon > bool   GeometryScript/PolygonFunctions.h  
bFixHoleOrientations FGeometryScriptSimplePolygon const TArray< FGeometryScriptSimplePolygon > bool   GeometryScript/PolygonFunctions.h  
HolePolygons const TArray< FGeometryScriptSimplePolygon > &   GeometryScript/PolygonFunctions.h  
HolePolygons FGeometryScriptSimplePolygon const TArray< FGeometryScriptSimplePolygon > &   GeometryScript/PolygonFunctions.h  
OuterPolygon FGeometryScriptSimplePolygon   GeometryScript/PolygonFunctions.h  

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void AppendPolygonList ( UPARAM(ref) FGeometryScriptGeneralPolygonList& PolygonList,
FGeometryScriptGeneralPolygonList PolygonsToAppend
)

 Append the polygons in 'Polygons to Append' to Polygon List GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static FGeometryScriptGeneralPolygonList CreatePolygonsFromOpenPolyPathsOffset ( TArray< FGeometryScriptPolyPath > PolyPaths,
FGeometryScriptOpenPathOffsetOptions OffsetOptions,
double Offset,
bool& bOperationSuccess,
bool bCopyInputOnFailure
)

 Apply an offset to a set of open 2D PolyPaths, generating closed polygons as a result GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"

static FGeometryScriptGeneralPolygonList CreatePolygonsFromPathOffset ( TArray< FVector2D > Path,
FGeometryScriptOpenPathOffsetOptions OffsetOptions,
double Offset,
bool& bOperationSuccess,
bool bCopyInputOnFailure
)

 Apply an offset to a single open 2D path, generating closed polygons as a result GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"

static double GetPolygonArea ( FGeometryScriptGeneralPolygonList PolygonList,
bool& bValidIndex,
int32 PolygonIndex
)

 Returns the area enclosed by a specified Polygon in a Polygon List. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod, DisplayName="Get Area of Polygon in List")

static FBox2D GetPolygonBounds ( FGeometryScriptGeneralPolygonList PolygonList,
bool& bValidIndex,
int32 PolygonIndex
)

 Returns the bounding box of a Polygon. Returns an empty, invalid box for an invalid PolygonIndex. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static int32 GetPolygonCount ( FGeometryScriptGeneralPolygonList PolygonList
)

 Returns the number of polygons in the Polygon List GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static int32 GetPolygonHoleCount ( FGeometryScriptGeneralPolygonList PolygonList,
bool& bValidIndex,
int32 PolygonIndex
)

 Returns the number of holes in a Polygon. Returns zero for an invalid PolygonIndex. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static double GetPolygonListArea ( FGeometryScriptGeneralPolygonList PolygonList
)

 Returns the area enclosed by a Polygon List GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static FBox2D GetPolygonListBounds ( FGeometryScriptGeneralPolygonList PolygonList
)

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

static FVector2D GetPolygonVertex ( FGeometryScriptGeneralPolygonList PolygonList,
bool& bIsValidVertex,
int32 VertexIndex,
int32 PolygonIndex,
int32 HoleIndex
)

 Returns the specified vertex of a Polygon either of the outer polygon, if HoleIndex is -1, or specified inner hole. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static int32 GetPolygonVertexCount ( FGeometryScriptGeneralPolygonList PolygonList,
bool& bValidIndices,
int32 PolygonIndex,
int32 HoleIndex
)

 Returns the number of vertices in a Polygon's outer shape, if HoleIndex is -1, or in the specified inner hole. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static void GetPolygonVertices ( FGeometryScriptGeneralPolygonList PolygonList,
TArray< FVector2D >& OutVertices,
bool& bValidIndices,
int32 PolygonIndex,
int32 HoleIndex
)

 Returns the vertices of a Polygon either of the outer polygon, if HoleIndex is -1, or specified inner hole. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static FGeometryScriptSimplePolygon GetSimplePolygon ( FGeometryScriptGeneralPolygonList PolygonList,
bool& bValidIndices,
int32 PolygonIndex,
int32 HoleIndex
)

 Returns a specified Simple Polygon from a Polygon List either the outer polygon, if HoleIndex is -1, or specified inner hole. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static FGeometryScriptGeneralPolygonList PolygonsDifference ( FGeometryScriptGeneralPolygonList PolygonList,
FGeometryScriptGeneralPolygonList PolygonsToSubtract
)

 Compute difference of Polygon List and Polygons to Subtract GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static FGeometryScriptGeneralPolygonList PolygonsExclusiveOr ( FGeometryScriptGeneralPolygonList PolygonList,
FGeometryScriptGeneralPolygonList PolygonsToExclusiveOr
)

 Compute exclusive or of Polygon List and Polygons to Exclusive Or GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static FGeometryScriptGeneralPolygonList PolygonsIntersection ( FGeometryScriptGeneralPolygonList PolygonList,
FGeometryScriptGeneralPolygonList PolygonsToIntersect
)

 Compute intersection of Polygon List and Polygons to Intersect GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static FGeometryScriptGeneralPolygonList PolygonsMorphologyClose ( FGeometryScriptGeneralPolygonList PolygonList,
FGeometryScriptPolygonOffsetOptions OffsetOptions,
double Offset,
bool& bOperationSuccess,
bool bCopyInputOnFailure
)

 Apply a morphological "close" operator to a list of closed polygons first offsetting by +Offset, then by -Offset. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static FGeometryScriptGeneralPolygonList PolygonsMorphologyOpen ( FGeometryScriptGeneralPolygonList PolygonList,
FGeometryScriptPolygonOffsetOptions OffsetOptions,
double Offset,
bool& bOperationSuccess,
bool bCopyInputOnFailure
)

 Apply a morphological "open" operator to a list of closed polygons first offsetting by -Offset, then by +Offset. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static FGeometryScriptGeneralPolygonList PolygonsOffset ( FGeometryScriptGeneralPolygonList PolygonList,
FGeometryScriptPolygonOffsetOptions OffsetOptions,
double Offset,
bool& bOperationSuccess,
bool bCopyInputOnFailure
)

 Apply a single offset to a list of closed polygons GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static FGeometryScriptGeneralPolygonList PolygonsOffsets ( FGeometryScriptGeneralPolygonList PolygonList,
FGeometryScriptPolygonOffsetOptions OffsetOptions,
double FirstOffset,
double SecondOffset,
bool& bOperationSuccess,
bool bCopyInputOnFailure
)

 Apply two offsets in sequence to a list of closed polygons GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static FGeometryScriptGeneralPolygonList PolygonsUnion ( FGeometryScriptGeneralPolygonList PolygonList,
bool bCopyInputOnFailure
)

 Compute union of all polygons in Polygon List. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Create a Polygon List of a single Polygon, with optional holes GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod, AutoCreateRefTerm="HolePolygons")

static static UPARAM ( DisplayName
)

 Add Polygon to a Polygon List, with optional holes. Returns index of the added polygon. GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"
  • Meta=(ScriptMethod, AutoCreateRefTerm="HolePolygons")

static static UPARAM ( DisplayName
) const

 Create a Polygon List from an array of Simple Polygons GeometryScript/PolygonFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolygonList"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page