messykitchenなブログ

ただひたすらに散らかった台所や人生やその他を晒す。

脱W〇rd, 脱E×cel, 脱@st@h = Markdown, PlantUML, etc. : #7

スプライトを表示する

スプライトってどんなもの?

ドキュメントより引用:

Spriteは、図で使用できる小さなグラフィック要素です。

たとえば、こんな画像を配置したいとします。

※ PlantUML の HP より画像を拝借 & リサイズ

表示するにはどうするの?

白黒ですが、記述は次のようになります。

@startuml ./output/

component   "<$demo>" as demo #white

right header
%date[yyyy.MM.dd 'at' HH:mm]%
endheader

sprite $demo [40x36/16z] {
dT27aciX20PWgdX0Szx_RI_YzXRd_hj9BD_029oa8Hp5-8XHFsEkm2VCsFe9Q_wy77hJO3XmU50keyPkHyCJEvkB61yDkPqmy-xNSzZ2p7euFd59klNkzBIj
Xn-ympn3W7ZWBZnp_X-kzVqYLCMzk0o_kHPpZWv0sbIifUgF-vwvw1yS-HmZOZgtnXbjIztvSR1uTNJD4VcdEaOn1EhpVimxC-ErtkgOKRcOnhWK8Vz8_A4w
FUvxlCnbx4GJQUlN28c5kOqkEbRxKVNSuvNkJmXBXjchytfFzItuJZtPggTAdYZZ35NFFyXG04ebAWXjkP2Q9euekLcD5aMKrqBs2BUJ7gybEq5brLh1QRKe
1o0H1QrgfQtP2-u52swNqMekkI9zgScl2z5t1tmbrBMg_VT5kLro2FoHSfNUaNuDupy
}

@enduml

$demo を下記のように設定すると、色が付きます。

私が知らないだけだったかもなのですが、カラーなスプライトも表示できるようになってました。

sprite $demo [40x36/color] {
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzztrzRzz
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzztJuvzz
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzyvt&zizz
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz>s~u:zzue
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz>sWtauetJtJ
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz>sWtatrs~uvzz
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzRsWtau:o~yvzzzz
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzRsWzRtrs~ufzzzz
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzu:tJyvs~tJzzzz
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzztJuNtat&zzzz
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzyetJuezzzz
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzrRRraNuvzzzzzz
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzyW:JJRrJJNrn>zzzz
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzWO~JW:W:W:RrJJJJvi
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzK<#e~bRrW:RrRrNarR
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzK<#f#v*MJKW:ivvivi
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzK<#e#v#w*drRzzvivi
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzK<#f#v#v;uvRzzvivi
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzK<#f#v#v*urRzzvivi
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzK<#f#v#v*urRzzvivi
zzzzzzzzzzzzvie;ZbrRzzzzzzzzzzviicibrRzzzzzzzzzzrRRbW:vizzvjzzK<#f#v#v*urRzzvivi
zzzzzzzzviaNQoU$U%QHZrzzzzrSeci%uWuXe$eMzzzzrRRs:H!%!$:XaNzzzzK<#f#v#v*urRzzvivi
zzzzzzr>V*Q$YHYHYIYIU$UpmviJqGynynynz*qYiJRr&H!$&%&%:&&%&%JKviOP#e#v#v*urRzzvivi
zzn>ZaQHY%YIYHYYYHmOm<Y%UGq%z&ynypypzgzxz-dn>H&&:&>Z&%&%&%!$>Y;L#w#v#v*urRzzvivi
N&QGU$YHYHYHYHm;qfd+qwv>YHUHd%uXzfzyzPzizgzMuXRH:IefeP:YJ-J-!%&%#-#v#w*uvRzzvivi
*-MZYHYHYHYHYHYHlsqfqOlsYHYHY%YHhXz:zfzMypynynz%mHInVtiweO_p&%&%&%&I#M*urRzzvivi
#v#v;-QHYHYHYHYHY%YHYIY%YHYHYHYIU%YmqYynynynynynz&ynRG>I&%&%&%&%&&&%!$:pvizzvivi
#e#v#w#e_pYHYHYHYHYHYHYHYHYIYHU%Ypmfr;ynyoynyoynuXmZvQNL!%:&&%&&&%&%JLn>zzzzvivi
#v#v#v#v#v;MMIYHYHYHYHYHYHY%YYiNvizzvPyXyoynyXqZmuvizza;&%:&&%&%_pivzzzzzzzzvivi
#-#e#v#v#v#w#e>qUHYHYHY%UHdsvizzzzzzvhyoynqYqtvizzzzzziv&%&%>YaOzyzzzzzzzzzzvivi
ivK;#N#f#w#v#v#v*MIIUHdLr?zzzzzzzzzzzzqZqrrRzzzzzzzzzzrR>YVsvizzzzzzzzzzzzzzvivi
zzzzef;L#N#w#v#v#w#eW;zzzzzzrRivrRzzzzvRzzzzzzrRivrRzzzzrRzzzzzzn>ivvizzzzzzvivi
zzzzzzviae#-#e#w#v#favzzzzzzrReerRzzzzzzzzzzzzn>eerRzzzzzzzzzzzziveevizzzzzzvivi
zzzzzzzzzzn>Js#M#v#vafzzzzzzzzvivizzzzzzzzzzzzzzvizzzzzzzzzzzzzzvivizzzzzzzzvivi
zzzzzzzzzzzzzzaN;+#:evzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzvivi
zzzzzzzzzzzzvzzzzyRrRrrRn>n>n>n>n>n>n>n>n>n>n>n>n>n>n>n>n>n>n>n>n>n>n>n>n>rRivvi

しかしながら、上記のようなデータを手動で作成するのは無理

どうやってスプライトのデータを作るの?

詳細は説明書に書いてありますので、そちらを参照してください。

作成方法1: コマンドライン

java -jar plantuml.jar -encodesprite 16z foo.png

しかし、次の方法のほうが楽にできるかも。

作成方法2: GUI

以降、Windows上での動作です。(java だから、どのOS上でも同じかな?)

  1. GUI を起動(plantuml.jar をダブルクリックなど)する。

  2. メニューバーの File / Open Sprite Window をクリックする。

  3. 画像をクリップボードへコピーする。

  4. エンコードされたスプライトデータが吐き出されるので、必要なものをコピーして使用できます。

スプライトデータは別ファイルにしておいて、!include するのがいいかもしれません。

脱W〇rd, 脱E×cel, 脱@st@h = Markdown, PlantUML, etc. : #6

ifdef/endif で表示を制御してみる

次のような、記述が長いコンポーネントが存在したとします。

'!define SHOW_LONGTEXT
'!define SHOW_STORY

rectangle myaccident [
  私の身の周りのできごと
!ifdef SHOW_LONGTEXT
  話せば長くなりますが、
  この数年間のできごとを
  伝えなければなりません。
!endif
]

rectangle story [
  始まりは、あの年のことでした。
!ifdef SHOW_LONGTEXT && SHOW_STORY
  奴らの携帯電話のメールがおかしい。
  奴らのパソコンのメールがおかしい。
  奴らの休日の行動がどうもおかしい。
  はい、やつらの(自主規制)、確定。
!endif
]

myaccident --> story

そのままの描画だと、大きな rectangle になってしまいそうですが、 実際には次のようなコンパクトな図になります。

これは先頭2行の !define と、文中の !ifdef !endif により、有効な範囲が制御されているためです。

コメント ' をひとつ、外してみます。

!define SHOW_LONGTEXT
'!define SHOW_STORY
...

するとこんな感じ。

もうひとつ、コメント ' を外します。

!define SHOW_LONGTEXT
!define SHOW_STORY
...

全ての文章が現れました。

!ifdef には、複数の条件を組み合わせることができます。&& ||

また、!ifndef というキーワードもあるようです。

上手に組み合わせて、描画範囲を適切に制御したいな、と。

脱W〇rd, 脱E×cel, 脱@st@h = Markdown, PlantUML, etc. : #5

コンポーネントに色を付ける

コンポーネントには色を付けることができます。
多用するとごちゃごちゃしてくるので、注目すべき部分に絞って適用したいところです。

これまでの説明でも何度も出てきていますが、色名称色コード を指定することで、 コンポーネントへの色付けを実現します。

component    "<color:#white>compoA"    as obj1 #red
component   "<color:#white>コンポB"    as obj2 #blue
component   "<color:#white>こんぽC"    as obj3 #green
component   "<color:#white>konpoD"    as obj4 #10A0F0

(この例では、文字の見やすさのため、文字色を白色に設定するタグも書いています)

単色だけでなく、2色を指定し、グラデーションをかけることもできるようです。

component    "<color:#white>compoA"    as obj1 #red-blue
component   "<color:#white>コンポB"    as obj2 #red|blue
component   "<color:#white>こんぽC"    as obj3 #red/blue
component   "<color:#white>konpoD"    as obj4 #red\blue

(この例は、なんだかキタナイ色使いだな・・・)

細かな設定はできませんが、技術資料を作るにあたっては、それは不要でしょう。

脱W〇rd, 脱E×cel, 脱@st@h = Markdown, PlantUML, etc. : #4

コンポーネント図でオブジェクトの配置を調整する (together 編)

グループ化するような方法でも、オブジェクトの配置をできます。
together キーワードを使います。

まずは、単純にコンポーネントを作ってみた場合です。

component    compoA  as obj1 #lightpink
component   コンポB  as obj2 #lightblue
component   こんぽC  as obj3 #lightgreen
component   konpoD  as obj4 #lightgray

ここで、B と C を近くに配置したい場合、それぞれを together キーワードで括ります。

component    compoA  as obj1 #lightpink
component   konpoD  as obj4 #lightgray

together {
component   コンポB  as obj2 #lightblue
component   こんぽC  as obj3 #lightgreen
}

前回使った、[hidden] も組み合わせて使用できます。

component    compoA  as obj1 #lightpink
component   konpoD  as obj4 #lightgray

together {
component   コンポB  as obj2 #lightblue
component   こんぽC  as obj3 #lightgreen
obj2 -[hidden]-> obj3
}

コンポーネント間の位置がちょっと気になる場合は、次のような操作を試し、工夫してみてください。

  • 記述順序を変えてみる
  • -[hidden]-> -[hidden]> をうまく使う

脱W〇rd, 脱E×cel, 脱@st@h = Markdown, PlantUML, etc. : #3

コンポーネント図でオブジェクトの配置を調整する

PlantUML では、通常は特に指示しなくても、ツールが自動的にいい塩梅にオブジェクトを配置してくれます。

component    compoA  as obj1 #lightpink
component   コンポB  as obj2 #lightblue

オブジェクト同士を接続するときに、次のように hidden キーワードを付与すると 線が描画されずにコンポーネント間の位置関係を調整できます。

component    compoA  as obj1 #lightpink
component   コンポB  as obj2 #lightblue

obj1 -[hidden]-> obj2

component    compoA  as obj1 #lightpink
component   コンポB  as obj2 #lightblue

obj2 -[hidden]> obj1

Note: -[hidden]->-[hidden]> が異なることに注意。

次のようなマクロを設定しておくと、便利かもしれません。

/'レイアウト調整用マクロ'/
!define cd(o1, o2)  o1 -[hidden]-> o2    /'Connect to Down'/
!define cr(o1, o2)  o1 -[hidden]>  o2    /'Connect to Right'/

component   compoA  as obj1 #lightpink
component   コンポB  as obj2 #lightblue
component   こんぽC  as obj3 #lightgreen

cd(obj2, obj1)
cr(obj3, obj2)

脱W〇rd, 脱E×cel, 脱@st@h = Markdown, PlantUML, etc. : #2

コンポーネント図で四角形を描画する

PlantUML のコンポーネント図において、次の方法で四角形の描画と文字を表示できます。

' 方法1
rectangle   "表示文字 1"    as alias_1
' 方法2
rectangle   alias_2 [
                表示文字 2
            ]

四角形に色を付けたい場合は、色コードを付与します。

' 方法3
rectangle   "表示文字 3"    as alias_3  #red
' 方法4
rectangle   alias_4 #0000FF [
                表示文字 4
            ]

エイリアス名で操作できます。

alias_1 -> alias_2  /' to right '/
alias_3 --> alias_4  /' to down'/

おまけ:オンライン版 PlantUML

脱W〇rd, 脱E×cel, 脱@st@h = Markdown, PlantUML, etc. : #1

シーケンス図で "実行仕様" を付与

PlantUML を使って、シーケンス図を描いてみます。
注:UMLとしての記述の厳密さ && 例題は気にしないで。

actor        ann as a    #red
actor       bob as b    #blue

a -> b : attack
a <- b : counter-attack

hide footbox

この例では、2つのオブジェクト (annさんとbobさん) で、メッセージのやり取りをしています。
注:UMLとしての記述の厳密さは、ここでは気にしないでください。

ここで、annさんからbobさんがメッセージを受けてなにかを実行する場合、これを「四角いバー」で示すことができます。

PlantUML では、ライフライン(Lifeline) に 実行仕様 (Execution Specification) (または活性区間)を付与する方法は、いくつかあるようです。

必要な部分に明示する方法 (activate, deactivate)

実行仕様の記述が必要になった部分/不要になった部分に、明示的に記述します。

actor        ann as a    #red
actor       bob as b    #blue

a -> b : attack
activate b
a <- b : counter-attack
deactivate b

hide footbox

自動的に付与する方法 (autoactivate)

autoactivate on を書いておくと、自動的に実行仕様を付与することができます。

actor        ann as a    #red
actor       bob as b    #blue

autoactivate on

a -> b : attack
a <- b : counter-attack

hide footbox

必要な部分に明示する方法 2 (++, --)

実行仕様の記述が必要になった部分/不要になった部分に、明示的に記述します。
前述の方法とは異なり、メッセージ(Message) の記述と同時に、実行仕様を指定できます。

個人的に便利に感じる の使い方です。

actor        ann as a    #red
actor       bob as b    #blue

a -> b ++ : attack
a <- b -- : counter-attack

hide footbox

おまけ: 実行仕様に 色を付ける

メッセージの最後に色コードを付与すると、実行仕様に色が付きます。

actor        ann as a    #red
actor       bob as b    #blue

a -> b ++ #green: attack
a <- b -- : counter-attack

hide footbox