Pythonスクリプトの使用

PIPコマンドについて

PIPコマンドを使用すると、Python標準ライブラリに含まれていないカスタムパッケージなどのPythonパッケージをインストールおよび管理できます。

BIMPYTHONコマンドについて

BIMPYTHONコマンドを使用すると、適切なPython(*.py)スクリプトを使用して、BricsCAD BIM内のモデルのデータを照会および管理できます。

Pythonスクリプトには、オブジェクトやBIM図形の数量および関連プロパティの取得などシンプルなものから、使用可能なモデルパラメータに基づいた一連の計算の実装など精巧なものまで、さまざまなスクリプトがあります。

BricsCAD BIM のインストーラーには、いくつかのサンプルPythonスクリプトが含まれており、 C:\Users\%username%\AppData\Roaming\Bricsys\BricsCAD\V27x64\ja_JP\Support\Bim\Scripts フォルダーに配置されます。

  • calculate_weight.pyを使用すると、図形の体積と密度に基づいて重量を計算できます。
  • schedules.pyを使用すると、カスタム集計表を生成し、CSVファイルに書き出すことができます。
  • set_name_and_number.pyは、階、BIMタイプ、およびそれらの位置に基づいて、名前と番号のプロパティに値を設定します。
  • tag_to_number.pyを使用すると、IFCの読み込み後に名前の一部として含まれているID番号を、番号プロパティにコピーできます。
  • thermal_transmittance.pyは、各層の熱伝導率に基づいて熱貫流率を計算します。

BIMプロジェクトブラウザパネルのファイルタブからスクリプトを使用することもできます(「BIMプロジェクトブラウザパネル」の記事を参照)。

注:
  • BricsCADにはPythonシェルが付属していないため、スクリプトはテキストエディターまたはコードエディターで作成する必要があります。
  • BricsCAD BIMにはPythonプログラミング言語と標準ライブラリが組み込まれているので、別途インストールする必要はありません。ただし、カスタムパッケージやライブラリをスクリプトで使用される場合は、別途インストールしてください。

Pythonスクリプトの実行

  1. Pythonスクリプトを実行するには、BricsCADファイルを新規作成、または既存のファイルを開きます。
  2. コマンドラインに BIMPYTHON と入力し、Enter キーを押します。

    Pythonスクリプトを選択ダイアログボックスが開きます。

  3. PYファイルを選択し、開くをクリックして実行します。
    注: スクリプトにインストールされていないモジュールが含まれている場合、BricsCADはそのモジュール名を一覧表示するメッセージを表示します。PIPコマンドを使用して、これらのモジュールをインストールします。
  4. BricsCAD 以外の外部のプログラムにデータを出力または表示するよう指定していない限り、BricsCAD は出力結果をコマンドラインに表示します。

Pythonスクリプトの設定

任意のテキストエディターまたはコードエディターを使用して、スクリプトを作成します。新しいファイルを開き、以下の例を参考に必要なコードを記述して、拡張子「.py」で保存します。

  1. APIにアクセスする前に、スクリプトに入れたいモジュールを読み込みまたは「コール」します。
    注: モジュールがPython標準ライブラリに含まれていない場合は、事前に別途インストールされていることを確認してください。これには、PIPコマンドを使用できます。

    mathなどの標準モジュールは「import」で読み込み、matplotlibパッケージに含まれる関数群であるPyplotなどの外部モジュールは「import as」で読み込むことができます。

    import math import matplotlib.pyplot as plt
  2. 必要なライブラリを「コール」したら、次のステップではAPIにアクセスして、BricsCADモデル内の要素を照会します。これは BIM オブジェクトの範囲を表し、モデルへのエントリーポイントとして機能します。

    bricscad.bimモジュールからcurrent_modelを読み込みます。

    from bricscad.bim import current_model
  3. これで、以下のステートメントの例を使用してモデルのデータを照会できます。
    # モデル内の壁の長さに関する情報を表示する
    lengths = [wall.prop('Length')current_model().filter(Type='Wall')] の壁用印刷(F'壁の長さ。max: {max(lengths)}, avg: {sum(lengths)/len(lengths)}') 
    # 選択範囲を作成し、オブジェクトを印刷する
    current_model().filter(Type='Wall',IsExternal=True).select()
    bim_model.filter(Type='Wall',IsExternal=True, Length=max(lengths)):
        印刷(壁面) 

    bricscad.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) 
  4. また、データを様々な形式で書き出して表示することもできます。

    # 辞書リストを作成する
    wall_info = [
        { 'ハンドル': wall.get_property('ハンドル'),'長さ': wall.get_property('長さ'),'高さ': wall.get_property('高さ')} for wall in current_model().filter(Type='Wall')] 
    # .json への書き出し 
    import json 
    file = open('C:\Users\%username%\Desktop\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() 
    # .csv への書き出し 
    df.to_csv(r'C:\Users\%username%\Desktop\file.csv', index = False) 

BricsCADのAPIクラスと構文

get_property(prop_name)
指定された名前のオブジェクトのプロパティ値を返します。
set_property(prop_name, value)
プロパティ名(prop_name)に値を設定します。
distance_to(other_obj, units='mm', distance_mode='exact')
  • 2つのオブジェクト間の距離を計算します。
  • 引数unitsに指定可能なオプション:INSUNITS(「センチ」、「フィート」、「パーセク」など)これらの略語からなる「mm」、「cm」、「m」、「km」および「ft」
  • 引数のオプションdistance_mode:「bbox_center」、「bbox」、「exact」
parts()
このオブジェクトのサブ要素を返します。
parent()
parts()の逆で、このサブ要素の親オブジェクトを返します。
plies()
反復可能なオブジェクトに関連付けられたPliesを返します。
within_distance(distance, unit='mm', distance_mode='exact', search_range=bim_model)
  • 引数distanceで指定した距離内にあるオブジェクトを返します。
  • 引数のオプションunits:distance_to を参照。
  • 引数のオプションdistance_mode::distance_to を参照。
openings()
このオブジェクトの関連する開口部を返します。
spaces()
このオブジェクトの関連する空間を返します。
bounding_elements()
この(空間)オブジェクトの関連する境界要素を返します。
select()
オブジェクトを選択に追加します。
deselect()
オブジェクトを選択から削除します。
__eq__()and __hash__()
オブジェクトをPythonのsetやdictionaryなどと相互運用できるようにします。
クラス bricscad.bim.Objects
BricsCAD BIMオブジェクトのコレクションを定義します。
filter(function)
関数パラメータを使用して、この範囲をフィルタリングします。
filter( **conditions )
キーワード引数として指定された条件を使用して、この範囲をフィルタリングします。
parts()
この範囲内のすべての要素に含まれる部品を返します。
parents()
この範囲内の要素の親オブジェクトを返します。
within_distance(distance, unit='undefined', distance_mode='exact', search_range=bim_model)
この範囲内のオブジェクトまでの距離内にあるオブジェクトを返します。
openings()
このオブジェクトの関連する開口部を返します。
spaces()
このオブジェクトの関連する空間を返します。
bounding_elements()
この(空間)オブジェクトの関連する境界要素を返します。
select()
選択にオブジェクトを追加します。
deselect()
選択からオブジェクトを削除します。
__len__ ()
この範囲内のオブジェクトの数を返します。
bricscad.bim.list_properties(obj)
渡された図形またはプライの利用可能なプロパティのリストを返します。
bricscad.bim.current_model()
アクティブなドキュメントのモデル空間内にあるオブジェクトを返します。
bricscad.bim.Pliesのクラス
Plyオブジェクトのインデックス付きでスライス可能なコンテナです。
__iter__()
__getitem__(index)
__getitem__(slice)
__len__()
bricscad.bim.Plyのクラス
個々のプライオブジェクト。
get_property(prop_name)
指定された名前のPlyオブジェクトのプロパティ値を返します。