SolAR::api::input::devices::ICamera Class Reference

Grabs images captured in real-time by a video camera. UUID: 5ddc7df0-8377-437f-9c81-3643f7676a5b More...

#include <ICamera.h>

Inheritance diagram for SolAR::api::input::devices::ICamera:

Collaboration diagram for SolAR::api::input::devices::ICamera:

Public Member Functions
	ICamera ()=default
	Specify the ICamera constructor class.
virtual	~ICamera ()=default
	Specify the ICamera destructor class.
virtual FrameworkReturnCode	getNextImage (SRef< SolAR::datastructure::Image > &img)=0
	Fill the SRef img buffer with a new image captured by the camera device. More...
virtual void	setResolution (const SolAR::datastructure::Sizei &resolution)=0
	Set the acquisition device image resolution. More...
virtual void	setIntrinsicParameters (const SolAR::datastructure::CamCalibration &intrinsic_parameters)=0
	Set the intrinsic camera parameters. More...
virtual void	setDistortionParameters (const SolAR::datastructure::CamDistortion &distortion_parameters)=0
	Set the distortion camera parameters. More...
virtual void	setParameters (const SolAR::datastructure::CameraParameters &parameters)=0
	Set the distortion and intrinsic camera parameters. More...
virtual SolAR::datastructure::Sizei	getResolution () const =0
	Get the acquisition device image resolution. More...
virtual const SolAR::datastructure::CamCalibration &	getIntrinsicsParameters () const =0
	Get the intrinsic camera parameters. More...
virtual const SolAR::datastructure::CameraParameters &	getParameters () const =0
	Get the camera parameters. More...
virtual const SolAR::datastructure::CamDistortion &	getDistortionParameters () const =0
	Get the distortion camera lens parameters. More...
Public Member Functions inherited from SolAR::api::input::devices::IDevice
	IDevice ()=default
	Specify the IDevice constructor class.
virtual	~IDevice () override=default
	Specify the IDevice destructor class.
virtual FrameworkReturnCode	start ()=0
	Start the acquisition device referenced by its device_id. More...
virtual FrameworkReturnCode	stop ()=0
	Stop the acquisition device. More...

Detailed Description

Grabs images captured in real-time by a video camera. UUID: 5ddc7df0-8377-437f-9c81-3643f7676a5b

This class describes the interface of a camera capture device.

Member Function Documentation

getDistortionParameters()

virtual const SolAR::datastructure::CamDistortion & SolAR::api::input::devices::ICamera::getDistortionParameters ( ) const

pure virtual

Get the distortion camera lens parameters.

Returns

SolAR::datastructure::CamDistortion the distortion camera lens parameters

getIntrinsicsParameters()

virtual const SolAR::datastructure::CamCalibration & SolAR::api::input::devices::ICamera::getIntrinsicsParameters ( ) const

pure virtual

Get the intrinsic camera parameters.

Returns

SolAR::datastructure::CamCalibration the intrinsic camera parameters

getNextImage()

virtual FrameworkReturnCode SolAR::api::input::devices::ICamera::getNextImage ( SRef< SolAR::datastructure::Image > &  img )

pure virtual

Fill the SRef img buffer with a new image captured by the camera device.

Parameters

[out]

img

the new image captured by the device

Returns

FrameworkReturnCode to track sucessful or failing event.

getParameters()

virtual const SolAR::datastructure::CameraParameters & SolAR::api::input::devices::ICamera::getParameters ( ) const

pure virtual

Get the camera parameters.

Returns

SolAR::datastructure::CameraParameters the camera parameters

getResolution()

virtual SolAR::datastructure::Sizei SolAR::api::input::devices::ICamera::getResolution ( ) const

pure virtual

Get the acquisition device image resolution.

Returns

SolAR::datastructure::Sizei the acquisition device image resolution

setDistortionParameters()

virtual void SolAR::api::input::devices::ICamera::setDistortionParameters ( const SolAR::datastructure::CamDistortion &  distortion_parameters )

pure virtual

Set the distortion camera parameters.

Parameters

[in]

distortion_parameters

distortion camera parameters

setIntrinsicParameters()

virtual void SolAR::api::input::devices::ICamera::setIntrinsicParameters ( const SolAR::datastructure::CamCalibration &  intrinsic_parameters )

pure virtual

Set the intrinsic camera parameters.

Parameters

[in]

intrinsic_parameters

intrinsic camera parameters

setParameters()

virtual void SolAR::api::input::devices::ICamera::setParameters ( const SolAR::datastructure::CameraParameters &  parameters )

pure virtual

Set the distortion and intrinsic camera parameters.

Parameters

[in]

parameters

distortion and intrinsic camera parameters

setResolution()

virtual void SolAR::api::input::devices::ICamera::setResolution ( const SolAR::datastructure::Sizei &  resolution )

pure virtual

Set the acquisition device image resolution.

Parameters

[in]

resolution

device image resolution

---

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

• interfaces/api/input/devices/ICamera.h