[[SIGVerse.org:http://sigverse.org]] | [[SIGVerse Forum:http://sigverse.org/sigverse/forum/]] | [[SIGVerse Wiki (JP):http://www.sociointelligenesis.org/SIGVerse/]] | [[SIGVerse Web:http://web.iir.nii.ac.jp/sigverse/web/]]

----

%%%''&size(24){SIGVerse Web};''%%%

#contents

----

* SIGVerse Web とは？ [#v827625f]
SIGVerse Web は''SIGVerseアプリケーションを構築するためのウェブインタフェースシステム''です. SIGViewerと一緒に使う事で，Cygwinのようなターミナルコンソール経由でのコマンドラインでの開発環境を用いることなく開発を進めることができます．プログラムはウェブベースでの簡易テキストエディタで作成することになります．コンパイルや設定ファイルの配置，プログラム実行などがクリックするだけで実行できます．ブラウザがあれば，開発環境が整っていないＰＣからでも簡単に開発を進めることができるわけです．

SIGVerse Web の主な特徴は以下の通りです:
- ウェブベースでのプログラムエディタとコンパイラ
- SIGServerの遠隔操作（実行・停止・設定ファイルの整備など）
- クラウド上でのプログラム開発環境の提供

----

* セットアップ [#vd852cbc]
** Webuser アカウントの登録 [#z9349b00]
- トップパネルで SIGVerse Web の利用登録を行い，ログインして下さい．http://web.iir.nii.ac.jp/sigverse/web/login/index.php

&ref(SIGVerse Web/Register&Login.png,alt-title-Register & Login on Top Panel,80%);

** SIGVerse のインストール/アンインストール [#f18f6cb3]
- ログインの次に，あなたのワークスペースにSIGVerseサーバをインストールします．このSIGVerseサーバを修正・変更していくことで，あなたの実行したい実験の世界を作ることになります．別の言い方をすると，他人が作ったSIGVerseの世界を用いる場合には，このインストールは必要無い，という事になります．
- メインページの， '''Connect to Socio''' の所にSIGVerse Web のサーバーホスト名（socio2.iir.nii.ac.jp）が記載されている事を確認し，Connect ボタンを押します．ここでsocio2.iir.nii.ac.jp 以外のSIGVerse web サーバを使う場合には，そのホスト名を入力して下さい．また，Username : webuser は変更しないで下さい．
- 次に Install という項目にあるフィールドにインストールしたいSIGVerseバージョンを記入します．通所は最新版のバージョンが既に記載されているので，何もしなくて結構です．Install ボタンを押すことで，あなたのワークスペース上にSIGVerseサーバがインストールされます．
- ''*重要*'' '''Install''' ボタンをクリックした後，作業完了まで5分程度かかることがあります．ログが出力され，インストールが完了したことが確認できるまで，他のボタンを押さないでください．
- インストールの完了後，'''Go''' ボタンをクリックして， '''Workspace''' にアクセスして下さい．

&ref(SIGVerse Web/SetupPage.png,alt-title-Setup Page,90%);

** '''* NIIで運用するSIGVerseサーバー上のアカウント''' [#wb2d5aa3]
- 国立情報学研究所(NII)で運用しているSIGVerseサーバに接続するためには，サーバでのユーザアカウントが必要になります．
-- ※だたし創発システムシンポジウムにご参加の方はワークショップ当日に限り，アカウントをこちらで用意致します
- NIIで運用するサーバ上のアカウント発行には制約条件がありますので，稲邑（inamura@nii.ac.jp）までご連絡をお願い致します．
- もしくは，１ヶ月間の有効期限付き評価用アカウントの発行も可能です．評価用アカウントの利用方法は以下の通りです．

** 評価用アカウントの利用方法 [#j23b2e39]
- SIGVerse Web にログインした直後のメインページからSSH-Keyをダウンロードして下さい．ダウンロードしたファイルを展開をすると二つのファイル(id_rsa and id_rsa.pub) が得られるので，C:\Program Files\SIGViewer-<version>\SIGViewer\.ssh というディレクトリに置いて下さい．
- SSH接続に用いるパスフレーズ(passphrase)は，展開ファイルのうちの一つpassphrase.txtに記載されています．
- 評価用アカウントは毎月末に期限が切れます．月が新しくなったら再度上記のSSH-Keyをダウンロードして設定を行って下さい．
- SIGViewerの機能を用いたSSHによるサーバーへの接続方法は，(SSH Connection)を参照して下さい．

----

* 基本的な開発ガイド [#u57f6de6]
** ワークスペースの概要 [#w170fd18]

&ref(SIGVerse Web/Workspace.png,alt-title-Workspace,80%);

- プロジェクトディレクトリ
-- The left panel consists of a file navigation for project directory. You can create new project folder and file, upload project file, and even import a whole project (Refer to '''Import''' below).

- 編集エリア
-- The center area is the editor for programming code developments. It supports multiple programming languages with syntax highlight, search and replace, and multi-tab for working of several files in parallel.

- コントロールパネル
-- The lower panel is the Control Panel for code compiling and execution.
-- ''Make'' - To '''make''' controller codes with a Makefile. Please make sure to prepare the Makefile.txt as below (sample):

Makefile.txt

#highlight(xml){{
#SIGVerseソースの場所指定
SIG_SRC  = ../sigverse-$(sigversion)/include/sigverse

#オブジェクトファイルの指定
OBJS     = Controller.so

all: $(OBJS)

#コンパイルを行います。
./%.so: ./%.cpp
	g++ -DCONTROLLER -DNDEBUG -DUSE_ODE -DdDOUBLE -I$(SIG_SRC) -I$(SIG_SRC)/comm/controller  -fPIC -shared -o $@   $<
}}

-- ''Build'' - To "build" the project files into the current SIGVerse version (indicated on the right end of Control Panel).
-- ''Import (.zip)'' - To import a project from local machine, upload the zip file of the project (with all files inside) onto Project Directory. Press '''Import''' to extract it (refresh to view the new folder).
-- ''Export'' - To download a project in zip format.
-- ''Delete'' - To delete a project (with all files inside).
-- Execute [Admin] - For administrative purpose only.

** SIGServer の実行 [#t214e637]
- ''Run'' - To execute SIGServer (./sigverse.sh).
- ''Check'' - To view output of the execution (for possible error).
- ''Kill'' - To terminate SIGServer.

** SSH 接続 [#s710319a]
- Input host name, user name and pass phrase
-- Run SIGViewer.exe on local machine.
-- From the top '''Setting''' menu, select '''SSH Connect'''.

#ref(SSH接続/ssh_connect1.jpg)

-- Input the server host name (or IP address), user name and passphrase on the dialogue box.
-- For temporary access,
--- Server host name: socio2.iir.nii.ac.jp
--- User name: testuser
--- Passphrase: (as written in passphrase.txt)

#ref(SSH接続/ssh_connect2.jpg)

-- Check the '''Use RSA key to login'''.
-- Enable port forwarding (in most cases blocked by firewall) by the following steps.
-- Check '''Local port forwarding with login''' and input the following details:
--- Local port: Port on local machine
--- Listen host:  Listening machine（normally '''localhost''')
--- Remote port: Port on server

#ref(SSH接続/ssh_connect3.jpg)

-- Check '''Remote port forwarding with login''' and input the following details:
--- Server port: Port on local machine
--- Listen host:  Listening machine（normally '''localhost''')
--- Local port: Port on server

#ref(SSH接続/ssh_connect4jpg.jpg)

-- * In normal cases, please use 9001 and above for local port forwarding, and 8001 and above for remote port forwarding. If the port number is currently in used, please try other number.
-- Check '''Download shape file''' for automatically update shape files from server.
-- Press '''Connect''', the SSH connection is established if the message "SSH Authentication succeeded (server host name)" appears on the bottom left of SIGViewer.

#ref(SSH接続/ssh_connect5.jpg)

----

* チュートリアル [#j1dec720]
** 最初のテスト (Tutorial01) [#x282fbcb]
- To simulate a falling object due to gravitational and external forces.
- ① 新しいプロジェクトの作成
-- Click the '''Add Folder''' icon on the top of the left Project Directory.
-- Insert "Tutorial01" and click SAVE.
-- A new folder named "Tutorial01" appears on the Project Directory.

- ② エージェントコントローラの作成
-- An agent is an autonomous object controlled by a controller.
-- Click into "Tutorial01" and click '''Add File''' to create the controller source code.
-- Insert "MoveController" and select "cpp" as the file type.
-- Insert the following codes into the Editor Area and click SAVE.

MoveController.cpp
 
#highlight(cpp){{
 #include "Controller.h"
 #include "Logger.h"
 
 //ControllerのサブクラスMoveControllerの宣言します。
 class MoveController : public Controller {
 public:
 
   //定期的な処理を行うonActionの利用を宣言します。
   double onAction(ActionEvent&);
 };
 
 
 double MoveController::onAction(ActionEvent &evt) {
   return 5.0;      //次にonActionが呼ばれるまでの時間を返します。
 }
 
 //自身のインスタンスをSIGVerseに返します。
 extern "C" Controller * createController() {
      return new MoveController;
 }
}}

-- The above controller codes do nothing except execute "onAction" on every 5 s.

- ③ コントローラー·コードのコンパイル
-- Create a file named "Makefile" with "txt" file type.
-- Insert the following codes into the Editor Area and click SAVE.

Makefile.txt

#highlight(xml){{
#SIGVerseソースの場所指定
SIG_SRC  = ../sigverse-$(sigversion)/include/sigverse

#オブジェクトファイルの指定
OBJS     = MoveController.so

all: $(OBJS)

#コンパイルを行います。
./%.so: ./%.cpp
	g++ -DCONTROLLER -DNDEBUG -DUSE_ODE -DdDOUBLE -I$(SIG_SRC) -I$(SIG_SRC)/comm/controller  -fPIC -shared -o $@   $<
}}

-- In the Control Panel, insert the project name "Tutorial01" for '''work/''' and click '''Make'''. Refresh the Project Directory to ensure the creation of "MoveController.so" file. If "MoveController.so" file is not created, means there is a compilation error during Make. Check your programming codes. Also, in the Makefile.txt, ensure that there is no any extra space in front and behind the lines, and the spacing in front of the last line (...g++) is a tab and not multiple space bar.

- ④ エージェントと仮想世界の作成
-- Create a new file named "NewWorld" with "xml" file type.
-- Insert the following codes into the Editor Area and click SAVE.

NewWorld.xml

#highlight(xml){{

<?xml version="1.0" encoding="utf8"?>
 <world name="myworld">
 
 <!--重力の設定-->
   <gravity x="0.0" y="-9.8" z="0.0"/>  
  
 <!--エージェントToy_Dのインスタンス作成-->
   <instanciate class="seToy_D.xml">
 
 <!--エージェント名-->
         <set-attr-value name="name" value="Toy_D"/>  
 
 <!--C++言語の指定-->
         <set-attr-value name="language" value="c++"/> 
 
 <!--作成したコントローラの指定-->
         <set-attr-value name="implementation" value="./MoveController.so"/>
 
 <!--動力学演算フラグ-->
         <set-attr-value name="dynamics" value="true"/>
  
 <!--エージェントの最初の位置(x,y,z)-->
         <set-attr-value name="x" value="0.0"/>
         <set-attr-value name="y" value="18.0"/>
         <set-attr-value name="z" value="5.0"/>
 
 <!--エージェントの質量設定-->
         <set-attr-value name="mass" value="1.0"/>
 
  </instanciate>
</world>
}}

-- The above codes create a virtual world named "myworld".
-- In the world, an agent named "Toy_D" using the instance of "seToy_D.xml" is created.
-- The "implementation" attribute attaches "MoveController.so" as the controller of the agent.
-- With the "dynamics" attribute value set to "true", the agent is subjected to dynamics simulation.
-- The initial position (x,y,z) and mass are set.

- ⑤ シミュレーションの実行
-- On the Control Panel, build the project by using '''Build'''.
-- Set "Port" to 9001 and "World" to "NewWorld.xml"
-- Click '''Run''' to execute SIGVerse.
-- Click '''Check''' to check the last line of the output is " Java VM start ok" for successful execution.
-- If you see "cannot bind socket: Address already in use", just try another port number other than 9001.
Try bigger number, e.g. 9002, 9003, 9004, ... There are various reasons why the port is temporary being used.
-- Run SIGViewer. Establish SSH connection under Setting. Set host name as "localhost" and port no. to "9001". Click '''Connect to SimServer'''.
-- An agent in a virtual world appears as follows.
-- * View controls for SIGViewer:
--- Turn around - Right click
--- Zoom - Ctrl + Right click
--- Pan - Shift + Right click

#ref(動力学シミュレーションのサンプル/toy_1.jpg)

-- Click '''Send''' under SIM_CTRL_CMD (START) to start the simulation.
-- The agent falls straight down the ground.
-- '''Disconnect SimServer''' in SIGViewer and '''Kill''' in the Control Panel to terminate the simulation.

- ⑥ 外力の加える
-- To apply an external force to the agent, edit the agent controller as follows:

MoveController.cpp

#highlight(cpp:firstline[13]){{
 double MoveController::onAction(ActionEvent &evt) {
   return 5.0;      //次にonActionが呼ばれるまでの時間を返します。
 }
}}

　　               ↓

#highlight(cpp:firstline[13]){{
 double MoveController::onAction(ActionEvent &evt) {
   SimObj *obj = getObj(myname());  //自分自身の取得
   obj->setForce(0,0,300);         //z軸方向に300[N]の力を加える
   return 5.0;      //次にonActionが呼ばれるまでの時間を返します。
 }
}}

-- '''Make''', '''Build''' and '''Run''' the simulation as above.
-- The agent moves forward as below.

#ref(動力学シミュレーションのサンプル/toy_3.jpg)

** チュートリアルプロジェクトファイル [#u6078d14]
- Tutorial01 - &ref(SIGVerse Web/Tutorial01.zip);
- Tutorial02 - 
- Tutorial03 - 
- Tutorial04 - 
- Tutorial05 - 
- Tutorial06 - 
- Tutorial07 - 
- Tutorial08 - 
- Tutorial09 - 
- Tutorial10 - 

** SIGVerse Web と一般的な開発の違い [#r45b397b]

SIGVerse Web is developed with the aim to ease and reduce learning curve for novice users (who are not familiar to Linux environment) to begin with SIGVerse development. The development process explained above is slightly different to manual programming developments illustrated in the rest of the tutorials in this wiki.

- The files system in SIGVerse Web is organized based on "Project". You can develop all related files (.cpp, .so, .xml, .wrl, .x3d, etc.) under the same project folder. By using "Build", SIGVerse Web will automatically build all the files into the respective folders of the current SIGVerse version that you are working on. This files system will provide a better files organization and enables "Import" and "Export" of projects for backup and sharing purposes.

- ''*違い*'' In World files (.xml), the path to the controller's shared object file (.so) is always at the current directory, example:

#highlight(xml){{
<set-attr-value name="implementation" value="./MoveController.so"/>
}}

- In SIGVerse Web, you can install and execute all available versions of SIGVerse servers in the same development environment. Because of the independent files system, the same project codes can be executed in different SIGVerse versions based on your selection when you enter the workspace.

- ''*違い*'' To make sure the Makefile indicates the current SIGVerse version in your workspace during compilation, please make sure the first line of the Makefile.txt is as follows:

#highlight(xml){{
SIG_SRC  = ../sigverse-$(sigversion)/include/sigverse
}}

----

* ライブラリー [#rc33b193]
- Object Gallery

- World Gallery
-- Living Room (Small)
-- Living Room (Big)
-- Kitchen

- Controller Collection
-- Mobile Robot
-- Humanoid

- User Interface Systems
-- Kinect
-- Webcam

----

For any inquiry, suggestion, and feedback, please kindly contact Jeffrey [jeffrey@nii.ac.jp].

#highlight(end)
Front page   New List of pages Search Recent changes   Help   RSS of recent changes