Public Member Functions | |
PhyJoint (PhyObject *parent, PhyObject *child) | |
Constructor. | |
virtual | ~PhyJoint () |
Destructor. | |
virtual wVector | centre () const =0 |
Return the centre of this joint in world coordinate. | |
virtual PhyObject * | child () |
Return the child object attached to this joint (see Newton Documentation) | |
virtual const PhyObject * | child () const |
Return the child object attached to this joint (see Newton Documentation) (const version) | |
virtual QVector< PhyDOF * > | dofs () |
Return descriptions of DOF. | |
void | enable (bool b) |
enable/disable the joint | |
virtual wVector | getForceOnJoint () const =0 |
Returns the force applied to this joint. | |
bool | isEnabled () const |
Return true if the joint is enabled. | |
virtual unsigned int | numDofs () const |
Return the number of DOF constrained by this joint. | |
virtual PhyObject * | parent () |
Return the parent object; (NULL means an object attached to static world; see Netwon Documentation) | |
virtual const PhyObject * | parent () const |
Return the parent object; (NULL means an object attached to static world; see Netwon Documentation) (const version) | |
virtual void | postUpdate () |
postUpdate the PhyJoint this method is called at each step of the world just after the physic update | |
virtual void | preUpdate () |
preUpdate the PhyJoint this method is called at each step of the world just before the physic update | |
virtual void | updateJointInfo ()=0 |
Update the Joint informations (each PhyDOF will be updated) | |
World * | world () |
Return the World. | |
const World * | world () const |
Return the World (const version) | |
Public Member Functions inherited from Ownable | |
Ownable () | |
Constructor. | |
virtual | ~Ownable () |
Destructor. | |
const QList< Owned > & | owned () const |
Returns the list of objects owned by this one. | |
Ownable * | owner () const |
Returns the owner of this object. | |
void | setOwner (Ownable *owner, bool destroy=true) |
Sets the owner of this object. | |
Protected Member Functions | |
virtual void | updateJoint (real timestep)=0 |
Protected Attributes | |
PhyObjectPrivate * | childpriv |
PhyObject * | childv |
child object | |
QVector< PhyDOF * > | dofsv |
vector of DOF's joint | |
int | dofv |
number of DOF | |
bool | enabled |
true if is enabled, false otherwise | |
PhyObjectPrivate * | parentpriv |
PhyObject * | parentv |
parent object | |
PhyJointPrivate * | priv |
Engine encapsulation. | |
WorldPrivate * | worldpriv |
World * | worldv |
world | |
Friends | |
class | PhyJointPrivate |
Additional Inherited Members | |
Public Types inherited from Ownable | |
typedef QList< Owned > | OwnedList |
The type for the list of owned objects. | |
Detailed Description
PhyJoint class.
\
- Motivation
- Common interface among Joints.
- Description
- This joint doesn't add constraints... so, it's a zero-DOF joint :-)
- Warnings
- Warnings
Definition at line 346 of file phyjoint.h.
Constructor & Destructor Documentation
Constructor.
- Parameters
-
parent is the parent object. The local frame is translated toward centre for create the complete local coordinate frame of this joint child is the child object
Definition at line 30 of file phyjoint.cpp.
References PhyJoint::child(), PhyJoint::childv, PhyJoint::enabled, PhyJoint::parent(), PhyJoint::parentv, PhyObject::priv, PhyJoint::priv, WObject::world(), and PhyJoint::worldv.
|
virtual |
Destructor.
Definition at line 52 of file phyjoint.cpp.
References PhyJoint::dofsv, PhyJoint::priv, and PhyJoint::worldv.
Member Function Documentation
|
pure virtual |
Return the centre of this joint in world coordinate.
Implemented in PhyHinge, PhySuspension, PhyFixed, and PhyBallAndSocket.
|
inlinevirtual |
Return the child object attached to this joint (see Newton Documentation)
Definition at line 358 of file phyjoint.h.
Referenced by PhyJoint::PhyJoint(), PhyBallAndSocket::updateJointInfo(), PhyFixed::updateJointInfo(), PhySuspension::updateJointInfo(), PhyUniversal::updateJointInfo(), and PhyHinge::updateJointInfo().
|
inlinevirtual |
Return the child object attached to this joint (see Newton Documentation) (const version)
Definition at line 362 of file phyjoint.h.
|
inlinevirtual |
Return descriptions of DOF.
Definition at line 378 of file phyjoint.h.
Referenced by PhyObjectsGroup::addJointDOF(), PhyMarXbot::enableAttachmentDevice(), MarXbotAttachmentDeviceMotorController::getDesiredPosition(), MarXbotAttachmentDeviceMotorController::getDesiredVelocity(), MarXbotAttachmentDeviceMotorController::getMaxVelocity(), MarXbotAttachmentDeviceMotorController::getPosition(), MarXbotAttachmentDeviceMotorController::getVelocity(), PhyEpuck::PhyEpuck(), PhyKhepera::PhyKhepera(), PhyMarXbot::PhyMarXbot(), MarXbotAttachmentDeviceMotorController::setDesiredPosition(), MarXbotAttachmentDeviceMotorController::setDesiredVelocity(), PhyObjectsGroup::setDOFPosition(), MarXbotAttachmentDeviceMotorController::setMaxVelocity(), and MarXbotAttachmentDeviceMotorController::update().
void enable | ( | bool | b | ) |
enable/disable the joint
Definition at line 63 of file phyjoint.cpp.
References PhyJoint::enabled.
Referenced by PhyMarXbot::doKinematicSimulation().
|
pure virtual |
Returns the force applied to this joint.
Implemented in PhyHinge, PhyUniversal, PhySuspension, PhyFixed, and PhyBallAndSocket.
Referenced by TractionSensorController::traction().
|
inline |
Return true if the joint is enabled.
Definition at line 384 of file phyjoint.h.
|
inlinevirtual |
Return the number of DOF constrained by this joint.
Definition at line 374 of file phyjoint.h.
Referenced by PhyObjectsGroup::addJointDOF(), and PhyiCub::PhyiCub().
|
inlinevirtual |
Return the parent object; (NULL means an object attached to static world; see Netwon Documentation)
Definition at line 366 of file phyjoint.h.
Referenced by PhyBallAndSocket::centre(), PhyFixed::centre(), PhySuspension::centre(), PhyUniversal::centre(), PhyHinge::centre(), PhyJoint::PhyJoint(), PhyBallAndSocket::updateJointInfo(), PhyFixed::updateJointInfo(), PhySuspension::updateJointInfo(), PhyUniversal::updateJointInfo(), and PhyHinge::updateJointInfo().
|
inlinevirtual |
Return the parent object; (NULL means an object attached to static world; see Netwon Documentation) (const version)
Definition at line 370 of file phyjoint.h.
|
inlinevirtual |
postUpdate the PhyJoint this method is called at each step of the world just after the physic update
Definition at line 419 of file phyjoint.h.
|
inlinevirtual |
preUpdate the PhyJoint this method is called at each step of the world just before the physic update
Definition at line 412 of file phyjoint.h.
|
pure virtual |
Update the Joint informations (each PhyDOF will be updated)
Implemented in PhyHinge, PhyUniversal, PhySuspension, PhyFixed, and PhyBallAndSocket.
Referenced by PhyKhepera::changedMatrix(), PhyMarXbot::changedMatrix(), PhyEpuck::changedMatrix(), PhyiCub::changedMatrix(), PhyiCub::configurePosture(), PhyEpuck::PhyEpuck(), PhyKhepera::PhyKhepera(), and PhyMarXbot::PhyMarXbot().
|
inline |
Return the World.
Definition at line 399 of file phyjoint.h.
Referenced by DOFStatusListener::update(), PhySuspension::updateJointInfo(), and PhyHinge::updateJointInfo().
|
inline |
Return the World (const version)
Definition at line 404 of file phyjoint.h.
Member Data Documentation
|
protected |
|
protected |
vector of DOF's joint
Definition at line 421 of file phyjoint.h.
Referenced by PhyHinge::PhyHinge(), PhySuspension::PhySuspension(), PhyUniversal::PhyUniversal(), PhySuspension::updateJointInfo(), PhyHinge::updateJointInfo(), and PhyJoint::~PhyJoint().
|
protected |
number of DOF
Definition at line 427 of file phyjoint.h.
Referenced by PhyBallAndSocket::PhyBallAndSocket(), PhyFixed::PhyFixed(), PhyHinge::PhyHinge(), PhySuspension::PhySuspension(), and PhyUniversal::PhyUniversal().
|
protected |
true if is enabled, false otherwise
Definition at line 429 of file phyjoint.h.
Referenced by PhyJoint::enable(), PhyJoint::PhyJoint(), PhySuspension::updateJointInfo(), and PhyHinge::updateJointInfo().
|
protected |
|
protected |
Engine encapsulation.
Definition at line 438 of file phyjoint.h.
Referenced by PhyBallAndSocket::createPrivateJoint(), PhyFixed::createPrivateJoint(), PhyUniversal::createPrivateJoint(), PhySuspension::createPrivateJoint(), PhyHinge::createPrivateJoint(), PhyJoint::PhyJoint(), PhySuspension::updateJointInfo(), PhyHinge::updateJointInfo(), and PhyJoint::~PhyJoint().
|
protected |
world
Definition at line 435 of file phyjoint.h.
Referenced by PhyJoint::PhyJoint(), and PhyJoint::~PhyJoint().
The documentation for this class was generated from the following files:
- worldsim/include/phyjoint.h
- worldsim/src/phyjoint.cpp