unreal.GeometryScriptPolyPath

class unreal.GeometryScriptPolyPath

Bases: StructBase

Geometry Script Poly Path

C++ Source:

• Plugin: GeometryScripting

• Module: GeometryScriptingCore

• File: GeometryScriptTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

• closed_loop (bool): [Read-Write] Closed Loop

convert_poly_path_to_array() → Array[Vector]

Convert Poly Path to Array

Returns:

vertex_array (Array[Vector]):

Return type:

Array[Vector]

convert_poly_path_to_array_of_vector2d() → Array[Vector2D]

Convert Poly Path to Array Of Vector 2D

Returns:

vertex_array (Array[Vector2D]):

Return type:

Array[Vector2D]

flatten_to2d_on_axis(drop_axis=GeometryScriptAxis.Z) → GeometryScriptPolyPath

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.

Parameters:

drop_axis (GeometryScriptAxis) –

Return type:

GeometryScriptPolyPath

get_nearest_vertex_index(point) → int32

Find the index of the vertex closest to a given point. Returns -1 if path has no vertices.

Parameters:

point (Vector) –

Return type:

int32

get_poly_path_arc_length() → double

Get Poly Path Arc Length

Return type:

double

get_poly_path_last_index() → int32

Get Poly Path Last Index

Return type:

int32

get_poly_path_num_vertices() → int32

Get Poly Path Num Vertices

Return type:

int32

get_poly_path_tangent(index) -> (Vector, is_valid_index=bool)

Get Poly Path Tangent

Parameters:

index (int32) –

Returns:

is_valid_index (bool):

Return type:

bool

get_poly_path_vertex(index) -> (Vector, is_valid_index=bool)

Get Poly Path Vertex

Parameters:

index (int32) –

Returns:

is_valid_index (bool):

Return type:

bool