Table of Contents

Class ThreeDofCameraDeviceFrameSource

Alternar para o guia

Espaço de nomes
easyar
Assembly
EasyAR.Sense.dll

A MonoBehaviour that controls the 3DOF camera device (ThreeDofCameraDeviceFrameSource) in the scene and provides functional extensions in the Unity environment.

This frame source is a 3DOF rotation tracking device and outputs data in ARSession.

public class ThreeDofCameraDeviceFrameSource : FrameSource
Herança
ThreeDofCameraDeviceFrameSource
Membros herdados

Campos

DesiredFocusMode

Desired focus mode. Changes take effect only before the DeviceOpened event or before OnEnable.

Note: Due to hardware or system limitations, focus switching may be ineffective on some devices.

public ThreeDofCameraDeviceFocusMode DesiredFocusMode

Propriedades

Camera

Fornecido somente ao criar um novo frame source. It is accessed only during Assemble().

On desktop devices or phones, this camera represents the Camera in the virtual world corresponding to the camera device in the real environment. Its projection matrix and position correspond to the real camera and are controlled by EasyAR. On headsets, this camera is used only to display diagnostic text in front of the eyes; it is not used for image rendering, and the camera is not controlled by EasyAR.

protected override Camera Camera { get; }

CameraCandidate

Alternative to Camera. Effective only when Unity XR Origin is not used. If not set, Camera.main will be used.

public Camera CameraCandidate { get; set; }

CameraFrameStarted

Fornecido somente ao criar um novo frame source. It is accessed throughout the lifecycle of ARSession.

Whether camera frame input has started.

protected override bool CameraFrameStarted { get; }

DesiredSize

Desired camera image size. Changes take effect only before the DeviceOpened event.

The size closest to the value in SupportedSize will be used. If not set, the default value will be used.

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

DeviceCameras

Fornecido somente ao criar um novo frame source. It is accessed when CameraFrameStarted is true.

Device cameras that provide camera frame data. If camera frame data is provided by multiple cameras, the list must contain all cameras.

Ensure that the value is correct when CameraFrameStarted is true.

protected override List<FrameSourceCamera> DeviceCameras { get; }

Display

Fornecido somente ao criar um novo frame source. It is accessed only during Assemble().

Provides display system information. You can use DefaultSystemDisplay or DefaultHMDDisplay to get default display information.

protected override IDisplay Display { get; }

FrameRateRange

Frame rate range. Available only when Opened is true.

public Vector2 FrameRateRange { get; }

IsAvailable

Fornecido somente ao criar um novo frame source. It is accessed only during Assemble().

Whether the current frame source is available.

If the value is null, CheckAvailability() will be called, and the value will be obtained after Coroutine ends.

protected override Optional<bool> IsAvailable { get; }

IsCameraUnderControl

Fornecido somente ao criar um novo frame source. It is accessed only during Assemble().

When the value is true, session updates the camera transform and renders the camera image.

When creating a headset extension, it should be false. You should fully control the 3D camera in the scene. You should handle camera rendering, especially in VST mode.

protected override bool IsCameraUnderControl { get; }

IsHMD

Fornecido somente ao criar um novo frame source. It is accessed only during Assemble().

Whether the current frame source is a headset. If it is a headset, diagnostic information will be displayed on a 3D board in front of the camera.

Some frame filters behave differently when running on device.

protected override bool IsHMD { get; }

Opened

Whether the camera is opened.

public bool Opened { get; }

Size

Current image size. Available only when Opened is true.

set will use the size closest to the value in SupportedSize.

If the image size is changed while FrameRecorder is recording, recorded data will stop updating and recording needs to be restarted after closing.

public Vector2Int Size { get; set; }

SupportedSize

All image sizes supported by the current device. Available only when Opened is true.

public List<Vector2Int> SupportedSize { get; }

enabled

Inicia/para collecting video stream data while ARSession is running. After session starts, collection starts only when MonoBehaviour.enabled is true.

public bool enabled { get; set; }

Métodos

Close()

Fecha the device.

public void Close()

OnSessionStart(ARSession)

Fornecido somente ao criar um novo frame source. It is accessed only during StartSession().

Processa session startup if this frame source has been assembled into Assembly. This method is designed for lazy initialization; you can perform AR-specific initialization work in this method.

protected override void OnSessionStart(ARSession session)

Parâmetros

session

OnSessionStop()

Fornecido somente ao criar um novo frame source. It is accessed during StopSession(bool) or other session stop/damage processes.

Processa session stop if this frame source has been assembled into Assembly. You can use this method to destroy resources created by StartSession() and during session running, and restore internal state. This method is guaranteed to be called before session destruction. If the frame source is destroyed before the session, it will not be called and the session will be damaged.

protected override void OnSessionStop()

Open()

Abre the device. If Open() and Close() are not manually called, ARSession will automatically call Open() after startup.

public void Open()

Eventos

DeviceClosed

Device closed event.

public event Action DeviceClosed

DeviceOpened

Device opened event. The bool value indicates whether it succeeded.

public event Action<bool, PermissionStatus, string> DeviceOpened