unreal.GuardianTestResult

class unreal.GuardianTestResult(is_triggering=False, device_type=TrackedDeviceType.NONE, closest_distance=0.0, closest_point=[0.0, 0.0, 0.0], closest_point_normal=[0.0, 0.0, 0.0])

Bases: unreal.StructBase

  • Information about relationships between a triggered boundary (EBoundaryType::Boundary_Outer or
  • EBoundaryType::Boundary_PlayArea) and a device or point in the world.
  • All dimensions, points, and vectors are returned in Unreal world coordinate space.

C++ Source:

  • Plugin: OculusVR
  • Module: OculusHMD
  • File: OculusFunctionLibrary.h

Editor Properties: (see get_editor_property/set_editor_property)

  • closest_distance (float): [Read-Write] Distance of device/point to surface of boundary specified by BoundaryType
  • closest_point (Vector): [Read-Write] Closest point on surface corresponding to specified boundary
  • closest_point_normal (Vector): [Read-Write] Normal of closest point
  • device_type (TrackedDeviceType): [Read-Write] Device type triggering boundary (ETrackedDeviceType::None if BoundaryTestResult corresponds to a point rather than a device)
  • is_triggering (bool): [Read-Write] Is there a triggering interaction between the device/point and specified boundary?
closest_distance

(float) – [Read-Only] Distance of device/point to surface of boundary specified by BoundaryType

closest_point

(Vector) – [Read-Only] Closest point on surface corresponding to specified boundary

closest_point_normal

(Vector) – [Read-Only] Normal of closest point

device_type

(TrackedDeviceType) – [Read-Only] Device type triggering boundary (ETrackedDeviceType::None if BoundaryTestResult corresponds to a point rather than a device)

is_triggering

(bool) – [Read-Only] Is there a triggering interaction between the device/point and specified boundary?