TSegment3

3D Line Segment stored as Center point, normalized Direction vector, and scalar Extent

Windows
MacOS
Linux

References

Module

GeometricObjects

Header

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

Include

#include "SegmentTypes.h"

Syntax

template<typename T>
struct TSegment3

Remarks

3D Line Segment stored as Center point, normalized Direction vector, and scalar Extent

Variables

Name Description

Public variable

FVector3< T >

 

Center

Center point of segment

Public variable

FVector3< T >

 

Direction

Normalized Direction vector of segment

Public variable

T

 

Extent

Extent of segment, which is half the total length

Constructors

Name Description

Public function

TSegment3()

Public function

TSegment3

(
    const FVector3< T >& Point0,
    const FVector3< T >& Point1
)

Construct a Segment from two Points

Public function

TSegment3

(
    const FVector3< T >& CenterIn,
    const FVector3< T >& DirectionIn,
    T ExtentIn
)

Construct a segment from a Center Point, normalized Direction, and scalar Extent

Functions

Name Description

Public function Const

T

 

DistanceSquared

(
    const FVector3< T >& Point,
    T& DistParameterOut
)

Public function Const

T

 

DistanceSquared

(
    const FVector3< T >& Point
)

Public function Const

FVector3< T ...

 

EndPoint()

Public function Const

TAxisAligned...

 

GetBounds

(
    T SegmentRadius
)

Public function Const

TAxisAligned...

 

GetBounds()

Public function Const

FVector3< T ...

 

GetPointFromIndex

(
    int i
)

Public function Const

T

 

Length()

Public function Const

FVector3< T ...

 

NearestPoint

(
    const FVector3< T >& QueryPoint
)

Public function Const

FVector3< T ...

 

PointAt

(
    T DistanceParameter
)

Public function Const

FVector3< T ...

 

PointBetween

(
    T UnitParameter
)

Public function Const

T

 

Project

(
    const FVector3< T >& QueryPoint
)

Public function Const

T

 

ProjectUnitRange

(
    const FVector3< T >& QueryPoint
)

Public function

void

 

Reverse()

Reverse the segment

Public function

void

 

SetEndPoint

(
    const FVector3< T >& Point
)

Update the Segment with a new end point

Public function

void

 

SetStartPoint

(
    const FVector3< T >& Point
)

Update the Segment with a new start point

Public function Const

FVector3< T ...

 

StartPoint()

Protected function

void

 

update_from_endpoints

(
    const FVector3< T >& p0,
    const FVector3< T >& p1
)

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