Solar
Public Member Functions | Friends | List of all members
SolAR::datastructure::QRCode Class Reference

This class defines a QR code datastructure. More...

#include <QRCode.h>

Inheritance diagram for SolAR::datastructure::QRCode:
Inheritance graph
[legend]
Collaboration diagram for SolAR::datastructure::QRCode:
Collaboration graph
[legend]

Public Member Functions

 QRCode ()=default
 QRCode default constructor.
 
 QRCode (const std::string &url, const Sizef &size, const std::string &code)
 QRCode constructor with decoding code and size of QR code image. More...
 
TrackableType getType () const override
 Returns the type of the Trackable object. More...
 
void setCode (const std::string &code)
 Set deconding code of QRCode. More...
 
std::string getCode () const
 Returns the decoding code. More...
 
template<typename Archive >
void serialize (Archive &ar, ATTRIBUTE(maybe_unused) const unsigned int version)
 
- Public Member Functions inherited from SolAR::datastructure::Trackable2D
 Trackable2D ()=default
 Trackable default constructor.
 
 Trackable2D (const std::string &url, const Sizef &size)
 Trackable2D constructor with url and size.
 
 Trackable2D (const std::string &url, const float &width, const float &height)
 Trackable2D constructor with url, width and height.
 
virtual ~Trackable2D ()
 Trackable2D destructor.
 
Sizef getSize () const
 Provides the size of the 2D trackable object. More...
 
float getWidth () const
 Provides the width of the 2D trackable object. More...
 
float getHeight () const
 Provides the height of the 2D trackable object. More...
 
void setSize (const Sizef &size)
 Sets the size of the 2D trackable object. More...
 
void setWidth (const float &width)
 Sets the width of the 2D trackable object. More...
 
void setHeight (const float &height)
 Sets the height of the 2D trackable object. More...
 
FrameworkReturnCode getWorldCorners (std::vector< SolAR::datastructure::Point3Df > &worldCorners) const
 Provide the position of 3D corners in world coordinate system. More...
 
template<typename Archive >
void serialize (Archive &ar, ATTRIBUTE(maybe_unused) const unsigned int version)
 
- Public Member Functions inherited from SolAR::datastructure::Trackable
 Trackable ()=default
 Trackable default constructor.
 
 Trackable (const std::string &url)
 Trackable constructor with url.
 
virtual ~Trackable ()
 Trackable destructor.
 
std::string getURL () const
 Returns the url of the trackable object. More...
 
void setURL (const std::string &url)
 Sets the url of the trackable object. More...
 
datastructure::Transform3Df getTransform3D () const
 Returns the 3D transform from the trackable object to the world coordinates system. More...
 
void setTransform3D (const datastructure::Transform3Df &transform3D)
 Sets the 3D transform to the world coordinates system. More...
 
template<typename Archive >
void serialize (Archive &ar, ATTRIBUTE(maybe_unused) const unsigned int version)
 

Friends

class boost::serialization::access
 
template<typename JsonType >
void to_json (JsonType &j, const QRCode &marker)
 
template<typename JsonType >
void from_json (JsonType &j, QRCode &marker)
 

Additional Inherited Members

- Protected Attributes inherited from SolAR::datastructure::Trackable2D
Sizef m_size
 
- Protected Attributes inherited from SolAR::datastructure::Trackable
std::string m_url
 
datastructure::Transform3Df m_transform3D = Transform3Df::Identity()
 

Detailed Description

This class defines a QR code datastructure.

Constructor & Destructor Documentation

◆ QRCode()

SolAR::datastructure::QRCode::QRCode ( const std::string &  url,
const Sizef size,
const std::string &  code 
)

QRCode constructor with decoding code and size of QR code image.

Parameters
[in]urlurl of the trackable object
[in]sizesize (width and height) of the QR code image
[in]codedecoding code of QRCode

Member Function Documentation

◆ getCode()

std::string SolAR::datastructure::QRCode::getCode ( ) const

Returns the decoding code.

Returns
the decoding code

◆ getType()

TrackableType SolAR::datastructure::QRCode::getType ( ) const
overridevirtual

Returns the type of the Trackable object.

Returns
TrackableType the type of the instance

Implements SolAR::datastructure::Trackable.

◆ setCode()

void SolAR::datastructure::QRCode::setCode ( const std::string &  code)

Set deconding code of QRCode.

Parameters
[in]codethe decoding code

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