Solar
Public Member Functions | Protected Attributes | Friends | List of all members
SolAR::datastructure::Trackable Class Referenceabstract

This abstract class defines the generic trackable datastructure. More...

#include <Trackable.h>

Inheritance diagram for SolAR::datastructure::Trackable:
Inheritance graph
[legend]

Public Member Functions

 Trackable ()=default
 Trackable default constructor.
 
 Trackable (const std::string &url)
 Trackable constructor with url.
 
virtual ~Trackable ()
 Trackable destructor.
 
virtual TrackableType getType () const =0
 Returns the type of the Trackable object. More...
 
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)
 

Protected Attributes

std::string m_url
 
datastructure::Transform3Df m_transform3D = Transform3Df::Identity()
 

Friends

class boost::serialization::access
 

Detailed Description

This abstract class defines the generic trackable datastructure.

Member Function Documentation

◆ getTransform3D()

datastructure::Transform3Df SolAR::datastructure::Trackable::getTransform3D ( ) const

Returns the 3D transform from the trackable object to the world coordinates system.

Returns
the 3D transform to the world coordinates system

◆ getType()

virtual TrackableType SolAR::datastructure::Trackable::getType ( ) const
pure virtual

Returns the type of the Trackable object.

Returns
TrackableType: the type of the instance

Implemented in SolAR::datastructure::FiducialMarker, SolAR::datastructure::ImageMarker, and SolAR::datastructure::QRCode.

◆ getURL()

std::string SolAR::datastructure::Trackable::getURL ( ) const

Returns the url of the trackable object.

Returns
the url of the trackable object

◆ setTransform3D()

void SolAR::datastructure::Trackable::setTransform3D ( const datastructure::Transform3Df transform3D)

Sets the 3D transform to the world coordinates system.

Parameters
[in]transform3Dthe 3D transform to the world coordinates system

◆ setURL()

void SolAR::datastructure::Trackable::setURL ( const std::string &  url)

Sets the url of the trackable object.

Parameters
[in]urlthe url

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