Viewer.h 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. // This file is part of libigl, a simple c++ geometry processing library.
  2. //
  3. // Copyright (C) 2014 Daniele Panozzo <daniele.panozzo@gmail.com>
  4. //
  5. // This Source Code Form is subject to the terms of the Mozilla Public License
  6. // v. 2.0. If a copy of the MPL was not distributed with this file, You can
  7. // obtain one at http://mozilla.org/MPL/2.0/.
  8. #ifndef IGL_OPENGL_GLFW_VIEWER_H
  9. #define IGL_OPENGL_GLFW_VIEWER_H
  10. #ifndef IGL_OPENGL_4
  11. #define IGL_OPENGL_4
  12. #endif
  13. #include "../../igl_inline.h"
  14. #include "../MeshGL.h"
  15. #include "../ViewerCore.h"
  16. #include "../ViewerData.h"
  17. #include "ViewerPlugin.h"
  18. #include <Eigen/Core>
  19. #include <Eigen/Geometry>
  20. #include <vector>
  21. #include <string>
  22. #include <cstdint>
  23. #define IGL_MOD_SHIFT 0x0001
  24. #define IGL_MOD_CONTROL 0x0002
  25. #define IGL_MOD_ALT 0x0004
  26. #define IGL_MOD_SUPER 0x0008
  27. struct GLFWwindow;
  28. namespace igl
  29. {
  30. namespace opengl
  31. {
  32. namespace glfw
  33. {
  34. // GLFW-based mesh viewer
  35. class Viewer
  36. {
  37. public:
  38. // UI Enumerations
  39. enum class MouseButton {Left, Middle, Right};
  40. enum class MouseMode { None, Rotation, Zoom, Pan, Translation} mouse_mode;
  41. IGL_INLINE int launch(bool resizable = true, bool fullscreen = false, const std::string &name = "libigl viewer", int width = 0, int height = 0);
  42. IGL_INLINE int launch_init(bool resizable = true, bool fullscreen = false, const std::string &name = "libigl viewer", int width = 0, int height = 0);
  43. IGL_INLINE bool launch_rendering(bool loop = true);
  44. IGL_INLINE void launch_shut();
  45. IGL_INLINE void init();
  46. IGL_INLINE void init_plugins();
  47. IGL_INLINE void shutdown_plugins();
  48. Viewer();
  49. ~Viewer();
  50. // Mesh IO
  51. IGL_INLINE bool load_mesh_from_file(const std::string & mesh_file_name);
  52. IGL_INLINE bool save_mesh_to_file(const std::string & mesh_file_name);
  53. // Callbacks
  54. IGL_INLINE bool key_pressed(unsigned int unicode_key,int modifier);
  55. IGL_INLINE bool key_down(int key,int modifier);
  56. IGL_INLINE bool key_up(int key,int modifier);
  57. IGL_INLINE bool mouse_down(MouseButton button,int modifier);
  58. IGL_INLINE bool mouse_up(MouseButton button,int modifier);
  59. IGL_INLINE bool mouse_move(int mouse_x,int mouse_y);
  60. IGL_INLINE bool mouse_scroll(float delta_y);
  61. // Scene IO
  62. IGL_INLINE bool load_scene();
  63. IGL_INLINE bool load_scene(std::string fname);
  64. IGL_INLINE bool save_scene();
  65. IGL_INLINE bool save_scene(std::string fname);
  66. // Draw everything
  67. IGL_INLINE void draw();
  68. // OpenGL context resize
  69. IGL_INLINE void resize(int w,int h); // explicitly set window size
  70. IGL_INLINE void post_resize(int w,int h); // external resize due to user interaction
  71. // Helper functions
  72. IGL_INLINE void snap_to_canonical_quaternion();
  73. IGL_INLINE void open_dialog_load_mesh();
  74. IGL_INLINE void open_dialog_save_mesh();
  75. ////////////////////////
  76. // Multi-mesh methods //
  77. ////////////////////////
  78. // Return the current mesh, or the mesh corresponding to a given unique identifier
  79. //
  80. // Inputs:
  81. // mesh_id unique identifier associated to the desired mesh (current mesh if -1)
  82. IGL_INLINE ViewerData& data(int mesh_id = -1);
  83. IGL_INLINE const ViewerData& data(int mesh_id = -1) const;
  84. // Append a new "slot" for a mesh (i.e., create empty entries at the end of
  85. // the data_list and opengl_state_list.
  86. //
  87. // Inputs:
  88. // visible If true, the new mesh is set to be visible on all existing viewports
  89. // Returns the id of the last appended mesh
  90. //
  91. // Side Effects:
  92. // selected_data_index is set this newly created, last entry (i.e.,
  93. // #meshes-1)
  94. IGL_INLINE int append_mesh(bool visible = true);
  95. // Erase a mesh (i.e., its corresponding data and state entires in data_list
  96. // and opengl_state_list)
  97. //
  98. // Inputs:
  99. // index index of mesh to erase
  100. // Returns whether erasure was successful <=> cannot erase last mesh
  101. //
  102. // Side Effects:
  103. // If selected_data_index is greater than or equal to index then it is
  104. // decremented
  105. // Example:
  106. // // Erase all mesh slots except first and clear remaining mesh
  107. // viewer.selected_data_index = viewer.data_list.size()-1;
  108. // while(viewer.erase_mesh(viewer.selected_data_index)){};
  109. // viewer.data().clear();
  110. //
  111. IGL_INLINE bool erase_mesh(const size_t index);
  112. // Retrieve mesh index from its unique identifier
  113. // Returns 0 if not found
  114. IGL_INLINE size_t mesh_index(const int id) const;
  115. ////////////////////////////
  116. // Multi-viewport methods //
  117. ////////////////////////////
  118. // Return the current viewport, or the viewport corresponding to a given unique identifier
  119. //
  120. // Inputs:
  121. // core_id unique identifier corresponding to the desired viewport (current viewport if 0)
  122. IGL_INLINE ViewerCore& core(unsigned core_id = 0);
  123. IGL_INLINE const ViewerCore& core(unsigned core_id = 0) const;
  124. // Append a new "slot" for a viewport (i.e., copy properties of the current viewport, only
  125. // changing the viewport size/position)
  126. //
  127. // Inputs:
  128. // viewport Vector specifying the viewport origin and size in screen coordinates.
  129. // append_empty If true, existing meshes are hidden on the new viewport.
  130. //
  131. // Returns the unique id of the newly inserted viewport. There can be a maximum of 31
  132. // viewports created in the same viewport. Erasing a viewport does not change the id of
  133. // other existing viewports
  134. IGL_INLINE int append_core(Eigen::Vector4f viewport, bool append_empty = false);
  135. // Erase a viewport
  136. //
  137. // Inputs:
  138. // index index of the viewport to erase
  139. IGL_INLINE bool erase_core(const size_t index);
  140. // Retrieve viewport index from its unique identifier
  141. // Returns 0 if not found
  142. IGL_INLINE size_t core_index(const int id) const;
  143. // Change selected_core_index to the viewport containing the mouse
  144. // (current_mouse_x, current_mouse_y)
  145. IGL_INLINE void select_hovered_core();
  146. public:
  147. //////////////////////
  148. // Member variables //
  149. //////////////////////
  150. // Alec: I call this data_list instead of just data to avoid confusion with
  151. // old "data" variable.
  152. // Stores all the data that should be visualized
  153. std::vector<ViewerData> data_list;
  154. size_t selected_data_index;
  155. int next_data_id;
  156. GLFWwindow* window;
  157. // Stores all the viewing options
  158. std::vector<ViewerCore> core_list;
  159. size_t selected_core_index;
  160. int next_core_id;
  161. // List of registered plugins
  162. std::vector<ViewerPlugin*> plugins;
  163. // Temporary data stored when the mouse button is pressed
  164. Eigen::Quaternionf down_rotation;
  165. int current_mouse_x;
  166. int current_mouse_y;
  167. int down_mouse_x;
  168. int down_mouse_y;
  169. float down_mouse_z;
  170. Eigen::Vector3f down_translation;
  171. bool down;
  172. bool hack_never_moved;
  173. // Keep track of the global position of the scrollwheel
  174. float scroll_position;
  175. // C++-style functions
  176. //
  177. // Returns **true** if action should be cancelled.
  178. std::function<bool(Viewer& viewer)> callback_init;
  179. std::function<bool(Viewer& viewer)> callback_pre_draw;
  180. std::function<bool(Viewer& viewer)> callback_post_draw;
  181. std::function<bool(Viewer& viewer, int button, int modifier)> callback_mouse_down;
  182. std::function<bool(Viewer& viewer, int button, int modifier)> callback_mouse_up;
  183. std::function<bool(Viewer& viewer, int mouse_x, int mouse_y)> callback_mouse_move;
  184. std::function<bool(Viewer& viewer, float delta_y)> callback_mouse_scroll;
  185. std::function<bool(Viewer& viewer, unsigned int key, int modifiers)> callback_key_pressed;
  186. std::function<bool(Viewer& viewer, int w, int h)> callback_post_resize;
  187. // THESE SHOULD BE DEPRECATED:
  188. std::function<bool(Viewer& viewer, unsigned int key, int modifiers)> callback_key_down;
  189. std::function<bool(Viewer& viewer, unsigned int key, int modifiers)> callback_key_up;
  190. // Pointers to per-callback data
  191. void* callback_init_data;
  192. void* callback_pre_draw_data;
  193. void* callback_post_draw_data;
  194. void* callback_mouse_down_data;
  195. void* callback_mouse_up_data;
  196. void* callback_mouse_move_data;
  197. void* callback_mouse_scroll_data;
  198. void* callback_key_pressed_data;
  199. void* callback_key_down_data;
  200. void* callback_key_up_data;
  201. public:
  202. EIGEN_MAKE_ALIGNED_OPERATOR_NEW
  203. };
  204. } // end namespace
  205. } // end namespace
  206. } // end namespace
  207. #ifndef IGL_STATIC_LIBRARY
  208. # include "Viewer.cpp"
  209. #endif
  210. #endif