unreal.GoogleVRHMDFunctionLibrary

class unreal.GoogleVRHMDFunctionLibrary(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

GoogleVRHMD Extensions Function Library

C++ Source:

  • Plugin: GoogleVRHMD
  • Module: GoogleVRHMD
  • File: GoogleVRHMDFunctionLibrary.h
classmethod clear_daydream_loading_splash_screen_texture() → None

Clear the loading splash texture it is current using. This will make the loading screen to black if the loading splash screen is still enabled. Note that this function only works for daydream app.

classmethod get_daydream_loading_splash_screen_distance() → float

Get the distance in meter the daydream splash screen will be rendered at

Returns:
Return type:float
classmethod get_daydream_loading_splash_screen_scale() → float

Get the render scale of the dayderam splash screen

Returns:
Return type:float
classmethod get_daydream_loading_splash_screen_view_angle() → float

Get the view angle of the dayderam splash screen

Returns:
Return type:float
classmethod get_distortion_correction_enabled() → bool

Check if distortion correction is enabled

Returns:
Return type:bool
classmethod get_floor_height() → float or None

Tries to get the floor height if available

Returns:floor_height (float): where the floor height read will get stored returns true is the read was successful, false otherwise
Return type:float or None
classmethod get_gvrhmd_render_target_size() → IntPoint

Get the RenderTarget size GoogleVRHMD is using for rendering the scene.

Returns:The render target size that is used when rendering the scene.
Return type:IntPoint
classmethod get_intent_data() → str

Returns the string representation of the data URI on which this activity’s intent is operating. See Intent.getDataString() in the Android documentation.

Returns:
Return type:str
classmethod get_neck_model_scale() → float

A scaling factor for the neck model offset, clamped from 0 to 1. This should be 1 for most scenarios, while 0 will effectively disable neck model application. This value can be animated to smoothly interpolate between alternative (client-defined) neck models.

Returns:the current neck model scale.
Return type:float
classmethod get_recenter_transform() → (recenter_orientation=Quat, recenter_position=Vector) or None

Tries to get the Recenter Transform if available

Returns:recenter_orientation (Quat): where the Recenter Orientation read will get stored

recenter_position (Vector): where the Recenter Position read will get stored returns true is the read was successful, false otherwise

Return type:tuple or None
classmethod get_safety_cylinder_inner_radius() → float or None

Tries to get the Safety Cylinder Inner Radius if available

Returns:inner_radius (float): where the Safety Cylinder Inner Radius read will get stored returns true is the read was successful, false otherwise
Return type:float or None
classmethod get_safety_cylinder_outer_radius() → float or None

Tries to get the Safety Cylinder Outer Radius if available

Returns:outer_radius (float): where the Safety Cylinder Outer Radius read will get stored returns true is the read was successful, false otherwise
Return type:float or None
classmethod get_safety_region() → SafetyRegionType or None

Tries to get the Safety Region Type if available

Returns:region_type (SafetyRegionType): where the Safety Region Type read will get stored returns true is the read was successful, false otherwise
Return type:SafetyRegionType or None
classmethod get_viewer_model() → str

Get the currently set viewer model

Returns:
Return type:str
classmethod get_viewer_vendor() → str

Get the currently set viewer vendor

Returns:
Return type:str
classmethod is_google_vr_stereo_rendering_enabled() → bool

Is Google VRStereo Rendering Enabled

Returns:
Return type:bool
classmethod is_google_vrhmd_enabled() → bool

Is Google VRHMDEnabled

Returns:
Return type:bool
classmethod is_in_daydream_mode() → bool

Is the application running in Daydream mode.

Returns:
Return type:bool
classmethod is_vr_launch() → bool

Was the application launched in Vr.

Returns:
Return type:bool
classmethod set_daydream_loading_splash_screen_distance(new_distance) → None

Set the distance in meter the daydream splash screen will be rendered at

Parameters:new_distance (float) –
classmethod set_daydream_loading_splash_screen_enable(enable) → None

Set whether to enable the loading splash screen in daydream app.

Parameters:enable (bool) –
classmethod set_daydream_loading_splash_screen_scale(new_size) → None

Set the render scale of the dayderam splash screen

Parameters:new_size (float) –
classmethod set_daydream_loading_splash_screen_texture(texture, uv_offset=[0.000000, 0.000000], uv_size=[1.000000, 1.000000]) → None

Set the loading splash screen texture the daydream app wil be using. Note that this function only works for daydream app.

Parameters:
  • texture (Texture2D) – A texture asset to be used for rendering the splash screen.
  • uv_offset (Vector2D) – A 2D vector for offset the splash screen texture. Default value is (0.0, 0.0)
  • uv_size (Vector2D) – A 2D vector specifies which part of the splash texture will be rendered on the screen. Default value is (1.0, 1.0)
classmethod set_daydream_loading_splash_screen_view_angle(new_view_angle) → None

Set the view angle of the dayderam splash screen

Parameters:new_view_angle (float) –
classmethod set_default_viewer_profile(viewer_profile_url) → bool

Change the default viewer profile

Parameters:viewer_profile_url (str) –
Returns:
Return type:bool
classmethod set_distortion_correction_enabled(enable) → None

Enable/disable distortion correction

Parameters:enable (bool) –
classmethod set_distortion_mesh_size(mesh_size) → None

Change the size of Distortion mesh

Parameters:mesh_size (DistortionMeshSizeEnum) –
classmethod set_gvrhmd_render_target_scale(scale_factor) → IntPoint or None

Set the RenderTarget size with a scale factor. The scale factor will be multiplied by the maximal effective render target size based on the window size and the viewer.

Parameters:scale_factor (float) – A float number that is within [0.1, 1.0].
Returns:true if the render target size changed.

out_render_target_size (IntPoint): The actual render target size it is set to.

Return type:IntPoint or None
classmethod set_gvrhmd_render_target_size(desired_width, desired_height) → IntPoint or None

Set the RenderTargetSize with the desired resolution.

Parameters:
  • desired_width (int32) – The width of the render target.
  • desired_height (int32) – The height of the render target.
Returns:

true if the render target size changed.

out_render_target_size (IntPoint): The actually render target size it is set to.

Return type:

IntPoint or None

classmethod set_neck_model_scale(scale_factor) → None

A scaling factor for the neck model offset, clamped from 0 to 1. This should be 1 for most scenarios, while 0 will effectively disable neck model application. This value can be animated to smoothly interpolate between alternative (client-defined) neck models.

Parameters:scale_factor (float) – The new neck model scale.
classmethod set_recenter_controller_only(is_recenter_controller_only) → None

Sets whether or not the Recenter event only recenters the Controller.

Parameters:is_recenter_controller_only (bool) –
classmethod set_render_target_size_to_default() → IntPoint

Set the GoogleVR render target size to default value.

Returns:The default render target size.
Return type:IntPoint
classmethod set_sustained_performance_mode_enabled(enable) → None

Set if the app use sustained performance mode. This can be toggled at run time but note that this function only works on Android build

Parameters:enable (bool) –