MotionTrackerFrameSource Class¶

Description¶

在场景中控制 MotionTrackerCameraDevice 的 MonoBehaviour ，在Unity环境下提供功能扩展。如有需要可以直接使用 MotionTrackerFrameSource.Device 。

这个frame source是一种运动跟踪设备，在 ARSession 中会输出运动数据。

Classes¶

public class MotionTrackerFrameSource.MotionTrackerCameraDeviceParameters

运动跟踪参数。

MonoBehaviour Messages¶

private void OnEnable()

private void OnDisable()

private void OnDestroy()

Fields¶

DesiredMotionTrackerParameters¶

C#: public MotionTrackerFrameSource.MotionTrackerCameraDeviceParameters DesiredMotionTrackerParameters

期望的运动跟踪参数，只在 MotionTrackerFrameSource.Device 启动时使用。

Properties¶

Device¶

C#: public MotionTrackerCameraDevice Device { get; }

EasyAR Sense API，如果功能可以使用，可以在 MotionTrackerFrameSource.DeviceCreated 和 MotionTrackerFrameSource.DeviceClosed 事件之间访问。

DeviceQualityLevel¶

C#: public MotionTrackerCameraDeviceQualityLevel DeviceQualityLevel { get; }

获取设备上Motion Tracking的质量，结合应用场景，可以通过此值判断是否启动Motion Tracking。

OriginCandidate¶

C#: public XROriginController OriginCandidate { get; set; }

ARSession.Origin 的备选，如果没设置，将会自动从场景中获取或生成。

CameraCandidate¶

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

MotionTrackerFrameSource.Camera 的备选，如果没设置，将会自动从场景中获取或生成。

IsHMD¶

C#: internal protected override bool IsHMD { }

仅当创建一个新的frame source时提供。它仅会在 ARSession.Assemble 过程中被访问。

当前frame source是否是头显。如果是头显，诊断信息将显示在相机前的3D板子上。

部分frame filter在设备上运行会有不同。

Camera¶

C#: internal protected override Camera Camera { }

仅当创建一个新的frame source时提供。它仅会在 ARSession.Assemble 过程中被访问。

在桌面设备或手机上，该相机代表现实环境中相机设备在虚拟世界中对应的 Camera ，其投影矩阵和位置都将与真实相机对应，受EasyAR控制。在头显上，该相机仅用于将一些诊断文字展示在眼前，不用于画面渲染，相机也不受EasyAR控制。

IsCameraUnderControl¶

C#: internal protected override bool IsCameraUnderControl { }

仅当创建一个新的frame source时提供。它仅会在 ARSession.Assemble 过程中被访问。

当值为ture时，session 会更新相机的transform，且会渲染相机图像.

在创建头显扩展时，它应为false。你应该完全控制场景中的3D相机。你应该处理相机渲染，尤其是在VST模式下。

Display¶

C#: internal protected override IDisplay Display { }

仅当创建一个新的frame source时提供。它仅会在 ARSession.Assemble 过程中被访问。

提供显示系统信息。你可以使用 Display.DefaultSystemDisplay 或 Display.DefaultHMDDisplay 来获取默认的显示信息。

IsAvailable¶

C#: internal protected override Optional<bool> IsAvailable { }

仅当创建一个新的frame source时提供。它仅会在 ARSession.Assemble 过程中被访问。

当前frame source是否可用。

如果数值等于null， FrameSource.CheckAvailability 会被调用，数值将在 Coroutine 结束后获取。

AvailableCenterMode¶

C#: internal protected virtual IReadOnlyList< ARSession.ARCenterMode > AvailableCenterMode { }

仅当创建一个新的frame source时提供。它仅会在 ARSession.Assemble 过程中被访问。

所有可以使用的中心模式。

Events¶

DeviceCreated¶

C#: public event Action DeviceCreated

MotionTrackerFrameSource.Device 创建的事件。

DeviceOpened¶

C#: public event Action DeviceOpened

MotionTrackerFrameSource.Device 打开的事件。

DeviceClosed¶

C#: public event Action DeviceClosed

MotionTrackerFrameSource.Device 关闭的事件。

Methods¶

Open¶

C#: public void Open()

打开设备。

Close¶

C#: public void Close()

关闭设备。

HitTestAgainstHorizontalPlane¶

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

在当前视野内实时检测到的水平面上进行Hit Test,点击到某个水平面后返回该平面上距离Hit Test射线最近的3D点的位置坐标。 pointInView 需要被归一化到[0, 1]^2。

HitTestAgainstPointCloud¶

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

在当前点云中进行Hit Test,得到距离相机从近到远一条射线上的最近的一个3D点位置坐标。 pointInView 需要被归一化到[0, 1]^2。

OnSessionStart¶

C#: private override void OnSessionStart( ARSession session)

仅当创建一个新的frame source时提供。它仅会在 ARSession.StartSession 过程中被访问。

处理session启动，如果这个frame source已经组装进 ARSession.Assembly 。这个方法设计上是用来做延迟初始化的，你可以在这个方法中做AR独有的初始化工作。

OnSessionStop¶

C#: private override void OnSessionStop()

仅当创建一个新的frame source时提供。它会在 ARSession.StopSession 或其它session停止/损坏过程中被访问。

处理session停止，如果这个frame source已经组装进 ARSession.Assembly 。你可以使用这个方法销毁 ARSession.StartSession 以及session运行中创建的资源并恢复内部状态。在session销毁之前这个方法会被保证调用。如果frame source在sessino之前销毁，它将不会被调用，且session将损坏。

CheckAvailability¶

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

仅当创建一个新的frame source时提供。它仅会在 ARSession.Assemble 过程中被访问。

FrameSource.IsAvailable 等于null时用于检查frame source是否可用的 Coroutine 。