FRay

3D Ray represented by Origin and (normalized) Direction

Windows
MacOS
Linux

References

Module

Core

Header

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

Include

#include "Math/Ray.h"

Syntax

class FRay

Remarks

3D Ray represented by Origin and (normalized) Direction

Variables

Name Description

Public variable

FVector

 

Direction

Ray direction vector (always normalized)

Public variable

FVector

 

Origin

Ray origin point

Constructors

Name Description

Public function

FRay()

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

Public function

FRay

(
    const FVector& Origin,
    const FVector& Direction,
    bool bDirectionIsNormalized
)

Initialize Ray with origin and direction

Functions

Name Description

Public function Const

FVector

 

ClosestPoint

(
    const FVector& Point
)

Find closest point on ray to query point

Public function Const

float

 

DistSquared

(
    const FVector& Point
)

Find minimum squared distance from query point to ray

Public function Const

float

 

GetParameter

(
    const FVector& Point
)

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

Public function Const

FVector

 

PointAt

(
    float RayParameter
)

Calculate position on ray at given distance/parameter
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss