Dev

.pylintrc

@@ -13,6 +13,7 @@ init-hook='import sys; sys.path.append("/usr/lib/freecad/lib"); sys.path.append(
 # paths.
 ignore=CVS
 
+
 # Python version
 # 2024-02-15: we target 3.8, same as FreeCAD 0.21
 py-version=3.8
@@ -39,6 +40,9 @@ unsafe-load-any-extension=no
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code
 extension-pkg-allow-list=PySide2,
+                         PySide6,
+                         PyQt5,
+                         PyQt6,
                          PySide,
                          FreeCAD,
                          FreeCADGui,
@@ -163,6 +167,8 @@ callbacks=cb_, _cb,
           execute,
           attach,
           updateData,
+          IsActive,
+          closeEvent,
           render,
           write_camera,
           write_mesh,
@@ -240,7 +246,7 @@ class-rgx=[A-Z_][a-zA-Z0-9]+$
 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
 
 # Regular expression matching correct method names
-method-rgx=([a-z_][a-z0-9_]{2,}$|GetResources|Activated|onDocumentRestored|onChanged|onDelete|getDisplayModes|getDefaultDisplayMode|setDisplayMode|isShow|getIcon|setEdit|setupContextMenu|claimChildren|Initialize|GetClassName|updateData|GetCommands)
+method-rgx=([a-z_][a-z0-9_]{2,}$|GetResources|Activated|onDocumentRestored|onChanged|onDelete|getDisplayModes|getDefaultDisplayMode|setDisplayMode|isShow|getIcon|setEdit|setupContextMenu|claimChildren|Initialize|GetClassName|updateData|GetCommands|IsActive|closeEvent)
 
 # Regular expression which should only match function or class names that do
 # not require a docstring.

InitGui.py

@@ -4,7 +4,7 @@
 # *                                                                         *
 # *   This program is free software; you can redistribute it and/or modify  *
 # *   it under the terms of the GNU Lesser General Public License (LGPL)    *
-# *   as published by the Free Software Foundation; either version 2 of     *
+# *   as published by the Free Software Foundation; either version 2.1 of   *
 # *   the License, or (at your option) any later version.                   *
 # *   for detail see the LICENCE text file.                                 *
 # *                                                                         *
@@ -30,11 +30,17 @@ class RenderWorkbench(Gui.Workbench):
     def __init__(self):
         """Initialize object."""
         # pylint: disable=import-outside-toplevel
-        from PySide.QtCore import QT_TRANSLATE_NOOP
+        from Render.utils import translate
+        from Render import TRANSDIR
+
+        from FreeCADGui import addLanguagePath, updateLocale
+
+        addLanguagePath(TRANSDIR)
+        updateLocale()
 
         self.__class__.MenuText = "Render"
-        self.__class__.ToolTip = QT_TRANSLATE_NOOP(
-            "Render",
+        self.__class__.ToolTip = translate(
+            "Workbench",
             "The Render workbench is a "
             "modern replacement for "
             "the Raytracing workbench",
@@ -102,11 +108,11 @@ def Initialize(self):
         """
         # pylint: disable=import-outside-toplevel
         from PySide.QtCore import QT_TRANSLATE_NOOP
+        from Render.utils import translate
         from FreeCAD import Console
-        from FreeCADGui import addIconPath, addPreferencePage, addLanguagePath
-        from Render import RENDER_COMMANDS, TRANSDIR, ICONDIR, PreferencesPage
+        from FreeCADGui import addIconPath, addPreferencePage
+        from Render import RENDER_COMMANDS, ICONDIR, PreferencesPage
 
-        addLanguagePath(TRANSDIR)
         self.appendToolbar(
             QT_TRANSLATE_NOOP("Workbench", "Render"), RENDER_COMMANDS
         )
@@ -115,9 +121,7 @@ def Initialize(self):
         )
         addIconPath(ICONDIR)
         addPreferencePage(PreferencesPage, "Render")
-        msg = (
-            QT_TRANSLATE_NOOP("Render", "Loading Render module... done") + "\n"
-        )
+        msg = translate("Workbench", "Loading Render module... done") + "\n"
         Console.PrintLog(msg)
 
     def GetClassName(self):  # pylint: disable=no-self-use

README.md

@@ -78,7 +78,8 @@ FreeCAD model is just a 4-steps process:
    src=./Render/resources/icons/RenderView.svg height=32>
 
 
-3. **Set your point of view:** [Navigate in FreeCAD 3D View](https://wiki.freecadweb.org/Manual:Navigating_in_the_3D_view)
+3. **Set your point of view:**
+[Navigate in FreeCAD 3D View](https://wiki.freecadweb.org/Manual:Navigating_in_the_3D_view)
    to the desired position and switch to _Perspective_ mode.
 
 
@@ -90,7 +91,8 @@ FreeCAD model is just a 4-steps process:
 <br /> **...and you should get a first rendering of your model.** <br />
 
 
-You may also find a short tutorial on how to get started here: https://www.youtube.com/watch?v=8wsOnwjKG9M
+You may also find a short tutorial on how to get started here:
+https://www.youtube.com/watch?v=8wsOnwjKG9M
 
 
 ## More features
@@ -108,11 +110,14 @@ These adjustments should take place between steps 2 and 3.
 ## FAQ
 ### How to solve library conflicts within a FreeCAD AppImage
 
-When using an AppImage, you might be confronted with an error like this on execution of the "Render" command:
+When using an AppImage, you might be confronted with an error like this on
+execution of the "Render" command:
 
 `.../usr/lib/libstdc++.so.6: version 'CXXABI_1.3.15' not found`
 
-This is due to different library versions of your host system and the AppImage. As a workaround, provide your host libraries to the rendering command using the "Prefix" field in the Render WB configuration:
+This is due to different library versions of your host system and the AppImage.
+As a workaround, provide your host libraries to the rendering command using the
+"Prefix" field in the Render WB configuration:
 
 `env LD_LIBRARY_PATH="/usr/lib64"`
 
@@ -132,3 +137,11 @@ This project is covered by FreeCAD [Code of
 Conduct](https://github.com/FreeCAD/FreeCAD/blob/master/CODE_OF_CONDUCT.md).
 Please comply to this code in all your contributions (issue openings, pull
 requests...).
+
+## License
+
+The Render Workbench is licensed under the terms of GNU Lesser General Public
+License (GNU LGPL) version 2 or any later version, except plugins `help` and
+`materialx` (located in [Render/plugins](./Render/plugins) directory), that are
+licensed under the terms of GNU General Public License (GNU GPL) version 3 or
+any later version. See [LICENSE](./LICENSE) file for more information.

Render/__init__.py

@@ -4,7 +4,7 @@
 # *                                                                         *
 # *   This program is free software; you can redistribute it and/or modify  *
 # *   it under the terms of the GNU Lesser General Public License (LGPL)    *
-# *   as published by the Free Software Foundation; either version 2 of     *
+# *   as published by the Free Software Foundation; either version 2.1 of   *
 # *   the License, or (at your option) any later version.                   *
 # *   for detail see the LICENCE text file.                                 *
 # *                                                                         *
@@ -25,11 +25,7 @@
 
 It imports all the public symbols which make up the Render Workbench API.
 """
-
-# First ensure we've got a Python virtual environment
-from Render.virtualenv import ensure_rendervenv  # noqa: F401
-
-ensure_rendervenv()
+import FreeCAD as App
 
 from Render.constants import (  # noqa: F401
     WBDIR,
@@ -82,12 +78,12 @@
 )
 from Render.commands import RENDER_COMMANDS  # noqa: F401
 from Render.prefpage import PreferencesPage  # noqa: F401
-from Render.subcontainer import start_help  # TODO
 
-if PARAMS.GetBool("MaterialX"):
-    from Render.materialx import import_materialx  # noqa: F401
+from Render.virtualenv import ensure_rendervenv  # noqa: F401
+
+# Ensure we've got a Python virtual environment
+ensure_rendervenv()
 
-import FreeCAD as App
 
 if App.GuiUp:
     import FreeCADGui as Gui

Render/base.py

@@ -4,7 +4,7 @@
 # *                                                                         *
 # *   This program is free software; you can redistribute it and/or modify  *
 # *   it under the terms of the GNU Lesser General Public License (LGPL)    *
-# *   as published by the Free Software Foundation; either version 2 of     *
+# *   as published by the Free Software Foundation; either version 2.1 of   *
 # *   the License, or (at your option) any later version.                   *
 # *   for detail see the LICENCE text file.                                 *
 # *                                                                         *

Render/camera.py

@@ -4,7 +4,7 @@
 # *                                                                         *
 # *   This program is free software; you can redistribute it and/or modify  *
 # *   it under the terms of the GNU Lesser General Public License (LGPL)    *
-# *   as published by the Free Software Foundation; either version 2 of     *
+# *   as published by the Free Software Foundation; either version 2.1 of   *
 # *   the License, or (at your option) any later version.                   *
 # *   for detail see the LICENCE text file.                                 *
 # *                                                                         *
@@ -85,54 +85,58 @@ class Camera(PointableFeatureMixin, FeatureBase):
             "App::PropertyEnumeration",
             "Camera",
             QT_TRANSLATE_NOOP(
-                "Render", "Type of projection: Perspective/Orthographic"
+                "App::Property", "Type of projection: Perspective/Orthographic"
             ),
             ("Perspective", "Orthographic"),
         ),
         "ViewportMapping": Prop(
             "App::PropertyEnumeration",
             "Camera",
-            QT_TRANSLATE_NOOP("Render", "(See Coin documentation)"),
+            QT_TRANSLATE_NOOP("App::Property", "(See Coin documentation)"),
             VIEWPORTMAPPINGENUM,
         ),
         "AspectRatio": Prop(
             "App::PropertyFloat",
             "Camera",
-            QT_TRANSLATE_NOOP("Render", "Ratio width/height of the camera."),
+            QT_TRANSLATE_NOOP(
+                "App::Property", "Ratio width/height of the camera."
+            ),
             1.0,
         ),
         "NearDistance": Prop(
             "App::PropertyDistance",
             "Camera",
-            QT_TRANSLATE_NOOP("Render", "Near distance, for clipping"),
+            QT_TRANSLATE_NOOP("App::Property", "Near distance, for clipping"),
             0.0,
         ),
         "FarDistance": Prop(
             "App::PropertyDistance",
             "Camera",
-            QT_TRANSLATE_NOOP("Render", "Far distance, for clipping"),
+            QT_TRANSLATE_NOOP("App::Property", "Far distance, for clipping"),
             200.0,
         ),
         "FocalDistance": Prop(
             "App::PropertyDistance",
             "Camera",
-            QT_TRANSLATE_NOOP("Render", "Focal distance"),
+            QT_TRANSLATE_NOOP("App::Property", "Focal distance"),
             100.0,
         ),
         "Height": Prop(
             "App::PropertyLength",
             "Camera",
-            QT_TRANSLATE_NOOP("Render", "Height, for orthographic camera"),
+            QT_TRANSLATE_NOOP(
+                "App::Property", "Height, for orthographic camera"
+            ),
             5.0,
         ),
         "HeightAngle": Prop(
             "App::PropertyAngle",
             "Camera",
             QT_TRANSLATE_NOOP(
-                "Render",
+                "App::Property",
                 "Height angle, for perspective camera, in "
                 "degrees. Important: This value will be sent as "
-                "'Field of View' to the renderers. Please note it is a"
+                "'Field of View' to the renderers. Please note it is a "
                 "*vertical* field-of-view.",
             ),
             60,

Render/coin.py

@@ -4,7 +4,7 @@
 # *                                                                         *
 # *   This program is free software; you can redistribute it and/or modify  *
 # *   it under the terms of the GNU Lesser General Public License (LGPL)    *
-# *   as published by the Free Software Foundation; either version 2 of     *
+# *   as published by the Free Software Foundation; either version 2.1 of   *
 # *   the License, or (at your option) any later version.                   *
 # *   for detail see the LICENCE text file.                                 *
 # *                                                                         *