-
Notifications
You must be signed in to change notification settings - Fork 190
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add example and explanation for use of CMake's FetchCOnten-API
- Loading branch information
Showing
9 changed files
with
276 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # set minimum required CMake-Version | ||
| cmake_minimum_required(VERSION 3.23) | ||
|
|
||
| # set Project name | ||
| project(simpletest_cmake LANGUAGES CXX) | ||
|
|
||
| # some basic configurations | ||
| set(CMAKE_AUTOMOC ON) | ||
| set(CMAKE_INCLUDE_CURRENT_DIR ON) | ||
|
|
||
| # Configure project for usage of Qt5/Qt6 | ||
| find_package(QT NAMES Qt6 Qt5 COMPONENTS Core Gui Widgets PrintSupport Svg Xml OpenGl REQUIRED) | ||
| find_package(Qt${QT_VERSION_MAJOR} COMPONENTS Core Gui Widgets PrintSupport Svg Xml OpenGL REQUIRED) | ||
|
|
||
|
|
||
| # include JKQTPlotter via FetchContent-API: | ||
| # ... first load the FetchContent-API: | ||
| include(FetchContent) # once in the project to include the module | ||
| # ... now declare JKQTPlotter5/6 | ||
| FetchContent_Declare(JKQTPlotter${QT_VERSION_MAJOR} | ||
| GIT_REPOSITORY https://github.com/jkriege2/JKQtPlotter.git | ||
| # GIT_TAG v5.0.0) | ||
| # ... finally make JKQTPlotter5/6 available | ||
| FetchContent_MakeAvailable(JKQTPlotter${QT_VERSION_MAJOR}) | ||
|
|
||
| # For Visual Studio, we need to set some additional compiler options | ||
| if(MSVC) | ||
| add_compile_options(/EHsc) | ||
| # To enable M_PI, M_E,... | ||
| add_definitions(/D_USE_MATH_DEFINES) | ||
| # To Prevent Errors with min() and max() | ||
| add_definitions(/DNOMINMAX) | ||
| # To fix error: C2338: va_start argument must not | ||
| # have reference type and must not be parenthesized | ||
| add_definitions(/D_CRT_NO_VA_START_VALIDATION) | ||
| endif() | ||
|
|
||
| # add the example executable | ||
| add_executable(${PROJECT_NAME} WIN32 simpletest.cpp) | ||
| # ... link against Qt5/6 and JKQTPlotterLib | ||
| # (you could use JKQTPlotterSharedLib if you don't want to link againast the | ||
| # static version, but against the shared/DLL version). | ||
| target_link_libraries(${PROJECT_NAME} PUBLIC Qt${QT_VERSION_MAJOR}::Core Qt${QT_VERSION_MAJOR}::Widgets Qt${QT_VERSION_MAJOR}::Gui Qt${QT_VERSION_MAJOR}::PrintSupport Qt${QT_VERSION_MAJOR}::Svg Qt${QT_VERSION_MAJOR}::Xml) | ||
| # ... link against JKQTPlotter: As the Targets contain the Qt-Version-Number in their names, we can | ||
| # link against 'JKQTPlotter${QT_VERSION_MAJOR}::JKQTPlotter${QT_VERSION_MAJOR}' and it works | ||
| # for Qt5 AND Qt6 ... | ||
| # if you have a speific Qt-Version, you can also write e.g. 'JKQTPlotter6::JKQTPlotter6' | ||
| target_link_libraries(${PROJECT_NAME} PUBLIC JKQTPlotter${QT_VERSION_MAJOR}::JKQTPlotter${QT_VERSION_MAJOR}) | ||
|
|
||
|
|
||
| # Installation | ||
| install(TARGETS ${PROJECT_NAME} | ||
| RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| # Example (JKQTPlotter): CMake FetchContent Example {#JKQTCMakeFetchContentExample} | ||
|
|
||
| This project (see [`cmake_fetchcontent_example`](https://github.com/jkriege2/JKQtPlotter/tree/master/examples/cmake_fetchcontent_example) demonstrates how to link against JKQTPlotter using CMake's [FetchContent-API](https://cmake.org/cmake/help/latest/module/FetchContent.html). Also have a look at [this blog post](https://www.foonathan.net/2022/06/cmake-fetchcontent/) for a detailed explanation. See https://jkriege2.github.io/JKQtPlotter/page_buildinstructions__c_m_a_k_e.html for details on how to build JKQTPlotter with CMake | ||
|
|
||
| This example uses very simple code, which simply displays a plotter and shows some data. The important part of this example is the ´CMakeLists.txt`-file: | ||
| ``` | ||
| # set minimum required CMake-Version | ||
| cmake_minimum_required(VERSION 3.23) | ||
| # set Project name | ||
| project(simpletest_cmake LANGUAGES CXX) | ||
| # some basic configurations | ||
| set(CMAKE_AUTOMOC ON) | ||
| set(CMAKE_INCLUDE_CURRENT_DIR ON) | ||
| # Configure project for usage of Qt5/Qt6 | ||
| find_package(QT NAMES Qt6 Qt5 COMPONENTS Core Gui Widgets PrintSupport Svg Xml OpenGl REQUIRED) | ||
| find_package(Qt${QT_VERSION_MAJOR} COMPONENTS Core Gui Widgets PrintSupport Svg Xml OpenGL REQUIRED) | ||
| # include JKQTPlotter via FetchContent-API: | ||
| # ... first load the FetchContent-API: | ||
| include(FetchContent) # once in the project to include the module | ||
| # ... now declare JKQTPlotter5/6 | ||
| FetchContent_Declare(JKQTPlotter${QT_VERSION_MAJOR} | ||
| GIT_REPOSITORY https://github.com/jkriege2/JKQtPlotter.git | ||
| # GIT_TAG v5.0.0) | ||
| # ... finally make JKQTPlotter5/6 available | ||
| FetchContent_MakeAvailable(JKQTPlotter${QT_VERSION_MAJOR}) | ||
| # For Visual Studio, we need to set some additional compiler options | ||
| if(MSVC) | ||
| add_compile_options(/EHsc) | ||
| # To enable M_PI, M_E,... | ||
| add_definitions(/D_USE_MATH_DEFINES) | ||
| # To Prevent Errors with min() and max() | ||
| add_definitions(/DNOMINMAX) | ||
| # To fix error: C2338: va_start argument must not | ||
| # have reference type and must not be parenthesized | ||
| add_definitions(/D_CRT_NO_VA_START_VALIDATION) | ||
| endif() | ||
| # add the example executable | ||
| add_executable(${PROJECT_NAME} WIN32 simpletest.cpp) | ||
| # ... link against Qt5/6 and JKQTPlotterLib | ||
| # (you could use JKQTPlotterSharedLib if you don't want to link againast the | ||
| # static version, but against the shared/DLL version). | ||
| target_link_libraries(${PROJECT_NAME} PUBLIC Qt${QT_VERSION_MAJOR}::Core Qt${QT_VERSION_MAJOR}::Widgets Qt${QT_VERSION_MAJOR}::Gui Qt${QT_VERSION_MAJOR}::PrintSupport Qt${QT_VERSION_MAJOR}::Svg Qt${QT_VERSION_MAJOR}::Xml) | ||
| # ... link against JKQTPlotter: As the Targets contain the Qt-Version-Number in their names, we can | ||
| # link against 'JKQTPlotter${QT_VERSION_MAJOR}::JKQTPlotter${QT_VERSION_MAJOR}' and it works | ||
| # for Qt5 AND Qt6 ... | ||
| # if you have a speific Qt-Version, you can also write e.g. 'JKQTPlotter6::JKQTPlotter6' | ||
| target_link_libraries(${PROJECT_NAME} PUBLIC JKQTPlotter${QT_VERSION_MAJOR}::JKQTPlotter${QT_VERSION_MAJOR}) | ||
| # Installation | ||
| install(TARGETS ${PROJECT_NAME} | ||
| RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} | ||
| ) | ||
| ``` | ||
|
|
||
| The important steps here are | ||
| ``` | ||
| include(FetchContent) # once in the project to include the module | ||
| # ... now declare JKQTPlotter5/6 | ||
| FetchContent_Declare(JKQTPlotter${QT_VERSION_MAJOR} | ||
| GIT_REPOSITORY https://github.com/jkriege2/JKQtPlotter.git | ||
| # GIT_TAG v5.0.0) | ||
| # ... finally make JKQTPlotter5/6 available | ||
| FetchContent_MakeAvailable(JKQTPlotter${QT_VERSION_MAJOR}) | ||
| ``` | ||
|
|
||
| where JKQTPlotter is first declared to the FetchContent-API and then loaded. | ||
|
|
||
|
|
||
| To build this example, you first need to make a subdirectory `build` and then call CMake form that subdirectory: | ||
| ```.sh | ||
| $ mkdir build | ||
| $ cd build | ||
| $ cmake .. -G "<GENERATOR>" "-DCMAKE_PREFIX_PATH=<path_to_your_qt_sources>" | ||
| cmake --build . --config "Debug" | ||
| ``` | ||
| In the configure step above, you need to specify the directory `<path_to_your_qt_sources>` of yout Qt installation and the `<GENERATOR>` appropriate for you use-case. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /** \example jkqtplotter_simpletest.cpp | ||
| * A very basic example for the usage of JKQTPlotter, using CMake | ||
| * | ||
| * \ref JKQTCMakeLinkExample | ||
| */ | ||
|
|
||
| #include <QApplication> | ||
| #include "jkqtplotter/jkqtplotter.h" | ||
| #include "jkqtplotter/graphs/jkqtpscatter.h" | ||
|
|
||
|
|
||
| int main(int argc, char* argv[]) | ||
| { | ||
| QApplication app(argc, argv); | ||
|
|
||
| // 1. create a plotter window and get a pointer to the internal datastore (for convenience) | ||
| JKQTPlotter plot; | ||
| JKQTPDatastore* ds=plot.getDatastore(); | ||
|
|
||
| // 2. now we create data for a simple plot (a sine curve) | ||
| QVector<double> X, Y; | ||
| const int Ndata=100; | ||
| for (int i=0; i<Ndata; i++) { | ||
| const double x=double(i)/double(Ndata)*8.0*M_PI; | ||
| X<<x; | ||
| Y<<sin(x); | ||
| } | ||
|
|
||
| // 3. make data available to JKQTPlotter by adding it to the internal datastore. | ||
| // Note: In this step the data is copied (of not specified otherwise), so you can | ||
| // reuse X and Y afterwards! | ||
| // the variables columnX and columnY will contain the internal column ID of the newly | ||
| // created columns with names "x" and "y" and the (copied) data from X and Y. | ||
| size_t columnX=ds->addCopiedColumn(X, "x"); | ||
| size_t columnY=ds->addCopiedColumn(Y, "y"); | ||
|
|
||
| // 4. create a graph in the plot, which plots the dataset X/Y: | ||
| JKQTPXYLineGraph* graph1=new JKQTPXYLineGraph(&plot); | ||
| graph1->setXColumn(columnX); | ||
| graph1->setYColumn(columnY); | ||
| graph1->setTitle(QObject::tr("sine graph")); | ||
|
|
||
| // 5. add the graph to the plot, so it is actually displayed | ||
| plot.addGraph(graph1); | ||
|
|
||
| // 6. autoscale the plot so the graph is contained | ||
| plot.zoomToFit(); | ||
|
|
||
| // show plotter and make it a decent size | ||
| plot.show(); | ||
| plot.resize(600,400); | ||
|
|
||
| return app.exec(); | ||
| } |
Oops, something went wrong.