OpenSim::PointConstraint Class Reference

A class implementing a Point Constraint. More...

#include <PointConstraint.h>

Inheritance diagram for OpenSim::PointConstraint:

List of all members.

Public Member Functions
	PointConstraint ()
	Default constructor.
	PointConstraint (const PointConstraint &aConstraint)
	Copy constructor.
virtual	~PointConstraint ()
	Destructor.
virtual Object *	copy () const
	Copy this body and return a pointer to the copy.
PointConstraint &	operator= (const PointConstraint &aConstraint)
	Assignment operator.
void	copyData (const PointConstraint &aConstraint)
	Copy data members from one PointConstraint to another.
void	setup (SimTK::State &s, Model &aModel)
	Perform some set up functions that happen after the object has been deserialized or copied.
void	setBody1ByName (std::string aBodyName)
	Following methods set attributes of the point constraint.
void	setBody1PointLocation (SimTK::Vec3 location)
void	setBody2ByName (std::string aBodyName)
void	setBody2PointLocation (SimTK::Vec3 location)
Protected Attributes
PropertyStr	_body1NameProp
	Specify first of two bodies connected together by the constraint.
std::string &	_body1Name
PropertyStr	_body2NameProp
	Specify second of two bodies connected by the constraint.
std::string &	_body2Name
PropertyDblVec3	_locationInBody1Prop
	Location of the point in first body specified in body1 reference frame.
SimTK::Vec3 &	_locationInBody1
PropertyDblVec3	_locationInBody2Prop
	Location of the point in second body specified in body2 reference frame.
SimTK::Vec3 &	_locationInBody2
Body *	_body1
	First body point constraint joins.
Body *	_body2
	Second body point constraint joins.
Friends
class	SimbodyEngine

---

Detailed Description

A class implementing a Point Constraint.

The underlying Constraint in Simbody is a Constraint::Point

Author:

Ajay Seth

Version:

1.0

---

Constructor & Destructor Documentation

PointConstraint::PointConstraint

(

)

Default constructor.

PointConstraint::PointConstraint

(

const PointConstraint &

aConstraint

)

Copy constructor.

Parameters:

aConstraint

PointConstraint to be copied.

PointConstraint::~PointConstraint

(

)

[virtual]

Destructor.

---

Member Function Documentation

Object * PointConstraint::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.

Reimplemented from OpenSim::Constraint.

void PointConstraint::copyData

(

const PointConstraint &

aConstraint

)

Copy data members from one PointConstraint to another.

Parameters:

aConstraint

PointConstraint to be copied.

Reimplemented from OpenSim::Constraint.

PointConstraint & PointConstraint::operator=

(

const PointConstraint &

aConstraint

)

Assignment operator.

Returns:

Reference to this object.

Reimplemented from OpenSim::Constraint.

void PointConstraint::setBody1ByName

(

std::string

aBodyName

)

Following methods set attributes of the point constraint.

void OpenSim::PointConstraint::setBody1PointLocation

(

SimTK::Vec3

location

)

void PointConstraint::setBody2ByName

(

std::string

aBodyName

)

void OpenSim::PointConstraint::setBody2PointLocation

(

SimTK::Vec3

location

)

void PointConstraint::setup	(	SimTK::State &	s,
		Model &	aModel
	)

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

Parameters:

aModel

OpenSim model containing this PointConstraint.

---

Friends And Related Function Documentation

friend class SimbodyEngine [friend]

Reimplemented from OpenSim::Constraint.

---

Member Data Documentation

Body* OpenSim::PointConstraint::_body1 [protected]

First body point constraint joins.

std::string& OpenSim::PointConstraint::_body1Name [protected]

PropertyStr OpenSim::PointConstraint::_body1NameProp [protected]

Specify first of two bodies connected together by the constraint.

Body* OpenSim::PointConstraint::_body2 [protected]

Second body point constraint joins.

std::string& OpenSim::PointConstraint::_body2Name [protected]

PropertyStr OpenSim::PointConstraint::_body2NameProp [protected]

Specify second of two bodies connected by the constraint.

SimTK::Vec3& OpenSim::PointConstraint::_locationInBody1 [protected]

PropertyDblVec3 OpenSim::PointConstraint::_locationInBody1Prop [protected]

Location of the point in first body specified in body1 reference frame.

SimTK::Vec3& OpenSim::PointConstraint::_locationInBody2 [protected]

PropertyDblVec3 OpenSim::PointConstraint::_locationInBody2Prop [protected]

Location of the point in second body specified in body2 reference frame.

---

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

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