dart::constraint::ConstraintBase Class Reference

Constraint is a base class of concrete constraints classes. More...

#include <ConstraintBase.hpp>

Inheritance diagram for dart::constraint::ConstraintBase:

Public Member Functions
virtual const std::string &	getType () const
	Returns a string representing the constraint type. More...
std::size_t	getDimension () const
	Return dimesion of this constranit. More...
virtual void	update ()=0
	Update constraint using updated Skeleton's states. More...
virtual void	getInformation (ConstraintInfo *info)=0
	Fill LCP variables. More...
virtual void	applyUnitImpulse (std::size_t index)=0
	Apply unit impulse to constraint space. More...
virtual void	getVelocityChange (double *vel, bool withCfm)=0
	Get velocity change due to the uint impulse. More...
virtual void	excite ()=0
	Excite the constraint. More...
virtual void	unexcite ()=0
	Unexcite the constraint. More...
virtual void	applyImpulse (double *lambda)=0
	Apply computed constraint impulse to constrained skeletons. More...
virtual bool	isActive () const =0
	Return true if this constraint is active. More...
virtual dynamics::SkeletonPtr	getRootSkeleton () const =0
virtual void	uniteSkeletons ()
virtual	~ConstraintBase ()
	Destructor. More...

Static Public Member Functions
static dynamics::SkeletonPtr	compressPath (dynamics::SkeletonPtr skeleton)
static dynamics::SkeletonPtr	getRootSkeleton (dynamics::SkeletonPtr skeleton)

Protected Member Functions
	ConstraintBase ()
	Default contructor. More...

Protected Attributes
std::size_t	mDim
	Dimension of constraint. More...

Friends
class	ConstraintSolver
class	ConstrainedGroup

Detailed Description

Constraint is a base class of concrete constraints classes.

Constructor & Destructor Documentation

~ConstraintBase()

dart::constraint::ConstraintBase::~ConstraintBase ( )

virtual

Destructor.

ConstraintBase()

dart::constraint::ConstraintBase::ConstraintBase ( )

protected

Default contructor.

Member Function Documentation

applyImpulse()

virtual void dart::constraint::ConstraintBase::applyImpulse ( double *  lambda )

pure virtual

Apply computed constraint impulse to constrained skeletons.

Implemented in dart::constraint::ServoMotorConstraint, dart::constraint::MimicMotorConstraint, dart::constraint::JointLimitConstraint, dart::constraint::ContactConstraint, dart::constraint::WeldJointConstraint, dart::constraint::SoftContactConstraint, dart::constraint::JointCoulombFrictionConstraint, and dart::constraint::BallJointConstraint.

applyUnitImpulse()

virtual void dart::constraint::ConstraintBase::applyUnitImpulse ( std::size_t  index )

pure virtual

Apply unit impulse to constraint space.

Implemented in dart::constraint::ServoMotorConstraint, dart::constraint::MimicMotorConstraint, dart::constraint::JointLimitConstraint, dart::constraint::ContactConstraint, dart::constraint::WeldJointConstraint, dart::constraint::JointCoulombFrictionConstraint, dart::constraint::BallJointConstraint, and dart::constraint::SoftContactConstraint.

compressPath()

dynamics::SkeletonPtr dart::constraint::ConstraintBase::compressPath ( dynamics::SkeletonPtr  skeleton )

static

excite()

virtual void dart::constraint::ConstraintBase::excite ( )

pure virtual

Excite the constraint.

Implemented in dart::constraint::WeldJointConstraint, dart::constraint::SoftContactConstraint, dart::constraint::ServoMotorConstraint, dart::constraint::MimicMotorConstraint, dart::constraint::JointLimitConstraint, dart::constraint::JointCoulombFrictionConstraint, dart::constraint::ContactConstraint, and dart::constraint::BallJointConstraint.

getDimension()

std::size_t dart::constraint::ConstraintBase::getDimension

(

)

const

Return dimesion of this constranit.

getInformation()

virtual void dart::constraint::ConstraintBase::getInformation ( ConstraintInfo *  info )

pure virtual

Fill LCP variables.

Implemented in dart::constraint::ServoMotorConstraint, dart::constraint::MimicMotorConstraint, dart::constraint::JointLimitConstraint, dart::constraint::ContactConstraint, dart::constraint::WeldJointConstraint, dart::constraint::JointCoulombFrictionConstraint, dart::constraint::BallJointConstraint, and dart::constraint::SoftContactConstraint.

getRootSkeleton() [1/2]

virtual dynamics::SkeletonPtr dart::constraint::ConstraintBase::getRootSkeleton ( ) const

pure virtual

Implemented in dart::constraint::WeldJointConstraint, dart::constraint::SoftContactConstraint, dart::constraint::ServoMotorConstraint, dart::constraint::MimicMotorConstraint, dart::constraint::JointLimitConstraint, dart::constraint::JointCoulombFrictionConstraint, dart::constraint::ContactConstraint, and dart::constraint::BallJointConstraint.

getRootSkeleton() [2/2]

dynamics::SkeletonPtr dart::constraint::ConstraintBase::getRootSkeleton ( dynamics::SkeletonPtr  skeleton )

static

getType()

const std::string & dart::constraint::ConstraintBase::getType ( ) const

virtual

Returns a string representing the constraint type.

Reimplemented in dart::constraint::WeldJointConstraint, dart::constraint::SoftContactConstraint, dart::constraint::ServoMotorConstraint, dart::constraint::MimicMotorConstraint, dart::constraint::JointLimitConstraint, dart::constraint::JointCoulombFrictionConstraint, dart::constraint::ContactConstraint, and dart::constraint::BallJointConstraint.

getVelocityChange()

virtual void dart::constraint::ConstraintBase::getVelocityChange ( double *  vel, bool  withCfm  )

pure virtual

Get velocity change due to the uint impulse.

Implemented in dart::constraint::ContactConstraint, dart::constraint::ServoMotorConstraint, dart::constraint::MimicMotorConstraint, dart::constraint::JointLimitConstraint, dart::constraint::WeldJointConstraint, dart::constraint::SoftContactConstraint, dart::constraint::BallJointConstraint, and dart::constraint::JointCoulombFrictionConstraint.

isActive()

virtual bool dart::constraint::ConstraintBase::isActive ( ) const

pure virtual

Return true if this constraint is active.

Implemented in dart::constraint::WeldJointConstraint, dart::constraint::SoftContactConstraint, dart::constraint::ServoMotorConstraint, dart::constraint::MimicMotorConstraint, dart::constraint::JointLimitConstraint, dart::constraint::JointCoulombFrictionConstraint, dart::constraint::ContactConstraint, and dart::constraint::BallJointConstraint.

unexcite()

virtual void dart::constraint::ConstraintBase::unexcite ( )

pure virtual

Unexcite the constraint.

Implemented in dart::constraint::WeldJointConstraint, dart::constraint::SoftContactConstraint, dart::constraint::ServoMotorConstraint, dart::constraint::MimicMotorConstraint, dart::constraint::JointLimitConstraint, dart::constraint::JointCoulombFrictionConstraint, dart::constraint::ContactConstraint, and dart::constraint::BallJointConstraint.

uniteSkeletons()

void dart::constraint::ConstraintBase::uniteSkeletons ( )

virtual

Reimplemented in dart::constraint::WeldJointConstraint, dart::constraint::SoftContactConstraint, dart::constraint::ContactConstraint, and dart::constraint::BallJointConstraint.

update()

virtual void dart::constraint::ConstraintBase::update ( )

pure virtual

Update constraint using updated Skeleton's states.

Implemented in dart::constraint::WeldJointConstraint, dart::constraint::SoftContactConstraint, dart::constraint::ServoMotorConstraint, dart::constraint::MimicMotorConstraint, dart::constraint::JointLimitConstraint, dart::constraint::JointCoulombFrictionConstraint, dart::constraint::ContactConstraint, and dart::constraint::BallJointConstraint.

Friends And Related Function Documentation

ConstrainedGroup

friend class ConstrainedGroup

friend

ConstraintSolver

friend class ConstraintSolver

friend

Member Data Documentation

mDim

std::size_t dart::constraint::ConstraintBase::mDim

protected

Dimension of constraint.