1. Epic GamesDeveloper
  3. UGeometryScriptLibrary_PolyPathFunctions

UGeometryScriptLibrary_PolyPathFunctions

API > API/Plugins > API/Plugins/GeometryScriptingCore

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

Syntax

UCLASS (MinimalAPI, Meta=(ScriptName="GeometryScript_PolyPath"))  
class UGeometryScriptLibrary_PolyPathFunctions : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIncludeScale TArray< FTransform > TArray< double > FGeometryScriptSplineSamplingOptionsFTransform bool   GeometryScript/PolyPathFunctions.h  
DropAxis EGeometryScriptAxis   GeometryScript/PolyPathFunctions.h  
EndAngle float int float float   GeometryScript/PolyPathFunctions.h  
Frames TArray< FTransform > &   GeometryScript/PolyPathFunctions.h  
FrameTimes TArray< FTransform > TArray< double > &   GeometryScript/PolyPathFunctions.h  
NumPoints float int   GeometryScript/PolyPathFunctions.h  
Radius float   GeometryScript/PolyPathFunctions.h  
RelativeTransform TArray< FTransform > TArray< double > FGeometryScriptSplineSamplingOptionsFTransform   GeometryScript/PolyPathFunctions.h  
SamplingOptions TArray< FTransform > TArray< double > FGeometryScriptSplineSamplingOptions   GeometryScript/PolyPathFunctions.h  
StartAngle float int float   GeometryScript/PolyPathFunctions.h  

Functions

Static

Name Remarks Include Path Unreal Specifiers
Returns a PolyPath created from an array of 2D position vectors. GeometryScript/PolyPathFunctions.h
  • BlueprintPure
  • Meta=(DisplayName="Array Of Vector2D To PolyPath", CompactNodeTitle="->", BlueprintAutocast)
  • Category="GeometryScript|PolyPath"

static FGeometryScriptPolyPath Conv_ArrayToGeometryScriptPolyPath ( const TArray< FVector >& PathVertices
)

 Returns a PolyPath created from an array of 3D position vectors. GeometryScript/PolyPathFunctions.h
  • BlueprintPure
  • Meta=(DisplayName="Array Of Vector To PolyPath", CompactNodeTitle="->", BlueprintAutocast)
  • Category="GeometryScript|PolyPath"

static TArray< FVector > Conv_GeometryScriptPolyPathToArray ( FGeometryScriptPolyPath PolyPath
)

 Returns an array of 3D vectors with the PolyPath vertex locations. GeometryScript/PolyPathFunctions.h
  • BlueprintPure
  • Meta=(DisplayName="PolyPath To Array Of Vector", CompactNodeTitle="->", BlueprintAutocast)
  • Category="GeometryScript|PolyPath"

static TArray< FVector2D > Conv_GeometryScriptPolyPathToArrayOfVector2D ( FGeometryScriptPolyPath PolyPath
)

 Returns an array of 2D Vectors with the PolyPath vertex locations projected onto the XY plane. GeometryScript/PolyPathFunctions.h
  • BlueprintPure
  • Meta=(DisplayName="PolyPath To Array Of Vector2D", CompactNodeTitle="->", BlueprintAutocast)
  • Category="GeometryScript|PolyPath"

static void ConvertArrayOfVector2DToPolyPath ( const TArray< FVector2D >& VertexArray,
FGeometryScriptPolyPath& PolyPath
)

 Creates a PolyPath from an array of 2D position vectors. GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"

static void ConvertArrayToPolyPath ( const TArray< FVector >& VertexArray,
FGeometryScriptPolyPath& PolyPath
)

 Creates a PolyPath from an array of 3D position vectors. GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"

static void ConvertPolyPathToArray ( FGeometryScriptPolyPath PolyPath,
TArray< FVector >& VertexArray
)

 Populates an array of 3D vectors with the PolyPath vertex locations. GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"
  • Meta=(ScriptMethod)

static void ConvertPolyPathToArrayOfVector2D ( FGeometryScriptPolyPath PolyPath,
TArray< FVector2D >& VertexArray
)

 Creates an array of 2D Vectors with the PolyPath vertex locations projected onto the XY plane. GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"
  • Meta=(ScriptMethod)

static void ConvertSplineToPolyPath ( const USplineComponent* Spline,
FGeometryScriptPolyPath& PolyPath,
FGeometryScriptSplineSamplingOptions SamplingOptions
)

 Sample positions from a USplineComponent into a PolyPath, based on the given SamplingOptions GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"

static int32 GetNearestVertexIndex ( FGeometryScriptPolyPath PolyPath,
FVector Point
)

 Find the index of the vertex closest to a given point. Returns -1 if the PolyPath has no vertices. GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"
  • Meta=(ScriptMethod)

static double GetPolyPathArcLength ( FGeometryScriptPolyPath PolyPath
)

 Returns the length of the PolyPath. GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"
  • Meta=(ScriptMethod)

static int GetPolyPathLastIndex ( FGeometryScriptPolyPath PolyPath
)

 Returns the index of the last vertex in the PolyPath. GeometryScript/PolyPathFunctions.h
  • BlueprintPure
  • Category="GeometryScript|PolyPath"
  • Meta=(ScriptMethod)

static int GetPolyPathNumVertices ( FGeometryScriptPolyPath PolyPath
)

 Returns the number of vertices in the the PolyPath. GeometryScript/PolyPathFunctions.h
  • BlueprintPure
  • Category="GeometryScript|PolyPath"
  • Meta=(ScriptMethod)

static FVector GetPolyPathTangent ( FGeometryScriptPolyPath PolyPath,
int Index,
bool& bIsValidIndex
)

 Returns the local tangent vector of the PolyPath at the specified vertex index. GeometryScript/PolyPathFunctions.h
  • BlueprintPure
  • Category="GeometryScript|PolyPath"
  • Meta=(ScriptMethod)

static FVector GetPolyPathVertex ( FGeometryScriptPolyPath PolyPath,
int Index,
bool& bIsValidIndex
)

 Returns the 3D position of the requested vertex in the PolyPath. GeometryScript/PolyPathFunctions.h
  • BlueprintPure
  • Category="GeometryScript|PolyPath"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Create a 2D, flattened copy of the path by dropping the given axis, and using the other two coordinates as the new X, Y coordinates. GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"
  • Meta=(ScriptMethod, DisplayName="Flatten To 2D On Axis")

static static UPARAM ( DisplayName
)

 Create a closed circle around the origin on the XY plane, then transformed by Transform. GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"

static static UPARAM ( DisplayName
)

 Create an open arc around the origin on the XY plane, then transformed by Transform. GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"

static static UPARAM ( DisplayName
)

 Create a closed circle on the XY plane around the given Center. GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"

static static UPARAM ( DisplayName
)

 Create an open arc on the XY plane around the given Center. GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"

static static UPARAM ( DisplayName
) const

 Sample a USplineComponent into a list of FTransforms, based on the given SamplingOptions. GeometryScript/PolyPathFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|PolyPath"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page