unreal.UOculusFunctionLibrary

class unreal.UOculusFunctionLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

UOculus Function Library

C++ Source:

  • Plugin: OculusVR

  • Module: OculusHMD

  • File: OculusFunctionLibrary.h

classmethod add_loading_splash_screen(texture, translation_in_meters, rotation, size_in_meters=[1.000000, 1.000000], delta_rotation=[0.000000, 0.000000, 0.000000], clear_before_add=False) → None

Add Loading Splash Screen deprecated: Use Add Loading Screen Splash from the Head Mounted Display Loading Screen functions instead.

Parameters:
classmethod clear_loading_splash_screens() → None

Clear Loading Splash Screens deprecated: Use Clear Loading Screen Splashes from the Head Mounted Display Loading Screen functions instead.

classmethod enable_orientation_tracking(orientation_tracking) → None

Enable Orientation Tracking deprecated: The OculusVR plugin is deprecated.

Parameters:

orientation_tracking (bool) –

classmethod enable_position_tracking(position_tracking) → None

Enable Position Tracking deprecated: The OculusVR plugin is deprecated.

Parameters:

position_tracking (bool) –

classmethod get_available_display_frequencies() → Array[float]

Get Available Display Frequencies deprecated: The OculusVR plugin is deprecated.

Return type:

Array[float]

classmethod get_base_rotation_and_base_offset_in_meters() -> (out_rotation=Rotator, out_base_offset_in_meters=Vector)

Get Base Rotation and Base Offset in Meters deprecated: The OculusVR plugin is deprecated.

Returns:

out_rotation (Rotator):

out_base_offset_in_meters (Vector):

Return type:

tuple

classmethod get_base_rotation_and_position_offset() -> (out_rot=Rotator, out_pos_offset=Vector)

Get Base Rotation and Position Offset deprecated: A hack, proper camera positioning should be used

Returns:

out_rot (Rotator):

out_pos_offset (Vector):

Return type:

tuple

classmethod get_current_display_frequency() → float

Get Current Display Frequency deprecated: The OculusVR plugin is deprecated.

Return type:

float

classmethod get_device_name() → str

Get Device Name deprecated: UOculusFunctionLibrary::GetDeviceName has been deprecated and no longer functions as before. Please use the enum-based GetDeviceType instead.

Return type:

str

classmethod get_device_type() → OculusDeviceType

Get Device Type deprecated: The OculusVR plugin is deprecated.

Return type:

OculusDeviceType

classmethod get_fixed_foveated_rendering_level() → FixedFoveatedRenderingLevel

Get Fixed Foveated Rendering Level deprecated: The OculusVR plugin is deprecated.

Return type:

FixedFoveatedRenderingLevel

classmethod get_gpu_frame_time() → float

Get GPUFrame Time deprecated: The OculusVR plugin is deprecated.

Return type:

float

classmethod get_gpu_utilization() -> (is_gpu_available=bool, gpu_utilization=float)

Get GPUUtilization deprecated: The OculusVR plugin is deprecated.

Returns:

is_gpu_available (bool):

gpu_utilization (float):

Return type:

tuple

classmethod get_guardian_dimensions(boundary_type) → Vector

Get Guardian Dimensions deprecated: The OculusVR plugin is deprecated.

Parameters:

boundary_type (BoundaryType) –

Return type:

Vector

classmethod get_guardian_points(boundary_type, use_pawn_space=False) → Array[Vector]

Get Guardian Points deprecated: The OculusVR plugin is deprecated.

Parameters:
Return type:

Array[Vector]

classmethod get_hmd_color_desc() → OculusColorSpace

Get Hmd Color Desc deprecated: The OculusVR plugin is deprecated.

Return type:

OculusColorSpace

classmethod get_node_guardian_intersection(device_type, boundary_type) → GuardianTestResult

Get Node Guardian Intersection deprecated: The OculusVR plugin is deprecated.

Parameters:
Return type:

GuardianTestResult

classmethod get_play_area_transform() → Transform

Get Play Area Transform deprecated: The OculusVR plugin is deprecated.

Return type:

Transform

classmethod get_point_guardian_intersection(point, boundary_type) → GuardianTestResult

Get Point Guardian Intersection deprecated: The OculusVR plugin is deprecated.

Parameters:
Return type:

GuardianTestResult

classmethod get_pose(use_orienation_for_player_camera=False, use_position_for_player_camera=False, position_scale=[0.000000, 0.000000, 0.000000]) -> (device_rotation=Rotator, device_position=Vector, neck_position=Vector)

Get Pose deprecated: The OculusVR plugin is deprecated.

Parameters:

  • use_orienation_for_player_camera (bool) –

  • use_position_for_player_camera (bool) –

  • position_scale (Vector) –

Returns:

device_rotation (Rotator):

device_position (Vector):

neck_position (Vector):

Return type:

tuple

classmethod get_raw_sensor_data(device_type=TrackedDeviceType.HMD) -> (angular_acceleration=Vector, linear_acceleration=Vector, angular_velocity=Vector, linear_velocity=Vector, time_in_seconds=float)

Get Raw Sensor Data deprecated: The OculusVR plugin is deprecated.

Parameters:

device_type (TrackedDeviceType) –

Returns:

angular_acceleration (Vector):

linear_acceleration (Vector):

angular_velocity (Vector):

linear_velocity (Vector):

time_in_seconds (float):

Return type:

tuple

classmethod get_system_hmd3_dof_mode_enabled() → bool

Get System Hmd 3Dof Mode Enabled deprecated: The OculusVR plugin is deprecated.

Return type:

bool

classmethod get_tiled_multires_level() → FixedFoveatedRenderingLevel

deprecated: ‘get_tiled_multires_level’ was renamed to ‘get_fixed_foveated_rendering_level’.

classmethod get_user_profile() → HmdUserProfile or None

Get User Profile deprecated: The OculusVR plugin is deprecated.

Returns:

profile (HmdUserProfile):

Return type:

HmdUserProfile or None

classmethod has_input_focus() → bool

Has Input Focus deprecated: The OculusVR plugin is deprecated.

Return type:

bool

classmethod has_system_overlay_present() → bool

Has System Overlay Present deprecated: The OculusVR plugin is deprecated.

Return type:

bool

classmethod is_device_tracked(device_type) → bool

Is Device Tracked deprecated: The OculusVR plugin is deprecated.

Parameters:

device_type (TrackedDeviceType) –

Return type:

bool

classmethod is_guardian_configured() → bool

Is Guardian Configured deprecated: The OculusVR plugin is deprecated.

Return type:

bool

classmethod is_guardian_displayed() → bool

Is Guardian Displayed deprecated: The OculusVR plugin is deprecated.

Return type:

bool

classmethod set_base_rotation_and_base_offset_in_meters(rotation, base_offset_in_meters, options) → None

Set Base Rotation and Base Offset in Meters deprecated: The OculusVR plugin is deprecated.

Parameters:
classmethod set_base_rotation_and_position_offset(base_rot, pos_offset, options) → None

Set Base Rotation and Position Offset deprecated: A hack, proper camera positioning should be used

Parameters:
classmethod set_client_color_desc(color_space) → None

Set Client Color Desc deprecated: The OculusVR plugin is deprecated.

Parameters:

color_space (OculusColorSpace) –

classmethod set_color_scale_and_offset(color_scale, color_offset, apply_to_all_layers=False) → None

Set Color Scale and Offset deprecated: The OculusVR plugin is deprecated.

Parameters:
classmethod set_cpu_and_gpu_levels(cpu_level, gpu_level) → None

Set CPUAnd GPULevels

Parameters:

  • cpu_level (int32) –

  • gpu_level (int32) –

classmethod set_display_frequency(requested_frequency) → None

Set Display Frequency deprecated: The OculusVR plugin is deprecated.

Parameters:

requested_frequency (float) –

classmethod set_fixed_foveated_rendering_level(level, is_dynamic) → None

Set Fixed Foveated Rendering Level deprecated: The OculusVR plugin is deprecated.

Parameters:
classmethod set_guardian_visibility(guardian_visible) → None

Set Guardian Visibility deprecated: The OculusVR plugin is deprecated.

Parameters:

guardian_visible (bool) –

classmethod set_position_scale3d(pos_scale3d) → None

Set Position Scale 3D deprecated: This feature is no longer supported.

Parameters:

pos_scale3d (Vector) –

classmethod set_tiled_multires_level(level: FixedFoveatedRenderingLevel, is_dynamic: bool) → None

deprecated: ‘set_tiled_multires_level’ was renamed to ‘set_fixed_foveated_rendering_level’.