OpenSim::MovingPathPoint Class Reference

A class implementing a moving muscle point, which is a muscle point that moves in a body's reference frame as a function of a coordinate. More...

#include <MovingPathPoint.h>

Inheritance diagram for OpenSim::MovingPathPoint:

List of all members.

Public Member Functions
	MovingPathPoint ()
	Default constructor.
	MovingPathPoint (const MovingPathPoint &aPoint)
	Copy constructor.
virtual	~MovingPathPoint ()
	Destructor.
virtual Object *	copy () const
	Copy this muscle via point and return a pointer to the copy.
MovingPathPoint &	operator= (const MovingPathPoint &aPoint)
	Assignment operator.
void	copyData (const MovingPathPoint &aPoint)
	Copy data members from one MovingPathPoint to another.
void	updateFromXMLNode ()
	Override default implementation by Object to intercept and fix the XML node underneath the MovingPathPoint to match the current version.
virtual void	init (const PathPoint &aPoint)
	Initialize a MovingPathPoint with data from a PathPoint.
const Coordinate *	getXCoordinate () const
const Coordinate *	getYCoordinate () const
const Coordinate *	getZCoordinate () const
void	setXCoordinate (const SimTK::State &s, Coordinate &aCoordinate)
	Set the coordinate used for the X location function.
void	setYCoordinate (const SimTK::State &s, Coordinate &aCoordinate)
	Set the coordinate used for the Y location function.
void	setZCoordinate (const SimTK::State &s, Coordinate &aCoordinate)
	Set the coordinate used for the Z location function.
virtual bool	isActive (const SimTK::State &s) const
virtual void	setup (const Model &aModel, GeometryPath &aPath)
	Perform some set up functions that happen after the object has been deserialized or copied.
virtual void	update (const SimTK::State &s)
	Update the point's location.
virtual void	getVelocity (const SimTK::State &s, SimTK::Vec3 &aVelocity)
	Get the velocity of the point in the body's local reference frame.
const std::string &	getXCoordinateName () const
const std::string &	getYCoordinateName () const
const std::string &	getZCoordinateName () const
virtual Function *	getXFunction () const
virtual Function *	getYFunction () const
virtual Function *	getZFunction () const
void	setXFunction (const SimTK::State &s, Function &aFunction)
	Set the function used for the X location.
void	setYFunction (const SimTK::State &s, Function &aFunction)
	Set the function used for the Y location.
void	setZFunction (const SimTK::State &s, Function &aFunction)
	Set the function used for the Z location.
virtual void	scale (const SimTK::State &s, const SimTK::Vec3 &aScaleFactors)
	Scale the muscle point.
	OPENSIM_DECLARE_DERIVED (MovingPathPoint, PathPoint)
Protected Attributes
PropertyObjPtr< Function >	_xLocationProp
Function *&	_xLocation
PropertyStr	_xCoordinateNameProp
std::string &	_xCoordinateName
const Coordinate *	_xCoordinate
PropertyObjPtr< Function >	_yLocationProp
Function *&	_yLocation
PropertyStr	_yCoordinateNameProp
std::string &	_yCoordinateName
const Coordinate *	_yCoordinate
PropertyObjPtr< Function >	_zLocationProp
Function *&	_zLocation
PropertyStr	_zCoordinateNameProp
std::string &	_zCoordinateName
const Coordinate *	_zCoordinate

---

Detailed Description

A class implementing a moving muscle point, which is a muscle point that moves in a body's reference frame as a function of a coordinate.

Author:

Peter Loan

Version:

1.0

---

Constructor & Destructor Documentation

MovingPathPoint::MovingPathPoint

(

)

Default constructor.

MovingPathPoint::MovingPathPoint

(

const MovingPathPoint &

aPoint

)

Copy constructor.

Parameters:

aPoint

MovingPathPoint to be copied.

MovingPathPoint::~MovingPathPoint

(

)

[virtual]

Destructor.

---

Member Function Documentation

Object * MovingPathPoint::copy

(

)

const [virtual]

Copy this muscle via point and return a pointer to the copy.

The copy constructor for this class is used.

Returns:

Pointer to a copy of this MovingPathPoint.

Reimplemented from OpenSim::PathPoint.

void MovingPathPoint::copyData

(

const MovingPathPoint &

aPoint

)

Copy data members from one MovingPathPoint to another.

Parameters:

aPoint

MovingPathPoint to be copied.

Reimplemented from OpenSim::PathPoint.

void MovingPathPoint::getVelocity	(	const SimTK::State &	s,
		SimTK::Vec3 &	aVelocity
	)			[virtual]

Get the velocity of the point in the body's local reference frame.

Parameters:

aVelocity

The velocity.

Reimplemented from OpenSim::PathPoint.

const Coordinate* OpenSim::MovingPathPoint::getXCoordinate

(

)

const [inline]

const std::string& OpenSim::MovingPathPoint::getXCoordinateName

(

)

const [inline]

virtual Function* OpenSim::MovingPathPoint::getXFunction

(

)

const [inline, virtual]

const Coordinate* OpenSim::MovingPathPoint::getYCoordinate

(

)

const [inline]

const std::string& OpenSim::MovingPathPoint::getYCoordinateName

(

)

const [inline]

virtual Function* OpenSim::MovingPathPoint::getYFunction

(

)

const [inline, virtual]

const Coordinate* OpenSim::MovingPathPoint::getZCoordinate

(

)

const [inline]

const std::string& OpenSim::MovingPathPoint::getZCoordinateName

(

)

const [inline]

virtual Function* OpenSim::MovingPathPoint::getZFunction

(

)

const [inline, virtual]

void MovingPathPoint::init

(

const PathPoint &

aPoint

)

[virtual]

Initialize a MovingPathPoint with data from a PathPoint.

Parameters:

aPoint

PathPoint to be copied.

virtual bool OpenSim::MovingPathPoint::isActive

(

const SimTK::State &

s

)

const [inline, virtual]

Reimplemented from OpenSim::PathPoint.

OpenSim::MovingPathPoint::OPENSIM_DECLARE_DERIVED	(	MovingPathPoint	,
		PathPoint
	)

MovingPathPoint & MovingPathPoint::operator=

(

const MovingPathPoint &

aPoint

)

Assignment operator.

Returns:

Reference to this object.

Reimplemented from OpenSim::PathPoint.

void MovingPathPoint::scale	(	const SimTK::State &	s,
		const SimTK::Vec3 &	aScaleFactors
	)			[virtual]

Scale the muscle point.

Parameters:

aScaleFactors

the XYZ scale factors to scale the point by.

Reimplemented from OpenSim::PathPoint.

void MovingPathPoint::setup	(	const Model &	aModel,
		GeometryPath &	aPath
	)			[virtual]

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

Parameters:

aModel

model containing this MovingPathPoint.

Reimplemented from OpenSim::PathPoint.

void MovingPathPoint::setXCoordinate	(	const SimTK::State &	s,
		Coordinate &	aCoordinate
	)

Set the coordinate used for the X location function.

Parameters:

aCoordinate

the coordinate to set to.

void MovingPathPoint::setXFunction	(	const SimTK::State &	s,
		OpenSim::Function &	aFunction
	)

Set the function used for the X location.

Parameters:

aFunction

the function to set to.

void MovingPathPoint::setYCoordinate	(	const SimTK::State &	s,
		Coordinate &	aCoordinate
	)

Set the coordinate used for the Y location function.

Parameters:

aCoordinate

the coordinate to set to.

void MovingPathPoint::setYFunction	(	const SimTK::State &	s,
		OpenSim::Function &	aFunction
	)

Set the function used for the Y location.

Parameters:

aFunction

the function to set to.

void MovingPathPoint::setZCoordinate	(	const SimTK::State &	s,
		Coordinate &	aCoordinate
	)

Set the coordinate used for the Z location function.

Parameters:

aCoordinate

the coordinate to set to.

void MovingPathPoint::setZFunction	(	const SimTK::State &	s,
		OpenSim::Function &	aFunction
	)

Set the function used for the Z location.

Parameters:

aFunction

the function to set to.

void MovingPathPoint::update

(

const SimTK::State &

s

)

[virtual]

Update the point's location.

Reimplemented from OpenSim::PathPoint.

void MovingPathPoint::updateFromXMLNode

(

)

[virtual]

Override default implementation by Object to intercept and fix the XML node underneath the MovingPathPoint to match the current version.

Reimplemented from OpenSim::Object.

---

Member Data Documentation

const Coordinate* OpenSim::MovingPathPoint::_xCoordinate [protected]

std::string& OpenSim::MovingPathPoint::_xCoordinateName [protected]

PropertyStr OpenSim::MovingPathPoint::_xCoordinateNameProp [protected]

Function* & OpenSim::MovingPathPoint::_xLocation [protected]

PropertyObjPtr<Function> OpenSim::MovingPathPoint::_xLocationProp [protected]

const Coordinate* OpenSim::MovingPathPoint::_yCoordinate [protected]

std::string& OpenSim::MovingPathPoint::_yCoordinateName [protected]

PropertyStr OpenSim::MovingPathPoint::_yCoordinateNameProp [protected]

Function* & OpenSim::MovingPathPoint::_yLocation [protected]

PropertyObjPtr<Function> OpenSim::MovingPathPoint::_yLocationProp [protected]

const Coordinate* OpenSim::MovingPathPoint::_zCoordinate [protected]

std::string& OpenSim::MovingPathPoint::_zCoordinateName [protected]

PropertyStr OpenSim::MovingPathPoint::_zCoordinateNameProp [protected]

Function* & OpenSim::MovingPathPoint::_zLocation [protected]

PropertyObjPtr<Function> OpenSim::MovingPathPoint::_zLocationProp [protected]

---

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

• OpenSim/Simulation/Model/MovingPathPoint.h
• OpenSim/Simulation/Model/MovingPathPoint.cpp