diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..f63d907 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,7 @@ +[codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = .git*,ADDON_DISABLED,.codespellrc,metadata.txt +check-hidden = true +# camel-cased +ignore-regex = (\b[A-Za-z][a-z]*[A-Z]\S+\b|\.edn\b|\S+…|\\nd\b) +ignore-words-list = vertexes diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..21f0366 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,7 @@ +[*.sh] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..6c5b3e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,78 @@ +name: Bug Report +description: Report a bug +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Please fill out the sections below to help everyone identify and fix the bug + - type: textarea + id: description + attributes: + label: Describe your issue + placeholder: When I use the X command this happens + description: Describe the problem and how it impacts user experience, workflow, maintainability or speed of the code. If the problem appears to be a bug with the current functionality, provide as test case or recipe that reproduces the error. Ideally record a macro and attach it. + validations: + required: true + - type: textarea + id: full_version + attributes: + label: FreeCAD version info + Quetzal WB version + placeholder: | + OS: Arch Linux, btw (Hyprland/hyprland/wayland) + Architecture: x86_64 + Version: 1.1.0dev.36460 +2653 (Git) + Build type: Release + Branch: main + Hash: 440b96eaf3a2a12a9079b3944101a11cb53a25fe + Python 3.12.7, Qt 6.8.0, Coin 4.0.3, Vtk 9.3.1, OCC 7.8.1 + Locale: English/United States (en_US) + Stylesheet/Theme/QtStyle: OpenDark.qss/OpenDark/ + Installed mods: + * Quetzal 1.0.0 + description: Please use the About FreeCAD dialog to copy your full version information and paste it here, include the Quetzal WB version on it. + render: shell + - type: dropdown + id: category + attributes: + label: What is the feature affected? + options: + - Frame tools + - Tube tools + - Utilities + - Icons + - Translations + - type: textarea + id: steps + attributes: + label: Steps to reproduce + placeholder: | + 1. Switch to Quetzal WB + 2. Click on X command + validations: + required: true + - type: textarea + id: expected + attributes: + label: What was the expected result? + placeholder: I expected this to happen + - type: textarea + id: screenshots + attributes: + label: Put here any screenshots or videos (optional) + description: | + Add links, references, screenshots or anything that will give us more context about the issue you are encountering! + If there is a discussion about the problem on the forum, provide link(s) here. + You can upload or copy your macro here to speed up the diagnosis and debugging. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. To attach a FCStd file, ZIP it first (GitHub won't recognize the extension otherwise). + - type: dropdown + id: assign + attributes: + label: "Would you like to work on this issue?" + options: + - "Yes" + - type: markdown + attributes: + value: | + Thanks for reporting this issue! We will get back to you as soon as possible. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..516bf1d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: true +contact_links: + - name: Read the documentation + url: https://wiki.freecad.org/Flamingo_Workbench + about: Read the FreeGrid workbench documentation on the FreeCAD Wiki + - name: General questions about the workbench + url: https://forum.freecad.org/viewtopic.php?t=22711 + about: You can join the discussions on the FreeCAD forum. + - name: Dudas y preguntas del banco de trabajo en español/castellano + url: https://t.me/FreeCAD_Es/93055 + about: Sección dedicada al sistema Flamingo/Dodo/Quetzal en el grupo de FreeCAD en español/castellano en Telegram diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..65474fb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,36 @@ +name: New feature +description: Suggest or request a new feature +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Please fill out the sections below to properly describe the new feature you are suggesting. + - type: textarea + id: description + attributes: + label: Describe the feature + placeholder: A new command to generate this new part + validations: + required: true + - type: textarea + id: rationale + attributes: + label: It should be implemented because + placeholder: It's needed to build this model, it's a very common part + - type: textarea + id: context + attributes: + label: Additional context + placeholder: | + Add any other context or screenshots about the feature request here. + - type: dropdown + id: assign + attributes: + label: "Would you like to work on this issue?" + options: + - "Yes" + - type: markdown + attributes: + value: | + Thanks for your suggestion! Let's see together if it can be implemented. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c0f005f --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +test_**.sh +__pycache__/ +cut_list/__pycache__/ +pyrightconfig.json diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..e2a77c5 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,2 @@ +line-length: + line_length: 100 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..24fa481 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,23 @@ +# SPDX-License-Identifier: LGPL-2.1-or-later + +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v5.0.0 + hooks: + - id: trailing-whitespace + exclude: '^(.*\.st.*p)$' + # - id: end-of-file-fixer # XXX: really needed? + - id: check-yaml + - id: check-added-large-files + - id: mixed-line-ending + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.9.1 + hooks: + - id: ruff-format + - repo: https://github.com/codespell-project/codespell + rev: v2.3.0 + hooks: + - id: codespell + files: ^.*\.(py|md|sh|ui|yml|xml)$ diff --git a/.ruff.toml b/.ruff.toml new file mode 100644 index 0000000..823378b --- /dev/null +++ b/.ruff.toml @@ -0,0 +1,46 @@ +# Enforce 100-char line width, same as FreeCAD's pre-commit hook +line-length = 100 +indent-width = 4 + +[lint] +# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default. +# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or +# McCabe complexity (`C901`) by default. +select = ["E4", "E7", "E9", "F"] +ignore = ["E402"] + +# Allow fix for all enabled rules (when `--fix`) is provided. +fixable = ["ALL"] +unfixable = [] + +# Allow unused variables when underscore-prefixed. +dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$" + +[format] +exclude = ["*.pyi", "ShpstData.py"] + +# Like Black, use double quotes for strings. +quote-style = "double" + +# Like Black, indent with spaces, rather than tabs. +indent-style = "space" + +# Like Black, respect magic trailing commas. +skip-magic-trailing-comma = false + +# Like Black, automatically detect the appropriate line ending. +line-ending = "auto" + +# Enable auto-formatting of code examples in docstrings. Markdown, +# reStructuredText code/literal blocks and doctests are all supported. +# +# This is currently disabled by default, but it is planned for this +# to be opt-out in the future. +docstring-code-format = false + +# Set the line length limit used when formatting code snippets in +# docstrings. +# +# This only has an effect when the `docstring-code-format` setting is +# enabled. +docstring-code-line-length = "dynamic" diff --git a/CFrame.py b/CFrame.py index 825889c..9011003 100644 --- a/CFrame.py +++ b/CFrame.py @@ -1,379 +1,604 @@ -#(c) 2019 R. T. LGPL: part of dodo tools w.b. for FreeCAD +# SPDX-License-Identifier: LGPL-3.0-or-later -__title__="frameTools toolbar" -__author__="oddtopus" -__url__="github.com/oddtopus/dodo" -__license__="LGPL 3" +__title__ = "frameTools toolbar" +__author__ = "oddtopus" +__url__ = "github.com/oddtopus/dodo" +__license__ = "LGPL 3" # import FreeCAD modules -import FreeCAD, FreeCADGui, inspect, os - -# helper ------------------------------------------------------------------- -# FreeCAD TemplatePyMod module -# (c) 2007 Juergen Riegel LGPL - -def addCommand(name,cmdObject): - (list,num) = inspect.getsourcelines(cmdObject.Activated) - pos = 0 - # check for indentation - while(list[1][pos] == ' ' or list[1][pos] == '\t'): - pos += 1 - source = "" - for i in range(len(list)-1): - source += list[i+1][pos:] - FreeCADGui.addCommand(name,cmdObject,source) - -#--------------------------------------------------------------------------- +import os + +import Quetzal_tooltips +import FreeCAD +import FreeCADGui + +from pCmd import fCmd +from quetzal_config import addCommand + +QT_TRANSLATE_NOOP = FreeCAD.Qt.QT_TRANSLATE_NOOP +translate = FreeCAD.Qt.translate + + +# --------------------------------------------------------------------------- # The command classes -#--------------------------------------------------------------------------- +# --------------------------------------------------------------------------- + class frameIt: - ''' - Given a beam object and an edge in the model, this tool lay down the - beam over the edge by selecting them one after the other until ESC is - pressed. - ''' - def Activated(self): - import FreeCAD, FreeCADGui, fObservers, fCmd - s=fObservers.frameItObserver() - FreeCADGui.Selection.addObserver(s) - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","beamFit.svg"),'MenuText':'Place one-beam over one-edge','ToolTip':'Place one beam after the other over the edges'} + """ + Given a beam object and an edge in the model, this tool lay down the + beam over the edge by selecting them one after the other until ESC is + pressed. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import fObservers + + s = fObservers.frameItObserver() + FreeCADGui.Selection.addObserver(s) + + def GetResources(self): + return { + "Pixmap": "Quetzal_FrameIt", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_FrameIt", "Place one-beam over one-edge"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_FrameIt", Quetzal_tooltips.frameit_tooltip + ), + } + class spinSect: - ''' - Tool to spin one object around the "Z" axis of its shape - by 45 degrees. - ''' - def Activated(self): - import FreeCAD, FreeCADGui, fCmd, pCmd - from math import pi - FreeCAD.activeDocument().openTransaction('Spin') - for beam in FreeCADGui.Selection.getSelection(): - pCmd.rotateTheTubeAx(beam) - FreeCAD.activeDocument().recompute() - FreeCAD.activeDocument().commitTransaction() - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","beamRot.svg"),'MenuText':'Spin beams by 45 deg.','ToolTip':'Rotates the section of the beam by 45 degrees'} + """ + Tool to spin one object around the "Z" axis of its shape + by 45 degrees. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pCmd + + # FreeCAD.activeDocument().openTransaction(translate("Transaction", "Spin")) + # FIXME: Transaction break when name is assign + FreeCAD.activeDocument().openTransaction() + for beam in FreeCADGui.Selection.getSelection(): + pCmd.rotateTheTubeAx(beam) + FreeCAD.activeDocument().recompute() + FreeCAD.activeDocument().commitTransaction() + + def GetResources(self): + return { + "Pixmap": "Quetzal_SpinSection", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_SpinSection", "Spin beams by 45 deg."), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_SpinSection", Quetzal_tooltips.spinsect_tooltip + ), + } + class reverseBeam: - ''' - Tool to spin one object around the "X" axis of its shape - by 180 degrees. - Note: - if one edge of the object is selected, that is used - as the pivot of rotation. - ''' - def Activated(self): - import FreeCAD, FreeCADGui, pCmd - FreeCAD.activeDocument().openTransaction('Reverse') - for objEx in FreeCADGui.Selection.getSelectionEx(): - pCmd.reverseTheTube(objEx) - FreeCAD.activeDocument().recompute() - FreeCAD.activeDocument().commitTransaction() - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","reverse.svg"),'MenuText':'Reverse orientation','ToolTip':'Reverse the orientation of selected objects'} + """ + Tool to spin one object around the "X" axis of its shape + by 180 degrees. + Note: - if one edge of the object is selected, that is used + as the pivot of rotation. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pCmd + + # FreeCAD.activeDocument().openTransaction(translate("Transaction", "Reverse")) + # FIXME: Transaction break when name is assign + FreeCAD.activeDocument().openTransaction() + for objEx in FreeCADGui.Selection.getSelectionEx(): + pCmd.reverseTheTube(objEx) + FreeCAD.activeDocument().recompute() + FreeCAD.activeDocument().commitTransaction() + + def GetResources(self): + return { + "Pixmap": "Quetzal_ReverseBeam", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_ReverseBeam", "Reverse orientation"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_ReverseBeam", Quetzal_tooltips.reversebeam_tooltip + ), + } + # class fillFrame: - # ''' - # Dialog to create over multiple edges selected in the viewport the - # beams of the type of that previously chosen among those present - # in the model. - # ''' - # def Activated(self): - # import fForms - # #frameFormObj=fForms.fillForm() - # FreeCADGui.Control.showDialog(fForms.fillForm()) - - # def GetResources(self): - # return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","fillFrame.svg"),'MenuText':'Fill the frame','ToolTip':'Fill the sketch of the frame with the selected beam'} +# ''' +# Dialog to create over multiple edges selected in the viewport the +# beams of the type of that previously chosen among those present +# in the model. +# ''' +# def Activated(self): +# import fForms +# #frameFormObj=fForms.fillForm() +# FreeCADGui.Control.showDialog(fForms.fillForm()) + +# def GetResources(self): +# return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","fillFrame.svg"),'MenuText':'Fill the frame','ToolTip':'Fill the sketch of the frame with the selected beam'} + class alignFlange: - ''' - Tool to rotate beams (or other objects) so that their surfaces are - parallel to one reference plane. - If multiple faces are preselected, objects will be rotated according - the first face in the selections set. Otherwise the program prompts - to select one reference face and then the faces to be reoriented until - ESC is pressed. - ''' - def Activated(self): - import fForms - FreeCADGui.Control.showDialog(fForms.alignForm()) - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","flangeAlign.svg"),'MenuText':'alignFlange','ToolTip':'Rotates the section of the beam to make the faces parallel to another face'} + """ + Tool to rotate beams (or other objects) so that their surfaces are + parallel to one reference plane. + If multiple faces are preselected, objects will be rotated according + the first face in the selections set. Otherwise the program prompts + to select one reference face and then the faces to be reoriented until + ESC is pressed. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import fForms + + FreeCADGui.Control.showDialog(fForms.alignForm()) + + def GetResources(self): + return { + "Pixmap": "Quetzal_AlignFlange", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_AlignFlange", "Align flange"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_AlignFlange", + "Rotates the section of the beam to make the faces parallel to another face", + ), + } + class shiftBeam: - ''' - Dialog to translate and copy objects. - * "x/y/z" textboxes: direct input of amount of translation in each - direction. - * "Multiple" textbox: the multiple coefficient of the translation - amount. - * "Steps" textbox: the denominator of the translation amount. It's - used when the amount of translation is to be covered in some steps. - * "move/copy" radiobuttons: to select if the selected objects shall - be copied or only translated. - * [Displacement] button: takes the amount and direction of translation - from the distance of selected entities (points, edges, faces). - * [Vector] button: defines the amount and direction of translation - by the orientation and length of the selected edge. - * [OK] button: execute the translation - * [Cancel]: exits - ''' - def Activated(self): - import fForms - #frameFormObj=fForms.translateForm() - FreeCADGui.Control.showDialog(fForms.translateForm()) - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","beamShift.svg"),'MenuText':'shiftTheBeam','ToolTip':'Translate objects by vectors defined on existing geometry'} + """ + Dialog to translate and copy objects. + * "x/y/z" textboxes: direct input of amount of translation in each + direction. + * "Multiple" textbox: the multiple coefficient of the translation + amount. + * "Steps" textbox: the denominator of the translation amount. It's + used when the amount of translation is to be covered in some steps. + * "move/copy" radiobuttons: to select if the selected objects shall + be copied or only translated. + * [Displacement] button: takes the amount and direction of translation + from the distance of selected entities (points, edges, faces). + * [Vector] button: defines the amount and direction of translation + by the orientation and length of the selected edge. + * [OK] button: execute the translation + * [Cancel]: exits + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import fForms + + # frameFormObj=fForms.translateForm() + FreeCADGui.Control.showDialog(fForms.translateForm()) + + def GetResources(self): + return { + "Pixmap": "Quetzal_ShiftBeam", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_ShiftBeam", "Shift the beam"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_ShiftBeam", Quetzal_tooltips.shiftbeam_tooltip + ), + } + class levelBeam: - ''' - Tool to flush the parallel faces of two objects. - - Note: - actually the command takes to the same level, respect the - position and orientation of the first face selected, the center-of-mass - of all faces selected. Thus it translates the objects even if the - faces are not parallel. - ''' - def Activated(self): - import FreeCAD, FreeCADGui, fCmd, fObservers - selex=Gui.Selection.getSelectionEx() - faces=fCmd.faces(selex) - beams=[sx.Object for sx in selex] - if len(faces)==len(beams)>1: - FreeCAD.activeDocument().openTransaction('LevelTheBeams') - beams.pop(0) - fBase=faces.pop(0) - for i in range(len(beams)): - fCmd.levelTheBeam(beams[i],[fBase,faces[i]]) - FreeCAD.activeDocument().commitTransaction() - elif len(faces)!=len(beams): - FreeCAD.Console.PrintError('Select only one face for each beam.\n') - else: - FreeCADGui.Selection.clearSelection() - s=fObservers.levelBeamObserver() - FreeCADGui.Selection.addObserver(s) - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","beamLevel.svg"),'MenuText':'Flush the surfaces','ToolTip':'Shift the beams to line-up the faces to the first selection (faces must be //)'} + """ + Tool to flush the parallel faces of two objects. + + Note: - actually the command takes to the same level, respect the + position and orientation of the first face selected, the center-of-mass + of all faces selected. Thus it translates the objects even if the + faces are not parallel. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import fCmd + import fObservers + + selex = FreeCADGui.Selection.getSelectionEx() + faces = fCmd.faces(selex) + beams = [sx.Object for sx in selex] + if len(faces) == len(beams) > 1: + #FIXME:openTransaction does not accept translate name + + # FreeCAD.activeDocument().openTransaction(translate("Transaction", "Level The Beams")) + FreeCAD.activeDocument().openTransaction() + beams.pop(0) + fBase = faces.pop(0) + for i in range(len(beams)): + fCmd.levelTheBeam(beams[i], [fBase, faces[i]]) + FreeCAD.activeDocument().commitTransaction() + elif len(faces) != len(beams): + FreeCAD.Console.PrintError("Select only one face for each beam.\n") + else: + FreeCADGui.Selection.clearSelection() + s = fObservers.levelBeamObserver() + FreeCADGui.Selection.addObserver(s) + + def GetResources(self): + return { + "Pixmap": "Quetzal_LevelBeam", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_LevelBeam", "Flush the surfaces"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_LevelBeam", + Quetzal_tooltips.levelbeam_tooltip, + ), + } + class alignEdge: - ''' - Tool to mate two parallel edges. - - Notes: - actually the command moves the objects along the minimum - distance of their selected edge to the first one. Thus it translates - the object even if edges are not parallel. - - It is also possible to select two edges of the same objects. With - this method is possible to move quickly one object by steps defined - on its own geometry. - ''' - def Activated(self): - import FreeCAD, FreeCADGui, fCmd, fObservers - edges=fCmd.edges() - if len(edges)>=2 and len(FreeCADGui.Selection.getSelection())>=2: - e1=edges.pop(0) - beams=FreeCADGui.Selection.getSelection()[1:] - if len(edges)==len(beams): - pairs=[(beams[i],edges[i]) for i in range(len(beams))] - FreeCAD.activeDocument().openTransaction('AlignEdge') - for p in pairs: - fCmd.joinTheBeamsEdges(p[0],e1,p[1]) - FreeCAD.activeDocument().commitTransaction() - else: - FreeCADGui.Selection.clearSelection() - s=fObservers.alignEdgeObserver() - FreeCADGui.Selection.addObserver(s) - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","edgeAlign.svg"),'MenuText':'Mate the edges','ToolTip':'Join two edges: select two or pre-select several'} + """ + Tool to mate two parallel edges. + + Notes: - actually the command moves the objects along the minimum + distance of their selected edge to the first one. Thus it translates + the object even if edges are not parallel. + - It is also possible to select two edges of the same objects. With + this method is possible to move quickly one object by steps defined + on its own geometry. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import fCmd + import fObservers + + edges = fCmd.edges() + if len(edges) >= 2 and len(FreeCADGui.Selection.getSelection()) >= 2: + e1 = edges.pop(0) + beams = FreeCADGui.Selection.getSelection()[1:] + if len(edges) == len(beams): + pairs = [(beams[i], edges[i]) for i in range(len(beams))] + #FIXME:openTransaction does not accept translate name + + # FreeCAD.activeDocument().openTransaction(translate("Transaction", "Align Edge")) + FreeCAD.activeDocument().openTransaction() + for p in pairs: + fCmd.joinTheBeamsEdges(p[0], e1, p[1]) + FreeCAD.activeDocument().commitTransaction() + else: + FreeCADGui.Selection.clearSelection() + s = fObservers.alignEdgeObserver() + FreeCADGui.Selection.addObserver(s) + + def GetResources(self): + return { + "Pixmap": "Quetzal_AlignEdge", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_AlignEdge", "Mate the edges"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_AlignEdge", "Join two edges: select two or pre-select several" + ), + } + class pivotBeam: - ''' - Dialog to rotate objects around one edge in the model or principal axis. - * Dial or textbox: the degree of rotation. - * "copy items" checkbox: select if the objects will be also copied. - * [Select axis] button: choose the pivot. - * [X / Y / Z]: choose one principal axis as pivot. - ''' - def Activated(self): - import fForms - #frameFormObj=fForms.pivotForm() - FreeCADGui.Control.showDialog(fForms.rotateAroundForm()) - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","around.svg"),'MenuText':'pivotTheBeam','ToolTip':'Rotates the beam around an axis (edge or center-of-curvature)'} + """ + Dialog to rotate objects around one edge in the model or principal axis. + * Dial or textbox: the degree of rotation. + * "copy items" checkbox: select if the objects will be also copied. + * [Select axis] button: choose the pivot. + * [X / Y / Z]: choose one principal axis as pivot. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import fForms + + # frameFormObj=fForms.pivotForm() + FreeCADGui.Control.showDialog(fForms.rotateAroundForm()) + + def GetResources(self): + return { + "Pixmap": "Quetzal_PivotBeam", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_PivotBeam", "Pivot the beam"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_PivotBeam", Quetzal_tooltips.pivotbeam_tooltip + ), + } + class stretchBeam: - ''' - Dialog to change the length of beams. - * "mm" textbox: the new length that will be applied to selected beams. - * [OK] button: execute the stretch operation to the selected beams. - * [Get Length] button: takes the new length from the selected geometry, - either the length of a beam or edge or the distance between geometric - entities (point, edges, faces). - * [Cancel]: exits - * slider: extends the reference length from -100% to +100%. - - ''' - def Activated(self): - import fForms - #frameFormObj=fForms.stretchForm() - FreeCADGui.Control.showDialog(fForms.stretchForm()) - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","beamStretch.svg"),'MenuText':'stretchTheBeam','ToolTip':'Changes the length of the beam, either according a preselected edge or a direct input'} + """ + Dialog to change the length of beams. + * "mm" textbox: the new length that will be applied to selected beams. + * [OK] button: execute the stretch operation to the selected beams. + * [Get Length] button: takes the new length from the selected geometry, + either the length of a beam or edge or the distance between geometric + entities (point, edges, faces). + * [Cancel]: exits + * slider: extends the reference length from -100% to +100%. + + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import fForms + + # frameFormObj=fForms.stretchForm() + FreeCADGui.Control.showDialog(fForms.stretchForm()) + + def GetResources(self): + return { + "Pixmap": "Quetzal_StretchBeam", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_StretchBeam", "Stretch the beam"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_StretchBeam", + "Changes the length of the beam, either according a preselected edge or a direct input", + ), + } + class extend: - ''' - Dialog to extend one beam to one selected target. - Note: - if entities are preselected before calling this command, the - first entity is automatically taken as target and the object attached - to it is removed from selection set. - ''' - def Activated(self): - import fForms - #frameFormObj=fForms.extendForm() - FreeCADGui.Control.showDialog(fForms.extendForm()) - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","extend.svg"),'MenuText':'extendTheBeam','ToolTip':'Extend the beam either to a face, a vertex or the c.o.m. of the selected object'} + """ + Dialog to extend one beam to one selected target. + Note: - if entities are preselected before calling this command, the + first entity is automatically taken as target and the object attached + to it is removed from selection set. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import fForms + + # frameFormObj=fForms.extendForm() + FreeCADGui.Control.showDialog(fForms.extendForm()) + + def GetResources(self): + return { + "Pixmap": "Quetzal_ExtendBeam", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_ExtendBeam", "Extend the beam"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_ExtendBeam", + "Extend the beam either to a face, a vertex or the c.o.m. of the selected object", + ), + } + class adjustFrameAngle: - ''' - Tool to adjust the beams at square angles of frames. - ''' - def Activated(self): - import FreeCADGui, fObservers - FreeCADGui.Selection.clearSelection() - s=fObservers.adjustAngleObserver() - FreeCADGui.Selection.addObserver(s) - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","adjustAngle.svg"),'MenuText':'adjustFrameAngle','ToolTip':'Adjust the angle of frame by two edges'} + """ + Tool to adjust the beams at square angles of frames. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import fObservers + + FreeCADGui.Selection.clearSelection() + s = fObservers.adjustAngleObserver() + FreeCADGui.Selection.addObserver(s) + + def GetResources(self): + return { + "Pixmap": "Quetzal_AdjustFrameAngle", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_AdjustFrameAngle", "Adjust frame angle"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_AdjustFrameAngle", "Adjust the angle of frame by two edges" + ), + } + class rotJoin: - ''' - Tool to translate and rotate the beams to mate two edges. - ''' - def Activated(self): - import FreeCAD, fCmd - if len(fCmd.beams())>1: - FreeCAD.activeDocument().openTransaction('rotJoin') - fCmd.rotjoinTheBeam() - FreeCAD.activeDocument().recompute() - FreeCAD.activeDocument().commitTransaction() - else: - FreeCAD.Console.PrintError('Please select two edges of beams before\n') - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","rotjoin.svg"),'MenuText':'rotJoinEdge','ToolTip':'Rotates and align the beam according another edge'} + """ + Tool to translate and rotate the beams to mate two edges. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import FreeCAD + import fCmd + + if len(fCmd.beams()) > 1: + # FreeCAD.activeDocument().openTransaction(translate("Transaction", "Rotate to Join on Edge")) + FreeCAD.activeDocument().openTransaction() + fCmd.rotjoinTheBeam() + FreeCAD.activeDocument().recompute() + FreeCAD.activeDocument().commitTransaction() + else: + FreeCAD.Console.PrintError("Please select two edges of beams before\n") + + def GetResources(self): + return { + "Pixmap": "Quetzal_RotateJoin", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_RotateJoin", "Rotate join to edge"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_RotateJoin", "Rotates and align the beam according another edge" + ), + } + class insertPath: - ''' - Tool to create a continuous DWire over the path defined by the - edges selected in the viewport, even if these are not continuous or - belongs to different objects. - ''' - def Activated(self): - import pCmd - FreeCAD.activeDocument().openTransaction('make Path') - pCmd.makeW() - FreeCAD.activeDocument().recompute() - FreeCAD.activeDocument().commitTransaction() - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","path.svg"),'MenuText':'insert Path','ToolTip':'Creates one path along selected edges'} + """ + Tool to create a continuous DWire over the path defined by the + edges selected in the viewport, even if these are not continuous or + belongs to different objects. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pCmd + + # FreeCAD.activeDocument().openTransaction(translate("Transaction", "Make Path")) + FreeCAD.activeDocument().openTransaction() + pCmd.makeW() + FreeCAD.activeDocument().recompute() + FreeCAD.activeDocument().commitTransaction() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertPath", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertPath", "Insert path"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_InsertPath", "Creates one path along selected edges" + ), + } + # class FrameLineManager: - # ''' - # Dialog to create and change properties of objects FrameLine - # providing the following features: - # * a list of beams' profiles previously included in the model - # by "insertSection" dialog; - # * a combo-box to select the active FrameLine among those already - # created or to create a new one; - # * a text-box where to write the name of the FrameLine that is going - # to be created; if nothing or "", the FrameLined will be named - # as default "Telaio00n"; - # * [Insert] button: creates a new FrameLine object or adds new members - # to the one selected in the combo-box if edges are selected in the - # active viewport. - # * [Redraw] button: creates new beams and places them over the selected - # path. New beams will be collected inside the group of the FrameLine. - # Does not create or update beams added to the FrameLine outside - # its defined path. - # * [Clear] button: deletes all beams in the FrameLine group. It applies - # also to beams added to the FrameLine outside its defined path. - # * [Get Path] button: assigns the Dwire selected to the attribute Path - # of the FrameLine object. - # * [Get Profile] button: changes the Profile attribute of the FrameLine - # object to the one of the beam selected in the viewport or the one - # selected in the list. - # * "Copy profile" checkbox: if checked generates a new profile object - # for each beam in order to avoid multiple references in the model. - # * "Move to origin" checkbox: if checked, moves the center-of-mass - # of the profile to the origin of coordinates system: that makes the - # centerline of the beam coincide with the c.o.m. of the profile. - - # Notes: - if the name of a FrameLine object is modified, also the name - # of the relevant group will change automatically but not viceversa. - # ''' - # def Activated(self): - # if FreeCAD.ActiveDocument: - # import fFeatures - # frameFormObj=fFeatures.frameLineForm() - - # def GetResources(self): - # return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","frameline.svg"),'MenuText':'FrameLine Manager','ToolTip':'Open FrameLine Manager'} +# ''' +# Dialog to create and change properties of objects FrameLine +# providing the following features: +# * a list of beams' profiles previously included in the model +# by "insertSection" dialog; +# * a combo-box to select the active FrameLine among those already +# created or to create a new one; +# * a text-box where to write the name of the FrameLine that is going +# to be created; if nothing or "", the FrameLined will be named +# as default "Telaio00n"; +# * [Insert] button: creates a new FrameLine object or adds new members +# to the one selected in the combo-box if edges are selected in the +# active viewport. +# * [Redraw] button: creates new beams and places them over the selected +# path. New beams will be collected inside the group of the FrameLine. +# Does not create or update beams added to the FrameLine outside +# its defined path. +# * [Clear] button: deletes all beams in the FrameLine group. It applies +# also to beams added to the FrameLine outside its defined path. +# * [Get Path] button: assigns the Dwire selected to the attribute Path +# of the FrameLine object. +# * [Get Profile] button: changes the Profile attribute of the FrameLine +# object to the one of the beam selected in the viewport or the one +# selected in the list. +# * "Copy profile" checkbox: if checked generates a new profile object +# for each beam in order to avoid multiple references in the model. +# * "Move to origin" checkbox: if checked, moves the center-of-mass +# of the profile to the origin of coordinates system: that makes the +# centerline of the beam coincide with the c.o.m. of the profile. + +# Notes: - if the name of a FrameLine object is modified, also the name +# of the relevant group will change automatically but not vice-versa. +# ''' +# def Activated(self): +# if FreeCAD.ActiveDocument: +# import fFeatures +# frameFormObj=fFeatures.frameLineForm() + +# def GetResources(self): +# return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","frameline.svg"),'MenuText':'FrameLine Manager','ToolTip':'Open FrameLine Manager'} + class FrameBranchManager: - ''' - Dialog to create and change properties of objects FrameBranch - ''' - def Activated(self): - if FreeCAD.ActiveDocument: - import fFeatures - FreeCADGui.Control.showDialog(fFeatures.frameBranchForm()) + """ + Dialog to create and change properties of objects FrameBranch + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + if FreeCAD.ActiveDocument: + import fFeatures + + FreeCADGui.Control.showDialog(fFeatures.frameBranchForm()) + + def GetResources(self): + return { + "Pixmap": "Quetzal_FrameBranchManager", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_FrameBranchManager", "FrameBranch Manager"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_FrameBranchManager", Quetzal_tooltips.framebranchmanager_tooltip), + } - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","framebranch.svg"),'MenuText':'FrameBranch Manager','ToolTip':'Open FrameBranch Manager'} class insertSection: - ''' - Dialog to create the set of profiles to be used in the model. - ''' - def Activated(self): - if FreeCAD.ActiveDocument: - import fForms - FreeCADGui.Control.showDialog(fForms.profEdit()) - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","sect.svg"),'MenuText':'Insert sections','ToolTip':'Creates customized beam profiles 2D'} - -#--------------------------------------------------------------------------- + """ + Dialog to create the set of profiles to be used in the model. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + if FreeCAD.ActiveDocument: + import fForms + + FreeCADGui.Control.showDialog(fForms.profEdit()) + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertSection", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertSection", "Insert sections"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_InsertSection", "Creates customized beam profiles 2D" + ), + } + + +# --------------------------------------------------------------------------- # Adds the commands to the FreeCAD command manager -#--------------------------------------------------------------------------- -addCommand('frameIt',frameIt()) -addCommand('spinSect',spinSect()) -addCommand('reverseBeam',reverseBeam()) -#addCommand('fillFrame',fillFrame()) -addCommand('alignFlange',alignFlange()) -addCommand('shiftBeam',shiftBeam()) -addCommand('levelBeam',levelBeam()) -addCommand('alignEdge',alignEdge()) -addCommand('pivotBeam',pivotBeam()) -addCommand('stretchBeam',stretchBeam()) -addCommand('extend',extend()) -addCommand('adjustFrameAngle',adjustFrameAngle()) -addCommand('rotJoin',rotJoin()) -addCommand('insertPath',insertPath()) -#addCommand('FrameLineManager',FrameLineManager()) -addCommand('insertSection',insertSection()) -addCommand('FrameBranchManager',FrameBranchManager()) +# --------------------------------------------------------------------------- +addCommand("Quetzal_FrameIt", frameIt()) +addCommand("Quetzal_SpinSection", spinSect()) +addCommand("Quetzal_ReverseBeam", reverseBeam()) +# addCommand('fillFrame',fillFrame()) +addCommand("Quetzal_AlignFlange", alignFlange()) +addCommand("Quetzal_ShiftBeam", shiftBeam()) +addCommand("Quetzal_LevelBeam", levelBeam()) +addCommand("Quetzal_AlignEdge", alignEdge()) +addCommand("Quetzal_PivotBeam", pivotBeam()) +addCommand("Quetzal_StretchBeam", stretchBeam()) +addCommand("Quetzal_ExtendBeam", extend()) +addCommand("Quetzal_AdjustFrameAngle", adjustFrameAngle()) +addCommand("Quetzal_RotateJoin", rotJoin()) +addCommand("Quetzal_InsertPath", insertPath()) +# addCommand('FrameLineManager',FrameLineManager()) +addCommand("Quetzal_InsertSection", insertSection()) +addCommand("Quetzal_FrameBranchManager", FrameBranchManager()) diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0fa8797 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,59 @@ +# Changelog + +## [1.7.8] - 2025-12-13 + +- Sync quetzal version +- Improve branch frame trim and extend method + +## [1.1.0] - 2025-01-17 + +### Added + +- Add ASME flange weld neck, lap join, socket slot +- Add German, Greek, Polish and Swedish translations + +### Changed + +- Update WB icon with an actual quetzal +- Replace original profiles to use BIM profiles +- Update icons to be easier to identify +- Update Spanish translations +- Rename icons and add them to FreeCAD resources path + +### Fixed + +- Fix object bases & added extra flange & pipe standards +- Mark `openTransaction()` strings for translation +- Don't translate objects' internal name, only translate `obj.Label` + +## [1.0.0] - 2024-10-20 + +🌱 Initial release of Quetzal WB based on the work of **oddtopus** on [Dodo WB]. + +### Added + +- Add Cut List function by File Phil +- Add translation support +- Add Spanish translation +- Add view provider class to assign icons to parametric objects +- Add miter corner feature + +### Changed + +- Apply black style to Python files +- Make commands to use "Quetzal_" prefix +- Extend RH profile profile CSV file +- Update some icons +- Mark commands unavailable when there is no active document + +### Fixed + +- Don't remove sketch profile by Ebrahim Raeyat +- Fix touched object after recomputation by Zheng, Lei +- Fix license ID by Chris Hennes +- Fix PypeLineForm pipe generation +- Fix typos + +[Dodo WB]: https://github.com/oddtopus/dodo +[1.0.0]: https://github.com/EdgarJRobles/dodo/releases/tag/V1.0.0RC2 +[1.1.0]: https://github.com/EdgarJRobles/dodo/releases/tag/1.1.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2d2e08e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +# Contributing + +Contributing can take many forms, and it's not just for developers. + +## Ideas + +Many of the workbench features were added because the developers thought they +might be useful to others or themselves. + +Is some step in the workflow hard to accomplish? +Do you think a feature is missing? Let us know. + +## Translators + +This may be one of the most undervalued type of contribution. FreeCAD and the +Quetzal Workbench aren't only for people speaking English. Translating different +languages requires the contributions of native speakers worldwide. + +The Quetzal Workbench, like FreeCAD itself, uses the CrowdIn platform + for management of translations. +Create an account and you'll be able to start contributing right away. In addition +to providing translations, you can also proof read the translations already contributed. +Do a little or a lot. Even small incremental gains are valuable. + +Of course, you can do translation locally on your machine, to know more about +the translation process take a look on [the README file](./translationz) +on the translations directory. + +## Designers + +Some icons may need to be improved to be easier to identify. + +Here are FreeCAD guidelines for icons: + +## Accessibility / Usability + +What can be done to improve your experience? +It is easy to overlook an accessibility issue when you're not personally affected +but it's often easy to accommodate once the issue is known. + +## Testers + +See a bug? Open an issue on GitHub: + +If you have QA experience consider writing test cases. + +## Developers + +Feel like adding a new feature/part? Open a ticket to use as a basis for discussion. + +Describe your idea. Discuss with the other developers and start coding! diff --git a/CPipe.py b/CPipe.py index 8248d3e..2007d4b 100644 --- a/CPipe.py +++ b/CPipe.py @@ -1,319 +1,757 @@ -#(c) 2019 R. T. LGPL: part of dodo w.b. for FreeCAD +# SPDX-License-Identifier: LGPL-3.0-or-later -__title__="pypeTools toolbar" -__author__="oddtopus" -__url__="github.com/oddtopus/dodo" -__license__="LGPL 3" +__title__ = "pypeTools toolbar" +__author__ = "oddtopus" +__url__ = "github.com/oddtopus/dodo" +__license__ = "LGPL 3" # import FreeCAD modules -import FreeCAD, FreeCADGui,inspect, os - -# helper ------------------------------------------------------------------- -# FreeCAD TemplatePyMod module -# (c) 2007 Juergen Riegel LGPL - -def addCommand(name,cmdObject): - (list,num) = inspect.getsourcelines(cmdObject.Activated) - pos = 0 - # check for indentation - while(list[1][pos] == ' ' or list[1][pos] == '\t'): - pos += 1 - source = "" - for i in range(len(list)-1): - source += list[i+1][pos:] - FreeCADGui.addCommand(name,cmdObject,source) - #print(name+":\n"+str(source)) +import FreeCAD +import FreeCADGui +import Quetzal_tooltips + +from quetzal_config import addCommand + +QT_TRANSLATE_NOOP = FreeCAD.Qt.QT_TRANSLATE_NOOP +# translate = FreeCAD.Qt.translate def updatesPL(dialogqm): - if FreeCAD.activeDocument(): - pypelines=[o.Label for o in FreeCAD.activeDocument().Objects if hasattr(o,'PType') and o.PType=='PypeLine'] - else: - pypelines=[] - if pypelines: # updates pypelines in combo - dialogqm.QM.comboPL.clear() - dialogqm.QM.comboPL.addItems(pypelines) - -#--------------------------------------------------------------------------- + if FreeCAD.activeDocument(): + pypelines = [ + o.Label + for o in FreeCAD.activeDocument().Objects + if hasattr(o, "PType") and o.PType == "PypeLine" + ] + else: + pypelines = [] + if pypelines: # updates pypelines in combo + dialogqm.QM.comboPL.clear() + dialogqm.QM.comboPL.addItems(pypelines) + + +# --------------------------------------------------------------------------- # The command classes -#--------------------------------------------------------------------------- +# --------------------------------------------------------------------------- + class insertPipe: - def Activated (self): - import pForms - pipForm=pForms.insertPipeForm() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","pipe.svg"),'MenuText':'Insert a tube','ToolTip':'Insert a tube'} - -class insertElbow: - def Activated (self): - import pForms,FreeCAD - elbForm=pForms.insertElbowForm() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","elbow.svg"),'MenuText':'Insert a curve','ToolTip':'Insert a curve'} - -class insertReduct: - def Activated (self): - import pForms - pipeFormObj=pForms.insertReductForm() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","reduct.svg"),'MenuText':'Insert a reduction','ToolTip':'Insert a reduction'} - -class insertCap: - def Activated (self): - import pForms - pipeFormObj=pForms.insertCapForm() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","cap.svg"),'MenuText':'Insert a cap','ToolTip':'Insert a cap'} + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pForms + + pipForm = pForms.insertPipeForm() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertPipe", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertPipe", "Insert a tube"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_InsertPipe", Quetzal_tooltips.insert_tube_tooltip), + } + + +class insertElbow: + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pForms + + elbForm = pForms.insertElbowForm() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertElbow", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertElbow", "Insert a elbow"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_InsertElbow", Quetzal_tooltips.elbow_tooltip), + } + + +class insertTerminalAdapter: + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + # import pCmd + # pCmd.makeTerminalAdapter() + import pForms + TerminalA=pForms.insertTerminalAdapterForm() + TerminalA.show() + # FreeCAD.activeDocument().recompute() + + def GetResources(self): + return { + "Pixmap": "Quetzal_TerminalAdapter", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertTerminalAdapter", "Insert Terminal adapter"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_InsertTerminalAdapter", "Insert Terminal adapter"), + } + + +class insertReduct: + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pForms + + pipeFormObj = pForms.insertReductForm() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertReduct", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertReduct", "Insert a reduction"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_InsertReduct", "Insert a reduction"), + } + + +class insertCap: + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pForms + + pipeFormObj = pForms.insertCapForm() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertCap", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertCap", "Insert a cap"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_InsertCap", "Insert a cap"), + } + class insertFlange: - def Activated (self): - import pForms - pipeFormObj=pForms.insertFlangeForm() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","flange.svg"),'MenuText':'Insert a flange','ToolTip':'Insert a flange'} + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pForms + + pipeFormObj = pForms.insertFlangeForm() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertFlange", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertFlange", "Insert a flange"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_InsertFlange", "Insert a flange"), + } + class insertUbolt: - def Activated (self): - import pForms - pipeFormObj=pForms.insertUboltForm() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","clamp.svg"),'MenuText':'Insert a U-bolt','ToolTip':'Insert a U-bolt'} + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pForms + + pipeFormObj = pForms.insertUboltForm() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertUBolt", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertUbolt", "Insert a U-bolt"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_InsertUbolt", "Insert a U-bolt"), + } + class insertPypeLine: - def Activated (self): - import pForms - pipeFormObj=pForms.insertPypeLineForm() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","pypeline.svg"),'MenuText':'PypeLine Manager','ToolTip':'Open PypeLine Manager'} + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pForms + + pipeFormObj = pForms.insertPypeLineForm() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertPypeLine", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertPypeLine", "PypeLine Manager"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_InsertPypeLine", "Open PypeLine Manager"), + } + class insertBranch: - def Activated (self): - import pForms - #pCmd.makeBranch() - pipeFormObj=pForms.insertBranchForm() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","branch.svg"),'MenuText':'Insert a branch','ToolTip':'Insert a PypeBranch'} + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pForms + + # pCmd.makeBranch() + pipeFormObj = pForms.insertBranchForm() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertBranch", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertBranch", "Insert a branch"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_InsertBranch", "Insert a PypeBranch"), + } + class breakPipe: - def Activated (self): - import pForms - pipeFormObj=pForms.breakForm() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","break.svg"),'MenuText':'Break the pipe','ToolTip':'Break one pipe at point and insert gap'} + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pForms + + pipeFormObj = pForms.breakForm() + + def GetResources(self): + return { + "Pixmap": "Quetzal_BreakPipe", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_BreakPipe", "Break the pipe"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_BreakPipe", "Break one pipe at point and insert gap" + ), + } + class mateEdges: - def Activated (self): - import pCmd - FreeCAD.activeDocument().openTransaction('Mate') - pCmd.alignTheTube() - FreeCAD.activeDocument().commitTransaction() - FreeCAD.activeDocument().recompute() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","mate.svg"),'Accel':"M,E",'MenuText':'Mate pipes edges','ToolTip':'Mate two terminations through their edges'} - -class flat: - def Activated (self): - import pCmd - pCmd.flatten() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","flat.svg"),'MenuText':'Fit one elbow','ToolTip':'Place the elbow between two pipes or beams'} + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pCmd + result=pCmd.translate("Transaction", "Mate") + FreeCAD.activeDocument().openTransaction(result) + pCmd.alignTheTube() + FreeCAD.activeDocument().commitTransaction() + FreeCAD.activeDocument().recompute() + + def GetResources(self): + return { + "Accel": "M,E", + "Pixmap": "Quetzal_MateEdges", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_MateEdges", "Mate pipes edges"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_MateEdges", "Mate two terminations through their edges" + ), + } + + +class flat: + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pCmd + + pCmd.flatten() + + def GetResources(self): + return { + "Pixmap": "Quetzal_Flat", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_Flat", "Fit one elbow"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_Flat", "Place a existing elbow between two pipes adjusting lenght pipes" + ), + } + class extend2intersection: - def Activated (self): - import pCmd - FreeCAD.activeDocument().openTransaction('Xtend2int') - pCmd.extendTheTubes2intersection() - FreeCAD.activeDocument().recompute() - FreeCAD.activeDocument().commitTransaction() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","intersect.svg"),'MenuText':'Extends pipes to intersection','ToolTip':'Extends pipes to intersection'} + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pCmd + result=pCmd.translate("Transaction", "Extend pipes to intersection") + FreeCAD.activeDocument().openTransaction(result) + pCmd.extendTheTubes2intersection() + FreeCAD.activeDocument().recompute() + FreeCAD.activeDocument().commitTransaction() + + def GetResources(self): + return { + "Pixmap": "Quetzal_ExtendIntersection2", + "MenuText": QT_TRANSLATE_NOOP( + "Quetzal_ExtendIntersection2", "Extend pipes to intersection" + ), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_ExtendIntersection2", "Extends pipes to intersection" + ), + } + class extend1intersection: - def Activated (self): - import pCmd - FreeCAD.activeDocument().openTransaction('Xtend1int') - pCmd.extendTheTubes2intersection(both=False) - FreeCAD.activeDocument().recompute() - FreeCAD.activeDocument().commitTransaction() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","intersect1.svg"),'MenuText':'Extends pipe to intersection','ToolTip':'Extends pipe to intersection'} + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pCmd + result=pCmd.translate("Transaction", "Extend pipe to intersection") + FreeCAD.activeDocument().openTransaction(result) + pCmd.extendTheTubes2intersection(both=False) + FreeCAD.activeDocument().recompute() + FreeCAD.activeDocument().commitTransaction() + + def GetResources(self): + return { + "Pixmap": "Quetzal_ExtendIntersection1", + "MenuText": QT_TRANSLATE_NOOP( + "Quetzal_ExtendIntersection1", "Extend pipe to intersection" + ), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_ExtendIntersection1", "Extends pipe to intersection" + ), + } + class laydown: - def Activated (self): - import pCmd, fCmd - from Part import Plane - refFace=[f for f in fCmd.faces() if type(f.Surface)==Plane][0] - FreeCAD.activeDocument().openTransaction('Lay-down the pipe') - for b in fCmd.beams(): - if pCmd.isPipe(b): - pCmd.laydownTheTube(b,refFace) - FreeCAD.activeDocument().recompute() - FreeCAD.activeDocument().commitTransaction() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","laydown.svg"),'MenuText':'Lay-down the pipe','ToolTip':'Lay-down the pipe on the support plane'} + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pCmd + import fCmd + from Part import Plane + + refFace = [f for f in fCmd.faces() if isinstance(f.Surface, Plane)][0] + result=pCmd.translate("Transaction", "Lay-down the pipe") + FreeCAD.activeDocument().openTransaction(result) + for b in fCmd.beams(): + if pCmd.isPipe(b): + pCmd.laydownTheTube(b, refFace) + FreeCAD.activeDocument().recompute() + FreeCAD.activeDocument().commitTransaction() + + def GetResources(self): + return { + "Pixmap": "Quetzal_Laydown", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_Laydown", "Lay-down the pipe"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_Laydown", "Lay-down the pipe on the support plane" + ), + } + class raiseup: - def Activated (self): - import pCmd, fCmd - from Part import Plane - selex=FreeCADGui.Selection.getSelectionEx() - for sx in selex: - sxFaces=[f for f in fCmd.faces([sx]) if type(f.Surface)==Plane] - if len(sxFaces)>0: - refFace=sxFaces[0] - support=sx.Object - FreeCAD.activeDocument().openTransaction('Raise-up the support') - for b in fCmd.beams(): - if pCmd.isPipe(b): - pCmd.laydownTheTube(b,refFace,support) - break - FreeCAD.activeDocument().recompute() - FreeCAD.activeDocument().commitTransaction() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","raiseup.svg"),'MenuText':'Raise-up the support','ToolTip':'Raise the support to the pipe'} -class joinPype: - ''' - - ''' - def Activated(self): - import FreeCAD, FreeCADGui, pForms #pObservers - # s=pObservers.joinObserver() - FreeCADGui.Control.showDialog(pForms.joinForm()) #.Selection.addObserver(s) + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","join.svg"),'MenuText':'Join pypes','ToolTip':'Select the part-pype and the port'} + def Activated(self): + import pCmd + import fCmd + from Part import Plane + + selex = FreeCADGui.Selection.getSelectionEx() + for sx in selex: + sxFaces = [f for f in fCmd.faces([sx]) if isinstance(f.Surface, Plane)] + if len(sxFaces) > 0: + refFace = sxFaces[0] + support = sx.Object + result=pCmd.translate("Transaction", "Raise-up the support") + FreeCAD.activeDocument().openTransaction(result) + for b in fCmd.beams(): + if pCmd.isPipe(b): + pCmd.laydownTheTube(b, refFace, support) + break + FreeCAD.activeDocument().recompute() + FreeCAD.activeDocument().commitTransaction() + + def GetResources(self): + return { + "Pixmap": "Quetzal_Raiseup", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_Raiseup", "Raise-up the support"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_Raiseup", "Raise the support to the pipe"), + } + + +class joinPype: + """ """ + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import FreeCADGui + import pForms # pObservers + + # s=pObservers.joinObserver() + FreeCADGui.Control.showDialog(pForms.joinForm()) # .Selection.addObserver(s) + + def GetResources(self): + return { + "Pixmap": "Quetzal_JoinPype", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_JoinPype", "Join pipes"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_JoinPype", "Select the part-pype and the port"), + } + class insertValve: - def Activated (self): - import pForms - #pipeFormObj=pForms.insertValveForm() - #FreeCADGui.Control.showDialog(pForms.insertValveForm()) - pipeFormObj=pForms.insertValveForm() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","valve.svg"),'MenuText':'Insert a valve','ToolTip':'Insert a valve'} + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pForms + + # pipeFormObj=pForms.insertValveForm() + # FreeCADGui.Control.showDialog(pForms.insertValveForm()) + pipeFormObj = pForms.insertValveForm() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertValve", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertValve", "Insert a valve"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_InsertValve", "Insert a valve"), + } + class attach2tube: - def Activated (self): - import pCmd - FreeCAD.activeDocument().openTransaction('Attach to tube') - pCmd.attachToTube() - FreeCAD.activeDocument().recompute() - FreeCAD.activeDocument().commitTransaction() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","attach.svg"),'MenuText':'Attach to tube','ToolTip':'Attach one pype to the nearest port of selected pipe'} + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pCmd + result=pCmd.translate("Transaction", "Attach to tube") + FreeCAD.activeDocument().openTransaction(result) + pCmd.attachToTube() + FreeCAD.activeDocument().recompute() + FreeCAD.activeDocument().commitTransaction() + + def GetResources(self): + return { + "Pixmap": "Quetzal_Attach2Tube", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_Attach2Tube", "Attach to tube"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_Attach2Tube", "Attach one pype to the nearest port of selected pipe" + ), + } + class point2point: - def Activated(self): - import pForms - form = pForms.point2pointPipe() + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + + def Activated(self): + import pForms + + form = pForms.point2pointPipe() + + def GetResources(self): + return { + "Pixmap": "Quetzal_Point2Point", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_Point2Point", "Draw a tube point by point"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_Point2Point", "A new body is created on each click on subsequent points" + ), + } + - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","point2point.svg"),'MenuText':'draw a tube point-to-point','ToolTip':'Click on subsequent points.'} - class insertAnyz: - ''' - Dialog to insert any object saved as .STEP, .IGES or .BREP in folder ../Mod/dodo/shapez or subfolders. - ''' - def Activated(self): - import anyShapez - FreeCADGui.Control.showDialog(anyShapez.shapezDialog()) - - def GetResources(self): - return{'MenuText':'Insert any shape','ToolTip':'Insert a STEP, IGES or BREP'} + """ + Dialog to insert any object saved as .STEP, .IGES or .BREP in folder ../Mod/dodo/shapez or subfolders. + """ + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + + def Activated(self): + import anyShapez + + FreeCADGui.Control.showDialog(anyShapez.shapezDialog()) + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertAnyShape", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertAnyShape", "Insert any shape"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_InsertAnyShape", "Insert a STEP, IGES or BREP"), + } + class insertTank: - def Activated(self): - import FreeCADGui, pForms - FreeCADGui.Control.showDialog(pForms.insertTankForm()) - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","tank.svg"),'MenuText':'Insert a tank','ToolTip':'Create tank and nozzles'} + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import FreeCADGui + import pForms + + FreeCADGui.Control.showDialog(pForms.insertTankForm()) + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertTank", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertTank", "Insert a tank"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_InsertTank", "Create tank and nozzles"), + } + class insertRoute: - def Activated(self): - import FreeCADGui, pForms - FreeCADGui.Control.showDialog(pForms.insertRouteForm()) - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","route.svg"),'MenuText':'Insert a pipe route','ToolTip':'Create a sketch attached to a circular edge'} + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import FreeCADGui + import pForms + + FreeCADGui.Control.showDialog(pForms.insertRouteForm()) + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertRoute", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_InsertRoute", "Insert a pipe route"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_InsertRoute", "Create a sketch attached to a circular edge" + ), + } + class makeHeader: - def Activated (self): - import pCmd - FreeCAD.activeDocument().openTransaction('Connect to header') - pCmd.header() - FreeCAD.activeDocument().recompute() - FreeCAD.activeDocument().commitTransaction() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","header.svg"),'MenuText':'Connect to header','ToolTip':'Connect branches to one header pipe\nBranches and header\'s axes must be ortho'} - -#--------------------------------------------------------------------------- + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import pCmd + result=pCmd.translate("Transaction", "Connect to header") + FreeCAD.activeDocument().openTransaction(result) + FreeCAD.activeDocument().recompute() + FreeCAD.activeDocument().commitTransaction() + pCmd.header() + + def GetResources(self): + return { + "Pixmap": "Quetzal_MakeHeader", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_MakeHeader", "Connect to header"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_MakeHeader", + "Connect branches to one header pipe\nBranches and header's axes must be ortho", + ), + } + + +# --------------------------------------------------------------------------- # Adds the commands to the FreeCAD command manager -#--------------------------------------------------------------------------- -addCommand('insertPipe',insertPipe()) -addCommand('insertElbow',insertElbow()) -addCommand('insertReduct',insertReduct()) -addCommand('insertCap',insertCap()) -addCommand('insertValve',insertValve()) -addCommand('insertFlange',insertFlange()) -addCommand('insertUbolt',insertUbolt()) -addCommand('insertPypeLine',insertPypeLine()) -addCommand('insertBranch',insertBranch()) -addCommand('insertTank',insertTank()) -addCommand('insertRoute',insertRoute()) -addCommand('breakPipe',breakPipe()) -addCommand('mateEdges',mateEdges()) -addCommand('joinPype',joinPype()) -addCommand('attach2tube',attach2tube()) -addCommand('flat',flat()) -addCommand('extend2intersection',extend2intersection()) -addCommand('extend1intersection',extend1intersection()) -addCommand('laydown',laydown()) -addCommand('raiseup',raiseup()) -addCommand('point2point',point2point()) -addCommand('insertAnyz',insertAnyz()) -addCommand('makeHeader',makeHeader()) +# --------------------------------------------------------------------------- +addCommand("Quetzal_InsertPipe", insertPipe()) +addCommand("Quetzal_InsertElbow", insertElbow()) +addCommand("Quetzal_InsertReduct", insertReduct()) +addCommand("Quetzal_InsertCap", insertCap()) +addCommand("Quetzal_InsertValve", insertValve()) +addCommand("Quetzal_InsertFlange", insertFlange()) +addCommand("Quetzal_InsertUBolt", insertUbolt()) +addCommand("Quetzal_InsertPypeLine", insertPypeLine()) +addCommand("Quetzal_InsertBranch", insertBranch()) +addCommand("Quetzal_InsertTank", insertTank()) +addCommand("Quetzal_InsertRoute", insertRoute()) +addCommand("Quetzal_BreakPipe", breakPipe()) +addCommand("Quetzal_MateEdges", mateEdges()) +addCommand("Quetzal_JoinPype", joinPype()) +addCommand("Quetzal_Attach2Tube", attach2tube()) +addCommand("Quetzal_Flat", flat()) +addCommand("Quetzal_ExtendIntersection2", extend2intersection()) +addCommand("Quetzal_ExtendIntersection1", extend1intersection()) +addCommand("Quetzal_Laydown", laydown()) +addCommand("Quetzal_Raiseup", raiseup()) +addCommand("Quetzal_Point2Point", point2point()) +addCommand("Quetzal_InsertAnyShape", insertAnyz()) +addCommand("Quetzal_MakeHeader", makeHeader()) +addCommand("Quetzal_InsertTerminalAdapter", insertTerminalAdapter()) + ### QkMenus ### class pipeQM: - def Activated(self): - import dodoPM - #dodoPM.pqm.updatePL() - dodoPM.pqm.show() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","pipe.svg"),'MenuText':'QM for pipes'} -addCommand('pipeQM',pipeQM()) - -class elbowQM(): - def Activated (self): - import dodoPM - dodoPM.eqm.show() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","elbow.svg"),'MenuText':'QM for elbows'} -addCommand('elbowQM',elbowQM()) - -class flangeQM(): - def Activated (self): - import dodoPM - dodoPM.fqm.show() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","flange.svg"),'MenuText':'QM for flanges'} -addCommand('flangeQM',flangeQM()) - -class valveQM(): - def Activated (self): - import dodoPM - dodoPM.vqm.show() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","valve.svg"),'MenuText':'QM for valves'} -addCommand('valveQM',valveQM()) - -class capQM(): - def Activated (self): - import dodoPM - dodoPM.cqm.show() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","cap.svg"),'MenuText':'QM for caps'} -addCommand('capQM',capQM()) + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import dodoPM + + # dodoPM.pqm.updatePL() + dodoPM.pqm.show() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertPipe", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_PipeQM", "QM for pipes"), + } + + +addCommand("Quetzal_PipeQM", pipeQM()) + + +# Quick Menu section + + +class elbowQM: + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import dodoPM + + dodoPM.eqm.show() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertElbow", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_ElbowQM", "QM for elbows"), + } + + +addCommand("Quetzal_ElbowQM", elbowQM()) + + +class flangeQM: + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import dodoPM + + dodoPM.fqm.show() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertFlange", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_FlangeQM", "QM for flanges"), + } + + +addCommand("Quetzal_FlangeQM", flangeQM()) + + +class valveQM: + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import dodoPM + + dodoPM.vqm.show() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertValve", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_ValveQM", "QM for valves"), + } + + +addCommand("Quetzal_ValveQM", valveQM()) + + +class capQM: + + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import dodoPM + + dodoPM.cqm.show() + + def GetResources(self): + return { + "Pixmap": "Quetzal_InsertCap", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_CapQM", "QM for caps"), + } + + +addCommand("Quetzal_CapQM", capQM()) diff --git a/CUtils.py b/CUtils.py index ca098af..77e1a85 100644 --- a/CUtils.py +++ b/CUtils.py @@ -1,131 +1,256 @@ -#(c) 2019 R. T. LGPL: part of dodo w.b. for FreeCAD +# SPDX-License-Identifier: LGPL-3.0-or-later -__license__="LGPL 3" +__license__ = "LGPL 3" # import FreeCAD modules -import FreeCAD, FreeCADGui,inspect , os - -# helper ------------------------------------------------------------------- -# FreeCAD TemplatePyMod module -# (c) 2007 Juergen Riegel LGPL - -def addCommand(name,cmdObject): - (list,num) = inspect.getsourcelines(cmdObject.Activated) - pos = 0 - # check for indentation - while(list[1][pos] == ' ' or list[1][pos] == '\t'): - pos += 1 - source = "" - for i in range(len(list)-1): - source += list[i+1][pos:] - FreeCADGui.addCommand(name,cmdObject,source) - -#--------------------------------------------------------------------------- + +import FreeCAD +import FreeCADGui + +from quetzal_config import addCommand + +QT_TRANSLATE_NOOP = FreeCAD.Qt.QT_TRANSLATE_NOOP + + +# --------------------------------------------------------------------------- # The command classes -#--------------------------------------------------------------------------- +# --------------------------------------------------------------------------- + class queryModel: + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import uForms + + form = uForms.QueryForm(FreeCADGui.Selection) + + def GetResources(self): + return { + "Pixmap": "Quetzal_QueryModel", + "Accel": "Q,M", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_QueryModel", "Query the model"), + "ToolTip": QT_TRANSLATE_NOOP("Quetzal_QueryModel", "Click objects to print infos"), + } - def Activated(self): - import FreeCAD, FreeCADGui, uForms - form = uForms.QueryForm(FreeCADGui.Selection) - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","query.svg"),'Accel':"Q,M",'MenuText':'query the model','ToolTip':'Click objects to print infos'} - class moveWorkPlane: - ''' - Tool to set the DraftWorkingPlane according existing geometry of - the model. - The normal of plane is set: - * 1st according the selected face, - * then according the plane defined by a curved edge, - * at last according the plane defined by two straight edges. - The origin is set: - * 1st according the selected vertex, - * then according the center of curvature of a curved edge, - * at last according the intersection of two straight edges. - ''' - def Activated(self): - import uCmd - uCmd.setWP() - - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","grid.svg"),'Accel':"A,W",'MenuText':'align Workplane','ToolTip':'Moves and rotates the drafting workplane with points, edges and faces'} - + """ + Tool to set the DraftWorkingPlane according existing geometry of + the model. + The normal of plane is set: + * 1st according the selected face, + * then according the plane defined by a curved edge, + * at last according the plane defined by two straight edges. + The origin is set: + * 1st according the selected vertex, + * then according the center of curvature of a curved edge, + * at last according the intersection of two straight edges. + """ + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import uCmd + + uCmd.setWP() + + def GetResources(self): + return { + "Pixmap": "Quetzal_MoveWorkPlane", + "Accel": "A,W", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_MoveWorkPlane", "Align workplane"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_MoveWorkPlane", + "Moves and rotates the drafting workplane with points, edges and faces", + ), + } + + class rotateWorkPlane: - def Activated(self): - import FreeCAD, FreeCADGui, uForms - form = uForms.rotWPForm() + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import uForms + + form = uForms.rotWPForm() + + def GetResources(self): + return { + "Accel": "R,W", + "Pixmap": "Quetzal_RotateWorkPlane", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_RotateWorkPlane", "Rotate workplane"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_RotateWorkPlane", "Spin the Draft working plane about one of its axes" + ), + } + - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","rotWP.svg"),'Accel':"R,W",'MenuText':'rotate Workplane','ToolTip':'Spin the Draft working plane about one of its axes'} - class offsetWorkPlane: - def Activated(self): - if hasattr(FreeCAD,'DraftWorkingPlane') and hasattr(FreeCADGui,'Snapper'): - import uCmd - s=FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Mod/Draft").GetInt("gridSize") - sc=[float(x*s) for x in [1,1,.2]] - arrow =uCmd.arrow(FreeCAD.DraftWorkingPlane.getPlacement(),scale=sc,offset=s) - from PySide.QtGui import QInputDialog as qid - offset=qid.getInt(None,'Offset Work Plane','Offset: ') - if offset[1]>0: - uCmd.offsetWP(offset[0]) - #FreeCADGui.ActiveDocument.ActiveView.getSceneGraph().removeChild(arrow.node) - arrow.closeArrow() - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","offsetWP.svg"),'Accel':"O,W",'MenuText':'offset Workplane','ToolTip':'Shifts the WP alongg its normal.'} - + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + if hasattr(FreeCAD, "DraftWorkingPlane") and hasattr(FreeCADGui, "Snapper"): + import uCmd + + s = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Mod/Draft").GetInt("gridSize") + sc = [float(x * s) for x in [1, 1, 0.2]] + arrow = uCmd.arrow(FreeCAD.DraftWorkingPlane.getPlacement(), scale=sc, offset=s) + from PySide.QtGui import QInputDialog as qid + + translate = FreeCAD.Qt.translate + + offset = qid.getInt( + None, + translate("Quetzal_OffsetWorkPlane", "Offset Work Plane"), + translate("Quetzal_OffsetWorkPlane", "Offset: "), + ) + if offset[1] > 0: + uCmd.offsetWP(offset[0]) + # FreeCADGui.ActiveDocument.ActiveView.getSceneGraph().removeChild(arrow.node) + arrow.closeArrow() + + def GetResources(self): + return { + "Pixmap": "Quetzal_OffsetWorkPlane", + "Accel": "O,W", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_OffsetWorkPlane", "Offset workplane"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_OffsetWorkPlane", "Shifts the WP along its normal." + ), + } + + class hackedL: - def Activated(self): - import uCmd - form = uCmd.hackedLine() + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import uCmd + + form = uCmd.hackedLine() + + def GetResources(self): + return { + "Pixmap": "Quetzal_HackedLine", + "Accel": "H,L", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_HackedLine", "Draw a Draft wire"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_HackedLine", + "WP is re-positioned at each point. Possible to spin and offset it.", + ), + } + - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","hackedL.svg"),'Accel':"H,L",'MenuText':'draw a DWire','ToolTip':'WP is re-positioned at each point. Possible to spin and offset it.'} - class moveHandle: - def Activated(self): - import uCmd - FreeCADGui.Control.showDialog(uCmd.handleDialog()) - #form = uCmd.handleDialog() + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import uCmd + + FreeCADGui.Control.showDialog(uCmd.handleDialog()) + # form = uCmd.handleDialog() + + def GetResources(self): + return { + "Pixmap": "Quetzal_MoveHandle", + "Accel": "M,H", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_MoveHandle", "Move objects"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_MoveHandle", "Move quickly objects inside viewport" + ), + } + - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","moveHandle.svg"),'Accel':"M,H",'MenuText':'Move objects','ToolTip':'Move quickly objects inside viewport'} - class dpCalc: - def Activated(self): - import uForms - FreeCADGui.Control.showDialog(uForms.dpCalcDialog()) + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + import uForms + + FreeCADGui.Control.showDialog(uForms.dpCalcDialog()) + + def GetResources(self): + return { + "Pixmap": "Quetzal_PressureLossCalculator", + "MenuText": QT_TRANSLATE_NOOP( + "Quetzal_PressureLossCalculator", "Pressure loss calculator" + ), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_PressureLossCalculator", + "Calculate pressure loss in 'pypes' using ChEDL libraries.\n" + "See __doc__ of the module for further information.", + ), + } - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","delta.svg"),'MenuText':'Pressure loss calculator','ToolTip':'Calculate pressure loss in "pypes" using ChEDL libraries.\n See __doc__ of the module for futher information.'} class selectSolids: - def Activated(self): - from fCmd import getSolids - if FreeCADGui.Selection.getSelection(): allDoc=False - else: allDoc=True - getSolids(allDoc) + def IsActive(self): + if FreeCAD.ActiveDocument is None: + return False + else: + return True + + def Activated(self): + from fCmd import getSolids + + if FreeCADGui.Selection.getSelection(): + allDoc = False + else: + allDoc = True + getSolids(allDoc) + + def GetResources(self): + return { + "Pixmap": "Quetzal_SelectSolids", + "MenuText": QT_TRANSLATE_NOOP("Quetzal_SelectSolids", "Select solids"), + "ToolTip": QT_TRANSLATE_NOOP( + "Quetzal_SelectSolids", + "Grab all solids or those partially selected\n to export in .step format", + ), + } - def GetResources(self): - return{'Pixmap':os.path.join(os.path.dirname(os.path.abspath(__file__)),"iconz","solids.svg"),'MenuText':'Select solids','ToolTip':'Grab all solids or those partially selected\n to export in .step format'} -#--------------------------------------------------------------------------- +# --------------------------------------------------------------------------- # Adds the commands to the FreeCAD command manager -#--------------------------------------------------------------------------- -addCommand('queryModel',queryModel()) -addCommand('moveWorkPlane',moveWorkPlane()) -addCommand('rotateWorkPlane',rotateWorkPlane()) -addCommand('offsetWorkPlane',offsetWorkPlane()) -addCommand('hackedL',hackedL()) -addCommand('moveHandle',moveHandle()) -addCommand('dpCalc',dpCalc()) -addCommand('selectSolids',selectSolids()) +# --------------------------------------------------------------------------- +addCommand("Quetzal_QueryModel", queryModel()) +addCommand("Quetzal_MoveWorkPlane", moveWorkPlane()) +addCommand("Quetzal_RotateWorkPlane", rotateWorkPlane()) +addCommand("Quetzal_OffsetWorkPlane", offsetWorkPlane()) +addCommand("Quetzal_HackedLine", hackedL()) +addCommand("Quetzal_MoveHandle", moveHandle()) +addCommand("Quetzal_PressureLossCalculator", dpCalc()) +addCommand("Quetzal_SelectSolids", selectSolids()) diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..e510e8c --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2863 @@ +# Doxyfile 1.9.8 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Quetzal" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 1.1.0 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = " Pipe & framing framework" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = ./iconz/quetzal.svg + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = YES + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = Python + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive(i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = SYSTEM + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, +# *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php, +# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be +# provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cxxm \ + *.cpp \ + *.cppm \ + *.c++ \ + *.c++m \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.ixx \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS +# tag is set to YES then doxygen will add the directory of each input to the +# include path. +# The default value is: YES. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /