API 4.4.1-2022-10-19-2c4045e59
For MATLAB, Python, Java, and C++ users
OpenSim::PointForceDirection Class Reference

Convenience class for a generic representation of geometry of a complex Force (or any other object) with multiple points of contact through which forces are applied to bodies. More...

Public Member Functions

virtual ~PointForceDirection ()
 
 PointForceDirection (SimTK::Vec3 point, const PhysicalFrame &frame, SimTK::Vec3 direction, double scale=1)
 Default constructor takes the point, body, direction and scale as arguments. More...
 
SimTK::Vec3 point ()
 get point of "contact" with on a body defined in the body frame More...
 
const PhysicalFrameframe ()
 get the body in which the point is defined More...
 
SimTK::Vec3 direction ()
 get direction of the force at the point defined in ground More...
 
double scale ()
 get the scale factor on the force More...
 
void addToDirection (SimTK::Vec3 newDirection)
 replace the current direction with the resultant with a new direction More...
 

Detailed Description

Convenience class for a generic representation of geometry of a complex Force (or any other object) with multiple points of contact through which forces are applied to bodies.

This represents one such point and an array of these objects defines a complete Force distribution (ie. path).

Author
Ajay Seth
Version
1.0

Constructor & Destructor Documentation

◆ ~PointForceDirection()

virtual OpenSim::PointForceDirection::~PointForceDirection ( )
inlinevirtual

◆ PointForceDirection()

OpenSim::PointForceDirection::PointForceDirection ( SimTK::Vec3  point,
const PhysicalFrame frame,
SimTK::Vec3  direction,
double  scale = 1 
)
inline

Default constructor takes the point, body, direction and scale as arguments.

Member Function Documentation

◆ addToDirection()

void OpenSim::PointForceDirection::addToDirection ( SimTK::Vec3  newDirection)
inline

replace the current direction with the resultant with a new direction

◆ direction()

SimTK::Vec3 OpenSim::PointForceDirection::direction ( )
inline

get direction of the force at the point defined in ground

◆ frame()

const PhysicalFrame & OpenSim::PointForceDirection::frame ( )
inline

get the body in which the point is defined

◆ point()

SimTK::Vec3 OpenSim::PointForceDirection::point ( )
inline

get point of "contact" with on a body defined in the body frame

◆ scale()

double OpenSim::PointForceDirection::scale ( )
inline

get the scale factor on the force


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