Table of Contents

Class VisionOSARKitFrameSource

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

在場景中控制VisionOS ARKit相機設備(easyar.VisionOSARKitCameraDevice)的MonoBehaviour,在Unity環境下提供功能擴展。

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

在自定義相機或頭顯上使用試用產品(個人版license、試用版XR license或試用版Mega服務等)時,EasyAR Sense每次啓動後會在固定的有限時間內停止響應。

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

屬性

AvailableCenterMode

僅當創建一個新的frame source時提供。它僅會在Assemble()過程中被訪問。

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

protected override IReadOnlyList<ARSession.ARCenterMode> AvailableCenterMode { get; }

Camera

僅當創建一個新的frame source時提供。它僅會在Assemble()過程中被訪問。

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

protected override Camera Camera { get; }

CameraFrameStarted

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

相機幀是否開始輸入。

protected override bool CameraFrameStarted { get; }

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時可用。

public Vector2Int Size { get; }

enabled

ARSession運行時開始/停止採集視頻流數據。在session啓動後,MonoBehaviour.enabled爲true時纔會開始採集。

public bool enabled { get; set; }

方法

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

事件

DeviceClosed

設備關閉的事件。

public event Action DeviceClosed

DeviceOpened

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

public event Action<bool, PermissionStatus, string> DeviceOpened