unreal.ARPin

class unreal.ARPin(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: Object

C++ Source:

  • Module: AugmentedReality

  • File: ARPin.h

Editor Properties: (see get_editor_property/set_editor_property)

  • on_ar_tracking_state_changed (OnARTrackingStateChanged): [Read-Write] On ARTracking State Changed

  • on_ar_transform_updated (OnARTransformUpdated): [Read-Write] On ARTransform Updated

get_debug_name() Name

Get Debug Name

Return type:

Name

get_local_to_tracking_transform() Transform

Maps from a Pin’s Local Space to the Tracking Space. Mapping the origin from the Pin’s Local Space to Tracking Space yield the Pin’s position in Tracking Space.

Return type:

Transform

get_local_to_world_transform() Transform

Convenience function. Same as LocalToTrackingTransform, but appends the TrackingToWorld Transform.

Return type:

Transform

get_pinned_component() SceneComponent
Returns:

the PinnedComponent that this UARPin is pinning to the TrackedGeometry

Return type:

SceneComponent

get_tracked_geometry() ARTrackedGeometry

The TrackedGeometry (if any) that this this pin is being “stuck” into.

Return type:

ARTrackedGeometry

get_tracking_state() ARTrackingState

Return the current tracking state of this Pin.

Return type:

ARTrackingState

property on_ar_tracking_state_changed: OnARTrackingStateChanged

[Read-Write] On ARTracking State Changed

Type:

(OnARTrackingStateChanged)

property on_ar_transform_updated: OnARTransformUpdated

[Read-Write] On ARTransform Updated

Type:

(OnARTransformUpdated)