Table of Contents

Class MotionTrackerFrameSource

命名空間
easyar
組件
EasyAR.Sense.dll

在場景中控制easyar.MotionTrackerCameraDeviceMonoBehaviour,在Unity環境下提供功能擴展。

這個frame source是一種運動追蹤設備,在ARSession中會輸出運動數據。

public class MotionTrackerFrameSource : FrameSource
繼承
MotionTrackerFrameSource
繼承成員

屬性

Camera

僅當建立一個新的frame source時提供。它僅會在Assemble()過程中被存取。

在桌面裝置或手機上,該相機代表現實環境中相機裝置在虛擬世界中對應的Camera,其投影矩陣和位置都將與真實相機對應,受EasyAR控制。在頭顯上,該相機僅用於將一些診斷文字展示在眼前,不用於畫面渲染,相機也不受EasyAR控制。

protected override Camera Camera { get; }

CameraCandidate

Camera的備選,僅當未使用Unity XR Origin時有效,如未設定會使用Camera.main。

public Camera CameraCandidate { get; set; }

CameraFrameStarted

僅當建立一個新的frame source時提供。它會在ARSession的整個生命週期內被存取。

相機幀是否開始輸入。

protected override bool CameraFrameStarted { get; }

DesiredFocusMode

期望的對焦模式,在DeviceOpened事件或OnEnable前修改才有效。

注意:受硬體或系統限制,對焦開關在一些裝置上可能無效。

public Optional<MotionTrackerCameraDeviceFocusMode> DesiredFocusMode { get; set; }

DesiredFrameRate

期望的裝置幀率,在DeviceOpened事件或OnEnable前修改才有效。

public Optional<MotionTrackerCameraDeviceFPS> DesiredFrameRate { get; set; }

DesiredMinQualityLevel

期望的最低允許的品質級別,在Assemble()前修改才有效。

public Optional<MotionTrackerCameraDeviceQualityLevel> DesiredMinQualityLevel { get; set; }

DesiredResolution

期望的解析度,在DeviceOpened事件或OnEnable前修改才有效。

如果在FrameRecorder錄製過程中修改了影像大小,錄製資料將停止更新,需要關閉之後重新錄製。

public Optional<MotionTrackerCameraDeviceResolution> DesiredResolution { get; set; }

DesiredTrackingMode

期望的追蹤模式,在session啟動前修改才有效。

public Optional<MotionTrackerCameraDeviceTrackingMode> DesiredTrackingMode { get; set; }

DeviceCameras

僅當建立一個新的frame source時提供。它會在CameraFrameStarted為true時被存取。

提供相機幀資料的裝置相機。如果相機幀資料由多個相機提供,清單中需要包含所有相機。

確保在CameraFrameStarted為true時數值正確。

protected override List<FrameSourceCamera> DeviceCameras { get; }

DeviceQualityLevel

取得裝置上Motion Tracking的品質,結合應用場景,可以透過此值判斷是否啟動Motion Tracking。

public static MotionTrackerCameraDeviceQualityLevel DeviceQualityLevel { get; }

Display

僅當建立一個新的frame source時提供。它僅會在Assemble()過程中被存取。

提供顯示系統資訊。你可以使用DefaultSystemDisplayDefaultHMDDisplay來取得預設的顯示資訊。

protected override IDisplay Display { get; }

FrameRateRange

幀率範圍。僅在Opened為true時可用。

public Vector2 FrameRateRange { get; }

IsAvailable

僅當建立一個新的frame source時提供。它僅會在Assemble()過程中被存取。

目前frame source是否可用。

如果數值等於null,CheckAvailability()會被呼叫,數值將在Coroutine結束後取得。

protected override Optional<bool> IsAvailable { get; }

IsCameraUnderControl

僅當建立一個新的frame source時提供。它僅會在Assemble()過程中被存取。

當值為ture時,session 會更新相機的transform,且會渲染相機影像。

在建立頭顯擴充時,它應為false。你應該完全控制場景中的3D相機。你應該處理相機渲染,尤其是在VST模式下。

protected override bool IsCameraUnderControl { get; }

IsHMD

僅當建立一個新的frame source時提供。它僅會在Assemble()過程中被存取。

目前frame source是否是頭顯。如果是頭顯,診斷資訊將顯示在相機前的3D板子上。

部分frame filter在裝置上執行會有不同。

protected override bool IsHMD { get; }

LocalPointCloud

目前點雲資料位置資訊。僅在Opened為true時可用。

public List<Vector3> LocalPointCloud { get; }

Opened

相機是否開啟。

public bool Opened { get; }

Size

目前影像大小。僅在OpenedMonoBehaviour.enabled都為true時可用。

public Vector2Int Size { get; }

enabled

ARSession執行時開始/停止採集視訊流資料。在session啟動後,MonoBehaviour.enabled為true時才會開始採集。

public bool enabled { get; set; }

方法

Close()

關閉裝置。

public void Close()

HitTestAgainstHorizontalPlane(Vector2)

在目前視野內即時偵測到的水平面上進行Hit Test,點擊到某個水平面後返回該平面上距離Hit Test射線最近的3D點的位置座標。pointInView 需要被歸一化到[0, 1]^2。

public List<Vector3> HitTestAgainstHorizontalPlane(Vector2 pointInView)

參數

pointInView

HitTestAgainstPointCloud(Vector2)

在目前點雲中進行Hit Test,得到距離相機從近到遠一條射線上的最近的一個3D點位置座標。pointInView 需要被歸一化到[0, 1]^2。

public List<Vector3> HitTestAgainstPointCloud(Vector2 pointInView)

參數

pointInView

OnSessionStart(ARSession)

僅當建立一個新的frame source時提供。它僅會在StartSession()過程中被存取。

處理session啟動,如果這個frame source已經組裝進Assembly。這個方法設計上是用來做延遲初始化的,你可以在這個方法中做AR獨有的初始化工作。

protected override void OnSessionStart(ARSession session)

參數

session

OnSessionStop()

僅當建立一個新的frame source時提供。它會在StopSession(bool)或其它session停止/損壞過程中被存取。

處理session停止,如果這個frame source已經組裝進Assembly。你可以使用這個方法銷毀StartSession()以及session執行中建立的資源並恢復內部狀態。在session銷毀之前這個方法會被保證呼叫。如果frame source在sessino之前銷毀,它將不會被呼叫,且session將損壞。

protected override void OnSessionStop()

Open()

開啟裝置。如果未手動呼叫Open()Close()ARSession啟動後會自動Open()

public void Open()

事件

DeviceClosed

裝置關閉的事件。

public event Action DeviceClosed

DeviceOpened

裝置開啟的事件,bool值表示是否成功。

public event Action<bool, PermissionStatus, string> DeviceOpened