DART
6.10.1
|
class ScrewJoint More...
#include <ScrewJoint.hpp>
Public Types | |
using | UniqueProperties = detail::ScrewJointUniqueProperties |
using | Properties = detail::ScrewJointProperties |
using | Base = detail::ScrewJointBase |
using | Impl = EmbedProperties< DerivedT, PropertiesDataT > |
using | Derived = typename Impl::Derived |
using | AspectPropertiesData = typename Impl::AspectPropertiesData |
using | AspectProperties = typename Impl::AspectProperties |
using | Aspect = typename Impl::Aspect |
Public Member Functions | |
bool | hasScrewJointAspect () const |
Check if this Composite currently has ScrewJointAspect . More... | |
Aspect * | getScrewJointAspect () |
Get a(an) ScrewJointAspect from this Composite. More... | |
const Aspect * | getScrewJointAspect () const |
Get a(an) ScrewJointAspect from this Composite. More... | |
Aspect * | getScrewJointAspect (const bool createIfNull) |
Get a(an) ScrewJointAspect from this Composite. More... | |
void | setScrewJointAspect (const Aspect *aspect) |
Make a clone of ScrewJointAspect and place the clone into this Composite. More... | |
void | setScrewJointAspect (std::unique_ptr< Aspect > &&aspect) |
Use move semantics to place ScrewJointAspect into this Composite. More... | |
template<typename... Args> | |
Aspect * | createScrewJointAspect (Args &&... args) |
Construct a(an) ScrewJointAspect inside of this Composite. More... | |
void | removeScrewJointAspect () |
Remove a(an) ScrewJointAspect from this Composite. More... | |
std::unique_ptr< Aspect > | releaseScrewJointAspect () |
Remove a(an) ScrewJointAspect from this Composite, but return its unique_ptr instead of letting it be deleted. More... | |
ScrewJoint (const ScrewJoint &)=delete | |
virtual | ~ScrewJoint () |
Destructor. More... | |
void | setProperties (const Properties &_properties) |
Set the Properties of this ScrewJoint. More... | |
void | setProperties (const UniqueProperties &_properties) |
Set the Properties of this ScrewJoint. More... | |
void | setAspectProperties (const AspectProperties &properties) |
Set the AspectProperties of this ScrewJoint. More... | |
Properties | getScrewJointProperties () const |
Get the Properties of this ScrewJoint. More... | |
void | copy (const ScrewJoint &_otherJoint) |
Copy the Properties of another ScrewJoint. More... | |
void | copy (const ScrewJoint *_otherJoint) |
Copy the Properties of another ScrewJoint. More... | |
ScrewJoint & | operator= (const ScrewJoint &_otherJoint) |
Copy the Properties of another ScrewJoint. More... | |
const std::string & | getType () const override |
bool | isCyclic (std::size_t _index) const override |
void | setAxis (const Eigen::Vector3d &_axis) |
const Eigen::Vector3d & | getAxis () const |
void | setPitch (double _pitch) |
double | getPitch () const |
GenericJoint< math::R1Space >::JacobianMatrix | getRelativeJacobianStatic (const GenericJoint< math::R1Space >::Vector &positions) const override |
const AspectProperties & | getAspectProperties () const |
Static Public Member Functions | |
static const std::string & | getStaticType () |
Get joint type for this class. More... | |
Protected Member Functions | |
ScrewJoint (const Properties &properties) | |
Constructor called by Skeleton class. More... | |
Joint * | clone () const override |
void | updateDegreeOfFreedomNames () override |
void | updateRelativeTransform () const override |
void | updateRelativeJacobian (bool _mandatory=true) const override |
void | updateRelativeJacobianTimeDeriv () const override |
Protected Attributes | |
AspectProperties | mAspectProperties |
Aspect::Properties data, directly accessible to your derived class. More... | |
Friends | |
class | Skeleton |
class ScrewJoint
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
delete |
|
virtual |
Destructor.
|
protected |
Constructor called by Skeleton class.
|
overrideprotected |
void dart::dynamics::ScrewJoint::copy | ( | const ScrewJoint & | _otherJoint | ) |
Copy the Properties of another ScrewJoint.
void dart::dynamics::ScrewJoint::copy | ( | const ScrewJoint * | _otherJoint | ) |
Copy the Properties of another ScrewJoint.
|
inline |
Construct a(an) ScrewJointAspect inside of this Composite.
|
inlineinherited |
const Eigen::Vector3d & dart::dynamics::ScrewJoint::getAxis | ( | ) | const |
double dart::dynamics::ScrewJoint::getPitch | ( | ) | const |
|
override |
|
inline |
Get a(an) ScrewJointAspect from this Composite.
|
inline |
Get a(an) ScrewJointAspect from this Composite.
|
inline |
Get a(an) ScrewJointAspect from this Composite.
If _createIfNull is true, then a(an) ScrewJointAspect will be generated if one does not already exist.
ScrewJoint::Properties dart::dynamics::ScrewJoint::getScrewJointProperties | ( | ) | const |
Get the Properties of this ScrewJoint.
|
static |
Get joint type for this class.
|
override |
|
inline |
Check if this Composite currently has ScrewJointAspect .
|
override |
ScrewJoint & dart::dynamics::ScrewJoint::operator= | ( | const ScrewJoint & | _otherJoint | ) |
Copy the Properties of another ScrewJoint.
|
inline |
Remove a(an) ScrewJointAspect from this Composite, but return its unique_ptr instead of letting it be deleted.
This allows you to safely use move semantics to transfer a(an) ScrewJointAspect between two Composites.
|
inline |
Remove a(an) ScrewJointAspect from this Composite.
void dart::dynamics::ScrewJoint::setAspectProperties | ( | const AspectProperties & | properties | ) |
Set the AspectProperties of this ScrewJoint.
void dart::dynamics::ScrewJoint::setAxis | ( | const Eigen::Vector3d & | _axis | ) |
void dart::dynamics::ScrewJoint::setPitch | ( | double | _pitch | ) |
void dart::dynamics::ScrewJoint::setProperties | ( | const Properties & | _properties | ) |
Set the Properties of this ScrewJoint.
void dart::dynamics::ScrewJoint::setProperties | ( | const UniqueProperties & | _properties | ) |
Set the Properties of this ScrewJoint.
|
inline |
Make a clone of ScrewJointAspect and place the clone into this Composite.
If a(an) ScrewJointAspect already exists in this Composite, the existing ScrewJointAspect will be destroyed.
|
inline |
Use move semantics to place ScrewJointAspect into this Composite.
If a(an) ScrewJointAspect already exists in this Composite, the existing ScrewJointAspect will be destroyed.
|
overrideprotected |
|
overrideprotected |
|
overrideprotected |
|
overrideprotected |
|
friend |
|
protectedinherited |
Aspect::Properties data, directly accessible to your derived class.