MotionTrackerFrameSource Class¶

Description¶

MonoBehaviour which controls MotionTrackerCameraDevice in the scene, providing a few extensions in the Unity environment. Use MotionTrackerFrameSource.Device directly when necessary.

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

This frame source will download device list from server when checking availability, timeout in MotionTrackerFrameSource.CalibrationDownloaderTimeout seconds. Device list is distributed more frequently than SDK, so some unsupported devices may happen to be supported later without repacking your application. You can disable device list update by setting MotionTrackerFrameSource.CalibrationDownloaderTimeout to a value less than or equal to 0.

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.

Classes¶

public class MotionTrackerFrameSource.MotionTrackerCameraDeviceParameters

Motion tracker parameters.

MonoBehaviour Messages¶

protected override void Awake()

protected override void OnEnable()

protected override void OnDisable()

protected virtual void OnDestroy()

Fields¶

DesiredMotionTrackerParameters¶

C#: public MotionTrackerFrameSource.MotionTrackerCameraDeviceParameters DesiredMotionTrackerParameters

Desired motion tracker parameters, used only when MotionTrackerFrameSource.Device start.

CalibrationDownloaderTimeout¶

C#: public float CalibrationDownloaderTimeout

Timeout in seconds to update device list from server when checking availability using MotionTrackerFrameSource.CheckAvailability . Set value less than or equal to 0 to skip update from server.

AlwaysWaitCalibrationUpdate¶

C#: public bool AlwaysWaitCalibrationUpdate

By default, MotionTrackerFrameSource.CheckAvailability will return immediately if device is supported with current device list data, and the updated list will be used in the next run. Turn on this option If you want to ensure list update in each run.

Properties¶

Device¶

C#: public MotionTrackerCameraDevice Device { get; }

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

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 MotionTrackerFrameSource.Device created.

DeviceOpened¶

C#: public event Action DeviceOpened

Event when MotionTrackerFrameSource.Device opened.

DeviceClosed¶

C#: public event Action DeviceClosed

Event when MotionTrackerFrameSource.Device closed.

Methods¶

CheckAvailability¶

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

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

Open¶

C#: public void Open()

Open device.

Close¶

C#: public void Close()

Close device.

HitTestAgainstHorizontalPlane¶

C#: public List< Vector3 > HitTestAgainstHorizontalPlane( Vector2 pointInView)

Performs ray cast from the user’s device in the direction of given screen point. Intersections with horizontal plane is detected in real time in the current field of view,and return the 3D point nearest to ray on horizontal plane. pointInView should be normalized to [0, 1]^2.

HitTestAgainstPointCloud¶

C#: public List< Vector3 > HitTestAgainstPointCloud( Vector2 pointInView)

Perform hit test against the point cloud and return the nearest 3D point. pointInView should be normalized to [0, 1]^2.