FC_Line3DToRotationMatrix - General Information
Overview
|
Type: |
Function |
|
Available as of: |
V1.0.0.0 |
|
Versions: |
Current version |
This chapter provides information on:
Description
Starting from the description of a line, the function defines an orientation considering the x axis pointing from i_stLine stPoint1 to i_stLine.stPoint2, the z axis points up (third component of the z versor with positive value) and the y axis accordingly to the right-hand rule. The rotation about the x axis is considered to be null.
The orientation is described as a 3D rotation matrix.
Interface
|
Input |
Data type |
Description |
|---|---|---|
|
i_stLine |
SE_MATH.ST_Line3D |
Line to consider. |
|
Output |
Data type |
Description |
|---|---|---|
|
q_xError |
BOOL |
If this output is set to TRUE, an error has been detected. For details, refer to q_etResult and q_etResultMsg. |
|
q_etResult |
Provides diagnostic and status information. If q_xError = FALSE, then q_etResult provides status information. If q_xError = TRUE, then q_etResult provides diagnostic/error information. The enumeration ET_Result contains the possible values of the POU operation results. |
|
|
q_sResultMsg |
STRING[80] |
Provides additional information about the current status of the POU. |
Return Value
|
Data type |
Description |
|---|---|
|
SE_MATH.ST_Matrix3D |
The functions returns an orientation described as a 3D rotation matrix. |
Diagnostic Messages
|
q_xError |
q_etResult |
Enumeration value |
Description |
|---|---|---|---|
|
FALSE |
Ok |
0 |
Success |
|
TRUE |
PointsIdentical |
3 |
Two points have the same coordinates. |
PointsIdentical
|
Enumeration name: |
PointsIdentical |
|
Enumeration value: |
3 |
|
Description: |
Two points have the same coordinates. |
|
Issue |
Cause |
Solution |
|---|---|---|
|
Evaluation of the rotation matrix was not successful. |
i_stLine.stPoint1 and i_stLine.stPoint2 have the same coordinates. |
Verify that i_stLine.stPoint1 and i_stLine.stPoint2 have different coordinates. |