This class defines a fiducial marker datastructure. More...
#include <ImageMarker.h>
Inheritance diagram for SolAR::datastructure::ImageMarker:
Collaboration diagram for SolAR::datastructure::ImageMarker:
Public Member Functions | |
| ImageMarker ()=default | |
| ImageMarker default constructor. | |
| ImageMarker (const std::string &url, const Sizef &size, const SRef< Image > image) | |
| ImageMarker constructor with image and size of image marker. More... | |
| TrackableType | getType () const override |
| Returns the type of the Trackable object. More... | |
| void | setImage (const SRef< Image > image) |
| Sets the image of the image marker. More... | |
| SRef< Image > | getImage () const |
| Returns the image of the image marker. More... | |
| FrameworkReturnCode | getImageCorners (std::vector< SolAR::datastructure::Point2Df > &imageCorners) const |
| Provide the position of 2D corners in image coordinate system. 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 ImageMarker &marker) |
| template<typename JsonType > | |
| void | from_json (JsonType &j, ImageMarker &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 fiducial marker datastructure.
Constructor & Destructor Documentation
◆ ImageMarker()
| SolAR::datastructure::ImageMarker::ImageMarker | ( | const std::string & | url, |
| const Sizef & | size, | ||
| const SRef< Image > | image | ||
| ) |
ImageMarker constructor with image and size of image marker.
- Parameters
-
[in] url url of the trackable object [in] size size (width and height) of the fiducial marker image [in] image the image representing the marker
Member Function Documentation
◆ getImage()
| SRef< Image > SolAR::datastructure::ImageMarker::getImage | ( | ) | const |
Returns the image of the image marker.
- Returns
- the image representing the marker
◆ getImageCorners()
| FrameworkReturnCode SolAR::datastructure::ImageMarker::getImageCorners | ( | std::vector< SolAR::datastructure::Point2Df > & | imageCorners | ) | const |
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.
◆ getType()
|
overridevirtual |
Returns the type of the Trackable object.
- Returns
- TrackableType: the type of the instance
Implements SolAR::datastructure::Trackable.
◆ setImage()
| void SolAR::datastructure::ImageMarker::setImage | ( | const SRef< Image > | image | ) |
Sets the image of the image marker.
- Parameters
-
[in] image the image representing the marker
The documentation for this class was generated from the following files:
- interfaces/datastructure/ImageMarker.h
- src/datastructure/ImageMarker.cpp
