add icon font

Author: nmwsharp

deps/CMakeLists.txt

@@ -41,3 +41,8 @@ endif()
 if(NOT TARGET stb)
   add_subdirectory(stb)
 endif()
+
+## IconFontCppHeaders
+if(NOT TARGET IconFontCppHeaders)
+  add_subdirectory(IconFontCppHeaders)
+endif()

deps/IconFontCppHeaders/CMakeLists.txt

@@ -0,0 +1,3 @@
+add_library(IconFontCppHeaders INTERFACE)
+
+target_include_directories(IconFontCppHeaders INTERFACE "include")

deps/IconFontCppHeaders/README.md

@@ -0,0 +1,17 @@
+Copyright (c) 2017 Juliette Foucaut and Doug Binks
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.

deps/IconFontCppHeaders/include/IconFontCppHeaders/IconsLucide.h

@@ -250,6 +250,7 @@ SET(SRCS
   ## Embedded binary data
   render/bindata/bindata_font_lato_regular.cpp
   render/bindata/bindata_font_cousine_regular.cpp
+  render/bindata/bindata_font_lucide_icons.cpp
   render/bindata/concrete_seamless.cpp
   render/bindata/bindata_clay.cpp
   render/bindata/bindata_wax.cpp
@@ -382,3 +383,6 @@ target_include_directories(polyscope PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/../incl
 # Link settings
 target_link_libraries(polyscope PUBLIC imgui glm::glm)
 target_link_libraries(polyscope PRIVATE "${BACKEND_LIBS}" stb nlohmann_json::nlohmann_json MarchingCube::MarchingCube)
+
+# For now, make this private, until we are sure we want to commit to it. We may expose it as public in the future.
+target_link_libraries(polyscope PRIVATE IconFontCppHeaders) 

deps/IconFontCppHeaders/licence.txt

@@ -12,6 +12,8 @@ unsigned int getCousineRegularCompressedSize();
 const unsigned int* getCousineRegularCompressedData();
 unsigned int getLatoRegularCompressedSize();
 const unsigned int* getLatoRegularCompressedData();
+unsigned int getLucideIconsCompressedSize();
+const unsigned char* getLucideIconsCompressedData();
 } // namespace render
 
 void configureImGuiStyle() {
@@ -84,16 +86,32 @@ std::tuple<ImFont*, ImFont*> loadBaseFonts(ImFontAtlas* fontAtlas) {
 
   float fontSize = 18.0;
 
-  { // add regular font
-    regularFont = fontAtlas->AddFontFromMemoryCompressedTTF(render::getLatoRegularCompressedData(),
-                                                            render::getLatoRegularCompressedSize(), fontSize);
-  }
+  // add regular font
+  regularFont = fontAtlas->AddFontFromMemoryCompressedTTF(render::getLatoRegularCompressedData(),
+                                                          render::getLatoRegularCompressedSize(), fontSize);
+
+  // append icons to regular font
+  {
+    ImFontConfig config;
+    config.MergeMode = true;
+    config.GlyphMinAdvanceX = fontSize; // make the icon monospaced
+
+    // this uses a tip from a helpful github issue to get teh alignment mostly right
+    // https://github.com/ocornut/imgui/issues/4127#issuecomment-2814162680
 
-  { // add mono font
-    monoFont = fontAtlas->AddFontFromMemoryCompressedTTF(render::getCousineRegularCompressedData(),
-                                                         render::getCousineRegularCompressedSize(), fontSize);
+    // Align vertically; the coefficients are specific to the particular icon font we're using.
+    float font_size_pixels = fontSize; // Or whatever you'd like.
+    float icon_scaling = 1.0f;         // Or whatever you'd like.
+    config.GlyphOffset = {0.0f, font_size_pixels * (0.5f * icon_scaling - 0.3f)};
+
+    fontAtlas->AddFontFromMemoryCompressedTTF(render::getLucideIconsCompressedData(),
+                                              render::getLucideIconsCompressedSize(), fontSize, &config);
   }
 
+  // add mono font
+  monoFont = fontAtlas->AddFontFromMemoryCompressedTTF(render::getCousineRegularCompressedData(),
+                                                       render::getCousineRegularCompressedSize(), fontSize);
+
   return std::tuple<ImFont*, ImFont*>(regularFont, monoFont);
 }
 

src/CMakeLists.txt

@@ -23,6 +23,8 @@
 #include "nlohmann/json.hpp"
 using json = nlohmann::json;
 
+#include "IconFontCppHeaders/IconsLucide.h"
+
 namespace polyscope {
 
 // Note: Storage for global members lives in state.cpp and options.cpp
@@ -712,9 +714,9 @@ void buildPolyscopeGui() {
   ImGui::SetNextWindowPos(ImVec2(internal::imguiStackMargin, internal::imguiStackMargin));
   ImGui::SetNextWindowSize(ImVec2(internal::leftWindowsWidth, 0.));
 
-  ImGui::Begin("Polyscope", nullptr);
+  ImGui::Begin("Polyscope ", nullptr);
 
-  if (ImGui::Button("Reset View")) {
+  if (ImGui::Button(ICON_LC_HOUSE " Reset View")) {
     view::flyToHomeView();
   }
   ImGui::SameLine();
@@ -746,7 +748,7 @@ void buildPolyscopeGui() {
 
 
   ImGui::SameLine();
-  if (ImGui::Button("Controls")) {
+  if (ImGui::Button(ICON_LC_CIRCLE_QUESTION_MARK)) {
     // do nothing, just want hover state
   }
   if (ImGui::IsItemHovered()) {