SO3Engine
Functions
Mathematical functions

Functions

int SO3MathsQuatToEulerXYZ (mmachine m)
 Main include.
 
int SO3MathsQuatToEulerXZY (mmachine m)
 SO3MathsQuatToEulerXZY : Scol function to transform quaternion vector in euler angles (XZY) !Deprecated! Prototype: fun [[F F F F]] [F F F].
 
int SO3MathsQuatToEulerYXZ (mmachine m)
 SO3MathsQuatToEulerYXZ : Scol function to transform quaternion vector in euler angles (YXZ) !Deprecated! Prototype: fun [[F F F F]] [F F F].
 
int SO3MathsQuatToEulerYZX (mmachine m)
 SO3MathsQuatToEulerYZX : Scol function to transform quaternion vector in euler angles (YZX) !Deprecated! Prototype: fun [[F F F F]] [F F F].
 
int SO3MathsQuatToEulerZXY (mmachine m)
 SO3MathsQuatToEulerZXY : Scol function to transform quaternion vector in euler angles (ZXY) !Deprecated! Prototype: fun [[F F F F]] [F F F].
 
int SO3MathsQuatToEulerZYX (mmachine m)
 SO3MathsQuatToEulerZYX : Scol function to transform quaternion vector in euler angles (ZYX) !Deprecated! Prototype: fun [[F F F F]] [F F F].
 
int SO3MathsQuatToEulerDegreeXYZ (mmachine m)
 SO3MathsQuatToEulerDegreeXYZ : Scol function to transform quaternion vector in euler angles (degree) (XYZ) !Deprecated! Prototype: fun [[F F F F]] [F F F].
 
int SO3MathsQuatToEulerDegreeXZY (mmachine m)
 SO3MathsQuatToEulerDegreeXZY : Scol function to transform quaternion vector in euler angles (degree) (XZY) !Deprecated! Prototype: fun [[F F F F]] [F F F].
 
int SO3MathsQuatToEulerDegreeYXZ (mmachine m)
 SO3MathsQuatToEulerDegreeYXZ : Scol function to transform quaternion vector in euler angles (degree) (YXZ) !Deprecated! Prototype: fun [[F F F F]] [F F F].
 
int SO3MathsQuatToEulerDegreeYZX (mmachine m)
 SO3MathsQuatToEulerDegreeYZX : Scol function to transform quaternion vector in euler angles (degree) (YZX) !Deprecated! Prototype: fun [[F F F F]] [F F F].
 
int SO3MathsQuatToEulerDegreeZXY (mmachine m)
 SO3MathsQuatToEulerDegreeZXY : Scol function to transform quaternion vector in euler angles (degree) (ZXY) !Deprecated! Prototype: fun [[F F F F]] [F F F].
 
int SO3MathsQuatToEulerDegreeZYX (mmachine m)
 SO3MathsQuatToEulerDegreeZYX : Scol function to transform quaternion vector in euler angles (degree) (ZYX) !Deprecated! Prototype: fun [[F F F F]] [F F F].
 
int SO3MathsEulerXYZToQuat (mmachine m)
 SO3MathsEulerXYZToQuat : Scol function to transform euler angles (XYZ) (radians) in a quaternion !Deprecated! Prototype: fun [[F F F]] [F F F F].
 
int SO3MathsEulerXZYToQuat (mmachine m)
 SO3MathsEulerXZYToQuat : Scol function to transform euler angles (XZY) (radians) in a quaternion !Deprecated! Prototype: fun [[F F F]] [F F F F].
 
int SO3MathsEulerYXZToQuat (mmachine m)
 SO3MathsEulerYXZToQuat : Scol function to transform euler angles (YXZ) (radians) in a quaternion !Deprecated! Prototype: fun [[F F F]] [F F F F].
 
int SO3MathsEulerYZXToQuat (mmachine m)
 SO3MathsEulerYZXToQuat : Scol function to transform euler angles (YZX) (radians) in a quaternion !Deprecated! Prototype: fun [[F F F]] [F F F F].
 
int SO3MathsEulerZYXToQuat (mmachine m)
 SO3MathsEulerZYXToQuat : Scol function to transform euler angles (ZYX) (radians) in a quaternion !Deprecated! Prototype: fun [[F F F]] [F F F F].
 
int SO3MathsEulerZXYToQuat (mmachine m)
 SO3MathsEulerZXYToQuat : Scol function to transform euler angles (ZXY) (radians) in a quaternion !Deprecated! Prototype: fun [[F F F]] [F F F F].
 
int SO3MathsQuatIsEqual (mmachine m)
 SO3MathsQuatIsEqual : Scol function test two quaternion equality.
 
int SO3MathsQuatDiff (mmachine m)
 SO3MathsQuatDiff : Scol function to make the mathematical difference between two quaternions.
 
int SO3MathsQuatSubstract (mmachine m)
 SO3MathsQuatSubstract : Scol function to substract two quaternions.
 
int SO3MathsQuatAdd (mmachine m)
 SO3MathsQuatAdd : Scol function to add two quaternions.
 
int SO3MathsQuatInterpolate (mmachine m)
 SO3MathsQuatInterpolate : function to interpolate two quaternions.
 
int SO3MathsDegreeToRadian (mmachine m)
 SO3MathsDegreeToRadian : function to convert a value from degrees to radians.
 
int SO3MathsRadianToDegree (mmachine m)
 SO3MathsRadianToDegree : function to convert a value from radians to degrees.
 
int SO3MathsQuatGetRoll (mmachine m)
 SO3MathsQuatGetRoll : function to get the roll value from quaternion.
 
int SO3MathsQuatGetYaw (mmachine m)
 SO3MathsQuatGetYaw : function to get the yaw value from quaternion.
 
int SO3MathsQuatGetPitch (mmachine m)
 SO3MathsQuatGetPitch : function to get the pitch value from quaternion.
 
int SO3MathsQuatGetDegreeRoll (mmachine m)
 SO3MathsQuatGetDegreeRoll : function to get the roll value in degree from quaternion.
 
int SO3MathsQuatGetDegreeYaw (mmachine m)
 SO3MathsQuatGetDegreeYaw : function to get the yaw value in degree from quaternion.
 
int SO3MathsQuatGetDegreePitch (mmachine m)
 SO3MathsQuatGetDegreePitch : function to get the pitch value in degree from quaternion.
 
int SO3MathsQuatToAxes (mmachine m)
 SO3MathsQuatToAxes : function to project quaternion to axis values.
 
int SO3MathsQuatFromAngle (mmachine m)
 SO3MathsQuatFromAngle : function to get Quaternion from X Y Z angle.
 
int SO3MathsQuatFromDegreeAngle (mmachine m)
 SO3MathsQuatFromDegreeAngle : function to get Quaternion from X Y Z angle in degree.
 
int SO3MathsQuatFromAngleAxis (mmachine m)
 SO3MathsQuatFromAngleAxis : function to get Quaternion from angle axis.
 
int SO3MathsQuatFromAxes (mmachine m)
 SO3MathsQuatFromAxes : function to get Quaternion from axis.
 
int SO3MathsQuatGetXaxis (mmachine m)
 SO3MathsQuatGetXaxis : function to get X-axis from quaternion.
 
int SO3MathsQuatGetYaxis (mmachine m)
 SO3MathsQuatGetYaxis : function to get Y-axis from quaternion.
 
int SO3MathsQuatGetZaxis (mmachine m)
 SO3MathsQuatGetZaxis : function to get Z-axis from quaternion.
 
int SO3MathsQuatGetDirection (mmachine m)
 SO3MathsQuatGetDirection : function to get the direction from quaternion.
 
int SO3MathsClampValue (mmachine m)
 SO3MathsClampValue : function to clamp a value.
 
int SO3MathsGetRotationTo (mmachine m)
 SO3MathsGetRotationTo : Scol function to get the shortest arc quaternion to rotate the source vector to the destination vector.
 
int SO3MathsGetRotationToAxis (mmachine m)
 SO3MathsGetRotationToAxis : Scol function to get the shortest arc quaternion to rotate the source vector to axis.
 
int SO3MathsVectorDotProduct (mmachine m)
 SO3MathsVectorDotProduct : Calculates the dot (scalar) product of this vector with another.
 
int SO3MathsQuatRotate (mmachine m)
 SO3MathsQuatRotate : Scol function to rotate a quaternion.
 
int SO3MathsQuatToEulerDegreePYR (mmachine m)
 SO3MathsQuatToEulerDegreePYR : Scol function to transform quaternion vector in euler angles (degree) (Pitch Yaw Roll)
 
int SO3MathsQuatToEulerPYR (mmachine m)
 SO3MathsQuatToEulerPYR : Scol function to transform quaternion vector in euler angles (Pitch Yaw Roll)
 
int SO3MathsEulerPYRToQuat (mmachine m)
 SO3MathsEulerPYRToQuat : Scol function to transform quaternion vector in euler angles (degree) (YZX)
 

Detailed Description

Scol functions definition

Function Documentation

◆ SO3MathsClampValue()

int SO3MathsClampValue ( mmachine  m)

SO3MathsClampValue : function to clamp a value.

Prototype: fun [F F F] F

Parameters
[FF F] : values : min, max and clamp value
Returns
F : result value if success, NIL otherwise

Definition at line 2291 of file SCOLMaths.cpp.

◆ SO3MathsDegreeToRadian()

int SO3MathsDegreeToRadian ( mmachine  m)

SO3MathsDegreeToRadian : function to convert a value from degrees to radians.

Prototype: fun [F] F

Parameters
F: value in degrees
Returns
F : result in radians if success, NIL otherwise

Definition at line 1418 of file SCOLMaths.cpp.

◆ SO3MathsEulerPYRToQuat()

int SO3MathsEulerPYRToQuat ( mmachine  m)

SO3MathsEulerPYRToQuat : Scol function to transform quaternion vector in euler angles (degree) (YZX)

Prototype: fun [[F F F]] [F F F F]

Parameters
[FF F] : current Pitch Yaw Roll
Returns
[F F F F] : the quaternion if success, NIL otherwise

Definition at line 2711 of file SCOLMaths.cpp.

◆ SO3MathsEulerXYZToQuat()

int SO3MathsEulerXYZToQuat ( mmachine  m)

SO3MathsEulerXYZToQuat : Scol function to transform euler angles (XYZ) (radians) in a quaternion !Deprecated! Prototype: fun [[F F F]] [F F F F].

Parameters
[FF F] : current vector (Euler angles)
Returns
[F F F F] : quaternion if success, NIL otherwise

Definition at line 753 of file SCOLMaths.cpp.

◆ SO3MathsEulerXZYToQuat()

int SO3MathsEulerXZYToQuat ( mmachine  m)

SO3MathsEulerXZYToQuat : Scol function to transform euler angles (XZY) (radians) in a quaternion !Deprecated! Prototype: fun [[F F F]] [F F F F].

Parameters
[FF F] : current vector (Euler angles)
Returns
[F F F F] : quaternion if success, NIL otherwise

Definition at line 812 of file SCOLMaths.cpp.

◆ SO3MathsEulerYXZToQuat()

int SO3MathsEulerYXZToQuat ( mmachine  m)

SO3MathsEulerYXZToQuat : Scol function to transform euler angles (YXZ) (radians) in a quaternion !Deprecated! Prototype: fun [[F F F]] [F F F F].

Parameters
[FF F] : current vector (Euler angles)
Returns
[F F F F] : quaternion if success, NIL otherwise

Definition at line 871 of file SCOLMaths.cpp.

◆ SO3MathsEulerYZXToQuat()

int SO3MathsEulerYZXToQuat ( mmachine  m)

SO3MathsEulerYZXToQuat : Scol function to transform euler angles (YZX) (radians) in a quaternion !Deprecated! Prototype: fun [[F F F]] [F F F F].

Parameters
[FF F] : current vector (Euler angles)
Returns
[F F F F] : quaternion if success, NIL otherwise

Definition at line 930 of file SCOLMaths.cpp.

◆ SO3MathsEulerZXYToQuat()

int SO3MathsEulerZXYToQuat ( mmachine  m)

SO3MathsEulerZXYToQuat : Scol function to transform euler angles (ZXY) (radians) in a quaternion !Deprecated! Prototype: fun [[F F F]] [F F F F].

Parameters
[FF F] : current vector (Euler angles)
Returns
[F F F F] : quaternion if success, NIL otherwise

Definition at line 1048 of file SCOLMaths.cpp.

◆ SO3MathsEulerZYXToQuat()

int SO3MathsEulerZYXToQuat ( mmachine  m)

SO3MathsEulerZYXToQuat : Scol function to transform euler angles (ZYX) (radians) in a quaternion !Deprecated! Prototype: fun [[F F F]] [F F F F].

Parameters
[FF F] : current vector (Euler angles)
Returns
[F F F F] : quaternion if success, NIL otherwise

Definition at line 989 of file SCOLMaths.cpp.

◆ SO3MathsGetRotationTo()

int SO3MathsGetRotationTo ( mmachine  m)

SO3MathsGetRotationTo : Scol function to get the shortest arc quaternion to rotate the source vector to the destination vector.

Prototype: fun [[F F F] [F F F]] [F F F F]

Parameters
[FF F] : source vector
[FF F] : destination vector
Returns
[F F F F] : quaternion result if success, NIL otherwise

Definition at line 2324 of file SCOLMaths.cpp.

◆ SO3MathsGetRotationToAxis()

int SO3MathsGetRotationToAxis ( mmachine  m)

SO3MathsGetRotationToAxis : Scol function to get the shortest arc quaternion to rotate the source vector to axis.

Prototype: fun [[F F F] [F F F]] [F F F F]

Parameters
[FF F] : source vector
[FF F] : up direction
Returns
[F F F F] : quaternion result if success, NIL otherwise

Definition at line 2393 of file SCOLMaths.cpp.

◆ SO3MathsQuatAdd()

int SO3MathsQuatAdd ( mmachine  m)

SO3MathsQuatAdd : Scol function to add two quaternions.

Prototype: fun [[F F F F] [F F F F]] [F F F F]

Parameters
[FF F F] : quaternion 1
[FF F F] : quaternion 2
Returns
[F F F F] : quaternion result if success, NIL otherwise

Definition at line 1281 of file SCOLMaths.cpp.

◆ SO3MathsQuatDiff()

int SO3MathsQuatDiff ( mmachine  m)

SO3MathsQuatDiff : Scol function to make the mathematical difference between two quaternions.

Prototype: fun [[F F F F] [F F F F]] [F F F F]

Parameters
[FF F F] : quaternion 1
[FF F F] : quaternion 2
Returns
[F F F F] : quaternion result if success, NIL otherwise

Definition at line 1156 of file SCOLMaths.cpp.

◆ SO3MathsQuatFromAngle()

int SO3MathsQuatFromAngle ( mmachine  m)

SO3MathsQuatFromAngle : function to get Quaternion from X Y Z angle.

Prototype: fun [[F F F]] [F F F F]

Parameters
[FF F] : given X Y Z angle transformations
Returns
[F F F F] : quaternion if success, NIL otherwise

Definition at line 1835 of file SCOLMaths.cpp.

◆ SO3MathsQuatFromAngleAxis()

int SO3MathsQuatFromAngleAxis ( mmachine  m)

SO3MathsQuatFromAngleAxis : function to get Quaternion from angle axis.

Prototype: fun [F [F F F]] [F F F F]

Parameters
F: radian angle
[FF F] : axis
Returns
[F F F F] : quaternion if success, NIL otherwise

Definition at line 1956 of file SCOLMaths.cpp.

◆ SO3MathsQuatFromAxes()

int SO3MathsQuatFromAxes ( mmachine  m)

SO3MathsQuatFromAxes : function to get Quaternion from axis.

Prototype: fun [[F F F] [F F F] [F F F]] [F F F F]

Parameters
[FF F] [F F F] [F F F] : given angle axis transformations
Returns
[F F F F] : quaternion if success, NIL otherwise

Definition at line 2008 of file SCOLMaths.cpp.

◆ SO3MathsQuatFromDegreeAngle()

int SO3MathsQuatFromDegreeAngle ( mmachine  m)

SO3MathsQuatFromDegreeAngle : function to get Quaternion from X Y Z angle in degree.

Prototype: fun [[F F F]]] [F F F F]

Parameters
[FF F] : given X Y Z angle transformations
Returns
[F F F F] : quaternion if success, NIL otherwise

Definition at line 1893 of file SCOLMaths.cpp.

◆ SO3MathsQuatGetDegreePitch()

int SO3MathsQuatGetDegreePitch ( mmachine  m)

SO3MathsQuatGetDegreePitch : function to get the pitch value in degree from quaternion.

Prototype: fun [[F F F F] I] F

Parameters
[FF F F] : given quaternion
I: boolean : if true : reproject axis
Returns
F : pitch value in degree if success, NIL otherwise

Definition at line 1699 of file SCOLMaths.cpp.

◆ SO3MathsQuatGetDegreeRoll()

int SO3MathsQuatGetDegreeRoll ( mmachine  m)

SO3MathsQuatGetDegreeRoll : function to get the roll value in degree from quaternion.

Prototype: fun [[F F F F] I] F

Parameters
[FF F F] : given quaternion
I: boolean : if true : reproject axis
Returns
F : roll value in degree if success, NIL otherwise

Definition at line 1611 of file SCOLMaths.cpp.

◆ SO3MathsQuatGetDegreeYaw()

int SO3MathsQuatGetDegreeYaw ( mmachine  m)

SO3MathsQuatGetDegreeYaw : function to get the yaw value in degree from quaternion.

Prototype: fun [[F F F F] I] F

Parameters
[FF F F] : given quaternion
I: boolean : if true : reproject axis
Returns
F : yaw value in degree if success, NIL otherwise

Definition at line 1655 of file SCOLMaths.cpp.

◆ SO3MathsQuatGetDirection()

int SO3MathsQuatGetDirection ( mmachine  m)

SO3MathsQuatGetDirection : function to get the direction from quaternion.

Prototype: fun [[F F F F] [F F F]] [F F F]

Parameters
[FF F F] : given quaternion
[FF F] : given vector for projection
Returns
[F F F] : Direction vector if success, NIL otherwise

Definition at line 2225 of file SCOLMaths.cpp.

◆ SO3MathsQuatGetPitch()

int SO3MathsQuatGetPitch ( mmachine  m)

SO3MathsQuatGetPitch : function to get the pitch value from quaternion.

Prototype: fun [[F F F F] I] F

Parameters
[FF F F] : given quaternion
I: boolean : if true : reproject axis
Returns
F : pitch value in radian if success, NIL otherwise

Definition at line 1567 of file SCOLMaths.cpp.

◆ SO3MathsQuatGetRoll()

int SO3MathsQuatGetRoll ( mmachine  m)

SO3MathsQuatGetRoll : function to get the roll value from quaternion.

Prototype: fun [[F F F F] I] F

Parameters
[FF F F] : given quaternion
I: boolean : if true : reproject axis
Returns
F : roll value in radian if success, NIL otherwise

Definition at line 1479 of file SCOLMaths.cpp.

◆ SO3MathsQuatGetXaxis()

int SO3MathsQuatGetXaxis ( mmachine  m)

SO3MathsQuatGetXaxis : function to get X-axis from quaternion.

Prototype: fun [[F F F F]] [F F F]

Parameters
[FF F F] : given quaternion
Returns
[F F F] : X axis if success, NIL otherwise

Definition at line 2068 of file SCOLMaths.cpp.

◆ SO3MathsQuatGetYaw()

int SO3MathsQuatGetYaw ( mmachine  m)

SO3MathsQuatGetYaw : function to get the yaw value from quaternion.

Prototype: fun [[F F F F] I] F

Parameters
[FF F F] : given quaternion
I: boolean : if true : reproject axis
Returns
F : yaw value in radian if success, NIL otherwise

Definition at line 1523 of file SCOLMaths.cpp.

◆ SO3MathsQuatGetYaxis()

int SO3MathsQuatGetYaxis ( mmachine  m)

SO3MathsQuatGetYaxis : function to get Y-axis from quaternion.

Prototype: fun [[F F F F]] [F F F]

Parameters
[FF F F] : given quaternion
Returns
[F F F] : Y axis if success, NIL otherwise

Definition at line 2120 of file SCOLMaths.cpp.

◆ SO3MathsQuatGetZaxis()

int SO3MathsQuatGetZaxis ( mmachine  m)

SO3MathsQuatGetZaxis : function to get Z-axis from quaternion.

Prototype: fun [[F F F F]] [F F F]

Parameters
[FF F F] : given quaternion
Returns
[F F F] : Z axis if success, NIL otherwise

Definition at line 2172 of file SCOLMaths.cpp.

◆ SO3MathsQuatInterpolate()

int SO3MathsQuatInterpolate ( mmachine  m)

SO3MathsQuatInterpolate : function to interpolate two quaternions.

Prototype: fun [[F F F F] [F F F F] F I] [F F F F]

Parameters
[FF F F] : quaternion 1
[FF F F] : quaternion 2
F: Interpolation coefficient between 0.0 and 1.0
I: 1 for the shortest orientation, 0 otherwise
Returns
[F F F F] : quaternion result if success, NIL otherwise

Definition at line 1348 of file SCOLMaths.cpp.

◆ SO3MathsQuatIsEqual()

int SO3MathsQuatIsEqual ( mmachine  m)

SO3MathsQuatIsEqual : Scol function test two quaternion equality.

Prototype: fun [[F F F F] [F F F F]] I

Parameters
[FF F F] : quaternion 1
[FF F F] : quaternion 2
Returns
I : 1 if quaternions are equal, 0 if not, NIL otherwise

Definition at line 1108 of file SCOLMaths.cpp.

◆ SO3MathsQuatRotate()

int SO3MathsQuatRotate ( mmachine  m)

SO3MathsQuatRotate : Scol function to rotate a quaternion.

Prototype: fun [[F F F F] [F F F]] [F F F F]

Parameters
[FF F F] : source quaternion
[FF F] : Yaw, pitch, roll rotation
Returns
[F F F F] : quaternion result if success, NIL otherwise

Definition at line 2540 of file SCOLMaths.cpp.

◆ SO3MathsQuatSubstract()

int SO3MathsQuatSubstract ( mmachine  m)

SO3MathsQuatSubstract : Scol function to substract two quaternions.

Prototype: fun [[F F F F] [F F F F]] [F F F F]

Parameters
[FF F F] : quaternion 1
[FF F F] : quaternion 2
Returns
[F F F F] : quaternion result if success, NIL otherwise

Definition at line 1218 of file SCOLMaths.cpp.

◆ SO3MathsQuatToAxes()

int SO3MathsQuatToAxes ( mmachine  m)

SO3MathsQuatToAxes : function to project quaternion to axis values.

Prototype: fun [[F F F F]] [[F F F] [F F F] [F F F]]

Parameters
[FF F F] : given quaternion
Returns
[[F F F] [F F F] [F F F]] : axis vectors if success, NIL otherwise

Definition at line 1742 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerDegreePYR()

int SO3MathsQuatToEulerDegreePYR ( mmachine  m)

SO3MathsQuatToEulerDegreePYR : Scol function to transform quaternion vector in euler angles (degree) (Pitch Yaw Roll)

Prototype: fun [[F F F F]] [F F F]

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler Pitch, Yaw, Roll in degrees if success, NIL otherwise

Definition at line 2605 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerDegreeXYZ()

int SO3MathsQuatToEulerDegreeXYZ ( mmachine  m)

SO3MathsQuatToEulerDegreeXYZ : Scol function to transform quaternion vector in euler angles (degree) (XYZ) !Deprecated! Prototype: fun [[F F F F]] [F F F].

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler angles in degrees if success, NIL otherwise

Definition at line 402 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerDegreeXZY()

int SO3MathsQuatToEulerDegreeXZY ( mmachine  m)

SO3MathsQuatToEulerDegreeXZY : Scol function to transform quaternion vector in euler angles (degree) (XZY) !Deprecated! Prototype: fun [[F F F F]] [F F F].

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler angles in degrees if success, NIL otherwise

Definition at line 460 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerDegreeYXZ()

int SO3MathsQuatToEulerDegreeYXZ ( mmachine  m)

SO3MathsQuatToEulerDegreeYXZ : Scol function to transform quaternion vector in euler angles (degree) (YXZ) !Deprecated! Prototype: fun [[F F F F]] [F F F].

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler angles in degrees if success, NIL otherwise

Definition at line 517 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerDegreeYZX()

int SO3MathsQuatToEulerDegreeYZX ( mmachine  m)

SO3MathsQuatToEulerDegreeYZX : Scol function to transform quaternion vector in euler angles (degree) (YZX) !Deprecated! Prototype: fun [[F F F F]] [F F F].

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler angles in degrees if success, NIL otherwise

Definition at line 576 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerDegreeZXY()

int SO3MathsQuatToEulerDegreeZXY ( mmachine  m)

SO3MathsQuatToEulerDegreeZXY : Scol function to transform quaternion vector in euler angles (degree) (ZXY) !Deprecated! Prototype: fun [[F F F F]] [F F F].

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler angles in degrees if success, NIL otherwise

Definition at line 635 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerDegreeZYX()

int SO3MathsQuatToEulerDegreeZYX ( mmachine  m)

SO3MathsQuatToEulerDegreeZYX : Scol function to transform quaternion vector in euler angles (degree) (ZYX) !Deprecated! Prototype: fun [[F F F F]] [F F F].

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler angles in degrees if success, NIL otherwise

Definition at line 694 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerPYR()

int SO3MathsQuatToEulerPYR ( mmachine  m)

SO3MathsQuatToEulerPYR : Scol function to transform quaternion vector in euler angles (Pitch Yaw Roll)

Prototype: fun [[F F F F]] [F F F]

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler Pitch, Yaw, Roll in radian if success, NIL otherwise

Definition at line 2658 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerXYZ()

int SO3MathsQuatToEulerXYZ ( mmachine  m)

Main include.

SO3MathsQuatToEulerXYZ : Scol function to transform quaternion vector in euler angles (XYZ) !Deprecated! Prototype: fun [[F F F F]] [F F F]

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler angles if success, NIL otherwise

Definition at line 50 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerXZY()

int SO3MathsQuatToEulerXZY ( mmachine  m)

SO3MathsQuatToEulerXZY : Scol function to transform quaternion vector in euler angles (XZY) !Deprecated! Prototype: fun [[F F F F]] [F F F].

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler angles if success, NIL otherwise

Definition at line 109 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerYXZ()

int SO3MathsQuatToEulerYXZ ( mmachine  m)

SO3MathsQuatToEulerYXZ : Scol function to transform quaternion vector in euler angles (YXZ) !Deprecated! Prototype: fun [[F F F F]] [F F F].

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler angles if success, NIL otherwise

Definition at line 168 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerYZX()

int SO3MathsQuatToEulerYZX ( mmachine  m)

SO3MathsQuatToEulerYZX : Scol function to transform quaternion vector in euler angles (YZX) !Deprecated! Prototype: fun [[F F F F]] [F F F].

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler angles if success, NIL otherwise

Definition at line 227 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerZXY()

int SO3MathsQuatToEulerZXY ( mmachine  m)

SO3MathsQuatToEulerZXY : Scol function to transform quaternion vector in euler angles (ZXY) !Deprecated! Prototype: fun [[F F F F]] [F F F].

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler angles if success, NIL otherwise

Definition at line 284 of file SCOLMaths.cpp.

◆ SO3MathsQuatToEulerZYX()

int SO3MathsQuatToEulerZYX ( mmachine  m)

SO3MathsQuatToEulerZYX : Scol function to transform quaternion vector in euler angles (ZYX) !Deprecated! Prototype: fun [[F F F F]] [F F F].

Parameters
[FF F F] : current quaternion
Returns
[F F F] : euler angles if success, NIL otherwise

Definition at line 343 of file SCOLMaths.cpp.

◆ SO3MathsRadianToDegree()

int SO3MathsRadianToDegree ( mmachine  m)

SO3MathsRadianToDegree : function to convert a value from radians to degrees.

Prototype: fun [F] F

Parameters
F: value in radians
Returns
F : result in degrees if success, NIL otherwise

Definition at line 1448 of file SCOLMaths.cpp.

◆ SO3MathsVectorDotProduct()

int SO3MathsVectorDotProduct ( mmachine  m)

SO3MathsVectorDotProduct : Calculates the dot (scalar) product of this vector with another.

Remarks
The dot product can be used to calculate the angle between 2 vectors. If both are unit vectors, the dot product is the cosine of the angle; otherwise the dot product must be divided by the product of the lengths of both vectors to get the cosine of the angle. This result can further be used to calculate the distance of a point from a plane.

Prototype: fun [[F F F] [F F F]] F

Parameters
[FF F] : Reference vector used to calculate the dot product
[FF F] : Vector with which to calculate the dot product
Returns
F : A float representing the dot product value.

Definition at line 2482 of file SCOLMaths.cpp.