PyGLM 项目使用教程

1. 项目目录结构及介绍

PyGLM 是一个用于图形编程的数学库，其目录结构如下：

PyGLM/
├── glm/
│   ├── __init__.py
│   ├── PyGLM.cpp
│   └── ...
├── setup.py
├── README.md
├── LICENSE
└── ...

目录结构介绍

• glm/: 包含 PyGLM 的核心代码文件，其中 __init__.py 是 Python 包的初始化文件，PyGLM.cpp 是 C++ 扩展的源文件。
• setup.py: 项目的安装脚本，用于编译和安装 PyGLM 扩展。
• README.md: 项目的说明文档，包含项目的基本信息、安装方法和使用示例。
• LICENSE: 项目的许可证文件，说明项目的开源许可协议。

2. 项目的启动文件介绍

PyGLM 项目没有传统的“启动文件”，因为它是一个库，而不是一个独立的应用程序。用户通过导入 glm 模块来使用 PyGLM 的功能。

使用示例

import glm

# 创建一个 3 维向量
v = glm.vec3(1.0, 2.0, 3.0)

# 打印向量
print(v)

3. 项目的配置文件介绍

PyGLM 项目的配置主要通过 setup.py 文件进行管理。setup.py 文件负责编译和安装 PyGLM 的 C++ 扩展。

setup.py 文件介绍

setup.py 文件的主要内容如下：

from setuptools import setup, Extension

module1 = Extension('glm',
                    sources = ['PyGLM.cpp'],
                    include_dirs=["glm/"],
                    extra_compile_args=['-std=c++11'])

setup(name='PyGLM',
      version='2.7.1',
      description='OpenGL Mathematics library for Python',
      long_description='...',
      long_description_content_type='text/markdown',
      url='https://github.com/Zuzu-Typ/PyGLM',
      author='Zuzu_Typ',
      author_email='[e-mail]',
      license='zlib/libpng license',
      classifiers=[...],
      keywords='...',
      packages=['glm-stubs'],
      include_package_data=True,
      ext_modules = [module1])

配置文件说明

• Extension: 定义了 C++ 扩展模块 glm，指定了源文件 PyGLM.cpp 和包含目录 glm/。
• setup: 配置了项目的名称、版本、描述、作者、许可证等信息，并指定了扩展模块 module1。

通过 setup.py 文件，用户可以使用 pip install . 命令来安装 PyGLM 库。

总结

PyGLM 是一个功能强大的数学库，适用于图形编程。通过了解其目录结构、启动文件和配置文件，用户可以更好地理解和使用该库。