ARKitFrameSource Class¶

Description¶

MonoBehaviour which controls ARKit camera device ( ARKitCameraDevice ) in the scene, providing a few extensions in the Unity environment. Use ARKitFrameSource.Device directly when necessary.

This frame source is one type of motion tracking device, and will output motion data in a ARSession .

To choose frame source in runtime, you can deactive Camera GameObject and set all required values of all frame sources for availability check, and active Camera GameObject when this frame source is chosen.

MonoBehaviour Messages¶

protected override void Awake()

protected override void OnEnable()

protected override void OnDisable()

protected virtual void OnDestroy()

Properties¶

Device¶

C#: public ARKitCameraDevice Device { get; }

EasyAR Sense API. Accessible between ARKitFrameSource.DeviceCreated and ARKitFrameSource.DeviceClosed event if available.

Type¶

C#: public override Optional< InputFrameSourceType > Type { get; }

Frame source type. Usually can be used only after device created.

IsAvailable¶

C#: public override Optional<bool> IsAvailable { get; }

If the frame source is available.

If the value equals null, FrameSource.CheckAvailability must be called and the value can be accessed after Coroutine finish. This property is used by ARComponentPicker when picking frame source.

WorldRoot¶

C#: public WorldRootController WorldRoot { get; set; }

The object Camera move against, will be automatically get from the scene or generate if not set.

Origin¶

C#: public override GameObject Origin { get; }

Origin of ARSession if the frame source can output motion tracking data.

Each type of motion tracking frame source has its own method to set the origin object containing some specific component. Some frame source will automatic pick a usable object from active objects in the scene or generate an object if the value is not set.

AvailableCenterMode¶

C#: public virtual IReadOnlyList< ARSession.ARCenterMode > AvailableCenterMode { get; }

Available center mode of the frame source.

Camera¶

C#: public virtual Camera Camera { get; set; }

Camera used by the frame source in an ARSession .

Each type of frame source has its own method to check if the camera is usable, and will reject value set if the camera is not usable by the frame source. This property is used by ARComponentPicker when picking frame source to determine if the frame source is available, and some frame source will automatic pick a usable Camera from active objects in the scene in the process if the value is not set. You can set this value to a usable Camera before session start. The value cannot be changed after ARSession is ready if the frame source is selected in the session.

Events¶

DeviceCreated¶

C#: public event Action DeviceCreated

Event when ARKitFrameSource.Device created.

DeviceOpened¶

C#: public event Action DeviceOpened

Event when ARKitFrameSource.Device opened.

DeviceClosed¶

C#: public event Action DeviceClosed

Event when ARKitFrameSource.Device closed.

Methods¶

Open¶

C#: public void Open()

Open device.

Close¶

C#: public void Close()

Close device.

CheckAvailability¶

C#: public virtual System.Collections.IEnumerator CheckAvailability()

Coroutine to check frame source availability when FrameSource.IsAvailable equals null.