Inheritance diagram for dart::dynamics::EndEffector:

Collaboration diagram for dart::dynamics::EndEffector:

Public Types
using	UniqueProperties = detail::EndEffectorProperties

using	BasicProperties = common::Composite::MakeProperties< NameAspect, FixedFrame, EndEffector >

using	Properties = common::Composite::Properties

Public Types inherited from dart::common::EmbedPropertiesOnTopOf< EndEffector, detail::EndEffectorProperties, detail::EndEffectorCompositeBase >
using	Impl = EmbedProperties< EndEffector, detail::EndEffectorProperties >

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	~EndEffector ()=default
	Destructor.

Structural Properties
void	setProperties (const BasicProperties &_properties)
	Set the Properties of this EndEffector. More...

void	setProperties (const UniqueProperties &properties, bool useNow=false)
	Set the Properties of this EndEffector. More...

void	setAspectProperties (const AspectProperties &properties)
	Set the AspectProperties of this EndEffector.

Properties	getEndEffectorProperties () const
	Get the Properties of this EndEffector.

void	copy (const EndEffector &_otherEndEffector)
	Copy the State and Properties of another EndEffector.

void	copy (const EndEffector *_otherEndEffector)
	Copy the State and Properties of another EndEffector.

EndEffector &	operator= (const EndEffector &_otherEndEffector)
	Copy the State and Properties of another EndEffector.

void	setDefaultRelativeTransform (const Eigen::Isometry3d &_newDefaultTf, bool _useNow=false)
	Set the default relative transform of this EndEffector. More...

void	resetRelativeTransform ()
	Set the current relative transform of this EndEffector to the default relative transform of this EndEffector. More...

Notifications
void	dirtyTransform () override

Public Member Functions inherited from dart::common::EmbedPropertiesOnTopOf< EndEffector, detail::EndEffectorProperties, detail::EndEffectorCompositeBase >
	EmbedPropertiesOnTopOf (Args &&... args)

Protected Member Functions
	EndEffector (BodyNode *parent, const BasicProperties &properties)
	Constructor used by the Skeleton class.

Node *	cloneNode (BodyNode *_parent) const override

Member Function Documentation

◆ resetRelativeTransform()

void dart::dynamics::EndEffector::resetRelativeTransform ( )

Set the current relative transform of this EndEffector to the default relative transform of this EndEffector.

The default relative transform can be set with setDefaultRelativeTransform()

void dart::dynamics::EndEffector::setDefaultRelativeTransform	(	const Eigen::Isometry3d &	_newDefaultTf,
		bool	_useNow = `false`
	)

Set the default relative transform of this EndEffector.

The relative transform of this EndEffector will be set to _newDefaultTf the next time resetRelativeTransform() is called. If _useNow is set to true, then resetRelativeTransform() will be called at the end of this function.

void dart::dynamics::EndEffector::setProperties ( const BasicProperties & _properties )

Set the Properties of this EndEffector.

If _useNow is true, the current Transform will be set to the new default transform.

void dart::dynamics::EndEffector::setProperties	(	const UniqueProperties &	properties,
		bool	useNow = `false`
	)

Set the Properties of this EndEffector.

If _useNow is true, the current Transform will be set to the new default transform.

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