cmdx 项目使用与配置教程

cmdx 项目使用与配置教程

cmdx Fast and persistent subset of maya.cmds 项目地址: https://gitcode.com/gh_mirrors/cm/cmdx

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

cmdx 是一个针对 Maya Python API 2.0 的高性能 Python 包装器，它的目录结构如下：

• docs/：包含项目的文档源文件。
• examples/：包含使用 cmdx 的示例代码。
• plots/：包含性能测试的图表数据。
• .gitignore：定义了 Git 忽略的文件和目录。
• Dockerfile：用于创建 Docker 容器的文件。
• LICENSE：项目的许可证文件，采用的是 BSD-2-Clause 许可。
• README.md：项目的自述文件，包含项目的基本信息和说明。
• apitypes.json：定义了 API 类型的 JSON 文件。
• build_docs.py 和 build_docs.sh：构建文档的脚本文件。
• build_livedocs.py：构建实时文档的脚本文件。
• cmdt.py：与 cmdx 相关的内部模块。
• cmdx.py：cmdx 的主模块文件。
• generate_cmdt.py：生成 cmdt 的脚本文件。
• plot.py：用于绘制性能测试图表的脚本文件。
• run_docs.py：运行文档的脚本文件。
• run_tests.py 和 run_tests.sh：运行测试的脚本文件。
• setup.cfg 和 setup.py：项目的设置和安装脚本文件。
• test_performance.py：性能测试的脚本文件。
• tests.py：单元测试的脚本文件。

2. 项目的启动文件介绍

cmdx 项目的启动主要是通过 cmdx.py 文件。该文件包含了 cmdx 的所有功能和接口，用户可以通过 pip install cmdx 命令安装该项目，或者在项目中直接导入 cmdx.py。

以下是一个简单的启动示例：

import cmdx

# 创建一个变换节点
node = cmdx.createNode('transform', name='myNode')

# 获取节点属性
attribute_value = cmdx.getAttr(node + '.tx')

# 设置节点属性
cmdx.setAttr(node + '.tx', 10)

3. 项目的配置文件介绍

cmdx 项目中的配置主要是通过环境变量和模块内的全局变量来控制的。在 cmdx.py 文件中，定义了一些可以控制 cmdx 行为的全局变量，如下所示：

• CMDX_ENABLE_NODE_REUSE：启用节点重用。
• CMDX_ENABLE_PLUG_REUSE：启用插头重用。
• CMDX_ENABLE_UNDO：启用撤销操作。
• CMDX_TIMINGS：启用性能计时。
• CMDX_MEMORY_HOG_MODE：启用内存占用模式。
• CMDX_IGNORE_VERSION：忽略版本检查。
• CMDX_ROGUE_MODE：启用 rogue 模式。
• CMDX_SAFE_MODE：启用安全模式。

用户可以根据自己的需求，在代码中设置这些变量的值，以改变 cmdx 的默认行为。

例如，如果用户希望启用节点重用功能，可以在导入 cmdx 后设置：

import cmdx

cmdx.CMDX_ENABLE_NODE_REUSE = True

# 现在创建的节点将启用重用功能
node = cmdx.createNode('transform', name='myNode')

以上就是 cmdx 项目的目录结构、启动文件和配置文件的介绍。通过这些基本介绍，用户可以更好地理解和使用 cmdx 项目。

cmdx Fast and persistent subset of maya.cmds 项目地址: https://gitcode.com/gh_mirrors/cm/cmdx