Move User Interface module out of Graphics namespace and split it to Typography and Widgets

egorodet · egorodet · commit 4ec1451b7a6a · 2020-06-28T23:55:01.000+03:00
diff --git a/Apps/Samples/Asteroids/AsteroidsApp.h b/Apps/Samples/Asteroids/AsteroidsApp.h
@@ -26,7 +26,7 @@ Sample demonstrating parallel rendering of the distinct asteroids massive
 #include "Planet.h"
 #include "AsteroidsArray.h"
 
-#include <Methane/Graphics/Kit.h>
+#include <Methane/Kit.h>
 
 namespace Methane::Samples
 {
diff --git a/Apps/Tutorials/01-HelloTriangle/HelloTriangleApp.h b/Apps/Tutorials/01-HelloTriangle/HelloTriangleApp.h
@@ -23,7 +23,7 @@ Tutorial demonstrating triangle rendering with Methane graphics API
 
 #pragma once
 
-#include <Methane/Graphics/Kit.h>
+#include <Methane/Kit.h>
 
 #include <string>
 #include <array>
diff --git a/Apps/Tutorials/01-HelloTriangle/HelloTriangleAppSimple.cpp b/Apps/Tutorials/01-HelloTriangle/HelloTriangleAppSimple.cpp
@@ -21,7 +21,7 @@ Simplified tutorial demonstrating triangle rendering with Methane graphics API
 
 ******************************************************************************/
 
-#include <Methane/Graphics/Kit.h>
+#include <Methane/Kit.h>
 
 using namespace Methane;
 using namespace Methane::Graphics;
diff --git a/Apps/Tutorials/02-TexturedCube/TexturedCubeApp.h b/Apps/Tutorials/02-TexturedCube/TexturedCubeApp.h
@@ -23,7 +23,7 @@ Tutorial demonstrating textured cube rendering with Methane graphics API
 
 #pragma once
 
-#include <Methane/Graphics/Kit.h>
+#include <Methane/Kit.h>
 
 #include <string>
 #include <vector>
diff --git a/Apps/Tutorials/03-ShadowCube/ShadowCubeApp.h b/Apps/Tutorials/03-ShadowCube/ShadowCubeApp.h
@@ -23,7 +23,7 @@ Tutorial demonstrating shadow-pass rendering with Methane graphics API
 
 #pragma once
 
-#include <Methane/Graphics/Kit.h>
+#include <Methane/Kit.h>
 
 namespace Methane::Tutorials
 {
diff --git a/Apps/Tutorials/04-TextRender/TextRenderApp.h b/Apps/Tutorials/04-TextRender/TextRenderApp.h
@@ -23,7 +23,7 @@ Tutorial demonstrating triangle rendering with Methane graphics API
 
 #pragma once
 
-#include <Methane/Graphics/Kit.h>
+#include <Methane/Kit.h>
 #include <Methane/Data/Receiver.hpp>
 
 #include <map>
diff --git a/CMake/MethaneApplications.cmake b/CMake/MethaneApplications.cmake
@@ -123,7 +123,7 @@ function(add_methane_application TARGET SOURCES RESOURCES_DIR INSTALL_DIR APP_NA
 
     target_link_libraries(${TARGET}
         PRIVATE
-            MethaneGraphicsKit
+            MethaneKit
             MethaneBuildOptions
             MethaneInstrumentation
             $<$<BOOL:${METHANE_TRACY_PROFILING_ENABLED}>:TracyClient>
@@ -134,7 +134,7 @@ function(add_methane_application TARGET SOURCES RESOURCES_DIR INSTALL_DIR APP_NA
             .
     )
 
-    get_target_property(METHANE_PREREQUISITE_MODULES MethaneGraphicsKit PREREQUISITE_MODULES)
+    get_target_property(METHANE_PREREQUISITE_MODULES MethaneKit PREREQUISITE_MODULES)
     add_prerequisite_binaries(${TARGET} "${METHANE_PREREQUISITE_MODULES}" ${INSTALL_DIR})
 
 endfunction()
diff --git a/Modules/CMakeLists.txt b/Modules/CMakeLists.txt
@@ -2,3 +2,5 @@ add_subdirectory(Common)
 add_subdirectory(Data)
 add_subdirectory(Platform)
 add_subdirectory(Graphics)
+add_subdirectory(UserInterface)
+add_subdirectory(Kit)
diff --git a/Modules/Graphics/App/CMakeLists.txt b/Modules/Graphics/App/CMakeLists.txt
@@ -35,9 +35,9 @@ PUBLIC
     MethanePlatformUtils
     MethanePlatformInput
     MethaneGraphicsCore
-    MethaneGraphicsUserInterface
     MethaneGraphicsPrimitives
     MethaneGraphicsCamera
+    MethaneUserInterfaceWidgets
     MethaneInstrumentation
 PRIVATE
     MethaneBuildOptions
diff --git a/Modules/Graphics/App/Include/Methane/Graphics/App.hpp b/Modules/Graphics/App/Include/Methane/Graphics/App.hpp
@@ -30,7 +30,6 @@ Base frame class provides frame buffer management with resize handling.
 #include "AppContextController.h"
 
 #include <Methane/Data/AppResourceProviders.h>
-#include <Methane/Timer.hpp>
 #include <Methane/Data/AnimationsPool.h>
 #include <Methane/Data/Receiver.hpp>
 #include <Methane/Platform/App.h>
@@ -41,8 +40,9 @@ Base frame class provides frame buffer management with resize handling.
 #include <Methane/Graphics/RenderCommandList.h>
 #include <Methane/Graphics/FpsCounter.h>
 #include <Methane/Graphics/ImageLoader.h>
-#include <Methane/Graphics/Badge.h>
-#include <Methane/Graphics/HeadsUpDisplay.h>
+#include <Methane/UserInterface/Badge.h>
+#include <Methane/UserInterface/HeadsUpDisplay.h>
+#include <Methane/Timer.hpp>
 #include <Methane/Instrumentation.h>
 
 #include <vector>
diff --git a/Modules/Graphics/CMakeLists.txt b/Modules/Graphics/CMakeLists.txt
@@ -1,8 +1,6 @@
 add_subdirectory(App)
 add_subdirectory(Core)
 add_subdirectory(Extensions)
-add_subdirectory(UserInterface)
 add_subdirectory(Primitives)
 add_subdirectory(Camera)
 add_subdirectory(Types)
-add_subdirectory(Kit)
diff --git a/Modules/Kit/CMakeLists.txt b/Modules/Kit/CMakeLists.txt
@@ -1,6 +1,6 @@
-set(TARGET MethaneGraphicsKit)
+set(TARGET MethaneKit)
 
-get_module_dirs("Methane/Graphics")
+get_module_dirs("Methane")
 
 set(SOURCES
     ${SOURCES_DIR}/Kit.cpp
@@ -27,24 +27,26 @@ target_link_libraries(${TARGET}
         MethaneGraphicsApp
         MethaneGraphicsCore
         MethaneGraphicsExtensions
-        MethaneGraphicsUserInterface
         MethaneGraphicsPrimitives
         MethaneGraphicsCamera
         MethaneGraphicsTypes
+        MethaneUserInterfaceTypography
+        MethaneUserInterfaceWidgets
 )
 
 set(PREREQUISITE_TARGETS
     MethaneGraphicsCore
     MethaneGraphicsExtensions
-    MethaneGraphicsUserInterface
+    MethaneUserInterfaceTypography
+    MethaneUserInterfaceWidgets
 )
 add_prerequisite_modules(${TARGET} "${PREREQUISITE_TARGETS}")
 
 source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} FILES ${HEADERS} ${SOURCES})
 
 set_target_properties(${TARGET}
     PROPERTIES
-    FOLDER Modules/Graphics
+    FOLDER Modules
     PUBLIC_HEADER "${HEADERS}"
 )
 
diff --git a/Modules/Kit/Include/Methane/Kit.h b/Modules/Kit/Include/Methane/Kit.h
@@ -23,25 +23,16 @@ Methane kit interfaces: all headers under one umbrella.
 
 #pragma once
 
-// ========= Root Methane Headers =========
+// Methane Graphics Headers
 
-// Graphics application class
 #include <Methane/Graphics/App.hpp>
-
-// Graphics types
 #include <Methane/Graphics/Types.h>
-
-// Graphics core API classes
 #include <Methane/Graphics/Core.h>
-
-// Graphics extension classes
 #include <Methane/Graphics/Extensions.h>
-
-// Graphics user interface classes
-#include <Methane/Graphics/UserInterface.h>
-
-// Graphics camera classes
 #include <Methane/Graphics/Camera.h>
-
-// Graphics primitives classes
 #include <Methane/Graphics/Primitives.h>
+
+// Methane User Interface Headers
+
+#include <Methane/UserInterface/Typography.h>
+#include <Methane/UserInterface/Widgets.h>
diff --git a/Modules/Kit/Sources/Methane/Kit.cpp b/Modules/Kit/Sources/Methane/Kit.cpp
diff --git a/Modules/UserInterface/CMakeLists.txt b/Modules/UserInterface/CMakeLists.txt
@@ -0,0 +1,2 @@
+add_subdirectory(Typography)
+add_subdirectory(Widgets)
diff --git a/Modules/UserInterface/Typography/CMakeLists.txt b/Modules/UserInterface/Typography/CMakeLists.txt
@@ -0,0 +1,63 @@
+set(TARGET MethaneUserInterfaceTypography)
+
+include(MethaneShaders)
+get_module_dirs("Methane/UserInterface")
+
+set(HEADERS
+    ${INCLUDE_DIR}/Typography.h
+    ${INCLUDE_DIR}/Font.h
+    ${INCLUDE_DIR}/Text.h
+)
+
+set(SOURCES
+    ${SOURCES_DIR}/Font.cpp
+    ${SOURCES_DIR}/Text.cpp
+)
+
+set(HLSL_SOURCES
+    ${CMAKE_CURRENT_SOURCE_DIR}/Shaders/Text.hlsl
+)
+
+add_library(${TARGET} STATIC
+    ${HEADERS}
+    ${SOURCES}
+)
+
+add_methane_shaders(${TARGET} "${HLSL_SOURCES}" "6_0")
+
+target_link_libraries(${TARGET}
+    PUBLIC
+        MethaneGraphicsCore
+        MethaneDataProvider
+        MethaneDataEvents
+    PRIVATE
+        MethaneBuildOptions
+        MethaneInstrumentation
+        MethaneDataPrimitives
+        freetype
+)
+
+target_include_directories(${TARGET}
+    PRIVATE
+        Sources
+    PUBLIC
+        Include
+)
+
+source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} FILES ${HEADERS} ${SOURCES})
+
+set_target_properties(${TARGET}
+    PROPERTIES
+    FOLDER Modules/UserInterface
+    PUBLIC_HEADER "${HEADERS}"
+)
+
+install(TARGETS ${TARGET}
+    PUBLIC_HEADER
+        DESTINATION ${INCLUDE_DIR}
+        COMPONENT Development
+    ARCHIVE
+        DESTINATION Lib
+        COMPONENT Development
+)
+
diff --git a/Modules/UserInterface/Typography/Include/Methane/UserInterface/Font.h b/Modules/UserInterface/Typography/Include/Methane/UserInterface/Font.h
@@ -16,7 +16,7 @@ limitations under the License.
 
 *******************************************************************************
 
-FILE: Methane/Graphics/Font.h
+FILE: Methane/UserInterface/Font.h
 Font atlas textures generation and fonts library management classes.
 
 ******************************************************************************/
diff --git a/Modules/UserInterface/Typography/Include/Methane/UserInterface/Text.h b/Modules/UserInterface/Typography/Include/Methane/UserInterface/Text.h
@@ -16,15 +16,15 @@ limitations under the License.
 
 *******************************************************************************
 
-FILE: Methane/Graphics/Text.h
-Text rendering primitive.
+FILE: Methane/UserInterface/Text.h
+Methane text rendering primitive.
 
 ******************************************************************************/
 
 #pragma once
 
+#include <Methane/UserInterface/Font.h>
 #include <Methane/Graphics/RenderContext.h>
-#include <Methane/Graphics/Font.h>
 #include <Methane/Graphics/Texture.h>
 #include <Methane/Graphics/Buffer.h>
 #include <Methane/Graphics/RenderState.h>
diff --git a/Modules/UserInterface/Typography/Include/Methane/UserInterface/Typography.h b/Modules/UserInterface/Typography/Include/Methane/UserInterface/Typography.h
@@ -0,0 +1,27 @@
+/******************************************************************************
+
+Copyright 2020 Evgeny Gorodetskiy
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+*******************************************************************************
+
+FILE: Methane/UserInterface/Typography.h
+Methane user interface typography headers.
+
+******************************************************************************/
+
+#pragma once
+
+#include "Font.h"
+#include "Text.h"
diff --git a/Modules/UserInterface/Typography/Shaders/Text.cfg b/Modules/UserInterface/Typography/Shaders/Text.cfg
diff --git a/Modules/UserInterface/Typography/Shaders/Text.hlsl b/Modules/UserInterface/Typography/Shaders/Text.hlsl
diff --git a/Modules/UserInterface/Typography/Sources/Methane/UserInterface/Font.cpp b/Modules/UserInterface/Typography/Sources/Methane/UserInterface/Font.cpp
@@ -16,14 +16,14 @@ limitations under the License.
 
 *******************************************************************************
 
-FILE: Methane/Graphics/Font.cpp
+FILE: Methane/UserInterface/Font.cpp
 Font atlas textures generation and fonts library management classes.
 
 ******************************************************************************/
 
 #define _SILENCE_CXX17_CODECVT_HEADER_DEPRECATION_WARNING
 
-#include <Methane/Graphics/Font.h>
+#include <Methane/UserInterface/Font.h>
 
 #include <Methane/Data/RectBinPack.hpp>
 #include <Methane/Instrumentation.h>
diff --git a/Modules/UserInterface/Typography/Sources/Methane/UserInterface/Text.cpp b/Modules/UserInterface/Typography/Sources/Methane/UserInterface/Text.cpp
@@ -16,13 +16,13 @@ limitations under the License.
 
 *******************************************************************************
 
-FILE: Methane/Graphics/Text.cpp
-Text rendering primitive.
+FILE: Methane/UserInterface/Text.h
+Methane text rendering primitive.
 
 ******************************************************************************/
 
-#include <Methane/Graphics/Text.h>
-#include <Methane/Graphics/Font.h>
+#include <Methane/UserInterface/Text.h>
+#include <Methane/UserInterface/Font.h>
 
 #include <Methane/Graphics/RenderCommandList.h>
 #include <Methane/Data/AppResourceProviders.h>
diff --git a/Modules/UserInterface/Widgets/CMakeLists.txt b/Modules/UserInterface/Widgets/CMakeLists.txt
diff --git a/Modules/UserInterface/Widgets/Include/Methane/UserInterface/Badge.h b/Modules/UserInterface/Widgets/Include/Methane/UserInterface/Badge.h
diff --git a/Modules/UserInterface/Widgets/Include/Methane/UserInterface/HeadsUpDisplay.h b/Modules/UserInterface/Widgets/Include/Methane/UserInterface/HeadsUpDisplay.h
diff --git a/Modules/UserInterface/Widgets/Include/Methane/UserInterface/Widgets.h b/Modules/UserInterface/Widgets/Include/Methane/UserInterface/Widgets.h
diff --git a/Modules/UserInterface/Widgets/Sources/Methane/UserInterface/Badge.cpp b/Modules/UserInterface/Widgets/Sources/Methane/UserInterface/Badge.cpp
diff --git a/Modules/UserInterface/Widgets/Sources/Methane/UserInterface/HeadsUpDisplay.cpp b/Modules/UserInterface/Widgets/Sources/Methane/UserInterface/HeadsUpDisplay.cpp
diff --git a/README.md b/README.md

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ Sample demonstrating parallel rendering of the distinct asteroids massive`
`26`	`26`	`#include "Planet.h"`
`27`	`27`	`#include "AsteroidsArray.h"`
`28`	`28`
`29`		`-#include <Methane/Graphics/Kit.h>`
	`29`	`+#include <Methane/Kit.h>`
`30`	`30`
`31`	`31`	`namespace Methane::Samples`
`32`	`32`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ Tutorial demonstrating shadow-pass rendering with Methane graphics API`
`23`	`23`
`24`	`24`	`#pragma once`
`25`	`25`
`26`		`-#include <Methane/Graphics/Kit.h>`
	`26`	`+#include <Methane/Kit.h>`
`27`	`27`
`28`	`28`	`namespace Methane::Tutorials`
`29`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ function(add_methane_application TARGET SOURCES RESOURCES_DIR INSTALL_DIR APP_NA`
`123`	`123`
`124`	`124`	`target_link_libraries(${TARGET}`
`125`	`125`	`PRIVATE`
`126`		`- MethaneGraphicsKit`
	`126`	`+ MethaneKit`
`127`	`127`	`MethaneBuildOptions`
`128`	`128`	`MethaneInstrumentation`
`129`	`129`	`$<$<BOOL:${METHANE_TRACY_PROFILING_ENABLED}>:TracyClient>`
`@@ -134,7 +134,7 @@ function(add_methane_application TARGET SOURCES RESOURCES_DIR INSTALL_DIR APP_NA`
`134`	`134`	`.`
`135`	`135`	`)`
`136`	`136`
`137`		`- get_target_property(METHANE_PREREQUISITE_MODULES MethaneGraphicsKit PREREQUISITE_MODULES)`
	`137`	`+ get_target_property(METHANE_PREREQUISITE_MODULES MethaneKit PREREQUISITE_MODULES)`
`138`	`138`	`add_prerequisite_binaries(${TARGET} "${METHANE_PREREQUISITE_MODULES}" ${INSTALL_DIR})`
`139`	`139`
`140`	`140`	`endfunction()`