TPolyline3

[TPolyline3](API\Plugins\GeometricObjects\TPolyline3) represents a 3D polyline stored as a list of Vertices.

Windows
MacOS
Linux

References

Module

GeometricObjects

Header

/Engine/Plugins/Experimental/GeometryProcessing/Source/GeometricObjects/Public/Polyline3.h

Include

#include "Polyline3.h"

Syntax

template<typename T>
class TPolyline3

Remarks

TPolyline3 represents a 3D polyline stored as a list of Vertices.

Variables

Name Description

Protected variable

int

 

Timestamp

A counter that is incremented every time the polyline vertices are modified

Protected variable

TArray< FVector...

 

Vertices

The list of vertices of the polyline

Constructors

Name Description

Public function

TPolyline3()

Public function

TPolyline3

(
    const TPolyline3& Copy
)

Construct polyline that is a copy of another polyline

Public function

TPolyline3

(
    const TArray< FVector3< T >>& Vert...
)

Construct polyline with given list of vertices

Functions

Name Description

Public function

void

 

AppendVertex

(
    const FVector3< T >& Position
)

Add a vertex to the polyline

Public function

void

 

AppendVertices

(
    const TArray< FVector3< T >>& NewV...
)

Add a list of Vertices to the polyline

Public function Const

T

 

AverageEdgeLength()

Public function

void

 

Clear()

Discard all vertices of polyline

Public function Const

T

 

DistanceSquared

(
    const FVector3< T >& QueryPoint,
    int& NearestSegIndexOut,
    T& NearestSegParamOut
)

Calculate the squared distance from a point to the polyline

Public function Const

T

 

DistanceSquared

(
    const FVector3< T >& QueryPoint
)

Calculate the squared distance from a point to the polyline

Public function Const

const FVecto...

 

End()

Public function Const

TAxisAligned...

 

GetBounds()

Public function Const

TSegment3< T...

 

GetSegment

(
    int SegmentIndex
)

Public function Const

FVector3< T ...

 

GetSegmentPoint

(
    int SegmentIndex,
    T SegmentParam
)

Public function Const

FVector3< T ...

 

GetSegmentPointUnitParam

(
    int SegmentIndex,
    T SegmentParam
)

Public function Const

FVector3< T ...

 

GetTangent

(
    int VertexIndex
)

Get the tangent vector at a vertex of the polyline, which is the normalized vector from the previous vertex to the next vertex

Public function Const

int

 

GetTimestamp()

Public function Const

const TArray...

 

GetVertices()

Public function

void

 

IncrementTimestamp()

Explicitly increment the Timestamp

Public function Const

T

 

Length()

Public function

void

 

RemoveVertex

(
    int VertexIndex
)

Remove a vertex of the polyline (existing Vertices are shifted)

Public function

void

 

Reverse()

Reverse the order of the Vertices in the polyline (ie switch between Clockwise and CounterClockwise)

Public function Const

int

 

SegmentCount()

Public function Const

SegmentItera...

 

SegmentItr()

Public function Const

SegmentEnume...

 

Segments()

Public function

void

 

Set

(
    int VertexIndex,
    const FVector3< T >& Position
)

Set vertex at given index to a new Position

Public function

void

 

SetVertices

(
    const TArray< FVector3< T >>& NewV...
)

Replace the list of Vertices with a new list

Public function Const

void

 

SmoothSubdivide

(
    TPolyline3< T >& NewPolyline
)

Produce a new polyline that is smoother than this one

Public function Const

const FVecto...

 

Start()

Public function Const

int

 

VertexCount()

Operators

Name Description

Public function

FVector3< T ...

 

operator[]

(
    int Index
)

Get the vertex at a given index

Public function Const

const FVecto...

 

operator[]

(
    int Index
)

Get the vertex at a given index

Classes

Name

Description

Public class

SegmentEnumerable

Wrapper around SegmentIterator that has begin() and end() suitable for range-based for loop

Public class

SegmentIterator

SegmentIterator is used to iterate over the TSegment3 segments of the polyline

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss