Files
make-cad/docs/api/make_rectangle_rface.md
T
倪旌哲 b80a323445 feat: Add automation scripts for updating API exports and syncing documentation
- Introduced `make_export.py` to automate the update of `__init__.py` with new API functions from `operations.py` and `evolve.py`.
- Implemented function extraction, categorization, and generation of import statements and aliases.
- Added `ragflow_sync.py` for synchronizing SimpleCADAPI documentation with RAGFlow database, including chunking markdown files and managing dataset.
- Updated package version to 1.0.5 in `uv.lock`.
2025-07-24 02:11:44 +08:00

56 lines
1.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# make_rectangle_rface
## API定义
```python
def make_rectangle_rface(width: float, height: float, center: Tuple[float, float, float] = (0, 0, 0), normal: Tuple[float, float, float] = (0, 0, 1)) -> Face
```
*来源文件: operations.py*
## API作用
创建矩形面对象,用于构建实心矩形截面。可以用于拉伸、旋转等操作来创建
立方体、棱柱等三维几何体。面积等于width×height。
## API参数说明
### width
- **类型**: `float`
- **说明**: 矩形的宽度,必须为正数
### height
- **类型**: `float`
- **说明**: 矩形的高度,必须为正数
### center
- **类型**: `Tuple[float, float, float], optional`
- **说明**: 矩形中心坐标 (x, y, z), 默认为 (0, 0, 0)
### normal
- **类型**: `Tuple[float, float, float], optional`
- **说明**: 矩形所在平面的法向量 (x, y, z), 默认为 (0, 0, 1) 表示XY平面
## 返回值说明
Face: 创建的面对象,表示一个实心的矩形面
## 异常
- **ValueError**: 当宽度或高度小于等于0或其他参数无效时抛出异常
## API使用例子
```python
# 创建标准矩形面
rect_face = make_rectangle_rface(5.0, 3.0)
area = rect_face.get_area() # 面积为5×3=15
# 创建用于拉伸的矩形截面
profile = make_rectangle_rface(2.0, 2.0)
box = extrude_rsolid(profile, (0, 0, 1), 3.0)
```