OpenSim::WrapTorus Class Reference

A class implementing a torus for muscle wrapping. More...

#include <WrapTorus.h>

Inheritance diagram for OpenSim::WrapTorus:
OpenSim::WrapObject OpenSim::Object

List of all members.

Classes

struct  CircleCallback

Public Member Functions

 WrapTorus ()
 Default constructor.
 WrapTorus (const WrapTorus &aWrapTorus)
 Copy constructor.
virtual ~WrapTorus ()
 Destructor.
virtual Objectcopy () const
 Copy this WrapTorus and return a pointer to the copy.
WrapTorusoperator= (const WrapTorus &aWrapTorus)
 Assignment operator.
void copyData (const WrapTorus &aWrapTorus)
 Copy data members from one WrapTorus to another.
virtual const char * getWrapTypeName () const
 Get the name of the type of wrap object ("torus" in this case).
virtual std::string getDimensionsString () const
 Get a string holding the dimensions definition that SIMM would use to describe this object.
virtual void scale (const SimTK::Vec3 &aScaleFactors)
 Scale the torus's dimensions.
virtual void setup (Model &aModel, OpenSim::Body &aBody)
 Perform some set up functions that happen after the object has been deserialized or copied.
virtual int wrapLine (const SimTK::State &s, SimTK::Vec3 &aPoint1, SimTK::Vec3 &aPoint2, const PathWrap &aPathWrap, WrapResult &aWrapResult, bool &aFlag) const
 Calculate the wrapping of one line segment over the torus.

Protected Member Functions

void setupProperties ()
 Connect properties to local pointers.

Detailed Description

A class implementing a torus for muscle wrapping.

Author:
Peter Loan
Version:
1.0

Constructor & Destructor Documentation

WrapTorus::WrapTorus (  ) 

Default constructor.

WrapTorus::WrapTorus ( const WrapTorus aWrapTorus  ) 

Copy constructor.

Parameters:
aWrapTorus WrapTorus to be copied.
WrapTorus::~WrapTorus (  )  [virtual]

Destructor.


Member Function Documentation

Object * WrapTorus::copy (  )  const [virtual]

Copy this WrapTorus and return a pointer to the copy.

The copy constructor for this class is used.

Returns:
Pointer to a copy of this WrapTorus.

Implements OpenSim::WrapObject.

void WrapTorus::copyData ( const WrapTorus aWrapTorus  ) 

Copy data members from one WrapTorus to another.

Parameters:
aWrapTorus WrapTorus to be copied.

Reimplemented from OpenSim::WrapObject.

string WrapTorus::getDimensionsString (  )  const [virtual]

Get a string holding the dimensions definition that SIMM would use to describe this object.

This is a rather ugly convenience function for outputting SIMM joint files.

Returns:
A string containing the dimensions of the wrap object

Reimplemented from OpenSim::WrapObject.

const char * WrapTorus::getWrapTypeName (  )  const [virtual]

Get the name of the type of wrap object ("torus" in this case).

Returns:
A string representing the type of wrap object

Implements OpenSim::WrapObject.

WrapTorus & WrapTorus::operator= ( const WrapTorus aWrapTorus  ) 

Assignment operator.

Returns:
Reference to this object.

Reimplemented from OpenSim::WrapObject.

void WrapTorus::scale ( const SimTK::Vec3 &  aScaleFactors  )  [virtual]

Scale the torus's dimensions.

The base class scales the origin of the torus in the body's reference frame.

Parameters:
aScaleFactors The XYZ scale factors.

Reimplemented from OpenSim::WrapObject.

void WrapTorus::setup ( Model aModel,
OpenSim::Body aBody 
) [virtual]

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

Parameters:
aModel pointer to OpenSim Model

Reimplemented from OpenSim::WrapObject.

void WrapTorus::setupProperties ( void   )  [protected]

Connect properties to local pointers.

Reimplemented from OpenSim::WrapObject.

int WrapTorus::wrapLine ( const SimTK::State &  s,
SimTK::Vec3 &  aPoint1,
SimTK::Vec3 &  aPoint2,
const PathWrap aPathWrap,
WrapResult aWrapResult,
bool &  aFlag 
) const [virtual]

Calculate the wrapping of one line segment over the torus.

Parameters:
aPoint1 One end of the line segment
aPoint2 The other end of the line segment
aPathWrap An object holding the parameters for this line/torus pairing
aWrapResult The result of the wrapping (tangent points, etc.)
aFlag A flag for indicating errors, etc.
Returns:
The status, as a WrapAction enum

Implements OpenSim::WrapObject.


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

Generated on Wed Dec 16 15:03:49 2009 for OpenSim by  doxygen 1.6.1