ZBrushのZScript入門

漠然とZBrushのプラグインか何かを作れるようになりたいとか思いながら、何も手をつけずに6年も経った(笑)



公式ドキュメントを読んでも、イマイチZScriptやZPluginの感覚(メンタルモデル)が掴めなかったのだ。
http://docs.pixologic.com/user-guide/customizing-zbrush/zscripting/
http://docs.pixologic.com/reference-guide/zscript/

記法もわからない段階からZScriptをゼロから書こうとしてもなかなか前に進まないので、とりあえずZScriptに慣れるところから始めようか。
まずはUI操作を記録してZScriptに書き出してみよう。こちらの記事を参考に↓
http://sassembla.github.io/Public/2018:01:19%2022-12-27/2018:01:19%2022-12-27.html

GUI上での操作がScriptコマンドとして残るのはMayaのMELみたいですね。



普段よくやる操作をZScriptで簡略化するのを最初の目標とする。
最近のアヴァンガメラ制作作業の区切りで必ずやっている作業履歴の動画書き出し(F履歴録画)設定をZScriptで自動化してみよう。
ZBrushでUndo Historyを動画に書き出す
ちょっと遅いけど、ZBrush 2019にアップグレードした。で、バージョン2019の新機能とは全然関係なく(笑)、最近になってZBrushのUndo Historyを動画にできることを知った。Undo History Moviesモデルの...


この設定値はZProjectに保存されず、毎回リセットされてしまうので地味に時間を取られていた。

ZScriptのRecord(記録開始)を押して、一連の操作を行ったらEnd Rec(記録停止)を押す↓



そして記録したZScriptをファイルに保存する。ZScriptの拡張子は普通に.txtなのね。
これが設定・録画のZScript↓

//RECORDED ZSCRIPT 2021
[IButton,Play,"Press to play this ZScript. ZScript can be aborted at anytime by pressing the eesci key.",
[IConfig,2021]
[IPress,Movie:Doc]
[IPress,Movie:Large]
[ISet,Movie:Modifiers:Recording FPS,30]
[IPress,Movie:TimeLine:Auto]
[ISet,Movie:Overlay Image :Opacity,0]
[ISet,Movie:Title Image :FadeOut Time,0]
[ISet,Movie:Title Image :FadeIn Time,0]
[IPress,Movie:F History]
]/*End of ZScript*/

ZScriptをシンタックスハイライトするVSCode拡張があるので有難く使わせていただく↓
https://marketplace.visualstudio.com/items?itemName=ouelletjonathan.zscript

読みやすくなった↓



.txtファイルと同じファイル名で一緒に出力される.zscファイルは何だろうと思ったら、ZBrushが.txtのZScriptを読み込むと同じフォルダにコンパイル済み(?)の.zscを書き出すのね。
Pytyonの.pyから.pycが作られるみたいな感じだな。(つまりバージョン管理外にしておいた方が良い)

あ、ZBrushのインストールフォルダの中のZPlugsフォルダ(またはZPlugs64フォルダ)に入っているのも.zscファイルだから、これらはつまりコンパイル済みのZScriptということか。そして、そのZScriptがdllを叩いているわけか。

ようやく理解した。ZPluginと呼ばれるものはZScriptの延長にあり、外部のデータやdllと連携するエントリポイントをZScriptで作るのね。
こちらのブログに書かれていることの意味が分かるようになってきたぞ↓
https://ichiyonnana.hateblo.jp/entry/2017/10/22/200228
https://ichiyonnana.hateblo.jp/entry/2017/10/23/030924

外部に処理を投げて、完了したら結果を受け取るコールバック的な実装はちょっと難しそうだな。クローズドにはSDKが存在するのかな。

公式のZScriptサンプルをちゃんと読んでみよう↓
http://docs.pixologic.com/user-guide/customizing-zbrush/zscripting/sample-zscripts/

ZPlugin interfaceのサンプルに従えば、パレットを自作してボタンから任意のコマンドや外部関数を叩けそうだな。
ZScriptの記法というか、コマンドの一覧はこちらを見れば良いのか↓
http://docs.pixologic.com/user-guide/customizing-zbrush/zscripting/command-reference/

同じページからZPluginのサンプルコードがダウンロードできるね。

GitHubを漁ってみると個人でZPluginを開発している人もチラホラいるようなので、SDKが開示されてなくても結構拡張できるようだ。
https://github.com/fuzzzzzz/zbrush-dll-template
https://github.com/n-taka/n_ZBrushPlugins

関連記事

Model View Controller

Gource:バージョン管理の履歴を可視化するツール

OpenCVでPhotoshopのプラグイン開発

OpenMayaRender

iOSデバイスのためのフィジカル・コンピューティングツールキット『konashi(こなし)』

Unityの各コンポーネント間でのやり取り

SIGGRAPH ASIA 2009で学生ボランティア募集してるみたい

UnityのTransformクラスについて調べてみた

ラクガキの立体化 分割ラインの変更・バランス調整

ZBrushでゴジラ2001を作ってみる 身体のSubToolを分割

OpenGVの用語

Photo Bash:複数の写真を組み合わせて1枚のイラストを制作する

OpenGV:画像からカメラの3次元位置・姿勢を推定するライブラリ

Python.NET:Pythonと.NETを連携させるパッケージ

Point Cloud Libraryに動画フォーマットが追加されるらしい

ゴジラ三昧

Raspberry Pi

ZBrushで基本となるブラシ

ZBrushで仮面ライダー3号を造る 仮面編

ZBrushでカスタムUIを設定する

LuxCoreRender:オープンソースの物理ベースレンダラ

Google App Engineのデプロイ失敗

Blender 2.8がついに正式リリース!

WinSCP

Google XML Sitemap Generatorプラグインを3.4.1へダウングレード

頭蓋骨からの顔復元と進化過程の可視化

Python for Unity:UnityEditorでPythonを使えるパッケージ

MFnDataとMFnAttribute

Physically Based Rendering

konashiのサンプルコードを動かしてみた

CreativeCOW.net

Zbrushでメカ物を作るチュートリアル動画

Amazon EC2ログイン用の秘密鍵を無くした場合の対処方法

ZBrushでアヴァン・ガメラを作ってみる 下アゴと頭部を作り込む

C++の抽象クラス

HTML5・WebGLベースのグラフィックスエンジン『Goo Engine』

UnrealCV:コンピュータビジョン研究のためのUnreal Engineプラグイン

ROSの薄い本

OpenCVの三角測量関数『cv::triangulatepoints』

ZBrushでアヴァン・ガメラを作ってみる 腕の作り込み

ZBrushのTranspose Masterでポーズを付ける

Stanford Bunny

コメント