PythonでARCHICADを操作する方法

2023.12.21

こんにちは、初めまして。
IU BIM STUDIOの原田と申します。

ブログ記事を書くことになりまして何を題材にしようかと考えた結果、ARCHICADでPythonスクリプトを使う記事があまりないようなので、ひとまずARCHICAD – Python連携の記事を書いていくことにしました。

私もそこまで詳しくないのですが、Python初心者の方の参考になれば幸いです。
今回は初回ということで環境構築から始めたいと思います。

今回の記事の動作環境です。
・OS　Windows10
・エディタ Visual Stuido Code
・ARCHICAD 26

1. Pythonをインストール

こちらからPythonのインストーラーをダウンロードし、インストールしてください。
https://www.python.org/downloads/

インストーラーの画面で「Add Python.exe to PATH」にチェックを入れてください。

2. ARCHICAD用ライブラリをインストール

pipを使ってPythonにARCHICAD用のライブラリをインストールします。
pipはPythonのパッケージ管理ツールです。
パッケージとかライブラリというのはPythonの拡張機能のようなもので、ライブラリを追加することにより便利にプログラミングをすることができます。

VSCodeであればメニューの「ターミナル>新しいターミナル」をクリックし、出てきたパネルに下記のコマンドを入力します。

pip install archicad

3. スクリプトを書く

ARCHICADのPython APIでは現状では柱やテキストなどのモデル要素を作成することはできません。
今回はゾーンの室名を”Hello World!”に変更するプログラムを作成します。

エディターでhello_world.pyというファイルを新規作成し保存します。
コードは下記のとおりです。

from archicad import ACConnection

conn = ACConnection.connect()
assert conn

acc = conn.commands
act = conn.types
acu = conn.utilities

# プロパティのGUIDを取得
property_id = acu.GetBuiltInPropertyId("Zone_ZoneName")

# ゾーン名の値を設定
new_zone_name = act.NormalStringPropertyValue("Hello World!")

# ゾーンを全て取得
zones = acc.GetElementsByType("Zone")

# プロパティ値を入れる配列を作成
property_values = []

# 新しいプロパティ値のリストを作成
for zone in zones:
    property_value = act.ElementPropertyValue(
        zone.elementId, property_id, new_zone_name
    )
    property_values.append(property_value)

# 作成したものをゾーンに適用
acc.SetPropertyValuesOfElements(property_values)

コードを書き終えたら保存しておきましょう。