mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-10-29 06:53:34 +08:00
adding detailed comments on rotation classes
This commit is contained in:
+14
-13
@@ -26,7 +26,8 @@ class Quaternion;
|
||||
/**
|
||||
* Euler angles class
|
||||
*
|
||||
* More elaborate class description
|
||||
* This class describes the transformation from the body fixed frame
|
||||
* to the inertial frame via 3-2-1 tait brian euler angles.
|
||||
*/
|
||||
template<typename Type>
|
||||
class Euler : public Vector<Type, 3>
|
||||
@@ -36,8 +37,6 @@ public:
|
||||
|
||||
/**
|
||||
* Standard constructor
|
||||
*
|
||||
* More elaborate function description
|
||||
*/
|
||||
Euler() : Vector<Type, 3>()
|
||||
{
|
||||
@@ -46,8 +45,6 @@ public:
|
||||
/**
|
||||
* Copy constructor
|
||||
*
|
||||
* More elaborate function description
|
||||
*
|
||||
* @param other vector to copy
|
||||
*/
|
||||
Euler(const Vector<Type, 3> & other) :
|
||||
@@ -58,8 +55,6 @@ public:
|
||||
/**
|
||||
* Constructor from Matrix31
|
||||
*
|
||||
* More elaborate function description
|
||||
*
|
||||
* @param other Matrix31 to copy
|
||||
*/
|
||||
Euler(const Matrix<Type, 3, 1> & other) :
|
||||
@@ -70,7 +65,8 @@ public:
|
||||
/**
|
||||
* Constructor from euler angles
|
||||
*
|
||||
* More elaborate function description
|
||||
* Instance is initialized from angle tripplet (3,2,1)
|
||||
* representing transformation from body frame to inertial frame.
|
||||
*
|
||||
* @param phi_ roll
|
||||
* @param theta_ pitch
|
||||
@@ -84,7 +80,8 @@ public:
|
||||
/**
|
||||
* Constructor from dcm
|
||||
*
|
||||
* More elaborate function description
|
||||
* Instance is initialized from dcm representing transformation
|
||||
* from body frame to inertial frame.
|
||||
*
|
||||
* @param dcm_ dcm to set angles to
|
||||
*/
|
||||
@@ -96,7 +93,8 @@ public:
|
||||
/**
|
||||
* Constructor from quaternion
|
||||
*
|
||||
* More elaborate function description
|
||||
* Instance is initialized from quaternion representing
|
||||
* transformation from body frame to inertial frame.
|
||||
*
|
||||
* @param q quaternion to set angles to
|
||||
*/
|
||||
@@ -109,7 +107,8 @@ public:
|
||||
/**
|
||||
* Set from euler angles
|
||||
*
|
||||
* More elaborate function description
|
||||
* Instance is set from angle tripplet (3,2,1) representing
|
||||
* transformation from body frame to inertial frame.
|
||||
*
|
||||
* @param phi_ roll
|
||||
* @param theta_ pitch
|
||||
@@ -125,7 +124,8 @@ public:
|
||||
/**
|
||||
* Set from dcm
|
||||
*
|
||||
* More elaborate function description
|
||||
* Instance is set from dcm representing transformation
|
||||
* from body frame to inertial frame.
|
||||
*
|
||||
* @param dcm_ dcm to set angles to
|
||||
*/
|
||||
@@ -152,7 +152,8 @@ public:
|
||||
/**
|
||||
* Set from dcm
|
||||
*
|
||||
* More elaborate function description
|
||||
* Instance is set from quaternion representing
|
||||
* transformation from body frame to inertial frame.
|
||||
*
|
||||
* @param q quaternion to set angles to
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user