1. Epic GamesDeveloper
  3. UGeometryScriptLibrary_PolygonListFunctions

UGeometryScriptLibrary_PolygonListFunctions

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

Inheritance Hierarchy

  • UBlueprintFunctionLibrary
  • UGeometryScriptLibrary_PolygonListFunctions

References

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

Syntax

UCLASS (Meta=(ScriptName="GeometryScript_PolygonList"))  
class UGeometryScriptLibrary_PolygonListFunctions : public UBlueprintFunctionLibrary

Variables

  Type Name Description
Public variable const TArray< FGeometryScriptSimplePolygon > bool bFixHoleOrientations  
Public variable FGeometryScriptSimplePolygon const TArray< FGeometryScriptSimplePolygon > bool bFixHoleOrientations  
Public variable const TArray< FGeometryScriptSimplePolygon > & HolePolygons  
Public variable FGeometryScriptSimplePolygon const TArray< FGeometryScriptSimplePolygon > & HolePolygons  
Public variable FGeometryScriptSimplePolygon OuterPolygon  

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta void Append the polygons in 'Polygons to Append' to Polygon List
Public function Static UFunction BlueprintCallable, Category 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
Public function Static UFunction BlueprintCallable, Category 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
Public function Static UFunction BlueprintCallable, Category, Meta double

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

 Returns the area enclosed by a Polygon. Returns zero for an invalid PolygonIndex.
Public function Static UFunction BlueprintCallable, Category, Meta FBox2D

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

 Returns the bounding box of a Polygon. Returns an empty, invalid box for an invalid PolygonIndex.
Public function Static UFunction BlueprintCallable, Category, Meta int32 Returns the number of polygons in the Polygon List
Public function Static UFunction BlueprintCallable, Category, Meta int32

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

 Returns the number of holes in a Polygon. Returns zero for an invalid PolygonIndex.
Public function Static UFunction BlueprintCallable, Category, Meta double Returns the area enclosed by a Polygon
Public function Static UFunction BlueprintCallable, Category, Meta FBox2D Returns the bounding box of a Polygon
Public function Static UFunction BlueprintCallable, Category, Meta 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.
Public function Static UFunction BlueprintCallable, Category, Meta 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.
Public function Static UFunction BlueprintCallable, Category, Meta 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.
Public function Static UFunction BlueprintCallable, Category, Meta 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.
Public function Static UFunction BlueprintCallable, Category, Meta FGeometryScriptGeneralPolygonList Compute difference of Polygon List and Polygons to Subtract
Public function Static UFunction BlueprintCallable, Category, Meta FGeometryScriptGeneralPolygonList Compute exclusive or of Polygon List and Polygons to Exclusive Or
Public function Static UFunction BlueprintCallable, Category, Meta FGeometryScriptGeneralPolygonList Compute intersection of Polygon List and Polygons to Intersect
Public function Static UFunction BlueprintCallable, Category, Meta 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.
Public function Static UFunction BlueprintCallable, Category, Meta 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.
Public function Static UFunction BlueprintCallable, Category, Meta FGeometryScriptGeneralPolygonList

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

 Apply a single offset to a list of closed polygons
Public function Static UFunction BlueprintCallable, Category, Meta 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
Public function Static UFunction BlueprintCallable, Category, Meta FGeometryScriptGeneralPolygonList

PolygonsUnion ( FGeometryScriptGeneralPolygonList PolygonList,
bool bCopyInputOnFailure
)

 Compute union of all polygons in Polygon List.
Public function Static UFunction BlueprintCallable, Category, Meta static Create a Polygon List of a single Polygon, with optional holes
Public function Static UFunction BlueprintCallable, Category, Meta static Add Polygon to a Polygon List, with optional holes. Returns index of the added polygon.
Public function Static Const UFunction BlueprintCallable, Category static Create a Polygon List from an array of Simple Polygons

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page