DAZ Script

DAZ StudioのSceneペインに表示されているNodeや、PosingペインのPropertyは、それぞれにLabel情報とName情報を保持しています。またPropertyはNumericPropertyなどいくつかの種類に分かれており、それぞれ各設定値の取り出し方が異なります。

このため、DAZ Scriptのどのメソッドを使うとどの情報が取り出せるかが、メソッド名から推測しにくい状況にあります。

そこでとりあえず、「ウィンドウ上に見える情報を取得するためのメソッド」をまとめてみました。

No	表示内容の概要	対応するDAZ Scriptのメソッド
1	ParameterのName 通常目にする機会はない情報。	DzProperty#getName() DzNumericProperty#getName()
2	ParameterのLabel Parameterペインのリストとして表示される。	DzProperty#getLabel() DzNumericProperty#getLabel()
3	ParameterのPath Parameterペインの階層構造と一致し、そのルートはSceneペインで選択しているNodeになる。	DzProperty#getPath() DzNumericProperty#getPath()
4	対象のParameterを、Parameterペイン上に表示する／しないの設定	DzProperty#isHidden() DzNumericProperty#isHidden()
5	Parameterの数値変更可能／不可能	DzProperty#isLocked() DzNumericProperty#isLocked()
6	Parameterの数値の制限のOn/Off DzNumericPropertyクラスでしか設定できない[1]adjust property “Use Limits" in script [SOLVED]	DzNumericProperty#isClamped()
7	親NodeのLabel Sceceペイン上での表示と一致する。	DzNode#getLabel() また下記のように、Property側からアクセスすることもできる。 DzProperty#getOwner().getLabel()
その他	親NodeのName 通常、目にする機会はない情報。	DzNode#getName() Labelと同様に、Property側からアクセスすることもできる。 DzProperty#getOwner().getName()

紛らわしいことに、Parameterの情報を格納しているクラスなのに、DzProperty～という名称になっています。

※本記事は、qiitaにも投稿しています。

https://qiita.com/lowpolysnow/items/a9bf84cb8fe31afe339b

---

以前の記事でTypeScriptでDAZ Scriptを書ける環境を整えたので、せっかくなのでクラスを利用してみたいと思います。

class Greeter {
    greeting: string;
    constructor(message: string) {
        this.greeting = message;
    }
    greet() {
        return "Hello," + this.greeting;
    }
}

(function () {
    let greeter = new Greeter("world");
    MessageBox.information(greeter.greet(), "doit()", "OK");
})();

トランスパイルすることで、次のようなJavaScriptがjsファイルで出力されます。 このjsファイルの拡張子をdsaに書き換えることで、DAZ Scriptとして利用できるようにします。 （以前の記事のように環境をつくておくと、自動で書き換えてくれます）

var Greeter = /** @class */ (function () {
    function Greeter(message) {
        this.greeting = message;
    }
    Greeter.prototype.greet = function () {
        return "Hello," + this.greeting;
    };
    return Greeter;
}());
(function () {
    var greeter = new Greeter("world");
    MessageBox.information(greeter.greet(), "doit()", "OK");
})();

実行結果は次のようになります。

TypeScriptのコードなど下記のサイトを参考にさせていただきました。 他のクラスの機能のサンプルも揃っているので、時間があるときにどこまでDAZ Scriptで使えるか試してみようと思います。

TypeScriptのClassについて – 公式ドキュメント日本語訳
https://mae.chab.in/archives/59843#post59843-1

※本記事は、qiitaにも投稿しています。

https://qiita.com/lowpolysnow/items/ef9897a8d3ca4a37c4cd

---

DAZ Scriptではウィンドウを表示する機能はなく、代わりにモーダルダイアログを利用します。

(function () {
    var dialog = new DzDialog;
    dialog.exec();
})();

実行結果は次のようになります。

ちなみにモーダレスダイアログ（開いている間もアプリを操作できるウィンドウ）は作ることが出来ません。^[1]参照：how make a modalless dialog?

ダイアログ要素の追加

new DzDialogで生成したインスタンスを引数に取ることで、ダイアログには様々な要素を追加することが出来ます。 例えば、ラベルを追加するときは、DzLabelオブジェクトをnewし、ボタンを追加するときもDzButtonオブジェクトをnewします。

ラベル要素

(function () {
    var dialog = new DzDialog;

    //ラベル要素
    var dialog_label = new DzLabel(dialog);
    dialog_label.text = "label text";

    //ダイアログの大きさを設定（要素を追加すると、大きさを指定しないとデバッグで表示されません）
    dialog.width = 200;
    dialog.height = 100;

    dialog.exec();
})();

実行結果は以下のようになります。

ボタン要素

(function () {
    var dialog = new DzDialog;

    //ボタン要素
    var dialog_button1 = new DzPushButton(dialog);
    dialog_button1.text = "button1";

    //ダイアログの大きさを設定（要素を追加すると、大きさを指定しないとデバッグで表示されません）
    dialog.width = 200;
    dialog.height = 100;

    dialog.exec();
})();

実行結果は以下のようになります。

グループボックスやレイアウト設定まとめ

(function () {
    var dialog = new DzDialog;

    //各要素を縦に等配置するDzVBoxLayoutオブジェクトを設定します。
    var dialog_layout = new DzVBoxLayout(dialog);
    dialog_layout.autoAdd = true;
    dialog_layout.margin = 5;
    dialog_layout.spacing = 5;

    //ボタン要素
    var dialog_button1 = new DzPushButton(dialog);
    dialog_button1.text = "button1";

    //ラベル要素
    var dialog_label = new DzLabel(dialog);
    dialog_label.text = "label text";

    //グループボックス要素
    var dialog_button_group = new DzVGroupBox(dialog);
    dialog_button_group.title = "Button Group";
    dialog_button_group.columns = 1;

    //  グループボックス要素にボタンを追加します
    var dialog_button2 = new DzPushButton(dialog_button_group);
    dialog_button2.text = "&Exit";
    dialog.setRejectButton(dialog_button2);

    //ダイアログの大きさを設定（要素を追加すると、大きさを指定しないとデバッグで表示されません）
    dialog.width = 200;
    dialog.height = dialog.minHeight;

    dialog.exec();
})();

実行結果は以下のようになります。

ちなみに、DzVBoxLayoutオブジェクトを使用しないと、各要素がすべて上部に配置されてしまいます。 この作り方はQtScript由来のもので^[2]参照：QVBoxLayout Class | Qt 4.8、次項でもそうですが、DAZ Scriptは基本的にQtScriptをベースとし、それにDAZ Studio特有の機能を載せていくという形でプログラムを組んでいくことになります。

クリックイベントと実行メソッドの紐づけ

ボタンをクリックしたとき、同じスクリプト内の別の関数が実行されるようにするには、Globalオブジェクトのconnectメソッドを使用します。（Globalオブジェクトについては別記事参照）

connectメソッドはオブジェクトとイベントと実行する関数を紐付けます。JavaScriptのaddEventListener()のようなものだと思ってください。

下記の例では、オブジェクトに対し、シグナルというイベント(例ではclicked())を発行し、メソッドを実行します。

(function () {
    var dialog = new DzDialog;
    var doit_button = new DzPushButton(dialog);
    doit_button.text = "call doit()";
    connect(doit_button, "clicked()", doit);
    dialog.exec();
})();

function doit() {
    MessageBox.information("do it.", "doit()", "OK");
    return;
}

実行結果は以下のようになります。

「call doit()」ボタンをクリックすると、cliked()シグナルに紐づけられたdoit()関数が呼び出され、メッセージボックスが表示されます。

シグナルの考え方はQtScriptやそもそものC++ライブラリ「Qt」に由来するのですが、ちょうどいい参考資料がまだ見つからないので、また後日記述します。

※本記事は、qiitaにも投稿しています。

https://qiita.com/lowpolysnow/items/63e84e9377446d3d7949

---

DAZ Scriptではメッセージボックスの表示やSceneパネルのノードの取得などの機能を、Globalオブジェクトとして提供しています。

詳しくは、以下にリファレンスがあります。

Global [Documentation Center]
http://docs.daz3d.com/doku.php/public/software/dazstudio/4/referenceguide/scripting/api_reference/object_index/global

Global「オブジェクト」と呼んでいますが、実際には「Global」をシンタックスとして指定する必要はなく、例えばメッセージボックスを表示したいときは、MessageBoxプロパティを直接指定します。

(function () {
    MessageBox.information("do it ! ジャスト　ドゥ　イット！", "doit()", "OK");
})();

実行結果は次のようになります。

リファレンスのMessageBoxプロパティの項を参照するとわかりますが、Globalシンタックスが省略されているものの、実際にはGlobalオブジェクトのMessageBoxプロパティを指定しており、DzMessageBoxオブジェクトを取得しています。上記の例では、そのDzMessageBoxオブジェクトのinformationメソッドを実行しています。

リファレンスのページにGlobalオブジェクトの詳しい説明があります。

The global object is never used directly, and cannot be created using the new operator. It is automatically created when the scripting engine is initialized, and its functions and properties are available immediately. The global object has no syntax. Its functions and properties are accessed directly.

Globalオブジェクトは直接使用されず、またnew演算子でインスタンスを作成するもできません。DAZ Scriptエンジンが初期化されると自動的に作成され、そのメソッドとプロパティはすぐに利用することができます。Globalオブジェクトにはシンタックスがありません。メソッドとプロパティは直接アクセスします。

要は、次の様には利用できません。

//このコードはエラーになります。
(function () {
    Global.MessageBox.information("do it ! ジャスト　ドゥ　イット！", "doit()", "OK");
})();

他にも、次のようなプロパティを使用することができます。（詳しくはリファレンス参照）

ECMA Script由来

• Math：数学関数のライブラリです。

など

DAZ Script由来

• MessageBox：画面上にメッセージボックスを表示します。
• Scene：Sceneパネルの情報にアクセスします。

など

※本記事は、qiitaにも投稿しています。

https://qiita.com/lowpolysnow/items/1cb0ab1315a95fae5d6d

---

概要

DAZ Studioにはスクリプト機能がありますが、エディタとデバッガしかついておらず、コード補完などのまともにプログラムが書ける環境がありません。 なにかいい方法は無いかと探していたところ、DAZのフォーラムで下記のトピックを見つけました。

New to the scripting IDE…
https://www.daz3d.com/forums/discussion/95971/new-to-the-scripting-ide

要はVisual StudioでTypeScriptとしてコードを書いて、それをDAZ Scriptに変換しDAZ Studioで読み込めるようにするというものです。 DAZ Scriptの開発用テンプレートプロジェクトのリンクも併記してありました。

jag11/dazsdk-typed: TypeScript definitions & tools for DAZ Studio Scripting
https://github.com/jag11/dazsdk-typed

本稿では、このdazsdk-typedでDAZ Scriptを開発する環境の構築方法を説明します。

前提知識

DAZ Scriptについて

名前からして独自の言語のようですが、QtScript4.5を拡張したECMAScript(3rdEdition)です。^[1]DAZ Scriptのリファレンス Scripting – Documentation Centerそのため、JavaScriptと同じ文法で記述することが出来ます。

TypeScriptについて

JavaScriptなどの動的型付け言語では開発時の難点として、IDEでコード補完が効かないなどの問題があります。さらにJavaScriptではクラスもありません。（特にDAZ Scriptに相当する、ECMAScript(3rdEdition)において）

そこでC++やJAVAと同等の開発効率を実現できるよう、TypeScriptというプログラミング言語がMicrosoftによって開発されました。^[2]TypeScript – WikipediaTypeScriptで書かれたコードは変換(トランスパイル)することで、JavaScriptのコードを出力することができます。 Visual Studio上でTypeScriptを用いて開発することで、C++やJAVAと同様、クラスの実装や、開発時のコード補完を実現することが出来ます。

やりたいこと

DAZ ScriptをJavaScriptに見立てて、TypeScriptで効率的な開発しつつ、JavaScriptを出力し、それをDAZ ScriptとしてDAZ Studioに読み込ませます。

開発環境構築手順

Visual Studio 2017の準備

Visual Studio 2017へのTypeScriptの導入は、下記のサイトを参考にさせていただきました。

Visual Studio 2017でTypeScript環境を構築する
http://takachan.hatenablog.com/entry/2018/03/09/002412

Visual Studioの準備は以上です。

dazsdk-typedについて

次に、下記からdazsdk-typedをダウンロードします。

jag11/dazsdk-typed: TypeScript definitions & tools for DAZ Studio Scripting
https://github.com/jag11/dazsdk-typed

展開すると、下記３つのソリューションファイルが出力されます。

• DazScriptProjectTemplate　…　実際にDAZ Scriptを記述する本体。
• DazTypeScriptDefinitionGenerator　…　DazTypeScriptDefinitionGenerator.dllを作成するだけのプロジェクト。編集不要。
• dazsdk-typed　…　DAZ Scriptの型定義ファイル。これのおかげでDAZ Script記述中に、コード補完が有効になる。プロジェクトの設定変更が必要。

DazScriptProjectTemplate.slnをダブルクリックして開きます。

dazsdk-typedプロジェクトの設定変更

DazScriptProjectTemplateソリューションには、DazScriptProjectTemplateプロジェクトに加え、dazsdk-typedプロジェクトが参照されています。 dazsdk-typedプロジェクトを右クリックし、プロパティを開きます。 「TypeScript ビルド」の 　「全般」→「ECMAScriptバージョン」を「ECMAScript 3」に変更 　「全般」→「モジュールシステム」を「AMD」に変更 変更後、上書き保存します。

DazScriptProjectTemplateプロジェクトの編集

実際にDAZ Scriptを記述するプロジェクトです。 開いてみると、実態のないファイルが登録されており、テンプレートとしてお膳立てがしてあるので、以下のようにカスタマイズして使用します。

• DazSDKフォルダの、dazsdk.d.ts、dazsdk.js、dazsdk.js.mapを削除する。
• TSフォルダのSimpleMultiPassRender.tsを削除する。※dazsdk-typedは、もともとこのスクリプトを開発するために作ったテンプレートのようです。
• DazSDKフォルダに、DazTypeScriptDefinitionGenerator\DazSDK\dazsdk.d.tsをコピーする。
• DazScriptフォルダを作成する。
• DazScriptProjectTemplateプロジェクトを右クリックし、プロパティを開く。「ビルドイベント」の「ビルド後のイベントのコマンドライン」にxcopyコマンドが書かれているので、このパスを変更する。
  xcopy /Y ..\*.js ..\*.dsa　→　xcopy /Y ..\..\TS\*.js ..\..\DazScript\*.dsa

あとはTSフォルダにTypeScriptでスクリプトを書いていきます。 TypeScriptと言ってもJavaScriptそのままで大丈夫です。(TypeScriptのバージョンによっては、ECMAScript6のletやconstも使えます。) dazsdk.d.tsファイルのおかげでDAZ Script用のコード補完を効かせながら書いていくことができます。

ビルド

コードが書けたらビルドし、DAZ Scriptを出力します。 「DazScriptProjectTempleteソリューション」を右クリックし、「ソリューションのビルド」を実行します。 （プロジェクトのビルドではないので気をつけてください。）

下記のようにTSフォルダ内のtsファイルがJavaScriptに変換され、DAZ Scriptフォルダにdsaファイル（DAZ Scriptファイル）が作成されます。 これをDAZ StudioのScript IDE画面で読み込ませれば、スクリプトの実行が可能です。

なお、DAZ Studioのスクリプト機能では、日本語は文字化けしてしまうので、注意してください。

DAZ Scriptの開発環境の構築方法は以上です。