Merge pull request #43 from iwatake2222/feature-#42-update_document

Feature #42 update document

Author: iwatake2222

NOTICE.md

@@ -1,3 +1,38 @@
+## EuclideanSpace - Mathematics and Computing 
+- http://www.euclideanspace.com/maths/geometry/rotations/conversions
+- Some conversion formulas are retrieved from EuclideanSpace
+
+## three.js
+- https://github.com/mrdoob/three.js
+- Copyright © 2010-2022 three.js authors
+- Licensed under the MIT License
+- Modification: Yes (Port some portion of the original JavaScript code to C++ code)
+- Some conversion calculations are retrieved from three.js
+
+```
+The MIT License
+
+Copyright © 2010-2022 three.js authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+```
+
 ## Dear ImGui
 - https://github.com/ocornut/imgui
 - Copyright (c) 2014-2022 Omar Cornut

README.md

@@ -1,18 +1,15 @@
-# +++++++++++++++++++++
-# Under development
-# +++++++++++++++++++++
-
-![image](https://user-images.githubusercontent.com/11009876/148526709-ecfff1a4-e0e4-4cc5-ab08-d74964e935f2.png)
-
+![image](https://user-images.githubusercontent.com/11009876/148989308-2d9c70b0-d25e-4124-b109-2fcb03c8ebb9.png)
 
 # Rotation Master
-- Provide conversion between the following representations of 3D rotation and display the pose
+- Provide conversion between the following representations of 3D rotation (rigid body orientation) and display the pose
     - Rotation Matrix
     - Rotation Vector
     - Axis-angle
     - Quaternion
-    - Euler Angle (Intrinsic(Mobile))
-    - Euler Angle (Extrinsic(Fixed))
+    - Euler Angle (Intrinsic; Mobile)
+    - Euler Angle (Extrinsic; Fixed)
+
+https://user-images.githubusercontent.com/11009876/148988739-5f775a11-c923-4557-aff7-12b9a4811d36.mp4
 
 ## CI Status
 Status | Build Type

desktop/ui.cpp

@@ -147,8 +147,8 @@ void Ui::Update(Window& window, AngleUnit& angle_unit, InputContainer& input_con
         }
         ImGui::Separator();
 
-        ImGui::RadioButton("Intrinsic (Mobile) Euler Angle", &input_container.selected_representation_type, static_cast<int32_t>(REPRESENTATION_TYPE::EULER_MOBILE));
-        if (ImGui::BeginTable("Intrinsic (Mobile) Euler Angle", 4)) {
+        ImGui::RadioButton("Euler Angle (Intrinsic; Mobile)", &input_container.selected_representation_type, static_cast<int32_t>(REPRESENTATION_TYPE::EULER_MOBILE));
+        if (ImGui::BeginTable("Euler Angle (Intrinsic; Mobile)", 4)) {
             bool is_value_changed = false;
             float val[3] = { angle_unit.Display(input_container.mobile_euler_angle[0]), angle_unit.Display(input_container.mobile_euler_angle[1]), angle_unit.Display(input_container.mobile_euler_angle[2]) };
             ImGui::TableNextRow();
@@ -164,8 +164,8 @@ void Ui::Update(Window& window, AngleUnit& angle_unit, InputContainer& input_con
         }
         ImGui::Separator();
 
-        ImGui::RadioButton("Extrinsic (Fixed) Euler Angle", &input_container.selected_representation_type, static_cast<int32_t>(REPRESENTATION_TYPE::EULER_FIXED));
-        if (ImGui::BeginTable("Extrinsic (Fixed) Euler Angle", 4)) {
+        ImGui::RadioButton("Euler Angle (Extrinsic; Fixed)", &input_container.selected_representation_type, static_cast<int32_t>(REPRESENTATION_TYPE::EULER_FIXED));
+        if (ImGui::BeginTable("Euler Angle (Extrinsic; Fixed)", 4)) {
             bool is_value_changed = false;
             float val[3] = { angle_unit.Display(input_container.fixed_euler_angle[0]), angle_unit.Display(input_container.fixed_euler_angle[1]), angle_unit.Display(input_container.fixed_euler_angle[2]) };
             ImGui::TableNextRow();
@@ -230,8 +230,8 @@ void Ui::Update(Window& window, AngleUnit& angle_unit, InputContainer& input_con
         }
         ImGui::Separator();
 
-        ImGui::Text("Intrinsic (Mobile) Euler Angle");
-        if (ImGui::BeginTable("Intrinsic (Mobile) Euler Angle", 4)) {
+        ImGui::Text("Euler Angle (Intrinsic; Mobile)");
+        if (ImGui::BeginTable("Euler Angle (Intrinsic; Mobile)", 4)) {
             for (int32_t i = 0; i < static_cast<int32_t>(sizeof(EULER_ORDER_STR) / sizeof(char*)); i++) {
                 ImGui::TableNextRow();
                 ImGui::TableSetColumnIndex(0); ImGui::Text("%s", EULER_ORDER_STR[i]);
@@ -244,8 +244,8 @@ void Ui::Update(Window& window, AngleUnit& angle_unit, InputContainer& input_con
         }
         ImGui::Separator();
 
-        ImGui::Text("Extrinsic (Fixed) Euler Angle");
-        if (ImGui::BeginTable("Extrinsic (Fixed) Euler Angle", 4)) {
+        ImGui::Text("Euler Angle (Extrinsic; Fixed)");
+        if (ImGui::BeginTable("Euler Angle (Extrinsic; Fixed)", 4)) {
             for (int32_t i = 0; i < static_cast<int32_t>(sizeof(EULER_ORDER_STR) / sizeof(char*)); i++) {
                 ImGui::TableNextRow();
                 ImGui::TableSetColumnIndex(0); ImGui::Text("%s", EULER_ORDER_STR[i]);