dart::dynamics::Marker Class Reference

#include <Marker.hpp>

Inheritance diagram for dart::dynamics::Marker:

Public Types
using	ConstraintType = detail::MarkerProperties::ConstraintType
using	BasicProperties = common::Composite::MakeProperties< NameAspect, FixedFrame, Marker >
using	Properties = common::Composite::Properties
using	Impl = EmbedProperties< Marker, detail::MarkerProperties >
using	Derived = typename Impl::Derived
using	AspectPropertiesData = typename Impl::AspectPropertiesData
using	AspectProperties = typename Impl::AspectProperties
using	Aspect = typename Impl::Aspect
using	Base = CompositeJoiner< Impl, CompositeBases... >

Public Member Functions
virtual	~Marker ()=default
	Destructor.
void	setAspectProperties (const AspectProperties &properties)
	Set the AspectProperties of this Marker.
BodyNode *	getBodyNode ()
	Get the BodyNode this Marker belongs to.
const BodyNode *	getBodyNode () const
	Get the (const) BodyNode this Marker belongs to.
Eigen::Vector3d	getLocalPosition () const
	Get position of this marker in the parent body node coordinates.
void	setLocalPosition (const Eigen::Vector3d &offset)
	Set position of this marker in the parent body node coordinates.
Eigen::Vector3d	getWorldPosition () const
	Get position in the world coordinates.
int	getID () const
	Get global unique ID.
void	setConstraintType (ConstraintType type)
	Set constraint type. which will be useful for inverse kinematics.
ConstraintType	getConstraintType () const
	Get constraint type. which will be useful for inverse kinematics.
void	setColor (const Eigen::Vector4d &color)
	Set the color of this Marker.
const Eigen::Vector4d &	getColor () const
	Return color of this Marker.
const AspectProperties &	getAspectProperties () const

Static Public Attributes
static constexpr ConstraintType	NO = detail::MarkerProperties::NO
static constexpr ConstraintType	HARD = detail::MarkerProperties::HARD
static constexpr ConstraintType	SOFT = detail::MarkerProperties::SOFT

Protected Member Functions
	Marker (BodyNode *parent, const BasicProperties &properties)
	Constructor used by BodyNode.
Node *	cloneNode (BodyNode *parent) const override

Protected Attributes
AspectProperties	mAspectProperties
	Aspect::Properties data, directly accessible to your derived class.

Private Attributes
int	mID
	Unique ID of this marker globally.

Static Private Attributes
static int	msMarkerCount = 0
	Counts the number of markers globally.

Friends
class	BodyNode

Member Typedef Documentation

Aspect

using dart::common::EmbedPropertiesOnTopOf< Marker , detail::MarkerProperties , CompositeBases >::Aspect = typename Impl::Aspect

inherited

AspectProperties

using dart::common::EmbedPropertiesOnTopOf< Marker , detail::MarkerProperties , CompositeBases >::AspectProperties = typename Impl::AspectProperties

inherited

AspectPropertiesData

using dart::common::EmbedPropertiesOnTopOf< Marker , detail::MarkerProperties , CompositeBases >::AspectPropertiesData = typename Impl::AspectPropertiesData

inherited

Base

using dart::common::EmbedPropertiesOnTopOf< Marker , detail::MarkerProperties , CompositeBases >::Base = CompositeJoiner<Impl, CompositeBases...>

inherited

BasicProperties

using dart::dynamics::Marker::BasicProperties = common::Composite::MakeProperties<NameAspect, FixedFrame, Marker>

ConstraintType

using dart::dynamics::Marker::ConstraintType = detail::MarkerProperties::ConstraintType

Derived

using dart::common::EmbedPropertiesOnTopOf< Marker , detail::MarkerProperties , CompositeBases >::Derived = typename Impl::Derived

inherited

Impl

using dart::common::EmbedPropertiesOnTopOf< Marker , detail::MarkerProperties , CompositeBases >::Impl = EmbedProperties<Marker , detail::MarkerProperties >

inherited

Properties

using dart::dynamics::Marker::Properties = common::Composite::Properties

Constructor & Destructor Documentation

~Marker()

virtual dart::dynamics::Marker::~Marker ( )

virtualdefault

Destructor.

Marker()

dart::dynamics::Marker::Marker ( BodyNode *  parent, const BasicProperties &  properties  )

protected

Constructor used by BodyNode.

Member Function Documentation

cloneNode()

Node * dart::dynamics::Marker::cloneNode ( BodyNode *  parent ) const

overrideprotected

getAspectProperties()

const AspectProperties & dart::common::EmbedProperties< Marker , detail::MarkerProperties >::getAspectProperties ( ) const

inlineinherited

getBodyNode() [1/2]

BodyNode * dart::dynamics::Marker::getBodyNode

(

)

Get the BodyNode this Marker belongs to.

Deprecated: Use getBodyNodePtr() instead

getBodyNode() [2/2]

const BodyNode * dart::dynamics::Marker::getBodyNode

(

)

const

Get the (const) BodyNode this Marker belongs to.

Deprecated: Use getBodyNodePtr() instead

getColor()

const Eigen::Vector4d & dart::dynamics::Marker::getColor

(

)

const

Return color of this Marker.

getConstraintType()

Marker::ConstraintType dart::dynamics::Marker::getConstraintType

(

)

const

Get constraint type. which will be useful for inverse kinematics.

getID()

int dart::dynamics::Marker::getID

(

)

const

Get global unique ID.

getLocalPosition()

Eigen::Vector3d dart::dynamics::Marker::getLocalPosition

(

)

const

Get position of this marker in the parent body node coordinates.

getWorldPosition()

Eigen::Vector3d dart::dynamics::Marker::getWorldPosition

(

)

const

Get position in the world coordinates.

setAspectProperties()

void dart::dynamics::Marker::setAspectProperties

(

const AspectProperties &

properties

)

Set the AspectProperties of this Marker.

setColor()

void dart::dynamics::Marker::setColor

(

const Eigen::Vector4d &

color

)

Set the color of this Marker.

setConstraintType()

void dart::dynamics::Marker::setConstraintType

(

Marker::ConstraintType

type

)

Set constraint type. which will be useful for inverse kinematics.

setLocalPosition()

void dart::dynamics::Marker::setLocalPosition

(

const Eigen::Vector3d &

offset

)

Set position of this marker in the parent body node coordinates.

Friends And Related Symbol Documentation

BodyNode

friend class BodyNode

friend

Member Data Documentation

HARD

constexpr Marker::ConstraintType dart::dynamics::Marker::HARD = detail::MarkerProperties::HARD

staticconstexpr

mAspectProperties

AspectProperties dart::common::EmbedProperties< Marker , detail::MarkerProperties >::mAspectProperties

protectedinherited

Aspect::Properties data, directly accessible to your derived class.

mID

int dart::dynamics::Marker::mID

private

Unique ID of this marker globally.

msMarkerCount

int dart::dynamics::Marker::msMarkerCount = 0

staticprivate

Counts the number of markers globally.

NO

constexpr Marker::ConstraintType dart::dynamics::Marker::NO = detail::MarkerProperties::NO

staticconstexpr

SOFT

constexpr Marker::ConstraintType dart::dynamics::Marker::SOFT = detail::MarkerProperties::SOFT

staticconstexpr