Simulated Reality SDK 7500c78d v1.30.2.51085 2024-04-26T11:23:03Z
Stable
Public Member Functions | List of all members
SR::UniqueCameraController Class Reference

Non-copyable class of CameraController interface that can only be constructed once per Camera (Camera::Descriptor) More...

#include <cameracontroller.h>

Inheritance diagram for SR::UniqueCameraController:
[legend]
Collaboration diagram for SR::UniqueCameraController:
[legend]

Public Member Functions

 UniqueCameraController (UniqueCameraController &&other)
 
UniqueCameraControlleroperator= (UniqueCameraController &&other)
 
 UniqueCameraController ()
 Construct UniqueCameraController to reserve memory. More...
 
 UniqueCameraController (Camera *camera, CameraController *controller)
 Construct instance of UniqueCameraController of that can only be created for a specific Camera if another UniqueCameraController instance does not exist for it. More...
 
 ~UniqueCameraController ()
 Destructs UniqueCameraController instance and allow a new one to be acquired. More...
 
virtual void setShuttertime (float shutterTime)
 Set camera shutter / exposure time in seconds. More...
 
virtual void setGain (float gain)
 Set camera gain. More...
 
virtual float getShuttertime ()
 Get current shutter / exposure time in seconds. More...
 
virtual float getGain ()
 Get current camera gain factor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SR::CameraController
static void addImplementation (CameraControlFunction *controlFunction, std::string cameraType)
 Static function to make a CameraController implementation available through the CameraController::control function. More...
 
static UniqueCameraController control (Camera *camera)
 Attempt to gain control of camera sensor. More...
 

Detailed Description

Non-copyable class of CameraController interface that can only be constructed once per Camera (Camera::Descriptor)

Constructor & Destructor Documentation

◆ UniqueCameraController() [1/3]

SR::UniqueCameraController::UniqueCameraController ( UniqueCameraController &&  other)
inline

◆ UniqueCameraController() [2/3]

SR::UniqueCameraController::UniqueCameraController ( )

Construct UniqueCameraController to reserve memory.

◆ UniqueCameraController() [3/3]

SR::UniqueCameraController::UniqueCameraController ( Camera camera,
CameraController controller 
)

Construct instance of UniqueCameraController of that can only be created for a specific Camera if another UniqueCameraController instance does not exist for it.

Exceptions
CameraControllerUnavailableExceptionif the Camera is already being controlled through another UniqueCameraController

◆ ~UniqueCameraController()

SR::UniqueCameraController::~UniqueCameraController ( )

Destructs UniqueCameraController instance and allow a new one to be acquired.

Member Function Documentation

◆ getGain()

virtual float SR::UniqueCameraController::getGain ( )
virtual

Get current camera gain factor.

A higher gain will produce brighter images but may affect image quality. Values produced by the sensor are multiplied by a factor derived from this gain value Implementations may vary.

Returns
current camera gain factor

Implements SR::CameraController.

◆ getShuttertime()

virtual float SR::UniqueCameraController::getShuttertime ( )
virtual

Get current shutter / exposure time in seconds.

A higher shutter time will produce brighter images but may increase latency. The effectiveness of changing the shutter time is also dependent on the aperture of the camera.

Returns
current shutter / exposure time in seconds

Implements SR::CameraController.

◆ operator=()

UniqueCameraController & SR::UniqueCameraController::operator= ( UniqueCameraController &&  other)

◆ setGain()

virtual void SR::UniqueCameraController::setGain ( float  gain)
virtual

Set camera gain.

A higher gain will produce brighter images but may affect image quality. Values produced by the sensor are multiplied by a factor derived from this gain value. Implementations may vary.

Implements SR::CameraController.

◆ setShuttertime()

virtual void SR::UniqueCameraController::setShuttertime ( float  shutterTime)
virtual

Set camera shutter / exposure time in seconds.

A higher shutter time will produce brighter images but may increase latency. The effectiveness of changing the shutter time is also dependent on the aperture of the camera.

Parameters
shutterTimein seconds

Implements SR::CameraController.


The documentation for this class was generated from the following file: