SolAR::api::input::files::IMarker2DSquared Class Reference

Loads any 2D squared marker. UUID: e9cdcf6e-c54c-11e7-abc4-cec278b6b50a More...

#include <IMarker2DSquared.h>

Inheritance diagram for SolAR::api::input::files::IMarker2DSquared:

Collaboration diagram for SolAR::api::input::files::IMarker2DSquared:

Public Member Functions
virtual void	setSize (const float &width, const float &height)=0
	define the size of the 2D Marker according to the user-defined unit (the same used for the camera calibration) More...
virtual float	getWidth () const =0
	Return the width of the 2D Marker. More...
virtual float	getHeight () const =0
	Return the height of the 2D Marker. More...
virtual const datastructure::Sizef &	getSize () const =0
	Return the width and height of the 2D Marker. More...
virtual FrameworkReturnCode	getImageCorners (std::vector< datastructure::Point2Df > &imageCorners) const =0
	Provide the position of 2D corners in image coordinate system. More...
virtual FrameworkReturnCode	getWorldCorners (std::vector< datastructure::Point3Df > &worldCorners) const =0
	Provide the position of 3D corners in world coordinate system. More...
Public Member Functions inherited from SolAR::api::input::files::IMarker
virtual FrameworkReturnCode	loadMarker ()=0
	Load a specific marker and its features (size, descriptors..). More...

Detailed Description

Loads any 2D squared marker. UUID: e9cdcf6e-c54c-11e7-abc4-cec278b6b50a

The origin of the marker is position at its center. The x-axis points to the right of the marker, the y-axis points to the top of the marker, and the z-axis points frontward.

Member Function Documentation

getHeight()

virtual float SolAR::api::input::files::IMarker2DSquared::getHeight ( ) const

pure virtual

Return the height of the 2D Marker.

Returns

float: height of 2D Marker

getImageCorners()

virtual FrameworkReturnCode SolAR::api::input::files::IMarker2DSquared::getImageCorners ( std::vector< datastructure::Point2Df > &  imageCorners ) const

pure virtual

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.

getSize()

virtual const datastructure::Sizef& SolAR::api::input::files::IMarker2DSquared::getSize ( ) const

pure virtual

Return the width and height of the 2D Marker.

Returns

datastructure::Sizef: width and height of 2D Marker

getWidth()

virtual float SolAR::api::input::files::IMarker2DSquared::getWidth ( ) const

pure virtual

Return the width of the 2D Marker.

Returns

float: width of 2D Marker

getWorldCorners()

virtual FrameworkReturnCode SolAR::api::input::files::IMarker2DSquared::getWorldCorners ( std::vector< datastructure::Point3Df > &  worldCorners ) const

pure virtual

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.

setSize()

virtual void SolAR::api::input::files::IMarker2DSquared::setSize ( const float &  width, const float &  height  )

pure virtual

define the size of the 2D Marker according to the user-defined unit (the same used for the camera calibration)

Parameters

[in]	width	width of 2D Marker
[in]	height	height of 2D Marker

---

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

• interfaces/api/input/files/IMarker2DSquared.h