SolAR::MODULES::OPENCV::SolARMarker2DNaturalImageOpencv Class Reference

Loads a 2D natural image marker from a file. UUID: efcdb590-c570-11e7-abc4-cec278b6b50a More...

#include <SolARMarker2DNaturalImageOpencv.h>

Inheritance diagram for SolAR::MODULES::OPENCV::SolARMarker2DNaturalImageOpencv:

Collaboration diagram for SolAR::MODULES::OPENCV::SolARMarker2DNaturalImageOpencv:

Public Member Functions
void	unloadComponent () override final
FrameworkReturnCode	loadMarker () override
FrameworkReturnCode	getImage (SRef< datastructure::Image > &img) const override
	get access to the image of the 2D natural marker More...
FrameworkReturnCode	getImageCorners (std::vector< datastructure::Point2Df > &imageCorners) const override
	Provide the position of 2D corners in image coordinate system. More...
FrameworkReturnCode	getWorldCorners (std::vector< datastructure::Point3Df > &worldCorners) const override
	Provide the position of 3D corners in world coordinate system. More...
void	setSize (const float &width, const float &height) override
float	getWidth () const override
float	getHeight () const override
const datastructure::Sizef &	getSize () const override

Detailed Description

Loads a 2D natural image marker from a file. UUID: efcdb590-c570-11e7-abc4-cec278b6b50a

Properties

filePath	the path to the file describing the 2D natural image marker
	type: string; default: ""

Member Function Documentation

getImage()

FrameworkReturnCode SolAR::MODULES::OPENCV::SolARMarker2DNaturalImageOpencv::getImage ( SRef< datastructure::Image > &  img ) const

override

get access to the image of the 2D natural marker

Parameters

[in,out]

img

a shared reference to the image

Returns

FrameworkReturnCode to track sucessful or failing event.

getImageCorners()

FrameworkReturnCode SolAR::MODULES::OPENCV::SolARMarker2DNaturalImageOpencv::getImageCorners ( std::vector< datastructure::Point2Df > &  imageCorners ) const

override

Provide the position of 2D corners in image coordinate system.

Parameters

[out]

imageCorners

the 2D corners of the marker in image coordinate system

Returns

FrameworkReturnCode::SUCCESS if sucessful, eiher FrameworkRetunrnCode::_ERROR.

getWorldCorners()

FrameworkReturnCode SolAR::MODULES::OPENCV::SolARMarker2DNaturalImageOpencv::getWorldCorners ( std::vector< datastructure::Point3Df > &  worldCorners ) const

override

Provide the position of 3D corners in world coordinate system.

Parameters

[out]

worldCorners

the 3D corners of the marker in world coordinate system

Returns

FrameworkReturnCode::SUCCESS if sucessful, eiher FrameworkRetunrnCode::_ERROR.

---

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

• SolARModuleOpenCV/interfaces/SolARMarker2DNaturalImageOpencv.h