OSVR-Core
Public Member Functions | List of all members
osvr::common::ParsedArticulation Class Reference

Public Member Functions

OSVR_COMMON_EXPORT ParsedArticulation (std::string const &src)
 Constructor - performs parse and normalization of format.
 
 ParsedArticulation (Json::Value src)
 Constructor - performs normalization of format.
 
OSVR_COMMON_EXPORT bool isValid () const
 Will return false if trackerPath is not specified. More...
 
OSVR_COMMON_EXPORT std::string getBoneName () const
 Get the ultimate source/leaf of the articulation. More...
 
OSVR_COMMON_EXPORT std::string getArticulationType () const
 Get the type of articulation. More...
 
OSVR_COMMON_EXPORT std::string getTrackerPath () const
 Get the tracker path to sensor that corresponds to current articulation. More...
 
OSVR_COMMON_EXPORT void setTrackerPath (std::string const &fullTrackerPath)
 Sets the tracker path. More...
 

Member Function Documentation

§ getArticulationType()

std::string osvr::common::ParsedArticulation::getArticulationType ( ) const

Get the type of articulation.

Returns an empty string if it's not specified

§ getBoneName()

std::string osvr::common::ParsedArticulation::getBoneName ( ) const

Get the ultimate source/leaf of the articulation.

May return an empty string if it it's not specified

§ getTrackerPath()

std::string osvr::common::ParsedArticulation::getTrackerPath ( ) const

Get the tracker path to sensor that corresponds to current articulation.

Tracker path must be specified during the creation and will make articulation invalid

§ isValid()

bool osvr::common::ParsedArticulation::isValid ( ) const

Will return false if trackerPath is not specified.

Other details are optional

Todo:
should I check for more conditions here

§ setTrackerPath()

void osvr::common::ParsedArticulation::setTrackerPath ( std::string const &  fullTrackerPath)

Sets the tracker path.

After getting the path from articulation spec, it should be converted to full path (with device name)


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