Main Page | Alphabetical List | Compound List | File List | Compound Members | File Members

srm_Orientation.h File Reference

#include "srm.h"

Go to the source code of this file.

Compounds

struct  SRM_Orientation_AA_Method_List
struct  SRM_Orientation_Axis_Angle
struct  SRM_Orientation_EA_Method_List
struct  SRM_Orientation_Euler_Angles_ZXZ
struct  SRM_Orientation_M_Method_List
struct  SRM_Orientation_Matrix
struct  SRM_Orientation_QT_Method_List
struct  SRM_Orientation_Quaternion
struct  SRM_Orientation_Tait_Bryan_Angles
struct  SRM_Orientation_TB_Method_List

Defines

#define EXPORT_DLL

Typedefs

typedef SRM_Status_Code SRM_GetMatrix3x3 (SRM_Object_Reference this_object, SRM_Matrix_3x3 *ori_matrix_3x3)
typedef SRM_Status_Code SRM_GetAxisAngleParams (SRM_Object_Reference this_object, SRM_Axis_Angle_Params *ori_axis_angle_params)
typedef SRM_Status_Code SRM_GetEulerAnglesZXZParams (SRM_Object_Reference this_object, SRM_Euler_Angles_ZXZ_Params *ori_auler_angles_zxz_params)
typedef SRM_Status_Code SRM_GetTaitBryanAnglesParams (SRM_Object_Reference this_object, SRM_Tait_Bryan_Angles_Params *ori_tait_bryan_angles_params)
typedef SRM_Status_Code SRM_GetQuaternionParams (SRM_Object_Reference this_object, SRM_Quaternion_Params *ori_quaternion_params)
typedef SRM_Status_Code SRM_SetMatrix3x3 (SRM_Object_Reference this_object, SRM_Matrix_3x3 *ori_matrix_3x3)
typedef SRM_Status_Code SRM_SetAxisAngleParams (SRM_Object_Reference this_object, SRM_Axis_Angle_Params *ori_axis_angle_params)
typedef SRM_Status_Code SRM_SetEulerAnglesZXZParams (SRM_Object_Reference this_object, SRM_Euler_Angles_ZXZ_Params *ori_auler_angles_zxz_params)
typedef SRM_Status_Code SRM_SetTaitBryanAnglesParams (SRM_Object_Reference this_object, SRM_Tait_Bryan_Angles_Params *ori_tait_bryan_angles_params)
typedef SRM_Status_Code SRM_SetQuaternionParams (SRM_Object_Reference this_object, SRM_Quaternion_Params *ori_quaternion_params)
typedef SRM_Status_Code SRM_TransformVectorOri (SRM_Object_Reference this_object, SRM_Vector_3D *in_vec, SRM_Vector_3D *out_vec)
typedef SRM_Status_Code SRM_Compose (SRM_Object_Reference left_ori_in, SRM_Object_Reference right_ori_in, SRM_Object_Reference out_ori)
typedef SRM_Status_Code SRM_GetOriType (SRM_Object_Reference this_object, SRM_Ori_Rep_Type *ori_type)
typedef SRM_Status_Code SRM_Ori_Destroy (SRM_Object_Reference object)

Functions

EXPORT_DLL SRM_Status_Code SRM_CreateOrientationMatrix (SRM_Matrix_3x3 *params, SRM_Orientation_Matrix *new_ori)
EXPORT_DLL SRM_Status_Code SRM_CreateOrientationAxisAngle (SRM_Axis_Angle_Params *params, SRM_Orientation_Axis_Angle *new_ori)
EXPORT_DLL SRM_Status_Code SRM_CreateOrientationEulerAnglesZXZ (SRM_Euler_Angles_ZXZ_Params *params, SRM_Orientation_Euler_Angles_ZXZ *new_ori)
EXPORT_DLL SRM_Status_Code SRM_CreateOrientationTaitBryanAngles (SRM_Tait_Bryan_Angles_Params *params, SRM_Orientation_Tait_Bryan_Angles *new_ori)
EXPORT_DLL SRM_Status_Code SRM_CreateOrientationQuaternion (SRM_Quaternion_Params *params, SRM_Orientation_Quaternion *new_ori)

Define Documentation

#define EXPORT_DLL
 

Definition at line 82 of file srm_Orientation.h.

Typedef Documentation

typedef SRM_Status_Code SRM_Compose( SRM_Object_Reference left_ori_in, SRM_Object_Reference right_ori_in, SRM_Object_Reference out_ori )
 

Definition at line 221 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_GetAxisAngleParams( SRM_Object_Reference this_object, SRM_Axis_Angle_Params *ori_axis_angle_params )
 

Gets the orientation parameters in axis-angle representation .

Parameters:
this_object in: this orientation object
ori_axis_angle_params out: the orientation parameters in axis-angle representation
Returns:
a status code

Definition at line 120 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_GetEulerAnglesZXZParams( SRM_Object_Reference this_object, SRM_Euler_Angles_ZXZ_Params *ori_auler_angles_zxz_params )
 

Gets the orientation parameters in Euler angles ZXZ representation .

Parameters:
this_object in: this orientation object
ori_euler_angles_zxz_params out: the orientation parameters in Euler angles ZXZ representation
Returns:
a status code

Definition at line 131 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_GetMatrix3x3( SRM_Object_Reference this_object, SRM_Matrix_3x3 *ori_matrix_3x3 )
 

Gets the orientation parameters in matrix 3x3 representation .

Parameters:
this_object in: this orientation object
ori_matrix_3x3 out: the orientation parameters in matrix 3x3 representation
Returns:
a status code

Definition at line 109 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_GetOriType( SRM_Object_Reference this_object, SRM_Ori_Rep_Type *ori_type )
 

Definition at line 228 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_GetQuaternionParams( SRM_Object_Reference this_object, SRM_Quaternion_Params *ori_quaternion_params )
 

Gets the orientation parameters in quaternion representation .

Parameters:
this_object in: this orientation object
ori_quaternion_params out: the orientation parameters in quaternion representation
Returns:
a status code

Definition at line 153 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_GetTaitBryanAnglesParams( SRM_Object_Reference this_object, SRM_Tait_Bryan_Angles_Params *ori_tait_bryan_angles_params )
 

Gets the orientation parameters in Tait-Bryan angles representation .

Parameters:
this_object in: this orientation object
ori_tiat_bryan_angles_params out: the orientation parameters in Tait-Bryan angles representation
Returns:
a status code

Definition at line 142 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_Ori_Destroy( SRM_Object_Reference object )
 

Definition at line 234 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_SetAxisAngleParams( SRM_Object_Reference this_object, SRM_Axis_Angle_Params *ori_axis_angle_params )
 

Sets the orientation parameters in axis-angle representation .

Parameters:
this_object in: this orientation object
ori_axis_angle_params in: the orientation parameters in axis-angle representation
Returns:
a status code

Definition at line 175 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_SetEulerAnglesZXZParams( SRM_Object_Reference this_object, SRM_Euler_Angles_ZXZ_Params *ori_auler_angles_zxz_params )
 

Sets the orientation parameters in Euler angles ZXZ representation .

Parameters:
this_object in: this orientation object
ori_euler_angles_zxz_params in: the orientation parameters in Euler angles ZXZ representation
Returns:
a status code

Definition at line 186 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_SetMatrix3x3( SRM_Object_Reference this_object, SRM_Matrix_3x3 *ori_matrix_3x3 )
 

Sets the orientation parameters in matrix 3x3 representation .

Parameters:
this_object in: this orientation object
ori_matrix_3x3 in: the orientation parameters in matrix 3x3 representation
Returns:
a status code

Definition at line 164 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_SetQuaternionParams( SRM_Object_Reference this_object, SRM_Quaternion_Params *ori_quaternion_params )
 

Sets the orientation parameters in quaternion representation .

Parameters:
this_object in: this orientation object
ori_quaternion_params in: the orientation parameters in quaternion representation
Returns:
a status code

Definition at line 208 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_SetTaitBryanAnglesParams( SRM_Object_Reference this_object, SRM_Tait_Bryan_Angles_Params *ori_tait_bryan_angles_params )
 

Sets the orientation parameters in Tait-Bryan angles representation .

Parameters:
this_object in: this orientation object
ori_tait_bryan_angles_params in: the orientation parameters in Tait-Bryan angles representation
Returns:
a status code

Definition at line 197 of file srm_Orientation.h.

typedef SRM_Status_Code SRM_TransformVectorOri( SRM_Object_Reference this_object, SRM_Vector_3D *in_vec, SRM_Vector_3D *out_vec )
 

Definition at line 214 of file srm_Orientation.h.

Function Documentation

EXPORT_DLL SRM_Status_Code SRM_CreateOrientationAxisAngle (  SRM_Axis_Angle_Params *  params,
SRM_Orientation_Axis_Angle *  new_ori
) 
 

Creates an axis-angle orientation object.

Note:
The returned SRF should be freed by calling its Destroy() method.

the input axis is a unit vector

the input angle is in radians in the range of [-2PI, 2PI]

Parameters:
params in: the axis-angle parameter.
new_ori out: results is a new SRM_Orientation_Axis_Angle
Returns:
a status code

EXPORT_DLL SRM_Status_Code SRM_CreateOrientationEulerAnglesZXZ (  SRM_Euler_Angles_ZXZ_Params *  params,
SRM_Orientation_Euler_Angles_ZXZ *  new_ori
) 
 

Creates a Euler angle ZXZ orientation object.

Note:
The returned SRF should be freed by calling its Destroy() method.

the spin angle is in radians in the range of [-2PI, 2PI]

the nutation angle is in radians in the range of [-PI/2, PI/2]

the precession angle is in radians in the range of [-PI/2, PI/2]

Parameters:
params in: the Euler angles ZXZ parameter.
new_ori out: results is a new SRM_Orientation_Euler_Angles_ZXZ
Returns:
a status code

EXPORT_DLL SRM_Status_Code SRM_CreateOrientationMatrix (  SRM_Matrix_3x3 *  params,
SRM_Orientation_Matrix *  new_ori
) 
 

Creates a Matrix 3x3 orientation object.

Note:
The returned SRF should be freed by calling its Destroy() method.

the INV(mat)=TRANSPOSE(mat), consequently, mat*TRANSPOSE(mat)=I

Parameters:
params in: the matrix 3x3 parameter.
new_ori out: result is a new SRM_Orientation_Matrix3x3
Returns:
a status code

EXPORT_DLL SRM_Status_Code SRM_CreateOrientationQuaternion (  SRM_Quaternion_Params *  params,
SRM_Orientation_Quaternion *  new_ori
) 
 

Creates a quaternion orientation object.

Note:
The returned SRF should be freed by calling its Destroy() method.

q = e0 + e1*i + e2*j + e3*k

e0^2 + e1^2 + e2^2 + e3^2 = 1

Parameters:
params in: the quaternion parameter.
new_ori out: results in a new SRM_Orientation_Quaternion
Returns:
a status code

EXPORT_DLL SRM_Status_Code SRM_CreateOrientationTaitBryanAngles (  SRM_Tait_Bryan_Angles_Params *  params,
SRM_Orientation_Tait_Bryan_Angles *  new_ori
) 
 

Creates a Tait_Bryan angles orientation object.

Note:
The returned SRF should be freed by calling its Destroy() method.

the roll angle is in radians in the range of [-2PI, 2PI]

the pitch angle is in radians in the range of [-2PI, 2PI]

the yaw angle is in radians in the range of [-2PI, 2PI]

Parameters:
params in: the Tait-Bryan angles parameter.
new_ori out: results is a new SRM_Orientation_Tait_Bryan_Angles
Returns:
a status code

C API Version: 4.4 - December 7, 2009
Copyright © 2009 SEDRIS™ Docs by Doxygen 1.3.2