HomeAboutMeArticlesDiaryModelViewerLinksContact

Deep dive into RhinoCompute through Rust

12 February, 2022 - 8 min read - Tags: Rust,RhinoCompute,Grasshopper

はじめに

最近流行りの言語として Rust があり、触ってみたいと思っている方も多いのではないでしょうか。 ただ、建築系ソフトをみるとその多くが Python や C# で SDK が提供されており、仕事で使わない Rust のような言語に触れることはほぼありません。

ならば Rust で建築系のソフトのなにかを操作できるようになれば、Rust を触れる機会が生まれるはずです。 ということで、本記事では Rhinoceros と HTTP 通信することで Rhinoceros の機能を使うことができる RhinoCompute を Rust で使う方法について紹介します。

本記事でははじめに Rust を触る前にどのように実装するべきか確認するため、RhinoCompute と通信することへの理解を深めます。 その後、その内容に基づいて Rust で実行環境を作成します。

技術的には Rust でも Rhino のデータを取得し rhino3dm 相当の操作が可能です。 しかしそのための実装は時間がかかるため、Grasshopper データを Post して RhinoCompute を使いその結果を取得することを目標とします。

必要な環境

  • Rhinoceros 7 以降
  • Grasshopper の Hops コンポーネント v0.11 以降
  • Rust(作成段階で rustc 1.58.1 を使っています)

RhinoCompute との通信内容について

最初から RhinoCompute の実装を確認してもわかりづらいので、まずは Hops コンポーネントを使ってどのような内容で通信が行われているか確認しましょう。

以下のように A+B を計算する簡単な Grasshopper データを作成し Hops に読み込みます。 v0.11 以降の Hops の場合、REST API の出力が追加されており、どのような内容で通信しているか理解する手助けとなります。

Hops

例えば Last IO Request は以下のようになっています。

特に目立つのが algo の箇所です。 下記では省略していますが、実際はかなり長い文字列になっていると思います。 ここの内容は Grasshopper ファイルを通信時に問題ない形式である Base64 へ変換したものになっています。

{
  "URL": "http://localhost:6500/io",
  "content": {
    "absolutetolerance": 0.0,
    "angletolerance": 0.0,
    "algo": "7VgJUBNZGk4gQEIIId.....",
    "pointer": null,
    "cachesolve": false,
    "recursionlevel": 0,
    "values": [],
    "warnings": [],
    "errors": []
  }
}

上記をポストした結果のレスポンスが以下です。 Input や Output がどのような内容かや Input の設定の内訳がどうなっているかが返ってきています。

ここで重要なのが、CacheKey の値です。ここに先ほどポストした Grasshopper のデータのキャッシュへのキーが入っています。

{
  "Description": "",
  "CacheKey": "md5_77996BBE6275E0EA0564BF666AF66C32",
  "InputNames": ["A", "B"],
  "OutputNames": ["RH_OUT:result"],
  "Icon": null,
  "Inputs": [
    {
      "Description": "",
      "AtLeast": 1,
      "AtMost": 1,
      "Default": "1",
      "Minimum": null,
      "Maximum": null,
      "Name": "A",
      "Nickname": null,
      "ParamType": "Number"
    },
    {
      "Description": "",
      "AtLeast": 1,
      "AtMost": 1,
      "Default": "1",
      "Minimum": null,
      "Maximum": null,
      "Name": "B",
      "Nickname": null,
      "ParamType": "Number"
    }
  ],
  "Outputs": [
    {
      "Name": "RH_OUT:result",
      "Nickname": null,
      "ParamType": "Number"
    }
  ]
}

/io へポストして Grasshopper をアップロードできたので、それに対して Input をポストすることで RhinoCompute で結果を取得します。

Solve へのリクエストの内容は以下です。 ここで確認してほしい点は pointer の値です。 IO からのレスポンスで取得した CacheKey が使われています。 実際に計算するため必要な許容差(tolerance)の値も指定されています。 Hops 側で結果をキャッシュするという設定にしていると、cachesolve の値が true になります。 キャッシュさせたくない場合はここを false にします。

{
  "URL": "http://localhost:6500/grasshopper",
  "content": {
    "absolutetolerance": 0.001,
    "angletolerance": 1.0,
    "algo": null,
    "pointer": "md5_77996BBE6275E0EA0564BF666AF66C32",
    "cachesolve": true,
    "recursionlevel": 0,
    "values": [
      {
        "ParamName": "A",
        "InnerTree": {
          "0": [
            {
              "type": "System.Double",
              "data": "1.0"
            }
          ]
        }
      },
      {
        "ParamName": "B",
        "InnerTree": {
          "0": [
            {
              "type": "System.Double",
              "data": "1.0"
            }
          ]
        }
      }
    ],
    "warnings": [],
    "errors": []
  }
}

なお、pointer を使わないで algo に base64 化した Grasshopper データをいれて送っても結果が返ってきます。 ですがアルゴリズムの特徴上 base64 化するとファイルサイズが約 4/3 倍になり、そのデータが RhinoCompute 側にどんどんキャッシュされていきます。 同一ファイルを数回実行するだけなら良いですが、何 100 回も実行すると蓄積された Grasshopper データのメモリの占有量がかなりの割合になります。 ですので、可能な場合は上記のように一度 /io にあげ、そのキャッシュを使う方が良いです。

返ってきた結果は以下です。 足し算をするように作成したので、RH_OUT:result には 1+1 の結果の 2 が返ってきています。

{
  "absolutetolerance": 0.0,
  "angletolerance": 0.0,
  "algo": "",
  "pointer": "md5_77996BBE6275E0EA0564BF666AF66C32",
  "cachesolve": false,
  "recursionlevel": 0,
  "values": [
    {
      "ParamName": "RH_OUT:result",
      "InnerTree": {
        "{0}": [
          {
            "type": "System.Double",
            "data": "2.0"
          }
        ]
      }
    }
  ],
  "warnings": [],
  "errors": []
}

Hops で概ねの挙動が理解できたので、次に実際の実装を確認します。 使われているスキーマは mcneel の compute.rhino3d のリポジトリの以下にあります。

今回値が返ってきていない空の配列である warningserrors はどんな値が返ってくるかを確認すると文字列のリストが返ってくる実装になっています。 (参照

以下は該当部分の抜粋です。

public class Schema
{
  [JsonProperty(PropertyName = "warnings")]
  public List<string> Warnings { get; set; } = new List<string>();

  [JsonProperty(PropertyName = "errors")]
  public List<string> Errors { get; set; } = new List<string>();
}

どのようなデータをポストすれば Grasshopper を実行できるか理解できたでしょうか。 詳細な実装については後半の Rust パートで書いていきます。

Rust について

Rust の特徴を公式サイトより引用します。

なぜ Rust か?

パフォーマンス
Rust は非常に高速でメモリ効率が高くランタイムやガベージコレクタがないため、パフォーマンス重視のサービスを実装できますし、組込み機器上で実行したり他の言語との調和も簡単にできます。

信頼性
Rust の豊かな型システムと所有権モデルによりメモリ安全性とスレッド安全性が保証されます。さらに様々な種類のバグをコンパイル時に排除することが可能です。

生産性
Rust には優れたドキュメント、有用なエラーメッセージを備えた使いやすいコンパイラ、および統合されたパッケージマネージャとビルドツール、多数のエディタに対応するスマートな自動補完と型検査機能、自動フォーマッタといった一流のツール群が数多く揃っています。

こういった特徴があり C/C++ に代わる言語として注目されています。 C# や Python との大きなわかりやすい違いはガベージコレクタ(GC)がないことです。 それらの言語では使わなかくなったメモリ領域が GC によって適宜解放されますが、Rust にはないため自分で管理する必要があります。 この点は C/C++も同じですが、より扱いやすくするためのものとして Rust では「所有権」や「ライフタイム」といった概念が出てきています。 ここでは細かくはふれられないので興味のある方は以下のドキュメントなどを読んで勉強してみてください。

インストールも同様に 公式サイトのインストール よりできます。

開発に VSCode を使う場合は Rust の公式が出している Rust という Extension がありますが、それを使うより rust-analyzer を使うことをおススメします。

VSCode の Settings で Rust-analyzer › Check On Save: Command の設定がデフォルトでは check になっています。 ここの値を clippy にすると保存するごとに linter が走るのでコードの確認をしやすくなります。 修正の提案もしてくれるのでとても便利です。

基本的な事項については公式のドキュメントがとても充実しているので実際に自分でコードを書いていきたい方は一読すると理解が深まります。

Rust を使った RhinoCompute 実行の実装

ここで作成するものは GitHub にあげていますので必要に応じて参照しながらすすめてください。

はじめに cargo を使って新しいパッケージを作成します。 名前を "rusthopper" とする場合は以下です。

cargo new rusthopper

これを使ってこれから作成してきます。

Json との IO 用の構造体の作成

通信部を作成する前に Input/Output で Json を簡単にやり取りするための構造体を作成します。 なお Rust にクラスと呼ばれるものはありません。 Json へのシリアライズ/デシリアライズをサポートする crate は Rust では serde が主に使われています。 依存関係は、Cargo.toml に記載することで解決できます。

[dependencies]
serde = "1.0.136"
serde_derive = "1.0.136"
serde_json = "1.0.78"

src ディレクトリに io.rs ファイルを作成し、ここに Json を I/O するための構造体を作成します。

この構造体は RhinoCompute のリポジトリにある Schema.cs を基に作成します。 上であげたようにここのクラスを使って RhinoCompute 側は処理しているので、この Schema に倣うことでスムーズにデータのやり取りができるようになります。

ただ、これを 0 から実装していくのは面倒なので、自動実装を使うと楽です。 例えば transform.tools を使うと Json から Rust の構造体を作成できるので、それを下敷きに足りない部分を手で修正してくことをおススメします。

Hops から出力された Json を使います。 例として Hops のポストした IO への Json を変換すると以下のようになります。

変換前

{
  "absolutetolerance": 0.0,
  "angletolerance": 0.0,
  "algo": "7VgJUBNZGk4gQ.....",
  "pointer": null,
  "cachesolve": false,
  "recursionlevel": 0,
  "values": [],
  "warnings": [],
  "errors": []
}

変換後

use serde_derive::Deserialize;
use serde_derive::Serialize;
use serde_json::Value;

#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Root {
    pub absolutetolerance: f64,
    pub angletolerance: f64,
    pub algo: String,
    pub pointer: Value,
    pub cachesolve: bool,
    pub recursionlevel: i64,
    pub values: Vec<Value>,
    pub warnings: Vec<Value>,
    pub errors: Vec<Value>,
}

Json 内で null だったり空の配列だったりする箇所は当然自動で型付けされたかたちでは生成されないので、Schema を見ながら修正してきましょう。 修正した結果が以下になります。

#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Schema {
    pub absolutetolerance: f64,
    pub angletolerance: f64,
    pub algo: Option<String>,
    pub pointer: Option<String>,
    pub cachesolve: bool,
    pub recursionlevel: i64,
    pub values: Vec<DataTree>,
    pub warnings: Vec<String>,
    pub errors: Vec<String>,
}

#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DataTree {
    #[serde(rename = "ParamName")]
    pub param_name: String,
    #[serde(rename = "InnerTree")]
    pub inner_tree: HashMap<String, Vec<RestHopperObject>>,
}

#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RestHopperObject {
    #[serde(rename = "type")]
    pub object_type: String,
    pub data: String,
}

algopointer は null(Rust では None)になる可能性があるので Option の Enum を使用して None または Some(T) を扱えるようにしています。

warningserrors は文字列の配列である Vec<String> としています。

values は Grasshopper のツリーの情報を入れるため、別途 DataTree という構造体を作成しています。 C# の Schema ファイルでは、DataTree は別の扱い方をしていますが、簡単に扱うためここでは違う構成にしています。 DataTree はパラメータの名前である param_name とそのパラメータに入れる値のパスの String と実際の値を持つ inner_tree の HashMap で構成しています。

同様にして Response の構造体も作成します。 作成した内容は以下です。 こちらの内容は C# の Schema.cs と同様の内容を Rust の構造体に書き換えたものとなっています。

#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct IoResponseSchema {
    #[serde(rename = "Description")]
    pub description: Option<String>,
    #[serde(rename = "CacheKey")]
    pub cache_key: Option<String>,
    #[serde(rename = "InputNames")]
    pub input_names: Vec<String>,
    #[serde(rename = "OutputNames")]
    pub output_names: Vec<String>,
    #[serde(rename = "Icon")]
    pub icon: Option<String>,
    #[serde(rename = "Inputs")]
    pub inputs: Vec<InputParamSchema>,
    #[serde(rename = "Outputs")]
    pub outputs: Vec<IoParamSchema>,
}

#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct InputParamSchema {
    #[serde(rename = "Description")]
    pub description: String,
    #[serde(rename = "AtLeast")]
    pub at_least: f64,
    #[serde(rename = "AtMost")]
    pub at_most: f64,
    #[serde(rename = "Default")]
    pub default: String,
    #[serde(rename = "Minimum")]
    pub minimum: f64,
    #[serde(rename = "Maximum")]
    pub maximum: f64,
    #[serde(rename = "Name")]
    pub name: String,
    #[serde(rename = "Nickname")]
    pub nickname: Option<String>,
    #[serde(rename = "ParamType")]
    pub param_type: String,
}

#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct IoParamSchema {
    #[serde(rename = "Name")]
    pub name: Option<String>,
    #[serde(rename = "Nickname")]
    pub nickname: Option<String>,
    #[serde(rename = "ParamType")]
    pub param_type: Option<String>,
}

通信部分の作成

IO 用の構造体が作成できたので、次にそれらを Post する部分を作成していきます。 必要な依存関係として、通信用にバイナリ(gh のファイル)を Base64 に変換する base64 と通信のための reqwest と非同期化に必要な tokio を依存関係に追加します。

[dependencies]
base64 = "0.13.0"
reqwest = { version = "0.11", features = ["json"] }
serde = "1.0.136"
serde_derive = "1.0.136"
serde_json = "1.0.78"
tokio =  { version = "1", features = ["full"] }

はじめに Grasshopper のファイルを /io にポストする部分を作成します。 実装としては引数に &str で gh ファイルへのパスをとり、ポストした結果を Result で返すようにしています。 また通信なので関数は非同期とするためはじめに async をつけています。

/io へのポストなので、algo に gh ファイルのデータが入ったものをいれ、レスポンスでそのデータへの cache_key が返ってくることを期待しています。

use base64::encode;
use std::fs::File;
use std::io::Read;

use crate::{io, URL};

async fn upload_definition(
    gh_path: &str,
) -> Result<io::IoResponseSchema, Box<dyn std::error::Error>> {
    // io の URL を作成
    let io_url = URL.to_owned() + "io";

    // ファイルを読み込み、Base64 にエンコード
    let mut gh_file = File::open(gh_path).unwrap();
    let mut buf = Vec::new();
    let _ = gh_file.read_to_end(&mut buf);
    let encoded: &str = &encode(&buf);

    // body となる各値を作成し Json の文字列化
    let io_schema = io::Schema {
        absolutetolerance: 0.0,
        angletolerance: 0.0,
        algo: Some(encoded.to_owned()),
        pointer: None,
        cachesolve: false,
        recursionlevel: 0,
        values: Vec::new(),
        warnings: Vec::new(),
        errors: Vec::new(),
    };
    let io_body = serde_json::to_string(&io_schema)?;

    // ポストして結果の Json をデシリアライズ
    let client = reqwest::Client::new();
    let res = client
        .post(io_url)
        .body(io_body)
        .send()
        .await?
        .json::<io::IoResponseSchema>()
        .await?;

    Ok(res)
}

Rust はコンパイラが厳しいとよく言われます。 上で io_schema を作成している箇所で、absolutetolerance は f64 なのですが、わざと文字列 "0.0" をいれて cargo check を実行します。

let io_schema = io::Schema {
    absolutetolerance: "0.0",

結果は以下のようにどこがどのようにダメなのかを細かくコンパイラが教えてくれます。 基本的にはこのコンパイラの指示に素直に従っていればコードが仕上がっていきます。

error[E0308]: mismatched types
  --> src\grasshopper.rs:15:28
   |
15 |         absolutetolerance: "0.0",
   |                            ^^^^^ expected `f64`, found `&str`

/io からのレスポンスでポストした gh ファイルの cache key が返ってくるので、それを使って実際にファイルを評価する部分を作成します。

実装としては mcneel の Python の compute-rhino3d の実装に倣って、gh ファイルのパスと DataTree を受け取ってそれを使って処理する関数としています。

pub async fn evaluate_definition(
    gh_path: &str,
    data_tree: Vec<io::DataTree>,
) -> Result<io::Schema, Box<dyn std::error::Error>> {

    // 上で実装した /io へのポストを使って cache_key を取得
    let cache_key = upload_definition(gh_path).await?.cache_key;

    // io の URL を作成
    let solve_url = URL.to_owned() + "grasshopper";

    // body となる各値を作成し Json の文字列化
    let solve_schema = io::Schema {
        absolutetolerance: 0.001,
        angletolerance: 1.0,
        cachesolve: false,
        algo: None,
        pointer: cache_key,
        recursionlevel: 0,
        values: data_tree,
        warnings: Vec::new(),
        errors: Vec::new(),
    };
    let solve_body = serde_json::to_string(&solve_schema)?;

    // ポストして結果の Json をデシリアライズ
    let solve_client = reqwest::Client::new();
    let solve_res = solve_client
        .post(solve_url)
        .body(solve_body)
        .send()
        .await?
        .json::<io::Schema>()
        .await?;

    Ok(solve_res)
}

これで Grasshopper ファイルを実行して値を取得する部分の作成が完了しました。

main.rs の作成

IO の部分、通信する部分が作成できたので、これらをまとめて実際にポストするデータを作成し結果を表示する部分を作成していきます。

mod grasshopper;
mod io;

use std::collections::HashMap;

// ベースとなる URL 作成
const URL: &str = "http://localhost:6500/";

// 非同期のメイン関数であることを示すため #[tokio::main] を付ける
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {

    // grasshopper のパスを入れる
    let gh_path = "definitions/sum.gh";

    // インプット用の DataTree を作成する
    let mut input_tree: Vec<io::DataTree> = Vec::new();
    let mut tree = HashMap::new();
    tree.insert(
        "0".to_string(),
        vec![io::RestHopperObject {
            object_type: "System.Double".to_string(),
            data: "1.0".to_string(),
        }],
    );
    input_tree.push(io::DataTree {
        param_name: "A".to_string(),
        inner_tree: tree,
    });

    let mut tree = HashMap::new();
    tree.insert(
        "0".to_string(),
        vec![io::RestHopperObject {
            object_type: "System.Double".to_string(),
            data: "2.0".to_string(),
        }],
    );
    input_tree.push(io::DataTree {
        param_name: "B".to_string(),
        inner_tree: tree,
    });

    // RhinoCompute と通信して結果を受け取る
    let output = grasshopper::evaluate_definition(gh_path, input_tree).await?;

    // 各結果を表示する
    // エラーの結果
    let errors = output.errors;
    if !errors.is_empty() {
        println!("Errors:");
        for error in errors {
            println!("{}", error);
        }
    }

    // ワーニングの結果
    let warnings = output.warnings;
    if !warnings.is_empty() {
        println!("Warnings:");
        for warning in warnings {
            println!("{}", warning);
        }
    }

    // RH_OUT で得られた結果
    let values = output.values;
    for value in values {
        let name = value.param_name;
        let inner_tree = value.inner_tree;
        println!("{}", name);
        for (key, value) in inner_tree {
            println!("{}", key);
            for v in value {
                println!("{}", v.data);
            }
        }
    }

    Ok(())
}

すべてできたら cargo check を実行して問題がないか確認しましょう。 問題なければ RhinoCompute を起動して cargo run することで実際にコードを実行しちゃんと結果が返ってくることを確認しましょう。

ここでは冒頭で出した A+B の足し算するデータに対して実行しているので結果は 3 が返ってきます。

まとめ

Rust で RhinoCompute を実行する例を出しましたがどうでしたでしょうか。 C# や Python とはだいぶ違う言語なため手こずったと思いますが、実際に書きながらすすめると Rust の強力なコンパイラの力を感じられたのではないでしょうか。

建築系ではあまり使うことはないと思いますが、機会があったら Rust にもぜひチャレンジしてみてください。

© 2022 hrntsm / Built with

Gatsby