siren クイックスタートマニュアル

siren クイックスタート
マニュアル
インストール手順
【インストール手順】
1. siren 公式サイト http://siren.xyz/ を開き、最新版の ZIP パッケージ版をダウンロードします。
2. ZIP パッケージに含まれるフォルダー siren_*.*.*_mingw32 (* はバージョン番号が入ります) を任意の場所に展開し
ます。(本解説では F ドライブの直下に siren_0.0.10_mingw32 を展開したものとして解説します)
3. 以上です。
上記の手順が分かりづらい方は、次のページからの図説を参照してください。
上記の手順ができた方は、図説をスキップして次章を参照してください。
1. WWWブラウザーで「http://siren.xyz/」を開き、ページの中央にある「最新版ダウンロード」をクリックします。
2.下図のようなページが表示されます。赤い丸で囲まれた ZIP パッケージ版のリンクをクリックしてください。
※下図はバージョンが「v0.10」ですが、バージョンが変わっていても同様の手順で入手します。
3.保存の確認が出てきたら、「保存」を選択してください。
4.ダウンロード完了後、ダウンロードフォルダーを開くと ZIP パッケージが保存されていることが分かります。
保存ができていることを確認したら、WWWブラウザーを閉じても構いません。
5.ZIP パッケージをダブルクリックして開くと、siren_0.0.10_mingw32 というフォルダが表示されます。
(バージョン番号が違う場合がありますが手順は同じです)
6. 赤い丸で囲ったフォルダーをドラッグして、任意のフォルダーにコピーします。
・パスに日本語や半角空白文字が含まれていないフォルダーにコピーするのが安全です。(意味が分からない方は、USBメモリーなどのドライ
ブの直下にコピーしてください) この例では、F ドライブの直下にコピーしています。
6. コピーできたらフォルダーをダブルクリックして開きます。
6. フォルダーを開くと、次のようなファイルが表示されていると思います。正しく表示されたら、インストール作業は完
了です。
インタラクティブシェル isr を実行する
【インタラクティブシェル isr とは】
siren インタラクティブシェル「isr」は、siren の機能を対話的に入力してすぐに結果を得るためのコマンド入力型のアプ
リケーションです。入力の手間がかからないちょっとした計算であったり、確認などは isr を使うと効率的に行うことがで
きます。
ここでは、siren が正しくインストールされ、お使いのコンピューターで実行できるかのテストを兼ねて、isr を実際に動
かしてみましょう。
【インタラクティブシェル isr の起動手順】
1. F:\siren_0.0.10_mingw32\isr.exe をダブルクリックして開きます。
2. コマンドプロンプトが表示され、入力待ちになっていれば成功です。
3. 終了するには、コマンドプロンプトのウィンドウを閉じるか、exit とタイプしてエンターキーを押下してください。
上記の手順が分かりづらい方は、次のページからの図説を参照してください。
上記の手順ができた方は、図説をスキップして次章を参照してください。
1. インストールしたフォルダーに入っている、isr.exe をダブルクリックします。
2. 次のような確認が出てきた場合、「実行」をクリックします。
3. 次の画面が出てきたら成功です。終了するには、左上の×マークをクリックします。
インタラクティブシェル isr で遊ぶ
【isr で遊ぶ】
isr の起動と終了方法が分かったら、今度は実際に isr から siren の幾何演算機能を呼び出してみましょう。
【遊び方】
isr を起動し、次の黄色い部分を入力します。白い部分は入力する必要はありません。
・「⏎」マークの部分で、エンターキーを押します。このマークは実際には表示されません。
mirb - Embeddable Interactive Ruby Shell
> box = Prim.box [10, 10, 10]⏎
=> #<Shape:0x1f55b20 @type=SOLID>
> _
上記の入力で「box」という名前の大きさ 10 x 10 x 10 の立方体が作成されました。
続けて「box.volume」と入力してください。
> box.volume⏎
=> 1000
> _
box の容積が「1000」と表示されました。
このように対話的に siren の機能を呼び出すことができます。詳しい入力方法は、リファレンスマニュアルやサンプルス
クリプト集をご覧ください。https://github.com/dyama/mruby-siren/wiki
siren スクリプトファイルの実行
【siren スクリプトファイルとは】
isr で入力していた一連コマンドをテキストファイルに保存したものを siren スクリプトファイルと言います。isr に対し
て、毎回入力しなくて良いため、バッチ処理に向いています。
【使い方】
1. コマンドプロンプトを起動して、siren のインストールフォルダーに移動します。
Microsoft
mirb
- Embeddable
Windows [Version
Interactive
6.1.7601]
Ruby Shell
Copyright (c) 2009 Microsoft Corporation. All rights reserved.
> box = Prim.box [10, 10, 10] ⏎
C:\Users\user>cd
=> #<Shape:0x1f55b20
/d F:\siren_0.0.10_mingw32⏎
@type=SOLID>
> _
F:\siren_0.0.10_mingw32>_
2. 試しに、同梱しているサンプルスクリプトの「tree.rb」を実行します。(インストールフォルダー内の「examples」
フォルダーに入っています。) siren コマンドの後にスクリプトファイルのパスを入力してエンターキーを押します。
F:\siren_0.0.10_mingw32>siren examples\tree.rb⏎
done.
F:\siren_0.0.10_mingw32>_
上図のように「done.」と表示されたら成功です。エクスプローラーでインストールフォルダーを開いてください。
3. 「tree.igs」という名前の IGES ファイルが生成されています。
4. 「tree.igs」を対応ソフトで開いて、siren スクリプトによるモデリングが正しく行われているかを確認します。
下図は「ライノセラス」で開いたところです。
siren スクリプトファイルの作成
【siren スクリプトファイルとは】
siren スクリプトファイルの実行方法が分かったところで、今度は自分でスクリプトを書いてみましょう。
【スクリプトファイルの作成手順】
1. 任意の場所にテキストファイルとして作成、内容を記述して保存します。
・日本語版 Windows の場合、文字コードは「Shift-JIS」(もしくは「CP932」)を指定します。
・改行コードは CRLF、LFのみのいずれでも構いません。
・拡張子は「.rb」にしておくことをお勧めします。(「.txt」のままでも実行に支障はありません)
2. 前章と同様に siren コマンドにスクリプトファイルのパスを指定して実行します。
上記の手順が分かりづらい方は、次のページからの図説を参照してください。
上記の手順ができた方は、図説をスキップして次章を参照してください。
1. 任意の場所に「test.txt」という名前でテキストファイルを作成します。
・この時、半角英数のみのファイル名にしてください。半角スペースや日本語は含めないでください。
2. test.txt をメモ帳で開き、次のように入力して保存します。保存したらメモ帳は閉じて構いません。
3. 「スタートメニュー」の「すべてのプログラム」をクリックし、「アクセサリ」フォルダーにある「コマンドプロンプ
ト」をクリックします。
4. 下図のような「コマンドプロンプト」が起動します。
5. 前章の手順と同様に、siren のインストールフォルダーに移動します。
・黄色い部分だけ入力してください。
・「⏎」マークの部分で、エンターキーを押します。このマークは実際には表示されません。
Microsoft Windows [Version 6.1.7601]
Copyright (c) 2009 Microsoft Corporation.
All rights reserved.
C:\Users\user>cd /d F:\siren_0.0.10_mingw32⏎
F:\siren_0.0.10_mingw32>_
6. siren コマンドの後に、作成したスクリプトファイルのパスを指定しエンターを押します。例では「F:\test.txt」で
す。
F:\siren_0.0.10_mingw32>siren F:\test.txt⏎
OK
F:\siren_0.0.10_mingw32>_
上図のように「OK」と表示されたら成功です。コマンドプロンプトを閉じて構いません。siren のインストールフォル
ダーをエクスプローラーで開いてみましょう。
7. 「box.igs」という名前の IGES ファイルが生成されています。
8. 「box.igs」を対応ソフトで開いて、siren スクリプトによるモデリングが正しく行われているかを確認します。
下図は「ライノセラス」で開いたところです。
siren viewer の利用
【siren viewer とは】
siren に付属している簡易 3D モデルビューアです。現在は開発中のため最低限の機能しかありませんが、ライノセラスな
どの商用 CAD ソフトをお持ちでない方などの、モデルデータの確認用途には使えると思います。
ビューア本体は WebGL ベースで記述しているため、WebGL に対応している WWW ブラウザーであればモデルを表示す
ることができます。
動作確認済の環境は次のとおりです。以下に示す環境以外でも、多くのプラットフォームで動作するはずです。
・Microsoft Windows 7
・ Internet Explorer 11
・ Mozilla Firefox 42
・ Google Chrome 46
・ Opera 33
・Linux (LMDE2/x64)
・Mozilla Firefox
・Google Chrome
・Opera
・MacOS X
・Safari
・Android
・Mozilla Firefox
・Google Chrome
・Opera
【siren viewer のしくみ】
siren viewer は次のように動作します。今のところ BRep ファイルのみですが、簡単に IGES や STEP、STL に対応でき
ます。
BATファイル or
シェルスクリプト
siren
実行エンジン
BRep
ファイル
brep2js
siren スクリプト
model.js
JavaScriptファイル
siren-viewer.js
JavaScriptファイル
siren-viewer.html
HTMLファイル
three.js
各WWW
ブラウザー
ユーザに
表示
Windows 環境では、BAT ファイル(siren-viewer.bat) を BRep ファイルのパスを引数にして実行すれば、3D モデルを
表示してくれます。つまり、次のことが可能です。
・エクスプローラ上で、siren-viewer.bat にBRepファイルをドラッグ＆ドロップ→表示
・拡張子 .brep を siren-viewer.bat に関連付け→ BRep ファイルを開くだけで表示
【siren viewer のスクリーンショット】
以上でクイックスタートマニュアルは終わりです。
さらに詳しい情報は次のリンクを参照してください。
siren チュートリアル
http://siren.xyz/tutorial.html
siren リファレンスマニュアル
https://github.com/dyama/mruby-siren/wiki/Reference-manual
siren サンプルスクリプト集
https://github.com/dyama/mruby-siren/wiki/Sample
siren 更新履歴
https://github.com/dyama/mruby-siren/commits/master
最新版の入手
https://github.com/dyama/mruby-siren/releases
また、不具合を発見した場合・ご要望・ご質問などは、次のリンクからお願いします。
(Github というサービスは英語ですが、日本語での投稿でも構いません)
https://github.com/dyama/mruby-siren/issues

Download Report