OpenSim::SliderJoint Class Reference

A class implementing an Slider joint. More...

#include <SliderJoint.h>

Inheritance diagram for OpenSim::SliderJoint:

List of all members.

Public Member Functions
	SliderJoint ()
	Slider has no additional properties.
	SliderJoint (const SliderJoint &aJoint)
	Copy constructor.
	SliderJoint (const std::string &name, OpenSim::Body &parent, SimTK::Vec3 locationInParent, SimTK::Vec3 orientationInParent, OpenSim::Body &body, SimTK::Vec3 locationInBody, SimTK::Vec3 orientationInBody, bool reverse=false)
	Convenience Constructor.
virtual	~SliderJoint ()
	Destructor.
virtual Object *	copy () const
	Copy this body and return a pointer to the copy.
SliderJoint &	operator= (const SliderJoint &aJoint)
	Assignment operator.
void	copyData (const SliderJoint &aJoint)
	Copy data members from one SliderJoint to another.
virtual void	setup (Model &aModel)
	Perform some set up functions that happen after the object has been deserialized or copied.
virtual int	numCoordinates () const
virtual void	scale (const ScaleSet &aScaleSet)
	Scale a joint based on XYZ scale factors for the bodies.
Protected Member Functions
void	createSystem (SimTK::MultibodySystem &system) const
	This is called when a SimTK System is being created for the Model.

---

Detailed Description

A class implementing an Slider joint.

The underlying implementation in Simbody is a MobilizedBody::Slider. Slider provides one DoF along the common X-axis of the joint frames (not body) in the parent and body.

Author:

Ajay Seth

Version:

1.0

---

Constructor & Destructor Documentation

SliderJoint::SliderJoint

(

)

Slider has no additional properties.

Default constructor.

SliderJoint::SliderJoint

(

const SliderJoint &

aJoint

)

Copy constructor.

Parameters:

aJoint

SliderJoint to be copied.

SliderJoint::SliderJoint	(	const std::string &	name,
		OpenSim::Body &	parent,
		SimTK::Vec3	locationInParent,
		SimTK::Vec3	orientationInParent,
		OpenSim::Body &	body,
		SimTK::Vec3	locationInBody,
		SimTK::Vec3	orientationInBody,
		bool	reverse = false
	)

Convenience Constructor.

SliderJoint::~SliderJoint

(

)

[virtual]

Destructor.

---

Member Function Documentation

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

void SliderJoint::copyData

(

const SliderJoint &

aJoint

)

Copy data members from one SliderJoint to another.

Parameters:

aJoint

SliderJoint to be copied.

Reimplemented from OpenSim::Joint.

void SliderJoint::createSystem

(

SimTK::MultibodySystem &

system

)

const [protected, virtual]

This is called when a SimTK System is being created for the Model.

It must be implemented to add appropriate elements to the System corresponding to this object. Methods for adding modeling options, state variables and their derivatives, discrete variables, as well must be called with createSystem() only.

Parameters:

system

the System being created

Reimplemented from OpenSim::Joint.

virtual int OpenSim::SliderJoint::numCoordinates

(

)

const [inline, virtual]

Implements OpenSim::Joint.

SliderJoint & SliderJoint::operator=

(

const SliderJoint &

aJoint

)

Assignment operator.

Returns:

Reference to this object.

Reimplemented from OpenSim::Joint.

void SliderJoint::scale

(

const ScaleSet &

aScaleSet

)

[virtual]

Scale a joint based on XYZ scale factors for the bodies.

Parameters:

aScaleSet

Set of XYZ scale factors for the bodies.

Reimplemented from OpenSim::Joint.

void SliderJoint::setup

(

Model &

aModel

)

[virtual]

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

Parameters:

aModel

OpenSim model containing this SliderJoint.

Reimplemented from OpenSim::Joint.

---

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

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