Class ThreeDofCameraDeviceFrameSource
- Namespace
- easyar
- Assembly
- EasyAR.Sense.dll
Control a 3DOF camera device (ThreeDofCameraDeviceFrameSource) in the scene, an MonoBehaviour that provides function extension under the Unity environment.
This frame source is a 3DOF rotation tracking device that outputs rotation data in an ARSession.
public class ThreeDofCameraDeviceFrameSource : FrameSource- Inheritance
-
ThreeDofCameraDeviceFrameSource
- Inherited Members
Fields
DesiredFocusMode
Desired focus mode, effective only if modified before the DeviceOpened event or OnEnable.
Note: Due to hardware or system restrictions, the focus switch may be ineffective on some devices.
public ThreeDofCameraDeviceFocusMode DesiredFocusModeField Value
Properties
Camera
Provided only when creating a new frame source. It will only be accessed during the Assemble() process.
On desktop devices or mobile phones, this camera represents the Camera corresponding to the camera device in the real environment in the virtual world, and its projection matrix and position will correspond to the real camera and be controlled by EasyAR. On a headset, this camera is only used to display some diagnostic text in front of the eyes, not for screen rendering, and the camera is not controlled by EasyAR.
protected override Camera Camera { get; }Property Value
CameraCandidate
An alternative for Camera, valid only when Unity XR Origin is not used, and if not set, Camera.main will be used.
public Camera CameraCandidate { get; set; }Property Value
CameraFrameStarted
Provided only when creating a new frame source. It will be accessed throughout the lifecycle of an ARSession.
Whether camera frames have started to be input.
protected override bool CameraFrameStarted { get; }Property Value
DesiredSize
Desired camera image size, effective only if modified before the DeviceOpened event.
Will use the size closest to the value in SupportedSize. If not set, the default value will be used.
public Optional<Vector2Int> DesiredSize { get; set; }Property Value
DeviceCameras
Provided only when creating a new frame source. It will be accessed when CameraFrameStarted is true.
The device camera that provides camera frame data. If camera frame data is provided by multiple cameras, all cameras need to be included in the list.
Ensure the value is correct when CameraFrameStarted is true.
protected override List<FrameSourceCamera> DeviceCameras { get; }Property Value
Display
Provided only when creating a new frame source. It will only be accessed during the Assemble() process.
Provide display system information. You can use DefaultSystemDisplay or DefaultHMDDisplay to get default display information.
protected override IDisplay Display { get; }Property Value
FrameRateRange
Frame rate range. Only available when Opened is true.
public Vector2 FrameRateRange { get; }Property Value
IsAvailable
Provided only when creating a new frame source. It will only be accessed during the Assemble() process.
Whether the current frame source is available.
If the value is equal to null, CheckAvailability() will be called, and the value will be obtained after the Coroutine ends.
protected override Optional<bool> IsAvailable { get; }Property Value
IsCameraUnderControl
Provided only when creating a new frame source. It will only be accessed during the Assemble() process.
When the value is true, the session will update the camera's transform and render 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; }Property Value
IsHMD
Provided only when creating a new frame source. It will only be accessed during the Assemble() process.
Whether the current frame source is a headset. If it is a headset, diagnostic information will be displayed on the 3D board in front of the camera.
Some frame filters behave differently on the device.
protected override bool IsHMD { get; }Property Value
Opened
Whether the camera is open.
public bool Opened { get; }Property Value
Size
Current image size. Only available when Opened is true.
Set will use the size closest to the value in SupportedSize.
If the image size is modified during recording in an FrameRecorder, the recording data will stop updating and need to be closed and recorded again.
public Vector2Int Size { get; set; }Property Value
SupportedSize
All image sizes supported by the current device. Only available when Opened is true.
public List<Vector2Int> SupportedSize { get; }Property Value
Methods
Close()
Close the device.
public void Close()OnSessionStart(ARSession)
Provided only when creating a new frame source. It will only be accessed during the StartSession() process.
Handle session startup if this frame source has been assembled into an Assembly. This method is designed for lazy initialization, and you can do AR-specific initialization work in this method.
protected override void OnSessionStart(ARSession session)Parameters
session
OnSessionStop()
Provided only when creating a new frame source. It will be accessed during StopSession(bool) or other session stop/damage processes.
Handle session stop if this frame source has been assembled into an Assembly. You can use this method to destroy resources created by StartSession() and the session during operation and restore internal state. This method is guaranteed to be called before the session is destroyed. 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()
Open the device. If Open() and Close() are not manually called, the ARSession will automatically Open() after startup.
public void Open()Events
DeviceClosed
Event when the device is closed.
public event Action DeviceClosedEvent Type
DeviceOpened
Event when the device is opened, a bool value indicating whether it was successful.
public event Action<bool, PermissionStatus, string> DeviceOpened