Defines a pose estimation pipeline. UUID: b5a6225e-6a91-4050-b298-886f4c17d9d2 More...

Inheritance diagram for SolAR::api::pipeline::IPoseEstimationPipeline:

Collaboration diagram for SolAR::api::pipeline::IPoseEstimationPipeline:

Public Member Functions
	IPoseEstimationPipeline ()=default
	IPoseEstimationPipeline default constructor.

virtual	~IPoseEstimationPipeline ()=default
	IPoseEstimationPipeline default destructor.

virtual FrameworkReturnCode	start (void *imageDataBuffer)=0
	Starts the pipeline and provides a texture buffer which will be updated when required. More...

virtual SolAR::datastructure::CameraParameters	getCameraParameters () const =0
	Provide the camera parameters. More...

virtual sink::SinkReturnCode	update (SolAR::datastructure::Transform3Df &pose)=0
	update the pipeline Get the new pose and update the texture buffer with the image that has to be displayed More...

virtual source::SourceReturnCode	loadSourceImage (void *sourceTextureHandle, int width, int height)=0
	load a generic texture buffer. More...

Public Member Functions inherited from SolAR::api::pipeline::IPipeline
virtual FrameworkReturnCode	init ()=0
	Initialization of the pipeline. More...

virtual FrameworkReturnCode	start ()=0
	Start the pipeline. More...

virtual FrameworkReturnCode	stop ()=0
	Stop the pipeline. More...

Detailed Description

Defines a pose estimation pipeline. UUID: b5a6225e-6a91-4050-b298-886f4c17d9d2

This class provides the interface to define a video see-through pipeline.

Member Function Documentation

virtual SolAR::datastructure::CameraParameters SolAR::api::pipeline::IPoseEstimationPipeline::getCameraParameters ( ) const

pure virtual

Provide the camera parameters.

virtual source::SourceReturnCode SolAR::api::pipeline::IPoseEstimationPipeline::loadSourceImage	(	void *	sourceTextureHandle,
		int	width,
		int	height
	)

pure virtual

load a generic texture buffer.

Parameters

[in]	sourceTextureHandle	a pointer to the texture buffer which will be updated at each call of the update method.
[in]	width	textureHandle buffer width.
[in]	height	textureHandle buffer height.

Returns: FrameworkReturnCode::SUCCESS if the loading succeed, else FrameworkReturnCode::_ERROR

virtual FrameworkReturnCode SolAR::api::pipeline::IPoseEstimationPipeline::start ( void * imageDataBuffer )

pure virtual

Starts the pipeline and provides a texture buffer which will be updated when required.

Parameters

[in] imageDataBuffer a pointer to the texture buffer which will be updated at each call of the update method.

virtual sink::SinkReturnCode SolAR::api::pipeline::IPoseEstimationPipeline::update ( SolAR::datastructure::Transform3Df & pose )

pure virtual

update the pipeline Get the new pose and update the texture buffer with the image that has to be displayed

Parameters

[out] pose the new pose given by the pipeline

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