Table of Contents

Class InertialCameraDeviceFrameSource

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

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

這個frame source是一種5DOF(旋轉+水平位移)追蹤設備,在ARSession中會輸出運動數據。

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

欄位

DesiredFocusMode

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

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

public InertialCameraDeviceFocusMode DesiredFocusMode

屬性

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; }

DesiredSize

期望的相機圖像大小,在DeviceOpened事件前修改才有效。

會使用SupportedSize中數值最接近的大小。未設定將使用預設值。

public Optional<Vector2Int> DesiredSize { get; set; }

DeviceCameras

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

提供相機幀數據的設備相機。如果相機幀數據由多個相機提供,清單中需要包含所有相機。

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

protected override List<FrameSourceCamera> DeviceCameras { 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; }

Opened

相機是否打開。

public bool Opened { get; }

Size

當前圖像大小。僅在Opened為true時可用。

set會使用SupportedSize中數值最接近的大小。

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

public Vector2Int Size { get; set; }

SupportedSize

當前設備支援的所有圖像大小。僅在Opened為true時可用。

public List<Vector2Int> SupportedSize { get; }

方法

Close()

關閉設備。

public void Close()

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()

ResetInertial()

重設狀態。

public void ResetInertial()

事件

DeviceClosed

設備關閉的事件。

public event Action DeviceClosed

DeviceOpened

設備打開的事件,bool值表示是否成功。

public event Action<bool, PermissionStatus, string> DeviceOpened