OpenSim::Scale Class Reference

#include <Scale.h>

Inheritance diagram for OpenSim::Scale:
OpenSim::Object

List of all members.

Public Member Functions

 Scale ()
 Default constructor of an Scale.
 Scale (const Scale &aMarker)
 Copy constructor.
 Scale (const std::string &scaleFileName)
virtual ~Scale (void)
 Destructor.
virtual Objectcopy () const
 Construct and return a copy of this object.
Scaleoperator= (const Scale &aMarker)
 Assign this object to the values of another.
const std::string & getSegmentName () const
 Get segment name.
void setSegmentName (const std::string &aSegmentName)
void getScaleFactors (SimTK::Vec3 &aScaleFactors) const
 Set the value of scale factors.
SimTK::Vec3 & getScaleFactors ()
void getScaleFactors (double rScaleFactors[])
void setScaleFactors (const SimTK::Vec3 &aScaleFactors)
 Set scale factors.
void setScaleFactors (const double aScaleFactors[])
bool getApply (void) const
void setApply (bool state)

Protected Attributes

PropertyDblVec3 _propScaleFactors
 A list of 3 scale factors.
PropertyStr _propSegmentName
 Name of object to scale.
PropertyBool _propApply
 Whether or not to apply this scale.
SimTK::Vec3 & _scaleFactors
std::string & _segmentName
bool & _apply

Constructor & Destructor Documentation

Scale::Scale (  ) 

Default constructor of an Scale.

Scale::Scale ( const Scale aScale  ) 

Copy constructor.

Parameters:
an Scale to copy
OpenSim::Scale::Scale ( const std::string &  scaleFileName  ) 
Scale::~Scale ( void   )  [virtual]

Destructor.


Member Function Documentation

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

Construct and return a copy of this object.

The object is allocated using the new operator, so the caller is responsible for deleting the returned object.

Returns:
Copy of this object.

Reimplemented from OpenSim::Object.

bool OpenSim::Scale::getApply ( void   )  const [inline]
void OpenSim::Scale::getScaleFactors ( double  rScaleFactors[]  )  [inline]
SimTK::Vec3& OpenSim::Scale::getScaleFactors (  )  [inline]
void Scale::getScaleFactors ( SimTK::Vec3 &  aScaleFactors  )  const

Set the value of scale factors.

const std::string & Scale::getSegmentName (  )  const

Get segment name.

Scale & Scale::operator= ( const Scale aScale  ) 

Assign this object to the values of another.

Returns:
Reference to this object.

Reimplemented from OpenSim::Object.

void OpenSim::Scale::setApply ( bool  state  )  [inline]
void OpenSim::Scale::setScaleFactors ( const double  aScaleFactors[]  )  [inline]
void Scale::setScaleFactors ( const SimTK::Vec3 &  aScaleFactors  ) 

Set scale factors.

void OpenSim::Scale::setSegmentName ( const std::string &  aSegmentName  ) 

Member Data Documentation

bool& OpenSim::Scale::_apply [protected]

Whether or not to apply this scale.

A list of 3 scale factors.

Name of object to scale.

SimTK::Vec3& OpenSim::Scale::_scaleFactors [protected]
std::string& OpenSim::Scale::_segmentName [protected]

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

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