FreeCAD Render Workbench 安装与使用教程-优快云博客

FreeCAD Render Workbench 安装与使用教程

FreeCAD-render The Render workbench 项目地址: https://gitcode.com/gh_mirrors/fr/FreeCAD-render

1. 项目的目录结构及介绍

FreeCAD Render Workbench 的目录结构如下：

FreeCAD-render/
├── github/workflows/       # GitHub Actions 工作流配置文件
├── docs/                   # 项目文档目录
├── licenses/               # 许可证文件目录
├── materials/              # 材质文件目录
├── renderplugin/           # 渲染插件目录
├── templates/              # 模板文件目录
├── wheelhouse/             # 轮子库目录
├── .gitignore              # Git 忽略文件
├── pre-commit-config.yaml  # pre-commit 配置文件
├── pylintrc                # Pylint 配置文件
├── InitGui.py              # 初始化 GUI 文件
├── LICENSE                 # 许可证文件
├── README.md               # 项目说明文件
├── package.xml             # 包配置文件
└── pyproject.toml          # Python 项目配置文件

目录详细介绍

github/workflows/: 包含用于自动化构建和测试的 GitHub Actions 配置文件。
docs/: 包含项目的相关文档，帮助用户更好地理解和使用项目。
licenses/: 包含项目的许可证文件。
materials/: 包含渲染所需的材质文件。
renderplugin/: 包含渲染引擎的插件文件。
templates/: 包含预配置的渲染模板文件。
wheelhouse/: 包含项目的依赖包。
.gitignore: 指定 Git 忽略的文件和目录。
pre-commit-config.yaml: pre-commit 钩子的配置文件，用于代码提交前的检查。
pylintrc: Pylint 静态代码分析工具的配置文件。
InitGui.py: 用于初始化 FreeCAD GUI 的 Python 脚本。
LICENSE: 项目的许可证文件，说明项目的使用权限。
README.md: 项目的主说明文件，包含项目简介、安装和使用方法等。
package.xml: 包配置文件，用于 FreeCAD 插件的安装。
pyproject.toml: Python 项目配置文件，用于定义项目的依赖和构建配置。

2. 项目的启动文件介绍

项目的启动文件主要是 InitGui.py，该文件负责在 FreeCAD 中初始化 Render Workbench 的 GUI 组件。

InitGui.py

# InitGui.py 示例代码
class RenderWorkbench(Workbench):
    MenuText = "Render"
    ToolTip = "A workbench for high-quality rendering"
    def Initialize(self):
        import rendercommands
        self.appendToolbar("Render Tools", rendercommandscommands)
        self.appendMenu("Render", rendercommandscommands)
    def GetClassName(self):
        return "Gui::PythonWorkbench"
FreeCADGui.addWorkbench(RenderWorkbench())

启动文件功能

MenuText: 定义工作台在菜单中显示的名称。
ToolTip: 定义工作台的提示信息。
Initialize: 初始化工作台时调用的方法，用于加载工具栏和菜单项。
GetClassName: 返回工作台的类名。

3. 项目的配置文件介绍

项目的配置文件主要包括 pyproject.toml 和 package.xml。

pyproject.toml

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "FreeCAD-render"
version = "0.1.0"
description = "A FreeCAD workbench for high-quality rendering"
authors = [
    { name="FreeCAD Community", email="info@freecadweb.org" }
]
license = { file="LICENSE" }
requires-python = ">=3.6"
dependencies = [
    "numpy",
    "Pillow"
]

pyproject.toml 功能

build-system: 定义项目的构建系统配置。
project: 定义项目的基本信息，如名称、版本、描述、作者、许可证和依赖项。

package.xml

<?xml version="1.0" encoding="UTF-8"?>
<package format="2">
  <name>FreeCAD-render</name>
  <version>0.1.0</version>
  <description>A FreeCAD workbench for high-quality rendering</description>
  <maintainer email="info@freecadweb.org">FreeCAD Community</maintainer>
  <license>GPLv3</license>
  <url>https://github.com/FreeCAD/FreeCAD-render</url>
  <author>FreeCAD Community</author>
  <buildtool_depend>python</buildtool_depend>
  <buildtool_depend>setuptools</buildtool_depend>
  <build_depend>numpy</build_depend>
  <build_depend>Pillow</build_depend>
  <exec_depend>FreeCAD</exec_depend>
</package>