SLProject  4.3.020
A platform independent 3D computer graphics framework for desktop OS, Android, iOS and online in web browsers
SENSCamera Class Referenceabstract

Pure abstract camera class. More...

#include <SENSCamera.h>

Inheritance diagram for SENSCamera:
[legend]

Public Member Functions

virtual ~SENSCamera ()
 
virtual const SENSCameraConfigstart (std::string deviceId, const SENSCameraStreamConfig &streamConfig, bool provideIntrinsics=true)=0
 
virtual void stop ()=0
 Stop a started camera device. More...
 
virtual const SENSCapturePropscaptureProperties ()=0
 Get SENSCaptureProps which contains necessary information about all available camera devices and their capabilities. More...
 
virtual SENSFrameBasePtr latestFrame ()=0
 Get the latest captured frame. If no frame was captured the frame will be empty (null). More...
 
virtual const SENSCameraConfigconfig () const =0
 defines how the camera was configured during start More...
 
virtual void registerListener (SENSCameraListener *listener)=0
 
virtual void unregisterListener (SENSCameraListener *listener)=0
 
virtual bool started () const =0
 
virtual bool permissionGranted () const =0
 
virtual void setPermissionGranted ()=0
 

Detailed Description

Pure abstract camera class.

Definition at line 159 of file SENSCamera.h.

Constructor & Destructor Documentation

◆ ~SENSCamera()

virtual SENSCamera::~SENSCamera ( )
inlinevirtual

Definition at line 162 of file SENSCamera.h.

162 {}

Member Function Documentation

◆ captureProperties()

virtual const SENSCaptureProps& SENSCamera::captureProperties ( )
pure virtual

Get SENSCaptureProps which contains necessary information about all available camera devices and their capabilities.

Implemented in SENSSimulatedCamera, SENSiOSCamera, SENSiOSARKit, SENSWebCamera, SENSAndroidCamera, and SENSAndroidARCore.

◆ config()

virtual const SENSCameraConfig& SENSCamera::config ( ) const
pure virtual

defines how the camera was configured during start

Implemented in SENSBaseCamera.

◆ latestFrame()

virtual SENSFrameBasePtr SENSCamera::latestFrame ( )
pure virtual

Get the latest captured frame. If no frame was captured the frame will be empty (null).

Implemented in SENSBaseCamera.

◆ permissionGranted()

virtual bool SENSCamera::permissionGranted ( ) const
pure virtual

Implemented in SENSBaseCamera.

◆ registerListener()

virtual void SENSCamera::registerListener ( SENSCameraListener listener)
pure virtual

Implemented in SENSBaseCamera.

◆ setPermissionGranted()

virtual void SENSCamera::setPermissionGranted ( )
pure virtual

Implemented in SENSBaseCamera.

◆ start()

virtual const SENSCameraConfig& SENSCamera::start ( std::string  deviceId,
const SENSCameraStreamConfig streamConfig,
bool  provideIntrinsics = true 
)
pure virtual

Call this function to configure the camera if you exactly know, what device you want to open and with which stream configuration. You can find out these properties by using SENSCaptureProps object (see getCaptureProperties())

Parameters
deviceIdcamera device id to start
streamConfigSENSCameraStreamConfig from camera device. This defines the size of the image. The image is converted to BGR and assigned to SENSFrame::imgBGR.
provideIntrinsicsspecifies if intrinsics estimation should be enabled. The estimated intrinsics are transferred with every SENSFrame as they may be different for every frame (e.g. on iOS). This value has different effects on different architectures.
Returns
the found configuration that is adjusted and used when SENSCamera::start() is called.

Implemented in SENSSimulatedCamera, SENSiOSCamera, SENSWebCamera, SENSAndroidCamera, SENSiOSARKit, and SENSAndroidARCore.

◆ started()

virtual bool SENSCamera::started ( ) const
pure virtual

Implemented in SENSBaseCamera.

◆ stop()

virtual void SENSCamera::stop ( )
pure virtual

Stop a started camera device.

Implemented in SENSSimulatedCamera, SENSiOSCamera, SENSiOSARKit, SENSWebCamera, SENSAndroidCamera, and SENSAndroidARCore.

◆ unregisterListener()

virtual void SENSCamera::unregisterListener ( SENSCameraListener listener)
pure virtual

Implemented in SENSBaseCamera.


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