Simbody  3.7
SimTK::CoordinateAxis::XCoordinateAxis Class Reference
+ Inheritance diagram for SimTK::CoordinateAxis::XCoordinateAxis:

Public Member Functions

 XCoordinateAxis ()
 
- Public Member Functions inherited from SimTK::CoordinateAxis
 CoordinateAxis (int i)
 Explicit construction of a CoordinateAxis from a calculated integer that must be 0, 1, or 2 representing XAxis, YAxis, or ZAxis. More...
 
 operator int () const
 Implicit conversion of a CoordinateAxis to int 0, 1, or 2. More...
 
CoordinateAxis getNextAxis () const
 Return the "next" coordinate axis after this one: More...
 
CoordinateAxis getPreviousAxis () const
 Return the "previous" coordinate axis before this one: More...
 
CoordinateAxis getThirdAxis (const CoordinateAxis &axis2) const
 Given this coordinate axis and one other, return the missing one: More...
 
bool isXAxis () const
 Return true if this is the X axis. More...
 
bool isYAxis () const
 Return true if this is the Y axis. More...
 
bool isZAxis () const
 Return true if this is the Z axis. More...
 
bool isNextAxis (const CoordinateAxis &axis2) const
 Return true if the given axis2 is the one following this one as would be reported by getNextAxis(). More...
 
bool isPreviousAxis (const CoordinateAxis &axis2) const
 Return true if the given axis2 is the one preceding this one as would be reported by getPreviousAxis(). More...
 
bool isSameAxis (const CoordinateAxis &axis2) const
 Return true if the given axis2 is the same as this one. You can use operator==() to perform the same comparison. More...
 
bool areAllSameAxes (const CoordinateAxis &axis2, const CoordinateAxis &axis3) const
 Return true if both axis2 and axis3 are the same as this one. More...
 
bool isDifferentAxis (const CoordinateAxis &axis2) const
 Return true if the given axis2 is not the same one as this one. You can use operator!=() to perform the same comparison. More...
 
bool areAllDifferentAxes (const CoordinateAxis &axis2, const CoordinateAxis &axis3) const
 Return true if neither axis2 nor axis3 is the same as this axis nor each other; that is, (this,axis2,axis3) together cover all three axes. More...
 
bool isForwardCyclical (const CoordinateAxis &axis2) const
 Return true if the given axis2 is the one following this one in a forward cyclical direction, that is, if axis2 is the one that would be reported by getNextAxis(). More...
 
bool isReverseCyclical (const CoordinateAxis &axis2) const
 Return true if the given axis2 is the one following this one in a reverse cyclical direction, that is, if axis2 is the one that would be reported by getPreviousAxis(). More...
 
int dotProduct (const CoordinateAxis &axis2) const
 Perform a specialized dot product between this axis and axis2; returning one if they are the same axis and zero otherwise, without performing any floating point operations. More...
 
int crossProductSign (const CoordinateAxis &axis2) const
 Return the sign that would result from a cross product between this axis and axis2: zero if axis2 is the same as this axis; one if the result would be in the positive direction along the third axis; -1 if it would be in the negative direction. More...
 
CoordinateAxis crossProductAxis (const CoordinateAxis &axis2) const
 Return the coordinate axis along which the cross product of this axis and axis2 would lie: same as this if axis2 is the same as this axis (doesn't matter because the sign would be zero); otherwise, the third axis that is neither this one nor axis2. More...
 
CoordinateAxis crossProduct (const CoordinateAxis &axis2, int &sign) const
 Return the axis and sign along that axis that would result from a cross product between this axis and axis2; this combines the functions of both crossProductAxis() and crossProductSign(). More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SimTK::CoordinateAxis
static const CoordinateAxisgetCoordinateAxis (int i)
 Return a reference to the CoordinateAxis constant XAxis, YAxis, or ZAxis corresponding to the given integer index which must be 0, 1, or 2. More...
 
static bool isIndexInRange (int i)
 Return true if the given integer is suitable as a coordinate axis, meaning it is one of 0, 1, or 2 designating XAxis, YAxis, or ZAxis, respectively. More...
 

Constructor & Destructor Documentation

◆ XCoordinateAxis()


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