¶ 使用Python脚本
¶
命令
BIMPYTHON
¶ 关于BIMPYTHON
BIMPYTHON命令使您能够使用合适的.py Python脚本在CSCAD 草图快手中查询和管理模型中的数据。
Python 脚本可以像获取对象和 BIM 实体的数量和相关属性一样简单，也可以像基于可用模型参数实现一系列计算一样复杂。
CSCAD不附带Python Shell，因此需要在文本或代码编辑器应用程序中准备脚本。
Python 编程语言及其标准库嵌入在 CSCAD 草图快手 中，因此除非您有希望在脚本中使用的自定义包和库，否则您无需单独安装它们。
CSCAD 草图快手安装程序中提供了几个Python脚本示例。
¶ 过程：使用 BIMPYTHON 模块设置 Python 脚本
- 在访问 API 之前，导入或“调用”您希望在脚本中使用的任何所需模块。
如果它们不是 Python 标准库的一部分，请确保事先单独安装它们。
您可以“导入”标准模块，例如数学，并“导入”外部模块，例如 Pyplot，它是 Matplotlib 包中的函数集合：
import math
import matplotlib.pyplot as plt
- “调用”所需的库后，下一步是访问 API，以便查询 CSCAD 模型中的元素。这是 BIM 对象的范围，用作模型的入口点。
从cscad 模块导入current_model：
from cscad.bim import current_model
- 现在，您可以使用这些示例语句查询模型。
# Display info about the lengths of walls in the model
lengths = [wall.prop('Length') for wall in current_model().filter(Type='Wall')]
print(f'wall lengths. max: {max(lengths)}, avg: {sum(lengths)/len(lengths)}') # Create a selection and print the objects
current_model().filter(Type='Wall', IsExternal=True).select()
for wall in bim_model.filter(Type='Wall', IsExternal=True, Length=max(lengths)):
print(wall) cscad.bim.Objects的映射器是可链接的。这是获取靠近墙壁的屋顶部分的示例：
# Get all parts of roof within 40cm range of all walls
roof_parts = current_model().filter(Type='Roof').parts()
roof_parts_close_to_wall = current_model().filter(Type='Wall').within_distance(40, 'cm', search_range=roof_parts) 而这是要过滤的函数语句的示例：
# Filter roof parts longer than 50 project units
def is_long(obj):
return obj.prop('Length') > 50
roof_parts.filter(is_long) 您还可以以各种格式导出和显示数据：
# create a dictionary list
wall_info = [
{ 'Handle': wall.get_property('Handle'),
'Length': wall.get_property('Length'),
'Height': wall.get_property('Height')
} for wall in current_model().filter(Type='Wall')] # export to .json
import json
file = open('path/to/file.json', 'w+')
file.write(json.dumps(wall_info, indent=4))
file.close() # plotting a histogram
import matplotlib.pyplot as plt
import pandas as pd
df = pd.DataFrame(wall_info)
df.hist();
plt.show() # export to .csv
df.to_csv(r'path/to/file.csv', index = False, header=True) 有关CSCAD API及其各种类的更多信息，请访问下面的API章节。
¶ 过程：执行 Python 脚本
- 打开一个新的或 CSCAD 文件，在其中运行 Python 脚本。
- 在命令行中键入 BIMPYTHON，然后按 Enter 键。
- 将显示一个对话框，您可以在其中选择 Python 脚本文件 （*.py）。选择它并单击“打开”以执行该文件。
- 除非您指定了要在 CSCAD 外部的外部程序中导出或显示的数据，否则 CSCAD 会在命令行中报告输出。
¶ 参考
类和语法
get_property（prop_name)
返回具有给定名称的对象的属性值。
set_property（prop_name，value)
设置属性名称的值 （prop_name）。
distance_to（ other_obj， units='mm'， distance_mode='exact' )
- 计算两个对象之间的距离。
- 参数单位选项：任何单位都以单位形式（“厘米”、“英尺”、“秒差距”等）和这些缩写：“毫米”、“厘米”、“米”、“公里”、“英尺”表示。
- 参数distance_mode的选项：“bbox_center”、“bbox”，精确”。
parts（）
返回此对象的子元素。
parent（）
与 parts（） 相反，返回此子元素的父对象。
plies（）
返回关联的 Plies 可迭代对象。
within_distance（ distance， units='mm'， distance_mode='exact'， search_range=bim_model )
- 返回参数距离范围内的对象。
- 参数单位的选项：请参阅distance_to。
- 参数distance_mode的选项：请参阅distance_to。
openings（）
返回此对象的关联开口。
spaces（）
返回此对象的关联空格。
bounding_elements（）
返回此（空格）对象的关联边界元素。
select（）
将对象添加到所选内容。
deselect（）
从选择中删除对象。
__eq__（） 和 __hash__（）
使对象可与例如 python 集或字典进行互操作。
class cscad.bim.Objects
定义 CSCAD 草图快手 对象的集合
- filter（ 函数 )
- 使用函数参数筛选此范围。
- filter（ **条件 )
- 使用作为关键字参数给出的条件过滤此范围。
- parts（）
- 返回此范围内所有元素的部分。
- parents（）
- 返回此区域中元素的父对象。
- within_distance（ distance， units='undefined'， distance_mode='exact'， search_range=bim_model )
- 返回与此范围内任何对象的距离范围内的对象。
- openings（）
- 返回这些对象的关联开口。
- spaces（）
- 返回这些对象的关联空间。
- bounding_elements（）
- 返回这些（空间）对象的关联边界元素。
- select（）
- 将对象添加到所选内容。
- deselect（）
- 从选择中删除对象。
- __len__ （）
- 返回此区域中的对象数。
cscad.bim.list_properties（obj)
返回传递的实体或层的可用属性的列表。
cscad.bim.current_model（）
返回活动文档的模型空间中的对象。
类 cscad.bim.Plies
层对象的索引、可切片容器。
__iter__（）
__getitem__（ 索引 ）
__getitem__（切片）
__len__（）
类 cscad.bim.Ply
单个层物体。
get_property（prop_name)
返回具有给定名称的 Ply 对象的属性值。