Constraint::PointInPlane Class Reference
#include <Constraint.h>
Inheritance diagram for Constraint::PointInPlane:
Detailed Description
One constraint equation.This constraint enforces that a point fixed to one body (the "follower body") must travel in a plane fixed on another body (the "plane body"). The constraint is enforced by an internal (non-working) scalar force acting at the spatial location of the follower point, directed along the plane normal, and equal and opposite on the two bodies.
The assembly condition is the same as the run-time constraint: the point has to be moved into the plane.
Constructor & Destructor Documentation
| PointInPlane | ( | MobilizedBody & | planeBody_B, | |
| const UnitVec3 & | defaultPlaneNormal_B, | |||
| Real | defaultHeight, | |||
| MobilizedBody & | followerBody_F, | |||
| const Vec3 & | defaultFollowerPoint_F | |||
| ) |
Member Function Documentation
| PointInPlane& setPlaneDisplayHalfWidth | ( | Real | ) |
| PointInPlane& setPointDisplayRadius | ( | Real | ) |
| Real getPlaneDisplayHalfWidth | ( | ) | const |
| Real getPointDisplayRadius | ( | ) | const |
| PointInPlane& setDefaultPlaneNormal | ( | const UnitVec3 & | ) |
| PointInPlane& setDefaultPlaneHeight | ( | Real | ) |
| PointInPlane& setDefaultFollowerPoint | ( | const Vec3 & | ) |
| MobilizedBodyIndex getPlaneMobilizedBodyIndex | ( | ) | const |
| MobilizedBodyIndex getFollowerMobilizedBodyIndex | ( | ) | const |
| const UnitVec3& getDefaultPlaneNormal | ( | ) | const |
| Real getDefaultPlaneHeight | ( | ) | const |
| const Vec3& getDefaultFollowerPoint | ( | ) | const |
| Real getPlaneHeight | ( | const State & | ) | const |
| Real getPositionError | ( | const State & | ) | const |
| Real getVelocityError | ( | const State & | ) | const |
| Real getAccelerationError | ( | const State & | ) | const |
| Real getMultiplier | ( | const State & | ) | const |
| Real getForceOnFollowerPoint | ( | const State & | ) | const |
| SimTK_INSERT_DERIVED_HANDLE_DECLARATIONS | ( | PointInPlane | , | |
| PointInPlaneImpl | , | |||
| Constraint | ||||
| ) |
The documentation for this class was generated from the following file:
