Solar
Public Member Functions | List of all members
SolAR::api::input::files::IMarker2DNaturalImage Class Referenceabstract

Loads a natural image marker. UUID: 8fed06f8-c54d-11e7-abc4-cec278b6b50a More...

#include <IMarker2DNaturalImage.h>

Inheritance diagram for SolAR::api::input::files::IMarker2DNaturalImage:
Inheritance graph
[legend]
Collaboration diagram for SolAR::api::input::files::IMarker2DNaturalImage:
Collaboration graph
[legend]

Public Member Functions

virtual FrameworkReturnCode getImage (SRef< datastructure::Image > &img) const =0
 get access to the image of the 2D natural marker More...
 
- Public Member Functions inherited from SolAR::api::input::files::IMarker2DSquared
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::SizefgetSize () 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 a natural image marker. UUID: 8fed06f8-c54d-11e7-abc4-cec278b6b50a

The origin of the marker is positionned 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

◆ getImage()

virtual FrameworkReturnCode SolAR::api::input::files::IMarker2DNaturalImage::getImage ( SRef< datastructure::Image > &  img) const
pure virtual

get access to the image of the 2D natural marker

Parameters
[in,out]imga shared reference to the image
Returns
FrameworkReturnCode to track sucessful or failing event.

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