1. Epic GamesDeveloper
  3. UGeometryScriptLibrary_PolyPathFunctions

UGeometryScriptLibrary_PolyPathFunctions

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

Inheritance Hierarchy

  • UBlueprintFunctionLibrary
  • UGeometryScriptLibrary_PolyPathFunctions

References

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

Syntax

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

Variables

  Type Name Description
Public variable TArray< FTransform > TArray< double > FGeometryScriptSplineSamplingOptionsFTransform bool bIncludeScale  
Public variable EGeometryScriptAxis DropAxis  
Public variable float int float float EndAngle  
Public variable TArray< FTransform > & Frames  
Public variable TArray< FTransform > TArray< double > & FrameTimes  
Public variable float int NumPoints  
Public variable float Radius  
Public variable TArray< FTransform > TArray< double > FGeometryScriptSplineSamplingOptionsFTransform RelativeTransform  
Public variable TArray< FTransform > TArray< double > FGeometryScriptSplineSamplingOptions SamplingOptions  
Public variable float int float StartAngle  

Functions

  Type Name Description
Public function Static UFunction BlueprintPure, Category, Meta FGeometryScriptPolyPath Returns a PolyPath created from an array of 2D position vectors.
Public function Static UFunction BlueprintPure, Category, Meta FGeometryScriptPolyPath Returns a PolyPath created from an array of 3D position vectors.
Public function Static UFunction BlueprintPure, Category, Meta TArray< FVector > Returns an array of 3D vectors with the PolyPath vertex locations.
Public function Static UFunction BlueprintPure, Category, Meta TArray< FVector2D > Returns an array of 2D Vectors with the PolyPath vertex locations projected onto the XY plane.
Public function Static UFunction BlueprintCallable, Category void Creates a PolyPath from an array of 2D position vectors.
Public function Static UFunction BlueprintCallable, Category void

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

 Creates a PolyPath from an array of 3D position vectors.
Public function Static UFunction BlueprintCallable, Category, Meta void Populates an array of 3D vectors with the PolyPath vertex locations.
Public function Static UFunction BlueprintCallable, Category, Meta void Creates an array of 2D Vectors with the PolyPath vertex locations projected onto the XY plane.
Public function Static UFunction BlueprintCallable, Category void

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

 Sample positions from a USplineComponent into a PolyPath, based on the given SamplingOptions
Public function Static UFunction BlueprintCallable, Category, Meta int32 Find the index of the vertex closest to a given point. Returns -1 if the PolyPath has no vertices.
Public function Static UFunction BlueprintCallable, Category, Meta double Returns the length of the PolyPath.
Public function Static UFunction BlueprintPure, Category, Meta int Returns the index of the last vertex in the PolyPath.
Public function Static UFunction BlueprintPure, Category, Meta int Returns the number of vertices in the the PolyPath.
Public function Static UFunction BlueprintPure, Category, Meta FVector

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

 Returns the local tangent vector of the PolyPath at the specified vertex index.
Public function Static UFunction BlueprintPure, Category, Meta FVector

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

 Returns the 3D position of the requested vertex in the PolyPath.
Public function Static UFunction BlueprintCallable, Category, Meta static 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.
Public function Static UFunction BlueprintCallable, Category static Create a closed circle around the origin on the XY plane, then transformed by Transform.
Public function Static UFunction BlueprintCallable, Category static Create an open arc around the origin on the XY plane, then transformed by Transform.
Public function Static UFunction BlueprintCallable, Category static Create a closed circle on the XY plane around the given Center.
Public function Static UFunction BlueprintCallable, Category static Create an open arc on the XY plane around the given Center.
Public function Static Const UFunction BlueprintCallable, Category static Sample a USplineComponent into a list of FTransforms, based on the given SamplingOptions.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page