|
Simbody
|
|
Simbody
|
This class represents the rotate-and-shift transform which gives the location and orientation of a new frame F in a base (reference) frame B. More...
#include <Transform.h>
Public Member Functions | |
| Transform_ () | |
| Default constructor gives an identity transform. | |
| Transform_ (const Rotation_< P > &R, const Vec< 3, P > &p) | |
| Combine a rotation and a translation into a transform. | |
| Transform_ (const Rotation_< P > &R) | |
| Construct or default-convert a rotation into a transform containing that rotation and zero translation. | |
| Transform_ (const Vec< 3, P > &p) | |
| Construct or default-convert a translation (expressed as a Vec3) into a transform with that translation and a zero rotation. | |
| Transform_ & | operator= (const InverseTransform_< P > &X) |
| Assignment from InverseTransform. | |
| Transform_ & | set (const Rotation_< P > &R, const Vec< 3, P > &p) |
| Assign a new value to this transform, explicitly providing the rotation and translation separately. | |
| Transform_ & | setToZero () |
| By zero we mean "zero transform", i.e., an identity rotation and zero translation. | |
| Transform_ & | setToNaN () |
| This fills both the rotation and translation with NaNs. | |
| const InverseTransform_< P > & | invert () const |
| Return a read-only inverse of the current Transform_. | |
| InverseTransform_< P > & | updInvert () |
| Return a writable (lvalue) inverse of the current transform, simply by casting it to the InverseTransform_. | |
| const InverseTransform_< P > & | operator~ () const |
| Overload transpose operator to mean inversion. | |
| InverseTransform_< P > & | operator~ () |
| Overload transpose operator to mean inversion. | |
| Transform_ | compose (const Transform_ &X_FY) const |
| Compose the current transform (X_BF) with the given one. | |
| Transform_ | compose (const InverseTransform_< P > &X_FY) const |
| Compose the current transform (X_BF) with one that is supplied as an InverseTransform_ (typically as a result of applying the "~" operator to a transform). | |
| Vec< 3, P > | xformFrameVecToBase (const Vec< 3, P > &vF) const |
| Transform a vector expressed in our "F" frame to our "B" frame. | |
| Vec< 3, P > | xformBaseVecToFrame (const Vec< 3, P > &vB) const |
| Transform a vector expressed in our "B" frame to our "F" frame. | |
| Vec< 3, P > | shiftFrameStationToBase (const Vec< 3, P > &sF) const |
| Transform a point (station) measured from and expressed in our "F" frame to that same point but measured from and expressed in our "B" frame. | |
| Vec< 3, P > | shiftBaseStationToFrame (const Vec< 3, P > &sB) const |
| Transform a point (station) measured from and expressed in our "B" frame to that same point but measured from and expressed in our "F" frame. | |
| const Rotation_< P > & | R () const |
| Return a read-only reference to the contained rotation R_BF. | |
| Rotation_< P > & | updR () |
| Return a writable (lvalue) reference to the contained rotation R_BF. | |
| const Rotation_< P >::ColType & | x () const |
| Return a read-only reference to the x direction (unit vector) of the F frame, expressed in the B frame. | |
| const Rotation_< P >::ColType & | y () const |
| Return a read-only reference to the y direction (unit vector) of the F frame, expressed in the B frame. | |
| const Rotation_< P >::ColType & | z () const |
| Return a read-only reference to the z direction (unit vector) of the F frame, expressed in the B frame. | |
| const InverseRotation_< P > & | RInv () const |
| Return a read-only reference to the inverse (transpose) of our contained rotation, that is R_FB. | |
| InverseRotation_< P > & | updRInv () |
| Return a writable (lvalue) reference to the inverse (transpose) of our contained rotation, that is R_FB. | |
| const Vec< 3, P > & | p () const |
| Return a read-only reference to our translation vector p_BF. | |
| Vec< 3, P > & | updP () |
| Return a writable (lvalue) reference to our translation vector p_BF. | |
| Transform_< P > & | setP (const Vec< 3, P > &p) |
| Assign a new value to our translation vector. | |
| Vec< 3, P > | pInv () const |
| Calculate the inverse of the translation vector in this transform. | |
| Transform_< P > & | setPInv (const Vec< 3, P > &p_FB) |
| Assign a value to the inverse of our translation vector. | |
| const Mat< 3, 4, P > & | asMat34 () const |
| Recast this transform as a read-only 3x4 matrix. | |
| Mat< 3, 4, P > | toMat34 () const |
| Less efficient version of asMat34(); copies into return variable. | |
| Mat< 4, 4, P > | toMat44 () const |
| Return the equivalent 4x4 transformation matrix. | |
| const Vec< 3, P > & | T () const |
| Vec< 3, P > & | updT () |
This class represents the rotate-and-shift transform which gives the location and orientation of a new frame F in a base (reference) frame B.
A frame is an orthogonal, right-handed set of three axes, and an origin point. A transform X from frame B to F consists of 3 perpendicular unit vectors defining F's axes as viewed from B (that is, as expressed in the basis formed by B's axes), and a vector from B's origin point OB to F's origin point OF. Note that the meaning of "B" comes from the context in which the transform is used. We use the phrase "frame F is in frame B" to describe the above relationship, that is, "in" means both measured from and expressed in.
The axis vectors constitute a Rotation. They are ordered 1-2-3 or x-y-z as you prefer, with z = x X y, making a right-handed set. These axes are arranged as columns of a 3x3 rotation matrix R_BF = [ x y z ] which is a direction cosine (rotation) matrix useful for conversions between frame B and F. (The columns of R_BF are F's coordinate axes, expressed in B.) For example, given a vector vF expressed in the F frame, that same vector re-expressed in B is given by vB = R_BF*vF. F's origin point OF is stored as the translation vector p_BF=(OF-OB) and expressed in B.
Transform is designed to behave as much as possible like the computer graphics 4x4 transform X which would be arranged like this:
[ | ]
X = [ R | p ] R is a 3x3 orthogonal rotation matrix
[.......|...] p os a 3x1 translation vector
[ 0 0 0 1 ]
These can be composed directly by matrix multiplication, but more importantly they have a particularly simple inverse:
-1 [ | ]
X = [ ~R | p* ] ~R is R transpose, p* = ~R(-p).
[.......|....]
[ 0 0 0 1 ]
This inverse is so simple that we compute it simply by defining another type, InverseTransform, which is identical to Transform in memory but behaves as though it contains the inverse. That way we invert just by changing point of view (recasting) rather than computing.
This is a "POD" (plain old data) class with a well-defined memory layout on which a client of this class may depend: There are exactly 4 consecutive, packed 3-vectors in the order x,y,z,p. That is, this class is equivalent to an array of 12 Reals with the order x1,x2,x3,y1,y2,y3,z1,z2,z3,p1,p2,p3. It is expressly allowed to reinterpret Transform objects in any appropriate manner that depends on this memory layout.
| SimTK::Transform_< P >::Transform_ | ( | ) | [inline] |
Default constructor gives an identity transform.
| SimTK::Transform_< P >::Transform_ | ( | const Rotation_< P > & | R, |
| const Vec< 3, P > & | p | ||
| ) | [inline] |
Combine a rotation and a translation into a transform.
| SimTK::Transform_< P >::Transform_ | ( | const Rotation_< P > & | R | ) | [inline] |
Construct or default-convert a rotation into a transform containing that rotation and zero translation.
| SimTK::Transform_< P >::Transform_ | ( | const Vec< 3, P > & | p | ) | [inline] |
Construct or default-convert a translation (expressed as a Vec3) into a transform with that translation and a zero rotation.
| Transform_< P > & SimTK::Transform_< P >::operator= | ( | const InverseTransform_< P > & | X | ) | [inline] |
Assignment from InverseTransform.
This means that the transform we're assigning to must end up with the same meaning as the inverse transform X has, so we'll need to end up with:
Cost: one frame conversion and a negation, 18 flops.
| Transform_& SimTK::Transform_< P >::set | ( | const Rotation_< P > & | R, |
| const Vec< 3, P > & | p | ||
| ) | [inline] |
Assign a new value to this transform, explicitly providing the rotation and translation separately.
We return a reference to the now-modified transform as though this were an assignment operator.
| Transform_& SimTK::Transform_< P >::setToZero | ( | ) | [inline] |
By zero we mean "zero transform", i.e., an identity rotation and zero translation.
We return a reference to the now-modified transform as though this were an assignment operator.
| Transform_& SimTK::Transform_< P >::setToNaN | ( | ) | [inline] |
This fills both the rotation and translation with NaNs.
Note: this is not the same as a default-constructed transform, which is a legitimate identity transform instead. We return a reference to the now-modified transform as though this were an assignment operator.
| const InverseTransform_<P>& SimTK::Transform_< P >::invert | ( | ) | const [inline] |
Return a read-only inverse of the current Transform_.
, simply by casting it to the InverseTransform_
type. Zero cost.
| InverseTransform_<P>& SimTK::Transform_< P >::updInvert | ( | ) | [inline] |
Return a writable (lvalue) inverse of the current transform, simply by casting it to the InverseTransform_.
type. That is, this is an lvalue. Zero cost.
| const InverseTransform_<P>& SimTK::Transform_< P >::operator~ | ( | ) | const [inline] |
Overload transpose operator to mean inversion.
| InverseTransform_<P>& SimTK::Transform_< P >::operator~ | ( | ) | [inline] |
Overload transpose operator to mean inversion.
| Transform_ SimTK::Transform_< P >::compose | ( | const Transform_< P > & | X_FY | ) | const [inline] |
Compose the current transform (X_BF) with the given one.
That is, return X_BY=X_BF*X_FY. Cost is 63 flops.
| Transform_< P > SimTK::Transform_< P >::compose | ( | const InverseTransform_< P > & | X_FY | ) | const [inline] |
Compose the current transform (X_BF) with one that is supplied as an InverseTransform_ (typically as a result of applying the "~" operator to a transform).
That is, return X_BY=X_BF*X_FY, but now X_FY is represented as ~X_YF. Cost is an extra 18 flops to calculate X_FY.p(), total 81 flops.
| Vec<3,P> SimTK::Transform_< P >::xformFrameVecToBase | ( | const Vec< 3, P > & | vF | ) | const [inline] |
Transform a vector expressed in our "F" frame to our "B" frame.
Note that this involves rotation only; it is independent of the translation stored in this transform. Cost is 15 flops.
| Vec<3,P> SimTK::Transform_< P >::xformBaseVecToFrame | ( | const Vec< 3, P > & | vB | ) | const [inline] |
Transform a vector expressed in our "B" frame to our "F" frame.
Note that this involves rotation only; it is independent of the translation stored in this transform. Cost is 15 flops.
| Vec<3,P> SimTK::Transform_< P >::shiftFrameStationToBase | ( | const Vec< 3, P > & | sF | ) | const [inline] |
Transform a point (station) measured from and expressed in our "F" frame to that same point but measured from and expressed in our "B" frame.
Cost is 18 flops.
| Vec<3,P> SimTK::Transform_< P >::shiftBaseStationToFrame | ( | const Vec< 3, P > & | sB | ) | const [inline] |
Transform a point (station) measured from and expressed in our "B" frame to that same point but measured from and expressed in our "F" frame.
Cost is 18 flops.
| const Rotation_<P>& SimTK::Transform_< P >::R | ( | ) | const [inline] |
Return a read-only reference to the contained rotation R_BF.
| Rotation_<P>& SimTK::Transform_< P >::updR | ( | ) | [inline] |
Return a writable (lvalue) reference to the contained rotation R_BF.
| const Rotation_<P>::ColType& SimTK::Transform_< P >::x | ( | ) | const [inline] |
Return a read-only reference to the x direction (unit vector) of the F frame, expressed in the B frame.
| const Rotation_<P>::ColType& SimTK::Transform_< P >::y | ( | ) | const [inline] |
Return a read-only reference to the y direction (unit vector) of the F frame, expressed in the B frame.
| const Rotation_<P>::ColType& SimTK::Transform_< P >::z | ( | ) | const [inline] |
Return a read-only reference to the z direction (unit vector) of the F frame, expressed in the B frame.
| const InverseRotation_<P>& SimTK::Transform_< P >::RInv | ( | ) | const [inline] |
Return a read-only reference to the inverse (transpose) of our contained rotation, that is R_FB.
| InverseRotation_<P>& SimTK::Transform_< P >::updRInv | ( | ) | [inline] |
Return a writable (lvalue) reference to the inverse (transpose) of our contained rotation, that is R_FB.
| const Vec<3,P>& SimTK::Transform_< P >::p | ( | ) | const [inline] |
Return a read-only reference to our translation vector p_BF.
| Vec<3,P>& SimTK::Transform_< P >::updP | ( | ) | [inline] |
Return a writable (lvalue) reference to our translation vector p_BF.
Caution: if you write through this reference you update the transform.
| Transform_<P>& SimTK::Transform_< P >::setP | ( | const Vec< 3, P > & | p | ) | [inline] |
Assign a new value to our translation vector.
We expect the supplied vector p to be expressed in our B frame. A reference to the now-modified transform is returned as though this were an assignment operator.
| Vec<3,P> SimTK::Transform_< P >::pInv | ( | ) | const [inline] |
Calculate the inverse of the translation vector in this transform.
The returned vector will be the negative of the original and will be expressed in the F frame rather than our B frame. Cost is 18 flops.
| Transform_<P>& SimTK::Transform_< P >::setPInv | ( | const Vec< 3, P > & | p_FB | ) | [inline] |
Assign a value to the inverse of our translation vector.
That is, we're given a vector in F which we invert and reexpress in B to store it in p, so that we get the original argument back if we ask for the inverse of p. Sorry, can't update pInv as an lvalue, but here we want -(~R_BF*p_BF)=p_FB => p_BF=-(R_BF*p_FB) so we can calculate it in 18 flops. A reference to the now-modified transform is returned as though this were an assignment operator.
| const Mat<3,4,P>& SimTK::Transform_< P >::asMat34 | ( | ) | const [inline] |
Recast this transform as a read-only 3x4 matrix.
This is a zero-cost reinterpretation of the data; the first three columns are the columns of the rotation and the last column is the translation.
| Mat<3,4,P> SimTK::Transform_< P >::toMat34 | ( | ) | const [inline] |
Less efficient version of asMat34(); copies into return variable.
| Mat<4,4,P> SimTK::Transform_< P >::toMat44 | ( | ) | const [inline] |
Return the equivalent 4x4 transformation matrix.
| const Vec<3,P>& SimTK::Transform_< P >::T | ( | ) | const [inline] |
| Vec<3,P>& SimTK::Transform_< P >::updT | ( | ) | [inline] |
1.7.3