Solar
Public Member Functions | List of all members
SolAR::api::input::devices::IARDevice Class Referenceabstract

Retrieve synchronized sensor images and poses from an external device (ie. HoloLens). UUID: 999085e6-1d11-41a5-8cca-3daf4e02e941 More...

#include <IARDevice.h>

Inheritance diagram for SolAR::api::input::devices::IARDevice:
Inheritance graph
[legend]
Collaboration diagram for SolAR::api::input::devices::IARDevice:
Collaboration graph
[legend]

Public Member Functions

 IARDevice ()=default
 Specify the IARDevice constructor class.
 
virtual ~IARDevice ()=default
 Specify the IARDevice destructor class.
 
virtual FrameworkReturnCode getData (std::vector< SRef< SolAR::datastructure::Image > > &images, std::vector< SolAR::datastructure::Transform3Df > &poses, std::chrono::system_clock::time_point &timestamp)=0
 Retrieve a set of images and their associated poses from the sensors as well as timestamp. More...
 
virtual const SolAR::datastructure::CameraRigParametersgetCameraParameters () const =0
 Get parameters of a camera rig. 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

Retrieve synchronized sensor images and poses from an external device (ie. HoloLens). UUID: 999085e6-1d11-41a5-8cca-3daf4e02e941

This class describes the interface for retrieving data from a AR device that provides.

Member Function Documentation

◆ getCameraParameters()

virtual const SolAR::datastructure::CameraRigParameters & SolAR::api::input::devices::IARDevice::getCameraParameters ( ) const
pure virtual

Get parameters of a camera rig.

Returns
the camera rig parameters

◆ getData()

virtual FrameworkReturnCode SolAR::api::input::devices::IARDevice::getData ( std::vector< SRef< SolAR::datastructure::Image > > &  images,
std::vector< SolAR::datastructure::Transform3Df > &  poses,
std::chrono::system_clock::time_point &  timestamp 
)
pure virtual

Retrieve a set of images and their associated poses from the sensors as well as timestamp.

Parameters
[out]imagesthe captured images.
[out]posesthe associated poses.
[out]timestampthe timestamp.
Returns
FrameworkReturnCode::SUCCESS if succeed, else FrameworkReturnCode::_ERROR

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