unreal.AppleARKitLibrary

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

Bases: unreal.BlueprintFunctionLibrary

Apple ARKit Blueprint Library

C++ Source:

  • Plugin: AppleARKit
  • Module: AppleARKit
  • File: AppleARKitBlueprintLibrary.h
classmethod get_current_frame(world_context_object) → AppleARKitFrame or None

Returns the last processed FAppleARKitFrame from the session.

When called from the game thread, we ensure a single frame is returned for the duration of the game thread update by watching for changes to GFrameNumber to trigger pulling a new frame from the session. deprecated: Function ‘GetCurrentFrame’ is deprecated.

Parameters:world_context_object (Object) –
Returns:out_current_frame (AppleARKitFrame):
Return type:AppleARKitFrame or None
classmethod hit_test_at_screen_position_tracking_space(world_context_object, screen_position, types) → Array(AppleARKitHitTestResult) or None

Searches the last processed frame for anchors corresponding to a point in the captured image.

A 2D point in the captured image’s coordinate space can refer to any point along a line segment in the 3D coordinate space. Hit-testing is the process of finding anchors of a frame located along this line segment.

NOTE: The hit test locations are reported in ARKit space. For hit test results in game world coordinates, you’re after UAppleARKitCameraComponent::HitTestAtScreenPosition deprecated: Function ‘HitTestAtScreenPosition_TrackingSpace’ is deprecated.

Parameters:
Returns:

out_results (Array(AppleARKitHitTestResult)):

Return type:

Array(AppleARKitHitTestResult) or None