OpenSim::PointOnLineConstraint Class Reference

A class implementing a Point On Line Constraint. More...

#include <PointOnLineConstraint.h>

Inheritance diagram for OpenSim::PointOnLineConstraint:

List of all members.

Public Member Functions
	PointOnLineConstraint ()
	Default constructor.
	PointOnLineConstraint (const PointOnLineConstraint &aConstraint)
	Copy constructor.
	PointOnLineConstraint (OpenSim::Body &lineBody, SimTK::Vec3 lineDirection, SimTK::Vec3 pointOnLine, OpenSim::Body &followerBody, SimTK::Vec3 followerPoint)
virtual	~PointOnLineConstraint ()
	Destructor.
virtual Object *	copy () const
	Copy this body and return a pointer to the copy.
PointOnLineConstraint &	operator= (const PointOnLineConstraint &aConstraint)
	Assignment operator.
void	copyData (const PointOnLineConstraint &aConstraint)
	Copy data members from one PointOnLineConstraint to another.
void	setLineBodyByName (std::string aBodyName)
	Following methods set attributes of the point on line constraint.
void	setFollowerBodyByName (std::string aBodyName)
void	setLineDirection (SimTK::Vec3 direction)
void	setPointOnLine (SimTK::Vec3 point)
void	setPointOnFollower (SimTK::Vec3 point)
Protected Member Functions
virtual void	setup (Model &aModel)
	Perform some set up functions that happen after the object has been deserialized or copied.
virtual void	createSystem (SimTK::MultibodySystem &system) const
	Create a SimTK::Constraint::PointOnLine which implements this constraint.
Protected Attributes
PropertyStr	_lineBodyNameProp
	Specify the body on which the line is defined.
std::string &	_lineBodyName
PropertyDblVec3	_lineDirectionProp
	Direction of the line in line body specified in the line body frame.
SimTK::Vec3 &	_lineDirection
PropertyDblVec3	_pointOnLineProp
	Specify the default point on the line in the line body frame.
SimTK::Vec3 &	_pointOnLine
PropertyStr	_followerBodyNameProp
	Specify the follower body constrained to the line.
std::string &	_followerBodyName
PropertyDblVec3	_pointOnFollowerProp
	Specify the point on the follower bocy constrained to the line in the follower body reference frame.
SimTK::Vec3 &	_pointOnFollower
Body *	_lineBody
	Line body.
Body *	_followerBody
	Follower body.

---

Detailed Description

A class implementing a Point On Line Constraint.

The underlying Constraint in Simbody is a Constraint::PointOnLine

Author:

Samuel Hamner

Version:

1.0

---

Constructor & Destructor Documentation

PointOnLineConstraint::PointOnLineConstraint

(

)

Default constructor.

PointOnLineConstraint::PointOnLineConstraint

(

const PointOnLineConstraint &

aConstraint

)

Copy constructor.

Parameters:

aConstraint

PointOnLineConstraint to be copied.

OpenSim::PointOnLineConstraint::PointOnLineConstraint	(	OpenSim::Body &	lineBody,
		SimTK::Vec3	lineDirection,
		SimTK::Vec3	pointOnLine,
		OpenSim::Body &	followerBody,
		SimTK::Vec3	followerPoint
	)

PointOnLineConstraint::~PointOnLineConstraint

(

)

[virtual]

Destructor.

---

Member Function Documentation

Object * PointOnLineConstraint::copy

(

)

const [virtual]

Copy this body and return a pointer to the copy.

The copy constructor for this class is used.

Returns:

Pointer to a copy of this OpenSim::Body.

Implements OpenSim::Constraint.

void PointOnLineConstraint::copyData

(

const PointOnLineConstraint &

aConstraint

)

Copy data members from one PointOnLineConstraint to another.

Parameters:

aConstraint

PointOnLineConstraint to be copied.

Reimplemented from OpenSim::Constraint.

void PointOnLineConstraint::createSystem

(

SimTK::MultibodySystem &

system

)

const [protected, virtual]

Create a SimTK::Constraint::PointOnLine which implements this constraint.

Reimplemented from OpenSim::ModelComponent.

PointOnLineConstraint & PointOnLineConstraint::operator=

(

const PointOnLineConstraint &

aConstraint

)

Assignment operator.

Returns:

Reference to this object.

Reimplemented from OpenSim::Constraint.

void PointOnLineConstraint::setFollowerBodyByName

(

std::string

aBodyName

)

void PointOnLineConstraint::setLineBodyByName

(

std::string

aBodyName

)

Following methods set attributes of the point on line constraint.

void OpenSim::PointOnLineConstraint::setLineDirection

(

SimTK::Vec3

direction

)

void OpenSim::PointOnLineConstraint::setPointOnFollower

(

SimTK::Vec3

point

)

void OpenSim::PointOnLineConstraint::setPointOnLine

(

SimTK::Vec3

point

)

void PointOnLineConstraint::setup

(

Model &

aModel

)

[protected, virtual]

Perform some set up functions that happen after the object has been deserialized or copied.

Parameters:

aModel

OpenSim model containing this PointOnLineConstraint.

Reimplemented from OpenSim::Constraint.

---

Member Data Documentation

Body* OpenSim::PointOnLineConstraint::_followerBody [protected]

Follower body.

std::string& OpenSim::PointOnLineConstraint::_followerBodyName [protected]

PropertyStr OpenSim::PointOnLineConstraint::_followerBodyNameProp [protected]

Specify the follower body constrained to the line.

Body* OpenSim::PointOnLineConstraint::_lineBody [protected]

Line body.

std::string& OpenSim::PointOnLineConstraint::_lineBodyName [protected]

PropertyStr OpenSim::PointOnLineConstraint::_lineBodyNameProp [protected]

Specify the body on which the line is defined.

SimTK::Vec3& OpenSim::PointOnLineConstraint::_lineDirection [protected]

PropertyDblVec3 OpenSim::PointOnLineConstraint::_lineDirectionProp [protected]

Direction of the line in line body specified in the line body frame.

SimTK::Vec3& OpenSim::PointOnLineConstraint::_pointOnFollower [protected]

PropertyDblVec3 OpenSim::PointOnLineConstraint::_pointOnFollowerProp [protected]

Specify the point on the follower bocy constrained to the line in the follower body reference frame.

SimTK::Vec3& OpenSim::PointOnLineConstraint::_pointOnLine [protected]

PropertyDblVec3 OpenSim::PointOnLineConstraint::_pointOnLineProp [protected]

Specify the default point on the line in the line body frame.

---

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

• OpenSim/Simulation/SimbodyEngine/PointOnLineConstraint.h
• OpenSim/Simulation/SimbodyEngine/PointOnLineConstraint.cpp