久しぶりにIllustratorのスクリプト記事です。今回は標題のスクリプトを作る過程から解説しようと思います。
はじめに
どんなスクリプトを作るの?
こんな感じのスクリプトを作ります。
開発環境
- macOS Mojave(10.14.6)
- Illustrator 2020(24.3)
- Visual Studio Code(1.51.0)
この記事で扱わないこと
- VSCodeのデバッグ設定など
- IllustratorのスクリプトAPI(DOM)の体系的な説明(部分的な説明にとどめています)
- JavaScript(ExtendScript)の基本構文などの体系的な説明(部分的な説明にとどめています)
開発しよう
フローチャート
下図を目標にスクリプトを組み立てていきます*1。
それぞれを小さな関数にまとめよう
スクリプトを開発していると、{}
ブロックが何層も入れ子になりがちです。適宜関数に分解して書くことを心がけます。このとき、一つの機能を一つの関数にする、ということだけ気をつけてください。
ドキュメントを開いているかどうか
ここから実際にコードを書いていきますが、Illustratorのスクリプトは匿名関数*2でラップして実行するのがオススメです。というのも、スクリプトを終了する、という命令がないのでコードが複雑な入れ子になりやすいのです。関数内であればreturn
文を使ってスクリプトを終了させることができるので、これを利用します。
匿名関数は下記のような書き方が一般的です。
(function() { // 処理を書く…… })();
関数そのものを()
で囲み、末尾の()
で実行させるという手法です。ただ()
の入れ子や引数の与え方がわかりにくいかもしれません。
もうひとつの方法として、頭に否定演算子!
や減算演算子-
を付けてもいいっちゃいいです。
!function() { // 処理を書く…… }();
こうする方法もありますが、あまり見慣れないと思うので前者の方法で書いていきます。
ドキュメントが開かれているかどうかは、Application
→Documents
とプロパティをたどりましょう。
if (app.documents.length === 0) { // ドキュメントが開かれていない状態なので return; // 終了する }
length
プロパティでDocument
オブジェクトがいくつ開かれているかを調べることができます。これがゼロ=== 0
であればスクリプトを終了します。
これを前述の匿名関数内に記述するとこうなります。
(function () { if (app.documents.length === 0) { return; } })();
オブジェクトを選択しているかどうか
続いて、オブジェクトを選択しているかどうかを判定です。先ほどのlength
を、Application.selection
というオブジェクトの選択範囲(選択しているオブジェクト群)に対して用いることで同様に「選択しているオブジェクトの数」を得ることができます*3。
if (app.selection.length === 0) { // オブジェクトを選択していない状態なので return; // 終了する }
これを先ほどのコードに追記しましょう。2つのif文を設けるより、どちらか一方でも満たせばスクリプトを終了してしまっていいので、OR演算子||
で条件式をつなげるとスマートです。
(function () { if (app.documents.length === 0 || app.selection.length === 0) { return; } })();
オブジェクトにランダムに色を塗る
Illustratorのスクリプトでオブジェクトの塗り色に色を設定するにはどうすればいいでしょうか。
この部分をスクリプト的に分解すると下記の手順になります。
- 新しい色オブジェクト(CMYKColorオブジェクトなど)を生成する
- オブジェクトの塗りにその色オブジェクトを設定する
それぞれ見ていきましょう。
新しい色オブジェクト(CMYKColorオブジェクトなど)を生成する
今回はCMYKカラースペースでコードを組み立てます(RGBの場合は適宜読み替えてください)。CMYKの色オブジェクトはCMYKColor
コンストラクタをnew
演算子を付けて呼び出すことで生成することができます。そのオブジェクトの各色成分名のプロパティに値をセットします。
var myCMYK = new CMYKColor(); myCMYK.cyan = 20; myCMYK.magenta = 30; myCMYK.yellow = 40; myCMYK.black = 0;
こうするとmyCMYK
はC20、M30、Y40という色成分値を持つCMYKカラーオブジェクトとなります。
オブジェクトの塗りにその色オブジェクトを設定する
これをオブジェクトの塗り色に設定するにはObject.fillColor
プロパティにこのオブジェクトを代入すればOKです。
試しにドキュメント上になにかオブジェクトを描画して下記のスクリプトを実行してみましょう。
var myCMYK = new CMYKColor(); myCMYK.cyan = 20; myCMYK.magenta = 30; myCMYK.yellow = 40; myCMYK.black = 0; app.activeDocument.selection[0].fillColor = myCMYK;
オブジェクトが意図した色に塗られたでしょうか?
ランダムな色を生成する
色の作り方と塗り方が分かったところで、今度はランダムに色成分を作ってみましょう。
ランダムな値を得る一般的なやり方は、JavaScriptが持っているMath
オブジェクトの静的メソッドMath.random()
を利用することでしょう。このメソッドは戻り値として0〜1までのランダムな値を返します*4。
しかし、欲しいのはそんな小さな数字ではないのですよね。0〜100までの間で欲しいわけです。Math.random()
から得られる値をx
と置くと、得られる戻り値は下記のように表現できます。
0 <= x < 1
全体を100倍すると
0 <= x < 100
となります。つまりMath.random() * 100
とすれば、0〜100までのランダムな値を得ることができるわけですね。
ただこれで得られる値は浮動小数点ですごく細かい値です。できれば整数で割り切った値が欲しい。また、このままだと100も得られません。これを処理するために、得られた値を四捨五入しましょう。四捨五入はMath.round()
メソッドを使います。
var myCMYK = new CMYKColor(); myCMYK.cyan = Math.round(Math.random() * 100); myCMYK.magenta = Math.round(Math.random() * 100); myCMYK.yellow = Math.round(Math.random() * 100); myCMYK.black = 0; app.activeDocument.selection[0].fillColor = myCMYK;
これで0〜100までのランダムな色でオブジェクトを塗ることができました。これを先ほどのコードに追記しましょう。全体はこうなります。
(function () { if (app.documents.length === 0 || app.selection.length === 0) { return; } var myCMYK = new CMYKColor(); myCMYK.cyan = Math.round(Math.random() * 100); myCMYK.magenta = Math.round(Math.random() * 100); myCMYK.yellow = Math.round(Math.random() * 100); myCMYK.black = 0; app.activeDocument.selection[0].fillColor = myCMYK; })();
次のオブジェクトがあるかどうか
これだと選択している一つのオブジェクトにしか適用されません。勘がいい方は気づいたでしょう、app.activeDocument.selection[0]
の0
が選択しているオブジェクト群のインデックスになるので、ここを0、1、2、と選択しているオブジェクトの数だけ順番に対処すればいいわけですね。今回はfor文で実装してみましょう。
(function () { if (app.documents.length === 0 || app.selection.length === 0) { return; } var sel = app.activeDocument.selection; for (var i=0; i<sel.length; i++) { // for文を追加 var myCMYK = new CMYKColor(); myCMYK.cyan = Math.round(Math.random() * 100); myCMYK.magenta = Math.round(Math.random() * 100); myCMYK.yellow = Math.round(Math.random() * 100); myCMYK.black = 0; app.activeDocument.selection[i].fillColor = myCMYK; // indexを i に変更 } // for文の受け })();
こうすると選択しているオブジェクトをまとめてランダムに塗り分けることができます。
関数にしてみよう
スクリプトの基本はこれだけです。意外とかんたんでしたか? 聞き慣れない言葉ばかりで難しかったでしょうか?
発展編として、ランダムに色を生成する部分を関数化してみます。
for文の中のCMYKColorオブジェクトを生成する部分を関数として末尾に宣言してみるとこうなります。
(function () { if (app.documents.length === 0 || app.selection.length === 0) { return; } var sel = app.activeDocument.selection; for (var i=0; i<sel.length; i++) { var myCMYK = getRandomCMYKColor(); app.activeDocument.selection[i].fillColor = myCMYK; } })(); function getRandomCMYKColor () { var cmyk = new CMYKColor(); cmyk.cyan = Math.round(Math.random() * 100); cmyk.magenta = Math.round(Math.random() * 100); cmyk.yellow = Math.round(Math.random() * 100); cmyk.black = 0; return cmyk; }
関数化にあたり、変数の名前をちょっと変えました*5。
この程度のスクリプトだとあまり関数化するメリットがないのですが、次回はこのスクリプトを少しカスタマイズしていきますのでその布石です。
今回の記事は以上です。
To Be Continued...
次回はもうちょっと応用的な感じにカスタマイズしようと思います。
例えば、ペールトーンでまとめるとか。
例えば、さらに色相を統一してみるとか。
お楽しみに!
応用編はこちら。