unreal.InputDeviceRay

class unreal.InputDeviceRay(world_ray: Ray = Ellipsis, has2d: bool = False, screen_position: Vector2D = Ellipsis)

Bases: StructBase

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.

C++ Source:

  • Module: InteractiveToolsFramework

  • File: InputState.h

Editor Properties: (see get_editor_property/set_editor_property)

  • has2d (bool): [Read-Write] If true, WorldRay has 2D device position coordinates

  • screen_position (Vector2D): [Read-Write] 2D device position coordinates associated with the ray

  • world_ray (Ray): [Read-Write] 3D ray in 3D scene, in world coordinates

property has2d: bool

[Read-Write] If true, WorldRay has 2D device position coordinates

Type:

(bool)

property screen_position: Vector2D

[Read-Write] 2D device position coordinates associated with the ray

Type:

(Vector2D)

property world_ray: Ray

[Read-Write] 3D ray in 3D scene, in world coordinates

Type:

(Ray)