TRay

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Math/Ray.h

Include

#include "Math/Ray.h"

Syntax

template<typename T>
struct TRay

Variables

Name Description

Public variable

TVector< T >

 

Direction

Ray direction vector (always normalized)

Public variable

TVector< T >

 

Origin

Ray origin point

Constructors

Name Description

Public function

TRay()

Default constructor initializes ray to Zero origin and Z-axis direction

Public function

TRay

(
    const TRay< FArg >& From
)

Conversion to other type.

Public function

TRay

(
    const TVector< T >& Origin,
    const TVector< T >& Direction,
    bool bDirectionIsNormalized
)

Initialize Ray with origin and direction

Functions

Name Description

Public function Const

TVector< T >

 

ClosestPoint

(
    const TVector< T >& Point
)

Find closest point on ray to query point

Public function Const

T

 

Dist

(
    const TVector< T >& Point
)

Find minimum distance from query point to ray

Public function Const

T

 

DistSquared

(
    const TVector< T >& Point
)

Find minimum squared distance from query point to ray

Public function Const

T

 

GetParameter

(
    const TVector< T >& Point
)

Calculate ray parameter (distance from origin to closest point) for query Point

Public function Const

TVector< T >

 

PointAt

(
    T RayParameter
)

Calculate position on ray at given distance/parameter

Typedefs

Name

Description

FReal