FInputDeviceRay

[FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) represents a 3D ray created based on an input device.

Choose your operating system:

Windows

macOS

Linux

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/InputState.h

Include

#include "InputState.h"

Syntax

struct FInputDeviceRay

Remarks

FInputDeviceRay represents a 3D ray created based on an input device. If the device is a 2D input device like a mouse, then the ray may have an associated 2D screen position.

Variables

Name Description

Public variable

bool

 

bHas2D

If true, WorldRay has 2D device position coordinates

Public variable

FVector2D

 

ScreenPosition

2D device position coordinates associated with the ray

Public variable

FRay

 

WorldRay

3D ray in 3D scene, in world coordinates

Constructors

Name Description

Public function

FInputDeviceRay

(
    const FRay& WorldRayIn
)

Public function

FInputDeviceRay

(
    const FInputDeviceState& Input
)

Public function

FInputDeviceRay

(
    const FRay& WorldRayIn,
    const FVector2D& ScreenPositionIn
)