Merge pull request #44 from iwatake2222/feature-#42-update_document_2

Fix terms in code and document. Issue #42

Author: iwatake2222

README.md

@@ -1,13 +1,13 @@
-![image](https://user-images.githubusercontent.com/11009876/148989308-2d9c70b0-d25e-4124-b109-2fcb03c8ebb9.png)
+![image](https://user-images.githubusercontent.com/11009876/148997642-8a54899a-8547-44a8-a211-b7d8f4b9b063.png)
 
 # Rotation Master
-- Provide conversion between the following representations of 3D rotation (rigid body orientation) and display the pose
+- Provide conversion between the following representations of 3D rotation and display a rigid body orientation
     - Rotation Matrix
     - Rotation Vector
     - Axis-angle
     - Quaternion
-    - Euler Angle (Intrinsic; Mobile)
-    - Euler Angle (Extrinsic; Fixed)
+    - Euler Angles (Intrinsic; Mobile)
+    - Euler Angles (Extrinsic; Fixed)
 
 https://user-images.githubusercontent.com/11009876/148988739-5f775a11-c923-4557-aff7-12b9a4811d36.mp4
 

desktop/container.h

@@ -135,7 +135,7 @@ class SettingContainer {
         is_dark_mode = true;
         is_draw_ground = true;
         is_view_from_axis = true;
-        is_go_around = true;
+        is_camera_revolution = true;
         is_normalize_rotation_matrix = true;
         is_update_input_pressed = false;
         is_reset_view_pressed = false;
@@ -147,7 +147,7 @@ class SettingContainer {
     bool is_dark_mode;
     bool is_draw_ground;
     bool is_view_from_axis;
-    bool is_go_around;
+    bool is_camera_revolution;
     bool is_normalize_rotation_matrix;
     bool is_update_input_pressed;
     bool is_reset_view_pressed;

desktop/gl_helper/window.cpp

@@ -98,9 +98,9 @@ void Window::SetIsDarkMode(bool is_darkmode)
     m_is_darkmode = is_darkmode;
 }
 
-void Window::SetIsGoAround(bool is_go_around)
+void Window::SetIsCameraRevolution(bool is_camera_revolution)
 {
-    m_is_go_around = is_go_around;
+    m_is_camera_revolution = is_camera_revolution;
 }
 
 Matrix Window::GetViewProjectionFromAxisX(float cx, float cy, float fovy, float z_near, float z_far)
@@ -245,7 +245,7 @@ bool Window::FrameStart()
     m_last_mouse_y = mouse_y;
 
     if (glfwGetMouseButton(m_window, GLFW_MOUSE_BUTTON_2) != GLFW_RELEASE) {
-        if (!m_is_go_around) {
+        if (!m_is_camera_revolution) {
             m_camera_angle[1] += mouse_move_x * MOUSE_ROT_SPEED;
             m_camera_angle[0] += mouse_move_y * MOUSE_ROT_SPEED;
         } else{
@@ -265,7 +265,7 @@ bool Window::FrameStart()
             LookAt({ m_camera_pos[0], m_camera_pos[1], m_camera_pos[2] }, { 0.0f, 0.0f, 0.0f }, { 0.0f, 1.0f, 0.0f });
         }
     }
-    if (!m_is_go_around && glfwGetMouseButton(m_window, GLFW_MOUSE_BUTTON_3) != GLFW_RELEASE) {
+    if (!m_is_camera_revolution && glfwGetMouseButton(m_window, GLFW_MOUSE_BUTTON_3) != GLFW_RELEASE) {
         //m_camera_pos[0] -= mouse_move_x * MOUSE_MOV_SPEED;
         //m_camera_pos[1] -= -mouse_move_y * MOUSE_MOV_SPEED;
         float dx_in_camera_cord = -mouse_move_x * MOUSE_MOV_SPEED;

desktop/gl_helper/window.h

@@ -47,7 +47,7 @@ class Window
 
     GLFWwindow* GetWindow();
     void SetIsDarkMode(bool);
-    void SetIsGoAround(bool);
+    void SetIsCameraRevolution(bool);
     int32_t GetWidth();
     int32_t GetHeight();
 
@@ -66,7 +66,7 @@ class Window
     double m_last_mouse_y;
 
     bool m_is_darkmode;
-    bool m_is_go_around;
+    bool m_is_camera_revolution;
 };
 
 

desktop/main.cpp

@@ -192,7 +192,7 @@ int main(int argc, char *argv[])
         }
 
         my_window.SetIsDarkMode(setting_container.is_dark_mode);
-        my_window.SetIsGoAround(setting_container.is_go_around);
+        my_window.SetIsCameraRevolution(setting_container.is_camera_revolution);
 
         /* Update display */
         my_window.SwapBuffers();

desktop/ui.cpp

@@ -147,8 +147,8 @@ void Ui::Update(Window& window, AngleUnit& angle_unit, InputContainer& input_con
         }
         ImGui::Separator();
 
-        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)) {
+        ImGui::RadioButton("Euler Angles (Intrinsic; Mobile)", &input_container.selected_representation_type, static_cast<int32_t>(REPRESENTATION_TYPE::EULER_MOBILE));
+        if (ImGui::BeginTable("Euler Angles (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("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)) {
+        ImGui::RadioButton("Euler Angles (Extrinsic; Fixed)", &input_container.selected_representation_type, static_cast<int32_t>(REPRESENTATION_TYPE::EULER_FIXED));
+        if (ImGui::BeginTable("Euler Angles (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("Euler Angle (Intrinsic; Mobile)");
-        if (ImGui::BeginTable("Euler Angle (Intrinsic; Mobile)", 4)) {
+        ImGui::Text("Euler Angles (Intrinsic; Mobile)");
+        if (ImGui::BeginTable("Euler Angles (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("Euler Angle (Extrinsic; Fixed)");
-        if (ImGui::BeginTable("Euler Angle (Extrinsic; Fixed)", 4)) {
+        ImGui::Text("Euler Angles (Extrinsic; Fixed)");
+        if (ImGui::BeginTable("Euler Angles (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]);
@@ -292,11 +292,11 @@ void Ui::Update(Window& window, AngleUnit& angle_unit, InputContainer& input_con
         ImGui::RadioButton("Degrees", &radio_degree, 1);
         angle_unit.is_degree = (radio_degree == 1);
 
-        int32_t go_around = setting_container.is_go_around ? 1 : 0;
-        ImGui::Text("Move:"); ImGui::SameLine();
-        ImGui::RadioButton("GoAround", &go_around, 1); ImGui::SameLine();
-        ImGui::RadioButton("Free", &go_around, 0);
-        setting_container.is_go_around = (go_around == 1);
+        int32_t is_revolution = setting_container.is_camera_revolution ? 1 : 0;
+        ImGui::Text("Camera:"); ImGui::SameLine();
+        ImGui::RadioButton("Revolution", &is_revolution, 1); ImGui::SameLine();
+        ImGui::RadioButton("Free", &is_revolution, 0);
+        setting_container.is_camera_revolution = (is_revolution == 1);
 
         int32_t is_normalize_rotation_matrix = setting_container.is_normalize_rotation_matrix ? 1 : 0;
         ImGui::Text("Normalize Rotation Matrix:"); ImGui::SameLine();