QuickGraphLib 0.1.0a5__tar.gz → 0.1.0a7__tar.gz

quickgraphlib-0.1.0a7/.clang-format

@@ -0,0 +1,7 @@
+BasedOnStyle: Google
+IndentWidth: 4
+ColumnLimit: 120
+AlignAfterOpenBracket: BlockIndent
+BreakBeforeBraces: Custom
+BraceWrapping:
+    BeforeElse: true

quickgraphlib-0.1.0a7/.gitignore

@@ -0,0 +1,9 @@
+*.qml~
+.mypy_cache
+__pycache__
+venv
+dist
+*.egg-info
+aqtinstall.log
+qt
+QuickGraphLib/_version.py

quickgraphlib-0.1.0a7/.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+fail_fast: true
+repos:
+  - repo: local
+    hooks:
+      - id: licence-present
+        name: licence-present
+        entry: SPDX-License-Identifier
+        language: pygrep
+        args: [--negate]
+        files: "((\\.(qml|py|css|qdoc|qdocconf|js|cpp|hpp))|qmldir|CMakeLists.txt)$"
+      - id: qdebug-present
+        name: qdebug-present
+        entry: qDebug
+        language: pygrep
+        files: "(\\.(cpp|hpp))$"
+      - id: black
+        name: black
+        entry: venv/Scripts/black.exe
+        language: system
+        types: [python]
+      - id: gersemi
+        name: gersemi
+        entry: venv/Scripts/gersemi.exe -i
+        language: system
+        files: "CMakeLists.txt"
+      - id: qmlformat
+        name: qmlformat
+        entry: venv/Scripts/pyside6-qmlformat.exe -i -n
+        files: "\\.qml$"
+        language: system
+      # - id: qmllint
+      #   name: qmllint
+      #   entry: venv/Scripts/pyside6-qmllint.exe
+      #   files: "\\.qml$"
+      #   language: system
+      - id: isort
+        name: isort
+        entry: venv/Scripts/isort.exe --settings-file pyproject.toml
+        language: system
+        types: [python]
+      # - id: pylint
+      #   name: pylint
+      #   entry: venv/Scripts/pylint.exe
+      #   language: system
+      #   types: [python]
+      #   require_serial: true
+      - id: mypy
+        name: mypy
+        entry: venv/Scripts/mypy.exe
+        language: system
+        types: [python]
+        require_serial: true

{quickgraphlib-0.1.0a5 → quickgraphlib-0.1.0a7}/CMakeLists.txt

@@ -4,7 +4,7 @@
 cmake_minimum_required(VERSION 3.16)
 set(CMAKE_OSX_ARCHITECTURES "arm64;x86_64" CACHE STRING "" FORCE)
 
-project(qmlmodule VERSION 1.0.0 LANGUAGES CXX)
+project(QuickGraphLib VERSION 1.0.0 LANGUAGES CXX)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
@@ -12,11 +12,15 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 if(MSVC)
     add_compile_options(/W4)
 else()
-    add_compile_options(-Wextra -Wpedantic -Werror -fno-visibility-inlines-hidden)
+    add_compile_options(-Wextra -Wpedantic -fno-visibility-inlines-hidden)
 endif()
 
 if(NOT INSTALL_SUBPATH)
-    set(INSTALL_SUBPATH ${CMAKE_INSTALL_LIBDIR}/qml CACHE STRING "Install subpath (defaults to lib/qml)")
+    set(INSTALL_SUBPATH
+        ${CMAKE_INSTALL_LIBDIR}/qml
+        CACHE STRING
+        "Install subpath (defaults to lib/qml)"
+    )
 endif()
 
 find_package(Qt6 REQUIRED COMPONENTS Quick Svg)

{quickgraphlib-0.1.0a5/QuickGraphLib.egg-info → quickgraphlib-0.1.0a7}/PKG-INFO

@@ -1,78 +1,81 @@
-Metadata-Version: 2.1
-Name: QuickGraphLib
-Version: 0.1.0a5
-Summary: A scientific graphing library for QtQuick
-Author-email: Matthew Joyce <matthew.joyce@refeyn.com>
-License: MIT License
-        
-        Copyright (c) 2024 Refeyn Ltd and other QuickGraphLib contributors
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-Project-URL: Homepage, https://github.com/refeyn/QuickGraphLib
-Project-URL: Issues, https://github.com/refeyn/QuickGraphLib/issues
-Project-URL: Documentation, https://refeyn.github.io/QuickGraphLib
-Project-URL: Source, https://github.com/refeyn/QuickGraphLib
-Classifier: Development Status :: 3 - Alpha
-Classifier: Environment :: X11 Applications :: Qt
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Topic :: Multimedia :: Graphics :: Presentation
-Classifier: Topic :: Scientific/Engineering :: Visualization
-Classifier: Topic :: Software Development :: User Interfaces
-Classifier: Typing :: Typed
-Description-Content-Type: text/markdown
-License-File: LICENCE
-Requires-Dist: PySide6
-Requires-Dist: contourpy
-Provides-Extra: analyse
-Requires-Dist: black; extra == "analyse"
-Requires-Dist: pylint; extra == "analyse"
-Requires-Dist: mypy; extra == "analyse"
-Requires-Dist: pre-commit; extra == "analyse"
-Requires-Dist: lxml; extra == "analyse"
-Requires-Dist: pytest; extra == "analyse"
-Requires-Dist: pytest-cov; extra == "analyse"
-
-# QuickGraphLib
-
-A scientific graphing library for [QtQuick](https://doc.qt.io/qt-6/qtquick-index.html) using Qt6.
-
-Links:
- - [Online documentation](https://refeyn.github.io/QuickGraphLib)
- - [PyPI page](https://pypi.org/project/QuickGraphLib/)
-
-Key advantages:
-
- - Written in C++ and QML (with some optional Python helpers), so it can be used in both C++ and Python projects
- - QtQuick's hardware-based rendering makes this library render very fast
- - Support for line graphs, histograms, contour plots and more
- - Interactivity supported natively though declarative bindings and QtQuick
- - Support for PNG and SVG export
-
-## Examples
-
-The example gallery can be run using (provided the Python environment has [PySide6](https://pypi.org/project/PySide6/) and [contourpy](https://pypi.org/project/contourpy/) installed):
-
-```bash
-python examples\gallery.py
-```
-
-<p align="center"><img src="https://github.com/refeyn/QuickGraphLib/assets/103422031/56fdff62-ef77-4184-9f43-59a76b92d728" width="80%"></p>
+Metadata-Version: 2.1
+Name: QuickGraphLib
+Version: 0.1.0a7
+Summary: A scientific graphing library for QtQuick
+Author-Email: Matthew Joyce <matthew.joyce@refeyn.com>
+License: MIT License
+        
+        Copyright (c) 2024 Refeyn Ltd and other QuickGraphLib contributors
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: X11 Applications :: Qt
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Topic :: Multimedia :: Graphics :: Presentation
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: User Interfaces
+Classifier: Typing :: Typed
+Project-URL: Homepage, https://github.com/refeyn/QuickGraphLib
+Project-URL: Issues, https://github.com/refeyn/QuickGraphLib/issues
+Project-URL: Documentation, https://refeyn.github.io/QuickGraphLib
+Project-URL: Source, https://github.com/refeyn/QuickGraphLib
+Requires-Dist: PySide6
+Requires-Dist: contourpy
+Requires-Dist: black; extra == "analyse"
+Requires-Dist: pylint; extra == "analyse"
+Requires-Dist: mypy; extra == "analyse"
+Requires-Dist: pre-commit; extra == "analyse"
+Requires-Dist: lxml; extra == "analyse"
+Requires-Dist: pytest; extra == "analyse"
+Requires-Dist: pytest-cov; extra == "analyse"
+Requires-Dist: scikit-build-core; extra == "analyse"
+Requires-Dist: shiboken6_generator==6.5.3; extra == "analyse"
+Requires-Dist: PySide6==6.5.3; extra == "analyse"
+Requires-Dist: setuptools_scm; extra == "analyse"
+Provides-Extra: analyse
+Description-Content-Type: text/markdown
+
+# QuickGraphLib
+
+A scientific graphing library for [QtQuick](https://doc.qt.io/qt-6/qtquick-index.html) using Qt6.
+
+Links:
+ - [Online documentation](https://refeyn.github.io/QuickGraphLib)
+ - [PyPI page](https://pypi.org/project/QuickGraphLib/)
+
+Key advantages:
+
+ - Written in C++ and QML (with some optional Python helpers), so it can be used in both C++ and Python projects
+ - QtQuick's hardware-based rendering makes this library render very fast
+ - Support for line graphs, histograms, contour plots and more
+ - Interactivity supported natively though declarative bindings and QtQuick
+ - Support for PNG and SVG export
+
+## Examples
+
+The example gallery can be run using (provided the Python environment has [PySide6](https://pypi.org/project/PySide6/) and [contourpy](https://pypi.org/project/contourpy/) installed):
+
+```bash
+python examples\gallery.py
+```
+
+<p align="center"><img src="https://github.com/refeyn/QuickGraphLib/assets/103422031/56fdff62-ef77-4184-9f43-59a76b92d728" width="80%"></p>

quickgraphlib-0.1.0a7/QuickGraphLib/AntialiasingContainer.qml

@@ -0,0 +1,28 @@
+// SPDX-FileCopyrightText: Copyright (c) 2024 Refeyn Ltd and other QuickGraphLib contributors
+// SPDX-License-Identifier: MIT
+
+import QtQuick
+
+/*!
+    \qmltype AntialiasingContainer
+    \inqmlmodule QuickGraphLib
+    \inherits QtQuick::Item
+    \brief Enables antialiasing for it's contents.
+
+    This item turns on \l {Multisample Antialiasing}. This helps with rendering in some cases.
+*/
+
+Item {
+    id: root
+
+    /*!
+        Whether MSAA antialiasing is enabled. This can help with rendering when the target display has a
+        fractional scaling factor. It can also make rendering worse, especially with text.
+    */
+    property alias antialiasingEnabled: root.layer.enabled
+
+    implicitHeight: 100
+    implicitWidth: 100
+    layer.enabled: false //
+    layer.samples: 2
+}

{quickgraphlib-0.1.0a5 → quickgraphlib-0.1.0a7}/QuickGraphLib/Axis.qml

@@ -24,14 +24,19 @@ Item {
     }
 
     /*!
-        TODO
-        \sa {GraphArea::dataTransform}
+        Must be assigned the data transform of the graph area this axis is paired to.
+
+        \sa GraphArea::dataTransform
     */
     property alias dataTransform: helper.dataTransform
-    /*! TODO */
-    property int decimalPoints: 2
-    /*! TODO
+    /*!
+        Number of decimal points the ticks should show.
 
+        \sa TickLabel::decimalPoints
+    */
+    property int decimalPoints: 2
+    /*!
+        The side of the graph the Axis is on. It can take one of the following values:
 
         \value Axis.Direction.Left Axis to the left of the GraphArea
         \value Axis.Direction.Right Axis to the right of the GraphArea
@@ -39,34 +44,67 @@ Item {
         \value Axis.Direction.Bottom Axis below of the GraphArea
      */
     property alias direction: helper.direction
-    /*! TODO */
+    /*!
+        The label text for this axis. Alias of \c labelItem.text.
+    */
     property alias label: labelText.text
-    /*! TODO */
+    /*!
+        The color of the label. Alias of \c labelItem.color.
+    */
     property alias labelColor: labelText.color
-    /*! TODO */
+    /*!
+        The font of the label. Alias of \c labelItem.font.
+    */
     property alias labelFont: labelText.font
-    /*! TODO */
+    /*!
+        The axis label (a \l Text).
+    */
+    property alias labelItem: labelText
+    /*!
+        Whether to show a label for each tick.
+    */
     property bool showTickLabels: true
-    /*! TODO */
+    /*!
+        Spacing between the axis label and the tick labels.
+    */
     property double spacing: 4
-    /*! TODO */
+    /*!
+        Color of the axis spine and ticks.
+    */
     property alias strokeColor: myPath.strokeColor
-    /*! TODO */
+    /*!
+        Width of the axis spine and ticks.
+    */
     property alias strokeWidth: myPath.strokeWidth
-    /*! TODO */
+    /*!
+        The component used for rendering tick labels. If overridden,
+        the \c color, \c decimalPoints, \c direction, and \c font properties
+        of the component should be set explicitly. To get proper positioning,
+        it is recommended that \l TickLabel or a subclass is used.
+    */
     property Component tickDelegate: TickLabel {
-        color: root.labelColor
+        color: root.tickLabelColor
         decimalPoints: root.decimalPoints
         direction: root.direction
-        font: root.labelFont
+        font: root.tickLabelFont
     }
-    /*! TODO */
+    /*!
+        The color of the tick labels.
+    */
     property color tickLabelColor: labelColor
-    /*! TODO */
+    /*!
+        The font of the tick labels.
+    */
     property font tickLabelFont: labelFont
-    /*! TODO */
+    /*!
+        The length of each tick.
+    */
     property alias tickLength: helper.tickLength
-    /*! TODO */
+    /*!
+        The position of each tick. This should be a list of doubles in data coordinates.
+
+        \sa Helpers::range, Helpers::linspace, Grid::xTicks, Grid::yTicks
+    */
     property alias ticks: helper.ticks
 
     implicitHeight: {

quickgraphlib-0.1.0a7/QuickGraphLib/CMakeLists.txt

@@ -0,0 +1,86 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024 Refeyn Ltd and other QuickGraphLib contributors
+# SPDX-License-Identifier: MIT
+
+set(QGL_QML_FILES
+    AntialiasingContainer.qml
+    Axis.qml
+    GraphArea.qml
+    ScalingContainer.qml
+    ZoomPanHandler.qml
+    TickLabel.qml
+    ShapeRepeater.qml
+)
+
+add_library(QuickGraphLibPlugin SHARED Plugin.cpp)
+target_link_libraries(QuickGraphLibPlugin PRIVATE Qt6::Gui)
+qt_add_qml_module(QuickGraphLib
+    URI QuickGraphLib
+    SHARED
+    VERSION 1.0
+    QML_FILES ${QGL_QML_FILES}
+    PLUGIN_TARGET QuickGraphLibPlugin
+    NO_GENERATE_PLUGIN_SOURCE
+    NO_PLUGIN_OPTIONAL
+    DEPENDENCIES QtQuick
+    SOURCES
+        helpers/Helpers.cpp helpers/Helpers.hpp helpers/AxisHelper.hpp helpers/AxisHelper.cpp helpers/Foreign.hpp
+        ImageView.hpp ImageView.cpp ColorMaps.hpp ColorMaps.cpp DataTypes.hpp DataTypes.cpp bindings/Bindings.hpp QuickGraphLib.hpp
+)
+set_property(
+    TARGET QuickGraphLib
+    PROPERTY LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+)
+set_property(
+    TARGET QuickGraphLib
+    PROPERTY RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+)
+
+target_compile_definitions(
+    QuickGraphLib
+    PRIVATE $<$<OR:$<CONFIG:Debug>,$<CONFIG:RelWithDebInfo>>:QT_QML_DEBUG>
+)
+target_link_libraries(QuickGraphLib PRIVATE Qt6::Quick Qt6::Svg)
+target_include_directories(
+    QuickGraphLib
+    PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/helpers
+)
+
+set(QGL_PYTHON_FILES
+    __init__.py
+    consts.py
+    contours.py
+    py.typed
+    _version.py
+)
+foreach(PYTHON_FILE ${QGL_PYTHON_FILES})
+    add_custom_command(
+        OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${PYTHON_FILE}
+        COMMAND
+            ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/${PYTHON_FILE}
+            ${CMAKE_CURRENT_BINARY_DIR}/${PYTHON_FILE}
+        DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${PYTHON_FILE}
+    )
+endforeach()
+list(TRANSFORM QGL_PYTHON_FILES PREPEND "${CMAKE_CURRENT_BINARY_DIR}/")
+add_custom_target(QuickGraphLibPythonFiles ALL DEPENDS ${QGL_PYTHON_FILES})
+
+install(
+    TARGETS QuickGraphLib
+    RUNTIME DESTINATION ${INSTALL_SUBPATH}/QuickGraphLib
+)
+install(
+    TARGETS QuickGraphLibPlugin
+    RUNTIME DESTINATION ${INSTALL_SUBPATH}/QuickGraphLib
+)
+install(FILES ${QGL_QML_FILES} DESTINATION ${INSTALL_SUBPATH}/QuickGraphLib)
+install(
+    FILES
+        ${CMAKE_CURRENT_BINARY_DIR}/qmldir
+        ${CMAKE_CURRENT_BINARY_DIR}/QuickGraphLib.qmltypes
+    DESTINATION ${INSTALL_SUBPATH}/QuickGraphLib
+)
+install(FILES ${QGL_PYTHON_FILES} DESTINATION ${INSTALL_SUBPATH}/QuickGraphLib)
+
+add_subdirectory(PreFabs)
+add_subdirectory(GraphItems)
+add_subdirectory(bindings)