1. Epic GamesDeveloper
  3. TSegment2

TSegment2

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

API > API/Runtime > API/Runtime/GeometryCore

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

   
Name TSegment2
Type struct
Header File /Engine/Source/Runtime/GeometryCore/Public/SegmentTypes.h
Include Path #include "SegmentTypes.h"
Source /Engine/Source/Runtime/GeometryCore/Public/Intersection/IntersectionQueries2.h

Syntax

template<typename T>  
struct TSegment2

Constructors

Name Remarks Include Path Unreal Specifiers
  SegmentTypes.h  

TSegment2 ( const TVector2< T >& Point0,
const TVector2< T >& Point1
)

 Construct a Segment from two Points SegmentTypes.h  

TSegment2 ( const TVector2< T >& CenterIn,
const TVector2< T >& DirectionIn,
T ExtentIn
)

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

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Center TVector2< T > Center point of segment SegmentTypes.h  
Direction TVector2< T > Normalized Direction vector of segment SegmentTypes.h  
Extent T Extent of segment, which is half the total length SegmentTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

T ConvertToUnitRange ( T DistanceParameter
) const

   SegmentTypes.h  

T DistanceSquared ( const TVector2< T >& Point,
T& DistParameterOut
) const

   SegmentTypes.h  

T DistanceSquared ( const TVector2< T >& Point
) const

   SegmentTypes.h  

TVector2< T > EndPoint()

   SegmentTypes.h  

TVector2< T > GetPointFromIndex ( int i
) const

   SegmentTypes.h  

int GetSide ( const TVector2< T >& QueryPoint,
T Tolerance
)

 Determine which side of the segment the query point lies on. SegmentTypes.h  

bool Intersects ( const TSegment2< T >& OtherSegment,
T DotThresh,
T IntervalThresh
) const

 Test if this segment intersects with OtherSegment. SegmentTypes.h  

T Length()

   SegmentTypes.h  

TVector2< T > NearestPoint ( const TVector2< T >& QueryPoint
) const

   SegmentTypes.h  

TVector2< T > PointAt ( T DistanceParameter
) const

   SegmentTypes.h  

TVector2< T > PointBetween ( T UnitParameter
) const

   SegmentTypes.h  

T Project ( const TVector2< T >& QueryPoint
) const

   SegmentTypes.h  

T ProjectUnitRange ( const TVector2< T >& QueryPoint
) const

   SegmentTypes.h  

void Reverse()

 Reverse the segment SegmentTypes.h  

void SetEndPoint ( const TVector2< T >& Point
)

 Update the Segment with a new end point SegmentTypes.h  

void SetStartPoint ( const TVector2< T >& Point
)

 Update the Segment with a new start point SegmentTypes.h  

TVector2< T > StartPoint()

   SegmentTypes.h  

int WhichSide ( const TVector2< T >& QueryPoint,
T Tolerance
)

 Determine which side of the segment the query point lies on. SegmentTypes.h  

Protected

Name Remarks Include Path Unreal Specifiers

void update_from_endpoints ( const TVector2< T >& p0,
const TVector2< T >& p1
)

 Update segment based on new endpoints SegmentTypes.h  

Static

Name Remarks Include Path Unreal Specifiers

static T FastDistanceSquared ( const TVector2< T >& StartPt,
const TVector2< T >& EndPt,
const TVector2< T >& QueryPt,
T Tolerance
)

 Calculate distance from QueryPoint to segment (StartPt,EndPt) SegmentTypes.h  

static int GetSide ( const TVector2< T >& StartPt,
const TVector2< T >& EndPt,
const TVector2< T >& QueryPt,
T Tolerance
)

 Determine which side of the segment the query point lies on. SegmentTypes.h  

static bool IsOnSegment ( const TVector2< T >& A,
const TVector2< T >& B,
const TVector2< T >& QueryPt,
T Tolerance
)

 Return true if QueryPt is on the segment between A and B. SegmentTypes.h  

static int WhichSide ( const TVector2< T >& StartPt,
const TVector2< T >& EndPt,
const TVector2< T >& QueryPt,
T Tolerance
)

 Determine which side of the segment the query point lies on. SegmentTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page