1. Epic GamesDeveloper
  3. TPolyline3

TPolyline3

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

API > API/Runtime > API/Runtime/GeometryCore

Inheritance Hierarchy

References

   
Module GeometryCore
Header /Engine/Source/Runtime/GeometryCore/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

  Type Name Description
Protected variable TArray< TVector< T > > Vertices The list of vertices of the polyline

Constructors

  Type Name Description
Public function    
Public function  

TPolyline3 ( const TArray< TVector< T > >& VertexList
)

 Construct polyline with given list of vertices
Public function  

TPolyline3 ( const TVector< T >& Point0,
const TVector< T >& Point1
)

 Construct a single-segment polyline

Functions

  Type Name Description
Public function void

AppendVertex ( const TVector< T >& Position
)

 Add a vertex to the polyline
Public function void

AppendVertices ( const TArray< VectorType >& NewVertices
)

 Add a list of Vertices to the polyline
Public function void

AppendVertices ( const TArray< TVector< T > >& NewVertices
)

 Add a list of Vertices to the polyline
Public function Const T  
Public function void

Clear ()

 Discard all vertices of polyline
Public function Const T

DistanceSquared ( const TVector< T >& QueryPoint
)

 Calculate the squared distance from a point to the polyline
Public function Const T

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

 Calculate the squared distance from a point to the polyline
Public function Const const TVector< T > &

End ()

  
Public function Const TAxisAlignedBox3< T >  
Public function Const TSegment3< T >

GetSegment ( int SegmentIndex
)

  
Public function Const TVector< T >

GetSegmentPoint ( int SegmentIndex,
T SegmentParam
)

  
Public function Const TVector< T >

GetSegmentPointUnitParam ( int SegmentIndex,
T SegmentParam
)

  
Public function Const TVector< 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 const TArray< TVector< T > > &  
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  
Public function Const SegmentIterator  
Public function Const SegmentEnumerable  
Public function void

Set ( int VertexIndex,
const TVector< T >& Position
)

 Set vertex at given index to a new Position
Public function void

SetVertices ( const TArray< TVector< T > >& NewVertices
)

 Replace the list of Vertices with a new list
Public function void

Simplify ( T ClusterTolerance,
T LineDeviationTolerance
)

 Simplify the Polyline to reduce the vertex count
Public function Const void

SmoothSubdivide ( TPolyline3< T >& NewPolyline
)

 Produce a new polyline that is smoother than this one
Public function Const const TVector< T > &

Start ()

  
Public function Const int  

Operators

  Type Name Description
Public function TVector< T > &

operator[] ( int Index
)

 Get the vertex at a given index
Public function Const const TVector< T > &

operator[] ( int Index
)

 Get the vertex at a given index

Classes

  Type 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  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page