mirrors/JKQtPlotter
1
0
Fork 0
mirror of https://github.com/jkriege2/JKQtPlotter.git synced 2024-11-16 02:25:50 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
8edab9865e
JKQtPlotter/doc/dox/buildinstructions.dox

117 lines
6.2 KiB
Plaintext
Raw Normal View History

finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
/*!
\page BUILDINSTRUCTIONS How to Build
This page explains how to use JKQTPlotter in your own Projects
\tableofcontents
\section BUILDINSTRUCTIONS_QMAKE Build using QMake
\subsection BUILDINSTRUCTIONS_QMAKEINCLUDE QMake Include Project
If you want to simply include the JKQTPlotter Source code into your projects, without build a shared or static library and linking against it, you can use one of these QMake-Include files:
- <a href="https://github.com/jkriege2/JKQtPlotter/blob/master/lib/jkqtplotter.pri">lib/jkqtplotter.pri</a> includes the complete library (JKQTPlotter, JKQTFastPlotter, JKQTMathText)
- <a href="https://github.com/jkriege2/JKQtPlotter/blob/master/lib/jkqtmathtext.pri">lib/jkqtmathtext.pri</a> includes only JKQTMathText
- <a href="https://github.com/jkriege2/JKQtPlotter/blob/master/lib/jkqtfastplotter.pri">lib/jkqtfastplotter.pri</a> includes only JKQTFastPlotter
.
In your QMake-projects it is then sufficient to add a line like:
\code{.qmake}
include(<PATHTOJKQTPLOTTERDIR>/lib/jkqtplotter.pri)
\endcode
\subsection BUILDINSTRUCTIONS_QMAKESTATIC QMake Static Library
There are several `.PRO`-files, that can be used to build the full library, or a limited subsets of it as static link library:
moved build-projects for libs into their own subdirectories (works better with QMake, when building different libs) + necessary docu updates
2019-02-09 22:25:16 +08:00
- <a href="https://github.com/jkriege2/JKQtPlotter/blob/master/staticlib/jkqtplotterlib/jkqtplotterlib.pro">staticlib/jkqtplotterlib/jkqtplotterlib.pro</a> builds the complete library (JKQTPlotter, JKQTFastPlotter, JKQTMathText) as static link library
- <a href="https://github.com/jkriege2/JKQtPlotter/blob/master/staticlib/jkqtmathtextlib/jkqtmathtextlib.pro">staticlib/jkqtmathtextlib/jkqtmathtextlib.pro</a> builds only JKQTMathText as static link library
- <a href="https://github.com/jkriege2/JKQtPlotter/blob/master/staticlib/jkqtfastplotterlib/jkqtfastplotterlib.pro">staticlib/jkqtfastplotterlib/jkqtfastplotterlib.pro</a> builds only JKQTFastPlotter as static link library
finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
.
They will produce a static link library that you can include into your projects, e.g. with the following QMake-snippet:
\code{.qmake}
# include JKQTPlotter library
- added styling system for JKQTPlotter (+example app) - improved documentation - changed: using static const variables instead of \c #define for fixed default values (e.g. JKQTPImageTools::LUTSIZE, JKQTPImageTools::PALETTE_ICON_WIDTH, JKQTPlotterDrawinTools::ABS_MIN_LINEWIDTH, JKQTMathText::ABS_MIN_LINEWIDTH ...) - new: added debugging option, which surrounds different regions with visible rectangles (JKQTBasePlotter::enableDebugShowRegionBoxes() ) - fixed: colorbars at top were positioned over the plot label - new: frames (plot viewport, key/legend ...) may be rounded off at the corners - new: diverse new styling options (default font name/size ...) - speed improvements to JKQTMathText::useSTIX()
2019-02-08 00:24:46 +08:00
DEPENDPATH += \
<PATHTOJKQTPLOTTERDIR>/lib \
moved build-projects for libs into their own subdirectories (works better with QMake, when building different libs) + necessary docu updates
2019-02-09 22:25:16 +08:00
<PATHTOJKQTPLOTTERDIR>/staticlib/jkqtplotterlib
finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
INCLUDEPATH += <PATHTOJKQTPLOTTERDIR>/lib
CONFIG (debug, debug|release) {
moved build-projects for libs into their own subdirectories (works better with QMake, when building different libs) + necessary docu updates
2019-02-09 22:25:16 +08:00
DEPENDPATH += <PATHTOJKQTPLOTTERDIR>/staticlib/jkqtplotterlib/debug
LIBS += -L<PATHTOJKQTPLOTTERDIR>/staticlib/jkqtplotterlib/debug -ljkqtplotterlib_debug
finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
} else {
moved build-projects for libs into their own subdirectories (works better with QMake, when building different libs) + necessary docu updates
2019-02-09 22:25:16 +08:00
DEPENDPATH += <PATHTOJKQTPLOTTERDIR>/staticlib/jkqtplotterlib/release
LIBS += -L<PATHTOJKQTPLOTTERDIR>/staticlib/jkqtplotterlib/release -ljkqtplotterlib
finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
}
\endcode
This snippet assumes that you built the libraries with the provided `.PRO`-files. You can also add a second `.pro`-file to your projects, which integrates both as subdirs. Such files are used for all examples in this project. Here is an example:
\code{.qmake}
TEMPLATE = subdirs
# the (static library version) of JKQTPlotter
moved build-projects for libs into their own subdirectories (works better with QMake, when building different libs) + necessary docu updates
2019-02-09 22:25:16 +08:00
jkqtplotterlib_static.file = ../../staticlib/jkqtplotterlib/jkqtplotterlib.pro
finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
# your project file, with declared dependencies on jkqtplotterlib_static
test_styling.file=$$PWD/test_styling.pro
test_styling.depends = jkqtplotterlib_static
# add the two entries to SUBDIRS
SUBDIRS += jkqtplotterlib_static test_styling
\endcode
\subsection BUILDINSTRUCTIONS_QMAKEDYNAMIC QMake Dynamic Library
There are several `.PRO`-files, that can be used to build the full library, or a limited subsets of it as shred library:
moved build-projects for libs into their own subdirectories (works better with QMake, when building different libs) + necessary docu updates
2019-02-09 22:25:16 +08:00
- <a href="https://github.com/jkriege2/JKQtPlotter/blob/master/sharedlib/jkqtplotterlib/jkqtplotterlib.pro">sharedlib/jkqtplotterlib/jkqtplotterlib.pro</a> builds the complete library (JKQTPlotter, JKQTFastPlotter, JKQTMathText) as shared library
- <a href="https://github.com/jkriege2/JKQtPlotter/blob/master/sharedlib/jkqtmathtextlib/jkqtmathtextlib.pro">sharedlib/jkqtmathtextlib/jkqtmathtextlib.pro</a> builds only JKQTMathText as shared library
- <a href="https://github.com/jkriege2/JKQtPlotter/blob/master/sharedlib/jkqtfastplotterlib/jkqtfastplotterlib.pro">sharedlib/jkqtfastplotterlib/jkqtfastplotterlib.pro</a> builds only JKQTFastPlotter as shared library
finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
.
They will produce a dynamic link library that you can include into your projects, e.g. with the following QMake-snippet:
\code{.qmake}
# include JKQTPlotter library
- added styling system for JKQTPlotter (+example app) - improved documentation - changed: using static const variables instead of \c #define for fixed default values (e.g. JKQTPImageTools::LUTSIZE, JKQTPImageTools::PALETTE_ICON_WIDTH, JKQTPlotterDrawinTools::ABS_MIN_LINEWIDTH, JKQTMathText::ABS_MIN_LINEWIDTH ...) - new: added debugging option, which surrounds different regions with visible rectangles (JKQTBasePlotter::enableDebugShowRegionBoxes() ) - fixed: colorbars at top were positioned over the plot label - new: frames (plot viewport, key/legend ...) may be rounded off at the corners - new: diverse new styling options (default font name/size ...) - speed improvements to JKQTMathText::useSTIX()
2019-02-08 00:24:46 +08:00
DEPENDPATH += \
<PATHTOJKQTPLOTTERDIR>/lib \
moved build-projects for libs into their own subdirectories (works better with QMake, when building different libs) + necessary docu updates
2019-02-09 22:25:16 +08:00
<PATHTOJKQTPLOTTERDIR>/sharedlib/jkqtplotterlib
finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
INCLUDEPATH += <PATHTOJKQTPLOTTERDIR>/lib
CONFIG (debug, debug|release) {
# ensure that DLLs are copied to the output directory
moved build-projects for libs into their own subdirectories (works better with QMake, when building different libs) + necessary docu updates
2019-02-09 22:25:16 +08:00
install_jkqtplotter_dll.files = <PATHTOJKQTPLOTTERDIR>/sharedlib/jkqtplotterlib/debug/jkqtplotterlib_debug.*
finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
install_jkqtplotter_dll.path = $$OUT_PWD
INSTALLS += install_jkqtplotter_dll
# link agains DLLs
moved build-projects for libs into their own subdirectories (works better with QMake, when building different libs) + necessary docu updates
2019-02-09 22:25:16 +08:00
DEPENDPATH += <PATHTOJKQTPLOTTERDIR>/sharedlib/jkqtplotterlib/debug
LIBS += -L<PATHTOJKQTPLOTTERDIR>/sharedlib/jkqtplotterlib/debug -ljkqtplotterlib_debug
finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
} else {
# ensure that DLLs are copied to the output directory
moved build-projects for libs into their own subdirectories (works better with QMake, when building different libs) + necessary docu updates
2019-02-09 22:25:16 +08:00
install_jkqtplotter_dll.files = <PATHTOJKQTPLOTTERDIR>/sharedlib/jkqtplotterlib/release/jkqtplotterlib.*
finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
install_jkqtplotter_dll.path = $$OUT_PWD
INSTALLS += install_jkqtplotter_dll
# link agains DLLs
moved build-projects for libs into their own subdirectories (works better with QMake, when building different libs) + necessary docu updates
2019-02-09 22:25:16 +08:00
DEPENDPATH += <PATHTOJKQTPLOTTERDIR>/sharedlib/jkqtplotterlib/release
LIBS += -L<PATHTOJKQTPLOTTERDIR>/sharedlib/jkqtplotterlib/release -ljkqtplotterlib
finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
}
\endcode
This snippet assumes that you built the libraries with the provided `.PRO`-files. You can also add a second `.pro`-file to your projects, which integrates both as subdirs. Such files are used for all examples in this project. Here is an example:
\code{.qmake}
TEMPLATE = subdirs
# the (shared library version) of JKQTPlotter
moved build-projects for libs into their own subdirectories (works better with QMake, when building different libs) + necessary docu updates
2019-02-09 22:25:16 +08:00
jkqtplotterlib_shared.file = ../../sharedlib/jkqtplotterlib.pro
finished mouse interaction example + improved documentation
2019-02-04 04:00:15 +08:00
# your project file, with declared dependencies on jkqtplotterlib_shared
test_styling.file=$$PWD/test_styling.pro
test_styling.depends = jkqtplotterlib_shared
# add the two entries to SUBDIRS
SUBDIRS += jkqtplotterlib_shared test_styling
\endcode
\note You will have to run a deployment step `make install` before running your executable, so the shared libararies are actually copied to the output directory (see `INSTALLS + ...` above).
*/
Reference in New Issue Copy Permalink