unreal.MagicLeapHeadTrackingNotificationsComponent

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

Bases: unreal.VRNotificationsComponent

Provides head tracking map events to enable apps to cleanly handle it. The most important event to be aware of is when a map changes. In the case that a new map session begins, or recovery fails, all formerly cached transform and world reconstruction data (raycast, planes, mesh) is invalidated and must be updated.

C++ Source:

  • Plugin: MagicLeap
  • Module: MagicLeap
  • File: MagicLeapHeadTrackingNotificationsComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array(AssetUserData)): [Read-Write] Array of user data stored with the component
  • auto_activate (bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.
  • can_ever_affect_navigation (bool): [Read-Write] Whether this component can potentially influence navigation
  • component_tags (Array(Name)): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.
  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class
  • hmd_connect_canceled_delegate (VRNotificationsDelegate): [Read-Write] This will be called when the user declines to connect the HMD when prompted to do so by a system dialog. (PS4 Only)
  • hmd_lost_delegate (VRNotificationsDelegate): [Read-Write] This will be called when connection to HMD is lost.
  • hmd_put_on_head_delegate (VRNotificationsDelegate): [Read-Write] This will be called when the HMD detects that it has been put on by a player.
  • hmd_recentered_delegate (VRNotificationsDelegate): [Read-Write] This will be called when the application is asked for VR headset recenter.
  • hmd_reconnected_delegate (VRNotificationsDelegate): [Read-Write] This will be called when connection to HMD is restored.
  • hmd_removed_from_head_delegate (VRNotificationsDelegate): [Read-Write] This will be called when the HMD detects that it has been taken off by a player (disconnecting the hmd also causes it to register as taken off).
  • hmd_tracking_initialized_delegate (VRNotificationsDelegate): [Read-Write] This will be called on Morpheus when the HMD is done initializing and therefore reprojection will start functioning. The app can continue now. (PS4 Only)
  • hmd_tracking_initializing_and_needs_hmd_to_be_tracked_delegate (VRNotificationsDelegate): [Read-Write] This will be called on Morpheus if the HMD starts up and is not fully initialized (in NOT_STARTED or CALIBRATING states). The HMD will stay in NOT_STARTED until it is successfully position tracked. Until it exits NOT_STARTED orientation based reprojection does not happen. Therefore we do not update rotation at all to avoid user discomfort. Instructions to get the hmd tracked should be shown to the user. Sony may fix this eventually. (PS4 Only)
  • is_editor_only (bool): [Read-Write] If true, the component will be excluded from non-editor builds
  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reset
  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivated
  • on_head_tracking_lost (VRNotificationsDelegate): [Read-Write] Map was lost. It could possibly recover.
  • on_head_tracking_new_session_started (VRNotificationsDelegate): [Read-Write] New map session created.
  • on_head_tracking_recovered (VRNotificationsDelegate): [Read-Write] Previous map was recovered.
  • on_head_tracking_recovery_failed (VRNotificationsDelegate): [Read-Write] Failed to recover previous map.
  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component
  • replicates (bool): [Read-Write] Replicates
  • vr_controller_recentered_delegate (VRNotificationsDelegate): [Read-Write] This will be called when the VR system recenters a controller.
on_head_tracking_lost

(VRNotificationsDelegate) – [Read-Write] Map was lost. It could possibly recover.

on_head_tracking_new_session_started

(VRNotificationsDelegate) – [Read-Write] New map session created.

on_head_tracking_recovered

(VRNotificationsDelegate) – [Read-Write] Previous map was recovered.

on_head_tracking_recovery_failed

(VRNotificationsDelegate) – [Read-Write] Failed to recover previous map.