RifidiWiki - User contributions [en]

Designer User's Guide

2008-06-05T18:34:39Z

Jochen: /* GPIO */

[[category:userDoc]]

=Requirements=
*Microsoft Windows 2000/XP/2003 or Linux (Ubuntu, Red Hat, SuSe)
*Sun Java Runtime Environment > 1.6.4 (J2SE 6.0)
*'''IMPORTANT:''' does not work with earlier JRE versions.

=Installation=
Designer is packaged in a standard installer, which makes installation very easy.

# Download the latest version of Rifidi Emulator from http://sourceforge.net/projects/rifidi/
# Double click to run the install. Follow the on screen instructions.

=Launching Rifidi Designer=

*Windows Users: Simply click the shortcut located in the Rifidi folder in the Start Menu/Programs folder.
*Linux Users: Double click the executable file located in the installation directory.

=Getting Started - Example Designer Simulation=
==Create Layout==
#Once the program is loaded, the main UI will be present. [[Image:Screen1.png |none|thumb|800px|The Rifidi Designer UI]]
#To create a new layout, click the 'file' and 'new'.
#Enter in a layout name, select size of the room (64x64 or 256x256 square feet) and click 'Finish'.[[Image:Screen2.png |none|thumb|400px|Create New Layout]]
#A new empty layout will be displayed in the UI ready for use [[Image:Screen3.png |none|thumb|800px|New Layout]]

==Add a Conveyor==
#Click on the 'Components' Tab to view the library of all available components to add to a layout.[[Image:Screen4.png |none|thumb|800px|The Rifidi Designer UI]]
#If the list is not expanded already, Click on the '+' next to RFID Base Models to expand the list. [[Image:Screen5.png |none|thumb|800px|The Rifidi Designer UI]]
#Highlight the 'Conveyor' component and drag and drop to the 'Layout Designer'
#The name and speed of the new component will show up in the "properties" tab at the bottom. You can change these values if you wish.
#You will now see the component displayed in the 'Layout Designer'. ''Note: For placement refer to the Component Placement Section''

==Add a Push Arm==
#Click on the 'Components' Tab to view the library of all available components to add to a layout.
#If the list is not expanded already, Click on the '+' next to RFID Base Models to expand the list.
#Highlight the 'Push Arm' component and drag and drop to the 'Layout Designer'
#The name and speed of the push-arm are given in the bottom tab marked "properties". You can edit them if you wish.
#You will now see the component displayed in the 'Layout Designer'. ''Note: For placement refer to the Component Placement Section''
#Right-click it and select Turn On to activate it
''Note: See the push-arm section for instructions on how to get a push-arm working''

==Add a Gate==
#Click on the 'Components' Tab to view the library of all available components to add to a layout.
#If the list is not expanded already, Click on the '+' next to RFID Base Models to expand the list.
#Highlight the 'Gate' component and drag and drop to the 'Layout Designer'
#Enter a name for the component, select a reader type and click 'Next'.
#Enter a name for the reader and click 'Finish'.
#You will now see the component displayed in the 'Layout Designer'. ''Note: For placement refer to the Component Placement Section''

==Add a Box Producer==
#Click on the 'Components' Tab to view the library of all available components to add to a layout.
#If the list is not expanded already, Click on the '+' next to RFID Base Models to expand the list.
#Highlight one of the 'Producer' components (choose based on the type of tag you wish to produce from this producer) and drag and drop to the 'Layout Designer'
#The name and speed of the pusharm are given in the bottom tab marked "properties". You can edit them if you wish.
#You will now see the component displayed in the 'Layout Designer'. ''Note: For placement refer to the Component Placement Section''

==Component Placement==
===Conveyor Placement===
#In the Layout Designer View, click on the conveyor. ''Note: Yellow arrows will show the direction of the conveyor''
#Move the conveyor to the desired location by holding the left mouse button down. ''Note: The area below the component will be highlighted in green when placement is valid and red when placement is invalid.''
#Release the left mouse button once the desired location has been reached.
#If placement is valid the component will move to the new location and if placement is invalid the component will move to the prior valid location

===Box Producer Placement===
#In the Layout Designer View, click on the Box Producer.
#Move the producer to the desired location by holding the left mouse button down. ''Note: The area below the component will be highlighted.''
#Once the producer is over the end of the conveyor, release the left mouse button to finish placement.

===Push Arm Placement===
#In the Layout Designer View, click on the Push Arm.
#Move the gate to the desired location by holding the left mouse button down. ''Note: The area below the component will be highlighted.''
#Once the push arm is next to the right end of the conveyor, release the left mouse button.
#To finalize the placement, verify the push arm is pointed in the direction to push over the conveyor (Look for shaded area to be over conveyor). If not then you can rotate the component by 90 degrees by clicking on the component and then clicking on the rotate 90 degrees button in the toolbar.
''

===Gate Placement===
#In the Layout Designer View, click on the Gate.
#Verify the space between the gate's legs can fit over the conveyor based on the conveyor's placement. If not then click on the gate and rotate 90 degrees by clicking on the 90 degree rotate button in the toolbar.
#Move the gate to the desired location by holding the left mouse button down. ''Note: The area below the component will be highlighted in green when placement is valid and red when placement is invalid.''
#Once the gate is over the center of the conveyor, release the left mouse button.

==Push Arm Instructions==
===Placing===
Place a push arm, and place a gate with an Alien reader near the push arm. Be sure to select the "Enable GPI/O for this reader in the New Reader Wizard. It should look something like this:
[[Image:push1.png |none|thumb|800px|The Rifidi Designer UI]]
===GPIO===
The push arm works by an Alien or LLRP (or any other reader that supports GPIO) reader sending a GPIO signal to the push arm. To connect up the GPIO, we first have to go to the GPIO perspective. Click on Perspectives -> GPIO. You should get a window that looks something like this:
[[Image:push2.png |none|thumb|800px|The Rifidi Designer UI]]
# Expand the Palette if it isn't already open by pressing the arrow on the right.
# Select the "Solid Connection" button in the palette and drag an arrow it from the Alien reader on top (in blue) to the push arm you want to move (in red). You can also just click on the alien and click on the push arm, and an arrow will be shown connecting the two.
#Don't forget to turn on the push arm and the gate. Other wise nothing will happen.
After that, the push arm should fire when you want it to.

==Create a Group==
#Click on the Layout Navigator tab.
#Right click on Grouped Components
#In the right click menu, click on create group
#In the create group wizard, enter in a group name (example: group1)
#You will now see the new group listed under Grouped Components

==Add Components to Group==
#Click on the Layout Navigator tab.
#Click on the '+' next to Ungrouped Components to expand the ungrouped components list if not expanded already.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#In the Ungrouped Components list, click on the conveyor component (Example: conveyor1).
#Hold the left mouse button down on the conveyor component and drag and drop into the Group (Example: group1)
#Repeat steps 2 - 4 for each or the remaining ungrouped components
#Once all the steps have been completed, you will now have all the components assigned to a group. (Example: group1) Now you can move the components around in a group in the Layout Designer instead of having to move each component seperately. There are other benefits of groups which will be described in later sections.

==Turn On Components==
There are two ways to turn on components:

#Click on the Layout Navigator tab if not already selected.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#Click on the '+' next to the group name (Example: group1) to expand the group if not expanded already.
#Right click on the conveyor component
#In the conveyor component right click menu, click on turn On
#Repeat steps 3-4 for each component in the group

or the short cut is to:

#Click on the Layout Navigator tab if not already selected.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#Click on the '+' next to the group name (Example: group1) to expand the group if not expanded already.
#Right click on group (Example: group1)
#In the group right click menu, click on Turn On
#This will Turn On all the components assigned to tha group

You can now connect to the virtual reader (Alien, AWID, Symbol, LLRP) you created with a client such as telnet, client library, middleware or EdgeServer.

==Start Simulation==
#On the Designer Toolbar, you can now click on the play button to start the simulation
#Once you start the simultaion you should now see boxes being produced and the conveyor and push arm moving at their defined rates.
#The client connected to the virtual reader should now report tags as the boxes pass through the gate's antenna.

==Pause Simulation==
#On the Designer Toolbar, you can now click on the Pause button to start the simultaion
#Once you pause the simultaion you should now see boxes being produced and the conveyor and push arm moving pause, left in the previous state.
#The client connected to the virtual reader will continue to be connected.

==Reset Simulation==
#On the Designer Toolbar, you can now click on the reset button to start the simultaion
#Once you reset the simultaion you should now see boxes being produced, the conveyor and push arm moving be reset
#The client connected to the virtual reader will continue to be connected.

==Turn Off Components==
There are two ways to Turn Off components:

#Click on the Layout Navigator tab if not already selected.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#Click on the '+' next to the group name (Example: group1) to expand the group if not expanded already.
#Right click on the conveyor component
#In the conveyor component right click menu, click on Turn Off
#Repeat steps 3-4 for each component in the group

or the short cut is to:

#Click on the Layout Navigator tab if not already selected.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#Click on the '+' next to the group name (Example: group1) to expand the group if not expanded already.
#Right click on group (Example: group1)
#In the group right click menu, click on Turn Off
#This will Turn Off all the components assigned to the group

The client should now disconnect from the virtual reader as if the device has been powered off

==Add Components to Group==
#Click on the Layout Navigator tab.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#Click on the '+' next to the group (Example: groups1) to expand the assigned grouped component list if not expanded already.
#Click on the conveyor component.
#At the bottom below the Layout Designer view you will now see the conveyor component's property view.
#Click on the speed property and change the value.
#The next time you Turn On the components (if not on already) and play the simulation you will see the new speed.

===Edit Box Producer Rate===
#Click on the Layout Navigator tab.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#Click on the '+' next to the group (Example: groups1) to expand the assigned grouped component list if not expanded already.
#Click on the box producer component.
#At the bottom below the Layout Designer view you will now see the box producer component's property view.
#Click on the rate property and change the value.
#The next time you Turn On the components (if not on already) and play the simulation you will see the new rate.

=Layout Navigation=
* The layout navigation is a tab on the left side of the Designer screen. It contains 3 collapsible lists of components:
# Grouped Components
# Ungrouped Components
# Generated Components
==Ungrouped Components==
* This is where all the ungrouped components are listed. Click on the plus sign to see them.
* You can also turn off and turn on all of the grouped components at the same time. To do this, right click on the "ungrouped components" and select "turn off" or "turn on".
[[Image:Screen6.png |none|thumb|800px|The Rifidi Designer UI]]
==Grouped Components==
* This is where all of the grouped components are listed. Click on the plus sign to see all of the groups, and click on the plus sign on individual groups to list the components in those groups.
* You can turn on and turn off everything in a group by right clicking on the group and clicking "turn on" or "turn off".
[[Image:Screen7.png |none|thumb|800px|The Rifidi Designer UI]]
==Generated Components==
* This is where you can find all of the components generated by a producer.
* You can delete these components by right clicking on them and selecting "Delete Entity".
[[Image:Screen8.png |none|thumb|800px|The Rifidi Designer UI]]

=MiniMap=
The MiniMap is on the lower left of the Designer screen. If you don't see it, click on views -> Show MiniMap.
[[Image:Screen9.png |none|thumb|800px|The Rifidi Designer UI]]
==Navigation==
* You can navigate around the MiniMap by clicking and dragging the red box where you want to go. This will cause the overhead camera to shift where you drag it to.
* You can also simply click on the map where you want the camera to be.

==Zoom in/Zoom out==
* You can zoom in and zoom out by clicking on the MiniMap and moving the mouse wheel backwards and forwards.

=Camera=
The camera is set at a fixed angle, but it can be zoomed in and zoomed out, and it can also be moved on the MiniMap.

==Zoom in/Zoom out==
* You can zoom in and zoom out by clicking on the main view screen and moving the mouse wheel backwards and forwards.

Designer User's Guide

2008-06-05T18:33:53Z

Jochen: /* Add a Push Arm */

[[category:userDoc]]

=Requirements=
*Microsoft Windows 2000/XP/2003 or Linux (Ubuntu, Red Hat, SuSe)
*Sun Java Runtime Environment > 1.6.4 (J2SE 6.0)
*'''IMPORTANT:''' does not work with earlier JRE versions.

=Installation=
Designer is packaged in a standard installer, which makes installation very easy.

# Download the latest version of Rifidi Emulator from http://sourceforge.net/projects/rifidi/
# Double click to run the install. Follow the on screen instructions.

=Launching Rifidi Designer=

*Windows Users: Simply click the shortcut located in the Rifidi folder in the Start Menu/Programs folder.
*Linux Users: Double click the executable file located in the installation directory.

=Getting Started - Example Designer Simulation=
==Create Layout==
#Once the program is loaded, the main UI will be present. [[Image:Screen1.png |none|thumb|800px|The Rifidi Designer UI]]
#To create a new layout, click the 'file' and 'new'.
#Enter in a layout name, select size of the room (64x64 or 256x256 square feet) and click 'Finish'.[[Image:Screen2.png |none|thumb|400px|Create New Layout]]
#A new empty layout will be displayed in the UI ready for use [[Image:Screen3.png |none|thumb|800px|New Layout]]

==Add a Conveyor==
#Click on the 'Components' Tab to view the library of all available components to add to a layout.[[Image:Screen4.png |none|thumb|800px|The Rifidi Designer UI]]
#If the list is not expanded already, Click on the '+' next to RFID Base Models to expand the list. [[Image:Screen5.png |none|thumb|800px|The Rifidi Designer UI]]
#Highlight the 'Conveyor' component and drag and drop to the 'Layout Designer'
#The name and speed of the new component will show up in the "properties" tab at the bottom. You can change these values if you wish.
#You will now see the component displayed in the 'Layout Designer'. ''Note: For placement refer to the Component Placement Section''

==Add a Push Arm==
#Click on the 'Components' Tab to view the library of all available components to add to a layout.
#If the list is not expanded already, Click on the '+' next to RFID Base Models to expand the list.
#Highlight the 'Push Arm' component and drag and drop to the 'Layout Designer'
#The name and speed of the push-arm are given in the bottom tab marked "properties". You can edit them if you wish.
#You will now see the component displayed in the 'Layout Designer'. ''Note: For placement refer to the Component Placement Section''
#Right-click it and select Turn On to activate it
''Note: See the push-arm section for instructions on how to get a push-arm working''

==Add a Gate==
#Click on the 'Components' Tab to view the library of all available components to add to a layout.
#If the list is not expanded already, Click on the '+' next to RFID Base Models to expand the list.
#Highlight the 'Gate' component and drag and drop to the 'Layout Designer'
#Enter a name for the component, select a reader type and click 'Next'.
#Enter a name for the reader and click 'Finish'.
#You will now see the component displayed in the 'Layout Designer'. ''Note: For placement refer to the Component Placement Section''

==Add a Box Producer==
#Click on the 'Components' Tab to view the library of all available components to add to a layout.
#If the list is not expanded already, Click on the '+' next to RFID Base Models to expand the list.
#Highlight one of the 'Producer' components (choose based on the type of tag you wish to produce from this producer) and drag and drop to the 'Layout Designer'
#The name and speed of the pusharm are given in the bottom tab marked "properties". You can edit them if you wish.
#You will now see the component displayed in the 'Layout Designer'. ''Note: For placement refer to the Component Placement Section''

==Component Placement==
===Conveyor Placement===
#In the Layout Designer View, click on the conveyor. ''Note: Yellow arrows will show the direction of the conveyor''
#Move the conveyor to the desired location by holding the left mouse button down. ''Note: The area below the component will be highlighted in green when placement is valid and red when placement is invalid.''
#Release the left mouse button once the desired location has been reached.
#If placement is valid the component will move to the new location and if placement is invalid the component will move to the prior valid location

===Box Producer Placement===
#In the Layout Designer View, click on the Box Producer.
#Move the producer to the desired location by holding the left mouse button down. ''Note: The area below the component will be highlighted.''
#Once the producer is over the end of the conveyor, release the left mouse button to finish placement.

===Push Arm Placement===
#In the Layout Designer View, click on the Push Arm.
#Move the gate to the desired location by holding the left mouse button down. ''Note: The area below the component will be highlighted.''
#Once the push arm is next to the right end of the conveyor, release the left mouse button.
#To finalize the placement, verify the push arm is pointed in the direction to push over the conveyor (Look for shaded area to be over conveyor). If not then you can rotate the component by 90 degrees by clicking on the component and then clicking on the rotate 90 degrees button in the toolbar.
''

===Gate Placement===
#In the Layout Designer View, click on the Gate.
#Verify the space between the gate's legs can fit over the conveyor based on the conveyor's placement. If not then click on the gate and rotate 90 degrees by clicking on the 90 degree rotate button in the toolbar.
#Move the gate to the desired location by holding the left mouse button down. ''Note: The area below the component will be highlighted in green when placement is valid and red when placement is invalid.''
#Once the gate is over the center of the conveyor, release the left mouse button.

==Push Arm Instructions==
===Placing===
Place a push arm, and place a gate with an Alien reader near the push arm. Be sure to select the "Enable GPI/O for this reader in the New Reader Wizard. It should look something like this:
[[Image:push1.png |none|thumb|800px|The Rifidi Designer UI]]
===GPIO===
The push arm works by an Alien or LLRP (or any other reader that supports GPIO) reader sending a GPIO signal to the push arm. To connect up the GPIO, we first have to go to the GPIO perspective. Click on Perspectives -> GPIO. You should get a window that looks something like this:
[[Image:push2.png |none|thumb|800px|The Rifidi Designer UI]]
# Expand the Palette if it isn't already open by pressing the arrow on the right.
# Select the "Solid Connection" button in the palette and drag an arrow it from the Alien reader on top (in blue) to the push arm you want to move (in red). You can also just click on the alien and click on the push arm, and an arrow will be shown connecting the two.

After that, the push arm should fire when you want it to.

==Create a Group==
#Click on the Layout Navigator tab.
#Right click on Grouped Components
#In the right click menu, click on create group
#In the create group wizard, enter in a group name (example: group1)
#You will now see the new group listed under Grouped Components

==Add Components to Group==
#Click on the Layout Navigator tab.
#Click on the '+' next to Ungrouped Components to expand the ungrouped components list if not expanded already.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#In the Ungrouped Components list, click on the conveyor component (Example: conveyor1).
#Hold the left mouse button down on the conveyor component and drag and drop into the Group (Example: group1)
#Repeat steps 2 - 4 for each or the remaining ungrouped components
#Once all the steps have been completed, you will now have all the components assigned to a group. (Example: group1) Now you can move the components around in a group in the Layout Designer instead of having to move each component seperately. There are other benefits of groups which will be described in later sections.

==Turn On Components==
There are two ways to turn on components:

#Click on the Layout Navigator tab if not already selected.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#Click on the '+' next to the group name (Example: group1) to expand the group if not expanded already.
#Right click on the conveyor component
#In the conveyor component right click menu, click on turn On
#Repeat steps 3-4 for each component in the group

or the short cut is to:

#Click on the Layout Navigator tab if not already selected.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#Click on the '+' next to the group name (Example: group1) to expand the group if not expanded already.
#Right click on group (Example: group1)
#In the group right click menu, click on Turn On
#This will Turn On all the components assigned to tha group

You can now connect to the virtual reader (Alien, AWID, Symbol, LLRP) you created with a client such as telnet, client library, middleware or EdgeServer.

==Start Simulation==
#On the Designer Toolbar, you can now click on the play button to start the simulation
#Once you start the simultaion you should now see boxes being produced and the conveyor and push arm moving at their defined rates.
#The client connected to the virtual reader should now report tags as the boxes pass through the gate's antenna.

==Pause Simulation==
#On the Designer Toolbar, you can now click on the Pause button to start the simultaion
#Once you pause the simultaion you should now see boxes being produced and the conveyor and push arm moving pause, left in the previous state.
#The client connected to the virtual reader will continue to be connected.

==Reset Simulation==
#On the Designer Toolbar, you can now click on the reset button to start the simultaion
#Once you reset the simultaion you should now see boxes being produced, the conveyor and push arm moving be reset
#The client connected to the virtual reader will continue to be connected.

==Turn Off Components==
There are two ways to Turn Off components:

#Click on the Layout Navigator tab if not already selected.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#Click on the '+' next to the group name (Example: group1) to expand the group if not expanded already.
#Right click on the conveyor component
#In the conveyor component right click menu, click on Turn Off
#Repeat steps 3-4 for each component in the group

or the short cut is to:

#Click on the Layout Navigator tab if not already selected.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#Click on the '+' next to the group name (Example: group1) to expand the group if not expanded already.
#Right click on group (Example: group1)
#In the group right click menu, click on Turn Off
#This will Turn Off all the components assigned to the group

The client should now disconnect from the virtual reader as if the device has been powered off

==Add Components to Group==
#Click on the Layout Navigator tab.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#Click on the '+' next to the group (Example: groups1) to expand the assigned grouped component list if not expanded already.
#Click on the conveyor component.
#At the bottom below the Layout Designer view you will now see the conveyor component's property view.
#Click on the speed property and change the value.
#The next time you Turn On the components (if not on already) and play the simulation you will see the new speed.

===Edit Box Producer Rate===
#Click on the Layout Navigator tab.
#Click on the '+' next to Grouped Components to expand the grouped list if not expanded already.
#Click on the '+' next to the group (Example: groups1) to expand the assigned grouped component list if not expanded already.
#Click on the box producer component.
#At the bottom below the Layout Designer view you will now see the box producer component's property view.
#Click on the rate property and change the value.
#The next time you Turn On the components (if not on already) and play the simulation you will see the new rate.

=Layout Navigation=
* The layout navigation is a tab on the left side of the Designer screen. It contains 3 collapsible lists of components:
# Grouped Components
# Ungrouped Components
# Generated Components
==Ungrouped Components==
* This is where all the ungrouped components are listed. Click on the plus sign to see them.
* You can also turn off and turn on all of the grouped components at the same time. To do this, right click on the "ungrouped components" and select "turn off" or "turn on".
[[Image:Screen6.png |none|thumb|800px|The Rifidi Designer UI]]
==Grouped Components==
* This is where all of the grouped components are listed. Click on the plus sign to see all of the groups, and click on the plus sign on individual groups to list the components in those groups.
* You can turn on and turn off everything in a group by right clicking on the group and clicking "turn on" or "turn off".
[[Image:Screen7.png |none|thumb|800px|The Rifidi Designer UI]]
==Generated Components==
* This is where you can find all of the components generated by a producer.
* You can delete these components by right clicking on them and selecting "Delete Entity".
[[Image:Screen8.png |none|thumb|800px|The Rifidi Designer UI]]

=MiniMap=
The MiniMap is on the lower left of the Designer screen. If you don't see it, click on views -> Show MiniMap.
[[Image:Screen9.png |none|thumb|800px|The Rifidi Designer UI]]
==Navigation==
* You can navigate around the MiniMap by clicking and dragging the red box where you want to go. This will cause the overhead camera to shift where you drag it to.
* You can also simply click on the map where you want the camera to be.

==Zoom in/Zoom out==
* You can zoom in and zoom out by clicking on the MiniMap and moving the mouse wheel backwards and forwards.

=Camera=
The camera is set at a fixed angle, but it can be zoomed in and zoomed out, and it can also be moved on the MiniMap.

==Zoom in/Zoom out==
* You can zoom in and zoom out by clicking on the main view screen and moving the mouse wheel backwards and forwards.

Rifidi:jmeswt

2008-06-04T23:35:47Z

Jochen: /* jMonkey SWT bindings */

=jMonkey SWT bindings=
[[Image:Screen1.jpg]] 
This screenshot is taken from the image converter we built using jmeswt.
==Overview==
Within this entry we will introduce you to the jmeswt plugin that allows developers to get the jMonkey engine into there app. 
All our code is release under the LGPL. The contained libraries are compatible with this license (if we overlooked something please inform us). 
Included libraries are: 
* [http://lwjgl.org/ lwjgl]
* [https://jmephysics.dev.java.net/ jmephysics]
* [http://jmonkeyengine.com/ jmonkey]
This whole library has come from tons of forum posts and a lot of hard work. 
Most notably we included the OffscreenRenderer from Olivier Sambourg and Joshua Slack. 
==Installation==
We have our own update site right now to make it as convenient as possible to use the plugin: 
[http://rifidi.org/update http://rifidi.org/update Rifidi update site] 
Just add this site in Help->Software Updates->find and install ... 
After adding it just select org.rifidi.jmeswt: 
[[Image:Screenshot-Updates.png]] 
Yoiu can also add the second plugin in the list, it's a (alpha!!!!) editor for .dae (collada) files. 
After adding the editor a doubleclick on a file ending with .dae will bring up a 3d view that displays the contents of the file. It's just a little demo app that will be enhanced as we progress on our ide for RifidiDesigner. 
The sourccde to this plugin is availabel from our puplic repository. 
==What's in it==
The plug-in contain two things:<nr/>
* A jar with the system provider: This is required as jmonkey uses the old service stuff from sun that requires some MANIFEST magic that apparently doesn't go well with the OSGi classloaders.
* The classes that actually form the layer between SWT and jMonkey.
** org.rifidi.jmeswt.input.SWTKeyInput: This is the KeyInput provider to be used with the different handlers of jmonkey.
** org.rifidi.jmeswt.input.SWTMouseInput: This is the KeyInput provider to be used with the different handlers of jmonkey.
** org.rifidi.jmeswt.input.Mapping: This is a static class to provide a fast and extensible way of mapping the different SWT events to LWJGL events. It's about 90% complete with only some minor things missing.
** org.rifidi.jmeswt.SWTBaseGame: This is the starting point for SWT based jmonkey games (See next chapter).
==How to use it==
I assume that you are an Eclipse RCP developer so I will just skip the details for creating an RCP projhect. 
After creating the project add org.rifidi.jmeswt to your dependencies. 
Now create your custom game: 
package test;

import org.eclipse.swt.widgets.Composite;
import org.rifidi.jmeswt.SWTBaseGame;

import com.jme.math.Vector3f;
import com.jme.scene.shape.Box;

/**
*
*
* @author Jochen Mader - jochen@pramari.com - Jun 2, 2008
*
*/
public class MyGame extends SWTBaseGame {

/**
* @param name
* @param updateResolution
* @param renderResolution
* @param width
* @param height
* @param parent
* @param single
*/
public MyGame(String name, int updateResolution, int renderResolution,
int width, int height, Composite parent, boolean single) {
super(name, updateResolution, renderResolution, width, height, parent,
single);
// TODO Auto-generated constructor stub
}

/*
* (non-Javadoc)
*
* @see org.rifidi.jmeswt.SWTBaseGame#simpleInitGame()
*/
@Override
protected void simpleInitGame() {
Box myBox=new Box("boxxy", Vector3f.ZERO.clone(), 2f, 2f, 2f);
myBox.setRandomColors();
getRootNode().attachChild(myBox);
getRootNode().updateRenderState();
}
}
 
After creating this game instantiated it in your createPartControl method and hit the start() method after creating it. 
MyGame my=new MyGame("gamy",10,20,640,480,parent,true);
my.start();
* The first parameter is a name for the game.
* The second one is the amount of msecs between two updates.
* The third one is the amount of msecs between two render runs.
* four and five are start width and height.
* number six is the parent composite for the glCanas.
* the seventh and last one states if this is the only SWTGame running.
The game is now running. 
==Controlling the scene==
Now we want to add a FirstPersonController. 
To do this add this code to your simpleInitGame() method: 
getGlCanvas().addKeyListener((KeyListener) KeyInput.get());
getGlCanvas()
.addMouseMoveListener((MouseMoveListener) MouseInput.get());
getGlCanvas().addMouseListener((MouseListener) MouseInput.get());
FirstPersonHandler firstPersonHandler = new FirstPersonHandler(display
.getRenderer().getCamera(), 50, 1);
input = firstPersonHandler;
And add a global var:
/**
* Handles our mouse/keyboard input.
*/
protected InputHandler input;
Now overwrite the update() method:
/* (non-Javadoc)
* @see org.rifidi.jmeswt.SWTBaseGame#update(float)
*/
@Override
protected void update(float interpolation) {
super.update(interpolation);
input.update(interpolation);
}
Start your RCP-app again, click in the 3d window and move around your fancy box. 
As you can see from this example SWTKeyInput and SWTMouseInput are already registered for handling events 
The RenderThread works good but I will add some timing related tweaks soon. 
Have Fun :)
==What does the "simple" parameter in the constructor mean?==
Ok, we are in eclipse RCP so mostly you will deal with multiwindow thing. 
First of all: 
If you don't intend to use more than one game/window inside eclipse stop reading here. Everything will work like you are used to it from jmonkey. You will have your GameTaskQueues as you are used to them and can live happily on without bothering ybout the rest. 
If you, like us, need support for multiple games in one app continue readiung. 
When you create let's say two games you will have to set single to false. 
That tells SWTBaseGame to create individual rendering and update queues for each game so that we don't have collisions there. 
The queues are name "<gamename>.render" and "<gamename>.update". This is important to remember as your callables will have to be sent to the right queues. 
You can also access the queues directly in SWTBaseGame with getUpdateQueue() or getRenderQueue(). 
Right now you can't render to two games at the same time (NOTE: the next release should include functionality for that, but our current app doesn't need that) so call stopRendering() when your game loses the focus and resumeRendering() when it acquires focus. The important thing is that the games don't stop updating!

File:Screen1.jpg

2008-06-04T23:34:41Z

Jochen: Scrrenshot from converter

Scrrenshot from converter

Rifidi:jmeswt

2008-06-03T23:29:23Z

Jochen:

=jMonkey SWT bindings=
==Overview==
Within this entry we will introduce you to the jmeswt plugin that allows developers to get the jMonkey engine into there app. 
All our code is release under the LGPL. The contained libraries are compatible with this license (if we overlooked something please inform us). 
Included libraries are: 
* [http://lwjgl.org/ lwjgl]
* [https://jmephysics.dev.java.net/ jmephysics]
* [http://jmonkeyengine.com/ jmonkey]
This whole library has come from tons of forum posts and a lot of hard work. 
Most notably we included the OffscreenRenderer from Olivier Sambourg and Joshua Slack. 
==Installation==
We have our own update site right now to make it as convenient as possible to use the plugin: 
[http://rifidi.org/update http://rifidi.org/update Rifidi update site] 
Just add this site in Help->Software Updates->find and install ... 
After adding it just select org.rifidi.jmeswt: 
[[Image:Screenshot-Updates.png]] 
Yoiu can also add the second plugin in the list, it's a (alpha!!!!) editor for .dae (collada) files. 
After adding the editor a doubleclick on a file ending with .dae will bring up a 3d view that displays the contents of the file. It's just a little demo app that will be enhanced as we progress on our ide for RifidiDesigner. 
The sourccde to this plugin is availabel from our puplic repository. 
==What's in it==
The plug-in contain two things:<nr/>
* A jar with the system provider: This is required as jmonkey uses the old service stuff from sun that requires some MANIFEST magic that apparently doesn't go well with the OSGi classloaders.
* The classes that actually form the layer between SWT and jMonkey.
** org.rifidi.jmeswt.input.SWTKeyInput: This is the KeyInput provider to be used with the different handlers of jmonkey.
** org.rifidi.jmeswt.input.SWTMouseInput: This is the KeyInput provider to be used with the different handlers of jmonkey.
** org.rifidi.jmeswt.input.Mapping: This is a static class to provide a fast and extensible way of mapping the different SWT events to LWJGL events. It's about 90% complete with only some minor things missing.
** org.rifidi.jmeswt.SWTBaseGame: This is the starting point for SWT based jmonkey games (See next chapter).
==How to use it==
I assume that you are an Eclipse RCP developer so I will just skip the details for creating an RCP projhect. 
After creating the project add org.rifidi.jmeswt to your dependencies. 
Now create your custom game: 
package test;

import org.eclipse.swt.widgets.Composite;
import org.rifidi.jmeswt.SWTBaseGame;

import com.jme.math.Vector3f;
import com.jme.scene.shape.Box;

/**
*
*
* @author Jochen Mader - jochen@pramari.com - Jun 2, 2008
*
*/
public class MyGame extends SWTBaseGame {

/**
* @param name
* @param updateResolution
* @param renderResolution
* @param width
* @param height
* @param parent
* @param single
*/
public MyGame(String name, int updateResolution, int renderResolution,
int width, int height, Composite parent, boolean single) {
super(name, updateResolution, renderResolution, width, height, parent,
single);
// TODO Auto-generated constructor stub
}

/*
* (non-Javadoc)
*
* @see org.rifidi.jmeswt.SWTBaseGame#simpleInitGame()
*/
@Override
protected void simpleInitGame() {
Box myBox=new Box("boxxy", Vector3f.ZERO.clone(), 2f, 2f, 2f);
myBox.setRandomColors();
getRootNode().attachChild(myBox);
getRootNode().updateRenderState();
}
}
 
After creating this game instantiated it in your createPartControl method and hit the start() method after creating it. 
MyGame my=new MyGame("gamy",10,20,640,480,parent,true);
my.start();
* The first parameter is a name for the game.
* The second one is the amount of msecs between two updates.
* The third one is the amount of msecs between two render runs.
* four and five are start width and height.
* number six is the parent composite for the glCanas.
* the seventh and last one states if this is the only SWTGame running.
The game is now running. 
==Controlling the scene==
Now we want to add a FirstPersonController. 
To do this add this code to your simpleInitGame() method: 
getGlCanvas().addKeyListener((KeyListener) KeyInput.get());
getGlCanvas()
.addMouseMoveListener((MouseMoveListener) MouseInput.get());
getGlCanvas().addMouseListener((MouseListener) MouseInput.get());
FirstPersonHandler firstPersonHandler = new FirstPersonHandler(display
.getRenderer().getCamera(), 50, 1);
input = firstPersonHandler;
And add a global var:
/**
* Handles our mouse/keyboard input.
*/
protected InputHandler input;
Now overwrite the update() method:
/* (non-Javadoc)
* @see org.rifidi.jmeswt.SWTBaseGame#update(float)
*/
@Override
protected void update(float interpolation) {
super.update(interpolation);
input.update(interpolation);
}
Start your RCP-app again, click in the 3d window and move around your fancy box. 
As you can see from this example SWTKeyInput and SWTMouseInput are already registered for handling events 
The RenderThread works good but I will add some timing related tweaks soon. 
Have Fun :)
==What does the "simple" parameter in the constructor mean?==
Ok, we are in eclipse RCP so mostly you will deal with multiwindow thing. 
First of all: 
If you don't intend to use more than one game/window inside eclipse stop reading here. Everything will work like you are used to it from jmonkey. You will have your GameTaskQueues as you are used to them and can live happily on without bothering ybout the rest. 
If you, like us, need support for multiple games in one app continue readiung. 
When you create let's say two games you will have to set single to false. 
That tells SWTBaseGame to create individual rendering and update queues for each game so that we don't have collisions there. 
The queues are name "<gamename>.render" and "<gamename>.update". This is important to remember as your callables will have to be sent to the right queues. 
You can also access the queues directly in SWTBaseGame with getUpdateQueue() or getRenderQueue(). 
Right now you can't render to two games at the same time (NOTE: the next release should include functionality for that, but our current app doesn't need that) so call stopRendering() when your game loses the focus and resumeRendering() when it acquires focus. The important thing is that the games don't stop updating!

Helpful links

2008-06-03T23:23:50Z

Jochen:

*[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/ javadocs for designer]
*[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.entities/ javadoc for the entites]

Threads

2008-06-03T23:22:39Z

Jochen:

Rendering and it's threads are now part of our jmonkey plugin:[http://wiki.rifidi.org/index.php/Rifidi:jmeswt jmeswt] 
Documentation in this chapter is from now on obsolete! 
Designer runs as a combination of eclipse and a 3d engine. 
It is very important to closely look where things are going. 
 
 
Just some rules:
* GameTaskQueueManager.getInstance().render()/update() can be called from every part of the application and should be used to submit things to the 3d engine. It is very important to add and remove nodes inside callables that get submitted to the 3d engine as it might break the software if you don't do it this way. 
 

Old stuff: 
IF YOU HAVE BEEN USING THE HELPER CLASS REMOVE THAT CODE AS IT WILL CAUSE A DEADLOCK FROM DESIGNER 1.3 ON!
* Waiting on Futures: Sometimes it is important to be able to wait on a future when you have submitted a callable. The [http://www.rifidi.org/javadoc/designer/doc/org/rifidi/designer/utils/Helpers.html Helpers class] contains a static method called waitOnCallable. This method can be used to wait for a futue to return and is the only way (that I know of) to do this from inside the eclipse thread. THIS METHOD IS BLOCKING AND IF CALLED WHEN UPDATETHREAD IS IN THE PAUSEDSTATE WILL BLOCK FOREVER!! 
 
APPARENTLY THIS ISSUE GOT RESOLVED WITH ECLIPSE 3.3!
* syncExec/asyncExec: Avoid syncExec. According to some newsgroup posts as of eclipse 3.2 there is a deadlock condition that might cause a hang on syncExec. Use asyncExec and a callback.

Threads

2008-06-03T23:22:27Z

Jochen:

Rendering and it's threads are now part of our jmonkey plugin:[http://wiki.rifidi.org/index.php/Rifidi:jmeswt jmeswt] 
Documentation in this chapter is from now on obsolete! 
Designer runs as a combination of eclipse and a 3d engine. 
It is very important to closely look where things are going. 
Just some rules:
* GameTaskQueueManager.getInstance().render()/update() can be called from every part of the application and should be used to submit things to the 3d engine. It is very important to add and remove nodes inside callables that get submitted to the 3d engine as it might break the software if you don't do it this way. 
 

Old stuff: 
IF YOU HAVE BEEN USING THE HELPER CLASS REMOVE THAT CODE AS IT WILL CAUSE A DEADLOCK FROM DESIGNER 1.3 ON!
* Waiting on Futures: Sometimes it is important to be able to wait on a future when you have submitted a callable. The [http://www.rifidi.org/javadoc/designer/doc/org/rifidi/designer/utils/Helpers.html Helpers class] contains a static method called waitOnCallable. This method can be used to wait for a futue to return and is the only way (that I know of) to do this from inside the eclipse thread. THIS METHOD IS BLOCKING AND IF CALLED WHEN UPDATETHREAD IS IN THE PAUSEDSTATE WILL BLOCK FOREVER!! 
 
APPARENTLY THIS ISSUE GOT RESOLVED WITH ECLIPSE 3.3!
* syncExec/asyncExec: Avoid syncExec. According to some newsgroup posts as of eclipse 3.2 there is a deadlock condition that might cause a hang on syncExec. Use asyncExec and a callback.

UpdateThread

2008-06-03T23:21:08Z

Jochen:

THIS PAGE NEEDS A REWORK, THE DIAGRAMS ARE NOT UP TO DATE
[http://www.rifidi.org/javadoc/designer/doc/org/rifidi/designer/rcp/views/view3d/threads/UpdateThread.html javadoc] 
The UpdateThread is responsible for executing the update queue, updating the geometric states, the collison information and executing repeated callables. 
[[Image:UpdateThread.png]]

RenderThread

2008-06-03T23:20:50Z

Jochen:

THIS PAGE NEEDS A REWORK, THE DIAGRAMS ARE NOT UP TO DATE
[[Image:Renderthread.png]] 
[http://www.rifidi.org/javadoc/designer/doc/org/rifidi/designer/rcp/views/view3d/threads/RenderThread.html javadoc] 
The RenderThread is instantiated and started after a new scene got loaded. 
The [http://www.rifidi.org/javadoc/designer/doc/org/rifidi/designer/services/core/world/WorldService.html WorldService] is responsible for controlling the states of this thread. 
As syncExec has a little problem with deadlocks (we got this from some newsgroup posts, we could never confirm this but as we were facing some deadlocks we eliminated all possible sources) we have to use asyncExec and a control variable in renderThread (running) to check if a RenderRunnable is currently running. 
The RenderRunnable is responsible for acquiring the lock that is shared with the UpdateThread to prevent simultanious operations of both on the scene graph. 
[[Image:RenderRunnable.png]]

Threads

2008-06-03T23:19:14Z

Jochen:

Designer runs as a combination of eclipse and a 3d engine. 
It is very important to closely look where things are going. 
Just some rules:
* GameTaskQueueManager.getInstance().render()/update() can be called from every part of the application and should be used to submit things to the 3d engine. It is very important to add and remove nodes inside callables that get submitted to the 3d engine as it might break the software if you don't do it this way. 
 

Old stuff: 
IF YOU HAVE BEEN USING THE HELPER CLASS REMOVE THAT CODE AS IT WILL CAUSE A DEADLOCK FROM DESIGNER 1.3 ON!
* Waiting on Futures: Sometimes it is important to be able to wait on a future when you have submitted a callable. The [http://www.rifidi.org/javadoc/designer/doc/org/rifidi/designer/utils/Helpers.html Helpers class] contains a static method called waitOnCallable. This method can be used to wait for a futue to return and is the only way (that I know of) to do this from inside the eclipse thread. THIS METHOD IS BLOCKING AND IF CALLED WHEN UPDATETHREAD IS IN THE PAUSEDSTATE WILL BLOCK FOREVER!! 
 
APPARENTLY THIS ISSUE GOT RESOLVED WITH ECLIPSE 3.3!
* syncExec/asyncExec: Avoid syncExec. According to some newsgroup posts as of eclipse 3.2 there is a deadlock condition that might cause a hang on syncExec. Use asyncExec and a callback.

FieldService

2008-06-03T23:11:02Z

Jochen:

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/collision/FieldService.html javadoc] 
[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.entities/org/rifidi/designer/entities/interfaces/Field.html Field] 
A field (antenna field of a reader, the watch areas, a infrared field, ...) will be automatically registered to this service when it is created. 
On every run of the update thread the fields are checked for new collisions or entities leaving the field.

CablingService

2008-06-03T23:10:29Z

Jochen:

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/cabling/CablingService.html javadoc] 
[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.entities/org/rifidi/designer/entities/interfaces/GPI.html GPI] 
[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.entities/org/rifidi/designer/entities/interfaces/GPO.html GPO] 
The cabling service is used for GPIO events. 
It provides facilities to add and remove cables. 
The reason why we don't allow a direct connection between a GPO and a GPI is that we want to be able to monitor and record events between these.

SceneDataService

2008-06-03T23:09:38Z

Jochen: New page: [http://www.rifidi.org/javadoc/designer/org.rifidi.designer.entities/org/rifidi/designer/services/core/entities/SceneDataService.html javadoc] * save/load a scene * access certain par...

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.entities/org/rifidi/designer/services/core/entities/SceneDataService.html javadoc] 
* save/load a scene
* access certain parts of the scene data in a save way (like the root node)
* inform the application of loading and closing of scene datas

ProductService

2008-06-03T23:07:49Z

Jochen: New page: [http://www.rifidi.org/javadoc/designer/org.rifidi.designer.entities/org/rifidi/designer/services/core/entities/ProductService.html javadoc] If your entity creates other entites while...

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.entities/org/rifidi/designer/services/core/entities/ProductService.html javadoc] 
If your entity creates other entites while the simulation is running you will have to use this service to make those new entites appear in the scene. 
The best example for using the product service is the BoxProducer in the base library of designer.

EntitiesService

2008-06-03T23:05:21Z

Jochen: New page: [http://www.rifidi.org/javadoc/designer/org.rifidi.designer.entities/org/rifidi/designer/services/core/entities/EntitiesService.html javadoc] This service is mostly used by designer t...

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.entities/org/rifidi/designer/services/core/entities/EntitiesService.html javadoc] 
This service is mostly used by designer to manage entites. 
* add/remove entities
* organize them into groups
It's very unlikely that you will need this service.

Entities Services

2008-06-03T23:02:23Z

Jochen: New page: Entites services are part of the org.rifidi.designer.entities bundle. Theay are also part of the core of designer but they are alos the ones you are most likely to need while creating...

Entites services are part of the org.rifidi.designer.entities bundle. 
Theay are also part of the core of designer but they are alos the ones you are most likely to need while creating new entities.

Designer documentation summary

2008-06-03T23:01:28Z

Jochen:

[[category:developerDoc]][[category:designerDoc]]
== Designer ==
*[[Helpful links]]
*[[Designer Internals]]
**[[Overview]]
**[[Threads]]
***[[RenderThread]]
***[[UpdateThread]]
****[[RepeatedUpdateAction]]
**[[Services]]
***[[How services work]]
***[[Creating your own service]]
*** [[Core Services]]
**** [[CablingService]]
**** [[CameraService]]
**** [[FieldService]]
**** [[EventsService]]
**** [[SelectionService]]
**** [[WorldService]]
*** [[Entities Services]]
**** [[EntitiesService]]
**** [[FinderService]]
**** [[ProductService]]
**** [[SceneDataService]]
**Utilities
***[[MessagingSystem]]
*[[Coding guidelines]]
**[[Style Guide]]
**[[Creating entities]]
*[[:Category:desginerDoc|Browse All Designer Documentation]]

WorldService

2008-06-03T22:56:16Z

Jochen: New page: [http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/world/WorldService.html javadoc] This service is used to control the running state of...

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/world/WorldService.html javadoc] 
This service is used to control the running state of the currently laoded scene.

SelectionService

2008-06-03T22:55:15Z

Jochen: New page: [http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/selection/SelectionService.html javadoc] This service manages the selections in the 3...

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/selection/SelectionService.html javadoc] 
This service manages the selections in the 3d scene and is the glue between the 3d view and the tree viewer on the left.

EventsService

2008-06-03T22:49:26Z

Jochen: New page: [http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/events/EventsService.html javadoc] Every entity can post events to this service. ...

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/events/EventsService.html javadoc] 
Every entity can post events to this service. 
This service is responsible for displaying them in the console and, if configured, to record the events.

FieldService

2008-06-03T22:47:45Z

Jochen:

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/collision/FieldService.html javadoc] 
A field (antenna field of a reader, the watch areas, a infrared field, ...) will be automatically registered to this service when it is created. 
On every run of the update thread the fields are checked for new collisions or entities leaving the field.

FieldService

2008-06-03T22:45:08Z

Jochen: New page: [url]http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/collision/FieldService.html javadoc[/url]

[url]http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/collision/FieldService.html javadoc[/url]

CameraService

2008-06-03T22:44:23Z

Jochen: New page: [http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/camera/CameraService.html javadoc] This service provides the methods to zoom the came...

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/camera/CameraService.html javadoc] 
This service provides the methods to zoom the camera and record camera positions that can later be restored.

CablingService

2008-06-03T22:42:25Z

Jochen:

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/cabling/CablingService.html javadoc] 
The cabling service is used for GPIO events. 
It provides facilities to add and remove cables. 
The reason why we don't allow a direct connection between a GPO and a GPI is that we want to be able to monitor and record events between these.

CablingService

2008-06-03T22:42:15Z

Jochen:

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/cabling/CablingService.html javadoc] 

The cabling service is used for GPIO events. 
It provides facilities to add and remove cables. 
The reason why we don't allow a direct connection between a GPO and a GPI is that we want to be able to monitor and record events between these.

CablingService

2008-06-03T22:40:55Z

Jochen:

[http://www.rifidi.org/javadoc/designer/org.rifidi.designer.rcp/org/rifidi/designer/services/core/cabling/CablingService.html javadoc]
The cabling service is used for GPIO events.

CablingService

2008-06-03T22:21:58Z

Jochen: New page: The cabling service is used for GPIO events.

The cabling service is used for GPIO events.

Core Services

2008-06-03T22:11:28Z

Jochen: New page: These are services that are provided by the org.rifidi.designer.rcp plugin. They are an integral part of designer.

These are services that are provided by the org.rifidi.designer.rcp plugin. 
They are an integral part of designer.

Designer documentation summary

2008-06-03T22:10:45Z

Jochen:

[[category:developerDoc]][[category:designerDoc]]
== Designer ==
*[[Helpful links]]
*[[Designer Internals]]
**[[Overview]]
**[[Threads]]
***[[RenderThread]]
***[[UpdateThread]]
****[[RepeatedUpdateAction]]
**[[Services]]
***[[How services work]]
***[[Creating your own service]]
*** [[Core Services]]
**** [[CablingService]]
**** [[CameraService]]
**** [[FieldService]]
**** [[EventsService]]
**** [[SelectionService]]
**** [[WorldService]]
**Utilities
***[[MessagingSystem]]
*[[Coding guidelines]]
**[[Style Guide]]
**[[Creating entities]]
*[[:Category:desginerDoc|Browse All Designer Documentation]]

Creating your own service

2008-06-03T22:07:59Z

Jochen:

* create a new OSGi Bundle.
* Create an interface for your service.
* Implement the interface.
* Register the service in the activator:
public void start(BundleContext context) throws Exception {
super.start(context);
plugin = this;
context.registerService(CablingService.class.getName(),
new CablingServiceImpl(), null);
}
And that's it. Your service is available as soon as the first class from your bundle is loaded.

Creating your own service

2008-06-03T22:07:46Z

Jochen: /* Define your service */

==Define your service==
* create a new OSGi Bundle.
* Create an interface for your service.
* Implement the interface.
* Register the service in the activator:
public void start(BundleContext context) throws Exception {
super.start(context);
plugin = this;
context.registerService(CablingService.class.getName(),
new CablingServiceImpl(), null);
}
And that's it. Your service is available as soon as the first class from your bundle is loaded.

Creating your own service

2008-06-03T22:07:33Z

Jochen: New page: ==Define your service== * create a new OSGi Bundle. * First create an interface for your service. * Implement the interface. * Register the service in the activator: public void start(Bun...

==Define your service==
* create a new OSGi Bundle.
* First create an interface for your service.
* Implement the interface.
* Register the service in the activator:
public void start(BundleContext context) throws Exception {
super.start(context);
plugin = this;
context.registerService(CablingService.class.getName(),
new CablingServiceImpl(), null);
}
And that's it. Your service is available as soon as the first class from your bundle is loaded.

How services work

2008-06-03T22:00:49Z

Jochen:

==Why services==
The first version of Designer (and also the rest of Rifidi) was littered with a lot of Singletons. 
As everybody knows by now:
* Singletons are bad.
* They are hard to test.
* Impossible (almost) to mock
So I replaced them with a little service registry where you register a concrete class with an interface this class implements. 
Once again I had to discover that somebody else had already had that idea some time ago. 
OSGi is an SOA (bright me, reading about OSGi all the time without actually realizing what it means). 
So I am using now the OSGi ServiceRegistry to deal with services. 
You, as an aspiring rifidi developer, won't need to worry about that. 
To make it easier to use the services I wrote a ServiceLocater that does all the work for you. 
The only thing to remember is to use the @Inject annotation and do the following call in the constructor. 
ServiceRegister.getInstance().service(this)
==@Inject==
This annotation is a marker for the ServiceLocator in the ServiceRegistry. It annotates a setter method that takes the desired service interface as it's only parameter. 
@Inject
public void setEventsService(EventsService eventsService) {
this.eventsService = eventsService;
}
After the call to service(this) in the constructor the locator will check the class for the annotation and try to resolve it. 
If the service is not available atb the time of the call it will be resolved as soon as the service becomes available. 
NOTE: All OSGi services are supported, als declarative services. The only problem is that due to the way they get initialized they are unsutable for a GUI application.

How services work

2008-06-03T21:48:52Z

Jochen: /* Why services */

How services work

2008-06-03T21:48:26Z

Jochen: New page: ==Why services== The first version of Designer (and also the rest of Rifidi) was littered with a lot of Singletons. As everybody knows by now: * Singletons are bad. * They are hard t...

Designer documentation summary

2008-06-03T15:25:23Z

Jochen:

Services

2008-06-03T15:24:49Z

Jochen: New page: Since designer 1.3 we have changed a lot of the it's internal works. We tried to stick even more with the principle of dependency injection. The most important change we made is ...

Since designer 1.3 we have changed a lot of the it's internal works. 
We tried to stick even more with the principle of dependency injection. 
The most important change we made is that we switched from our custom services and their ServiceRegistry-Singleton to the service architecture that comes with OSGi. 
We also created a service locator to make it even easier to make use of these services. 
The following chapters will introduce the basic concepts of services and how we use it in designer. I will also try to show how to create your own service. 
The last chapter will then introduce the various services that we are providing with the core of designer.

Designer documentation summary

2008-06-03T15:13:08Z

Jochen:

Rifidi:jmeswt

2008-06-02T15:14:57Z

Jochen: /* What the frick does the simple parameter in the constructor mean? */

=jMonkey SWT bindings=
==Overview==
Within this entry we will introduce you to the jmeswt plugin that allows developers to get the jMonkey engine into there app. 
All our code is release under the LGPL. The contained libraries are compatible with this license (if we overlooked something please inform us). 
Included libraries are: 
* [http://lwjgl.org/ lwjgl]
* [https://jmephysics.dev.java.net/ jmephysics]
* [http://jmonkeyengine.com/ jmonkey]
This whole library has come from tons of forum posts and a lot of hard work. 
Most notably we included the OffscreenRenderer from Olivier Sambourg and Joshua Slack. 
==Installation==
We have our own update site right now to make it as convenient as possible to use the plugin: 
[http://rifidi.org/update http://rifidi.org/update Rifidi update site] 
Just add this site in Help->Software Updates->find and install ... 
After adding it just select org.rifidi.jmeswt: 
[[Image:Screenshot-Updates.png]] 
Yoiu can also add the second plugin in the list, it's a (alpha!!!!) editor for .dae (collada) files. 
After adding the editor a doubleclick on a file ending with .dae will bring up a 3d view that displays the contents of the file. It's just a little demo app that will be enhanced as we progress on our ide for RifidiDesigner. 
The sourccde to this plugin is availabel from our puplic repository. 
==What's in it==
The plug-in contain two things:<nr/>
* A jar with the system provider: This is required as jmonkey uses the old service stuff from sun that requires some MANIFEST magic that apparently doesn't go well with the OSGi classloaders.
* The classes that actually form the layer between SWT and jMonkey.
** org.rifidi.jmeswt.input.SWTKeyInput: This is the KeyInput provider to be used with the different handlers of jmonkey.
** org.rifidi.jmeswt.input.SWTMouseInput: This is the KeyInput provider to be used with the different handlers of jmonkey.
** org.rifidi.jmeswt.input.Mapping: This is a static class to provide a fast and extensible way of mapping the different SWT events to LWJGL events. It's about 90% complete with only some minor things missing.
** org.rifidi.jmeswt.SWTBaseGame: This is the starting point for SWT based jmonkey games (See next chapter).
==How to use it==
I assume that you are an Eclipse RCP developer so I will just skip the details for creating an RCP projhect. 
After creating the project add org.rifidi.jmeswt to your dependencies. 
Now create your custom game: 
package test;

import org.eclipse.swt.widgets.Composite;
import org.rifidi.jmeswt.SWTBaseGame;

import com.jme.math.Vector3f;
import com.jme.scene.shape.Box;

/**
*
*
* @author Jochen Mader - jochen@pramari.com - Jun 2, 2008
*
*/
public class MyGame extends SWTBaseGame {

/**
* @param name
* @param updateResolution
* @param renderResolution
* @param width
* @param height
* @param parent
* @param single
*/
public MyGame(String name, int updateResolution, int renderResolution,
int width, int height, Composite parent, boolean single) {
super(name, updateResolution, renderResolution, width, height, parent,
single);
// TODO Auto-generated constructor stub
}

/*
* (non-Javadoc)
*
* @see org.rifidi.jmeswt.SWTBaseGame#simpleInitGame()
*/
@Override
protected void simpleInitGame() {
Box myBox=new Box("boxxy", Vector3f.ZERO.clone(), 2f, 2f, 2f);
myBox.setRandomColors();
getRootNode().attachChild(myBox);
getRootNode().updateRenderState();
}
}
 
After creating this game instantiated it in your createPartControl method and hit the start() method after creating it. 
MyGame my=new MyGame("gamy",10,20,640,480,parent,true);
my.start();
* The first parameter is a name for the game.
* The second one is the amount of msecs between two updates.
* The third one is the amount of msecs between two render runs.
* four and five are start width and height.
* number six is the parent composite for the glCanas.
* the seventh and last one states if this is the only SWTGame running.
The game is now running. 
==Controlling the scene==
Now we want to add a FirstPersonController. 
To do this add this code to your simpleInitGame() method: 
getGlCanvas().addKeyListener((KeyListener) KeyInput.get());
getGlCanvas()
.addMouseMoveListener((MouseMoveListener) MouseInput.get());
getGlCanvas().addMouseListener((MouseListener) MouseInput.get());
FirstPersonHandler firstPersonHandler = new FirstPersonHandler(display
.getRenderer().getCamera(), 50, 1);
input = firstPersonHandler;
And add a global var:
/**
* Handles our mouse/keyboard input.
*/
protected InputHandler input;
Now overwrite the update() method:
/* (non-Javadoc)
* @see org.rifidi.jmeswt.SWTBaseGame#update(float)
*/
@Override
protected void update(float interpolation) {
super.update(interpolation);
input.update(interpolation);
}
Start your RCP-app again, click in the 3d window and move around your fancy box. 
As you can see from this example SWTKeyInput and SWTMouseInput are already registered for handling events 
The RenderThread works good but I will add some timing related tweaks soon. 
Have Fun :)
==What the frick does the "simple" parameter in the constructor mean?==
Ok, we are in eclipse RCP so mostly you will deal with multiwindow thing. 
First of all: 
If you don't intend to use more than one game/window inside eclipse stop reading here. Everything will work like you are used to it from jmonkey. You will have your GameTaskQueues as you are used to them and can live happily on without bothering ybout the rest. 
If you, like us, need support for multiple games in one app continue readiung. 
When you create let's say two games you will have to set single to false. 
That tells SWTBaseGame to create individual rendering and update queues for each game so that we don't have collisions there. 
The queues are name "<gamename>.render" and "<gamename>.update". This is important to remember as your callables will have to be sent to the right queues. 
You can also access the queues directly in SWTBaseGame with getUpdateQueue() or getRenderQueue(). 
Right now you can't render to two games at the same time (NOTE: the next release should include functionality for that, but our current app doesn't need that) so call stopRendering() when your game loses the focus and resumeRendering() when it acquires focus. The important thing is that the games don't stop updating!

Rifidi:jmeswt

2008-06-02T15:14:41Z

Jochen:

=jMonkey SWT bindings=
==Overview==
Within this entry we will introduce you to the jmeswt plugin that allows developers to get the jMonkey engine into there app. 
All our code is release under the LGPL. The contained libraries are compatible with this license (if we overlooked something please inform us). 
Included libraries are: 
* [http://lwjgl.org/ lwjgl]
* [https://jmephysics.dev.java.net/ jmephysics]
* [http://jmonkeyengine.com/ jmonkey]
This whole library has come from tons of forum posts and a lot of hard work. 
Most notably we included the OffscreenRenderer from Olivier Sambourg and Joshua Slack. 
==Installation==
We have our own update site right now to make it as convenient as possible to use the plugin: 
[http://rifidi.org/update http://rifidi.org/update Rifidi update site] 
Just add this site in Help->Software Updates->find and install ... 
After adding it just select org.rifidi.jmeswt: 
[[Image:Screenshot-Updates.png]] 
Yoiu can also add the second plugin in the list, it's a (alpha!!!!) editor for .dae (collada) files. 
After adding the editor a doubleclick on a file ending with .dae will bring up a 3d view that displays the contents of the file. It's just a little demo app that will be enhanced as we progress on our ide for RifidiDesigner. 
The sourccde to this plugin is availabel from our puplic repository. 
==What's in it==
The plug-in contain two things:<nr/>
* A jar with the system provider: This is required as jmonkey uses the old service stuff from sun that requires some MANIFEST magic that apparently doesn't go well with the OSGi classloaders.
* The classes that actually form the layer between SWT and jMonkey.
** org.rifidi.jmeswt.input.SWTKeyInput: This is the KeyInput provider to be used with the different handlers of jmonkey.
** org.rifidi.jmeswt.input.SWTMouseInput: This is the KeyInput provider to be used with the different handlers of jmonkey.
** org.rifidi.jmeswt.input.Mapping: This is a static class to provide a fast and extensible way of mapping the different SWT events to LWJGL events. It's about 90% complete with only some minor things missing.
** org.rifidi.jmeswt.SWTBaseGame: This is the starting point for SWT based jmonkey games (See next chapter).
==How to use it==
I assume that you are an Eclipse RCP developer so I will just skip the details for creating an RCP projhect. 
After creating the project add org.rifidi.jmeswt to your dependencies. 
Now create your custom game: 
package test;

import org.eclipse.swt.widgets.Composite;
import org.rifidi.jmeswt.SWTBaseGame;

import com.jme.math.Vector3f;
import com.jme.scene.shape.Box;

/**
*
*
* @author Jochen Mader - jochen@pramari.com - Jun 2, 2008
*
*/
public class MyGame extends SWTBaseGame {

/**
* @param name
* @param updateResolution
* @param renderResolution
* @param width
* @param height
* @param parent
* @param single
*/
public MyGame(String name, int updateResolution, int renderResolution,
int width, int height, Composite parent, boolean single) {
super(name, updateResolution, renderResolution, width, height, parent,
single);
// TODO Auto-generated constructor stub
}

/*
* (non-Javadoc)
*
* @see org.rifidi.jmeswt.SWTBaseGame#simpleInitGame()
*/
@Override
protected void simpleInitGame() {
Box myBox=new Box("boxxy", Vector3f.ZERO.clone(), 2f, 2f, 2f);
myBox.setRandomColors();
getRootNode().attachChild(myBox);
getRootNode().updateRenderState();
}
}
 
After creating this game instantiated it in your createPartControl method and hit the start() method after creating it. 
MyGame my=new MyGame("gamy",10,20,640,480,parent,true);
my.start();
* The first parameter is a name for the game.
* The second one is the amount of msecs between two updates.
* The third one is the amount of msecs between two render runs.
* four and five are start width and height.
* number six is the parent composite for the glCanas.
* the seventh and last one states if this is the only SWTGame running.
The game is now running. 
==Controlling the scene==
Now we want to add a FirstPersonController. 
To do this add this code to your simpleInitGame() method: 
getGlCanvas().addKeyListener((KeyListener) KeyInput.get());
getGlCanvas()
.addMouseMoveListener((MouseMoveListener) MouseInput.get());
getGlCanvas().addMouseListener((MouseListener) MouseInput.get());
FirstPersonHandler firstPersonHandler = new FirstPersonHandler(display
.getRenderer().getCamera(), 50, 1);
input = firstPersonHandler;
And add a global var:
/**
* Handles our mouse/keyboard input.
*/
protected InputHandler input;
Now overwrite the update() method:
/* (non-Javadoc)
* @see org.rifidi.jmeswt.SWTBaseGame#update(float)
*/
@Override
protected void update(float interpolation) {
super.update(interpolation);
input.update(interpolation);
}
Start your RCP-app again, click in the 3d window and move around your fancy box. 
As you can see from this example SWTKeyInput and SWTMouseInput are already registered for handling events 
The RenderThread works good but I will add some timing related tweaks soon. 
Have Fun :)
==What the frick does the simple parameter in the constructor mean?==
Ok, we are in eclipse RCP so mostly you will deal with multiwindow thing. 
First of all: 
If you don't intend to use more than one game/window inside eclipse stop reading here. Everything will work like you are used to it from jmonkey. You will have your GameTaskQueues as you are used to them and can live happily on without bothering ybout the rest. 
If you, like us, need support for multiple games in one app continue readiung. 
When you create let's say two games you will have to set single to false. 
That tells SWTBaseGame to create individual rendering and update queues for each game so that we don't have collisions there. 
The queues are name "<gamename>.render" and "<gamename>.update". This is important to remember as your callables will have to be sent to the right queues. 
You can also access the queues directly in SWTBaseGame with getUpdateQueue() or getRenderQueue(). 
Right now you can't render to two games at the same time (NOTE: the next release should include functionality for that, but our current app doesn't need that) so call stopRendering() when your game loses the focus and resumeRendering() when it acquires focus. The important thing is that the games don't stop updating!

Rifidi:jmeswt

2008-06-02T15:04:56Z

Jochen: /* Controlling the scene */

Rifidi:jmeswt

2008-06-02T15:04:06Z

Jochen:

=jMonkey SWT bindings=
==Overview==
Within this entry we will introduce you to the jmeswt plugin that allows developers to get the jMonkey engine into there app. 
All our code is release under the LGPL. The contained libraries are compatible with this license (if we overlooked something please inform us). 
Included libraries are: 
* [http://lwjgl.org/ lwjgl]
* [https://jmephysics.dev.java.net/ jmephysics]
* [http://jmonkeyengine.com/ jmonkey]
This whole library has come from tons of forum posts and a lot of hard work. 
Most notably we included the OffscreenRenderer from Olivier Sambourg and Joshua Slack. 
==Installation==
We have our own update site right now to make it as convenient as possible to use the plugin: 
[http://rifidi.org/update http://rifidi.org/update Rifidi update site] 
Just add this site in Help->Software Updates->find and install ... 
After adding it just select org.rifidi.jmeswt: 
[[Image:Screenshot-Updates.png]] 
Yoiu can also add the second plugin in the list, it's a (alpha!!!!) editor for .dae (collada) files. 
After adding the editor a doubleclick on a file ending with .dae will bring up a 3d view that displays the contents of the file. It's just a little demo app that will be enhanced as we progress on our ide for RifidiDesigner. 
The sourccde to this plugin is availabel from our puplic repository. 
==What's in it==
The plug-in contain two things:<nr/>
* A jar with the system provider: This is required as jmonkey uses the old service stuff from sun that requires some MANIFEST magic that apparently doesn't go well with the OSGi classloaders.
* The classes that actually form the layer between SWT and jMonkey.
** org.rifidi.jmeswt.input.SWTKeyInput: This is the KeyInput provider to be used with the different handlers of jmonkey.
** org.rifidi.jmeswt.input.SWTMouseInput: This is the KeyInput provider to be used with the different handlers of jmonkey.
** org.rifidi.jmeswt.input.Mapping: This is a static class to provide a fast and extensible way of mapping the different SWT events to LWJGL events. It's about 90% complete with only some minor things missing.
** org.rifidi.jmeswt.SWTBaseGame: This is the starting point for SWT based jmonkey games (See next chapter).
==How to use it==
I assume that you are an Eclipse RCP developer so I will just skip the details for creating an RCP projhect. 
After creating the project add org.rifidi.jmeswt to your dependencies. 
Now create your custom game: 
package test;

import org.eclipse.swt.widgets.Composite;
import org.rifidi.jmeswt.SWTBaseGame;

import com.jme.math.Vector3f;
import com.jme.scene.shape.Box;

/**
*
*
* @author Jochen Mader - jochen@pramari.com - Jun 2, 2008
*
*/
public class MyGame extends SWTBaseGame {

/**
* @param name
* @param updateResolution
* @param renderResolution
* @param width
* @param height
* @param parent
* @param single
*/
public MyGame(String name, int updateResolution, int renderResolution,
int width, int height, Composite parent, boolean single) {
super(name, updateResolution, renderResolution, width, height, parent,
single);
// TODO Auto-generated constructor stub
}

/*
* (non-Javadoc)
*
* @see org.rifidi.jmeswt.SWTBaseGame#simpleInitGame()
*/
@Override
protected void simpleInitGame() {
Box myBox=new Box("boxxy", Vector3f.ZERO.clone(), 2f, 2f, 2f);
myBox.setRandomColors();
getRootNode().attachChild(myBox);
getRootNode().updateRenderState();
}
}
 
After creating this game instantiated it in your createPartControl method and hit the start() method after creating it. 
MyGame my=new MyGame("gamy",10,20,640,480,parent,true);
my.start();
* The first parameter is a name for the game.
* The second one is the amount of msecs between two updates.
* The third one is the amount of msecs between two render runs.
* four and five are start width and height.
* number six is the parent composite for the glCanas.
* the seventh and last one states if this is the only SWTGame running.
The game is now running. 
==Controlling the scene==
Now we want to add a FirstPersonController. 
To do this add this code to your simpleInitGame() method: 
getGlCanvas().addKeyListener((KeyListener) KeyInput.get());
getGlCanvas()
.addMouseMoveListener((MouseMoveListener) MouseInput.get());
getGlCanvas().addMouseListener((MouseListener) MouseInput.get());
FirstPersonHandler firstPersonHandler = new FirstPersonHandler(display
.getRenderer().getCamera(), 50, 1);
input = firstPersonHandler;
And add a global var:
/**
* Handles our mouse/keyboard input.
*/
protected InputHandler input;
Now overwrite the update() method:
/* (non-Javadoc)
* @see org.rifidi.jmeswt.SWTBaseGame#update(float)
*/
@Override
protected void update(float interpolation) {
super.update(interpolation);
input.update(interpolation);
}
Start your RCP-app again, click in the 3d window and move around your fancy box. 

The SWTBaseGame is an abstract class so you will have to extend it. 
SWTKeyInput and SWTMouseInput are already registered, just add your Controller and you are good to go. 
The SWTBaseGame is multithreaded. The values updateResolution and renderResolution are used by the threads to define how often they run. 
The RenderThread works good but I will add some timing related tweaks soon. 
Have Fun :)

Rifidi:jmeswt

2008-06-02T14:59:47Z

Jochen: /* How to use it */

Rifidi:jmeswt

2008-06-02T14:55:09Z

Jochen: /* How to use it */

Rifidi:jmeswt

2008-06-02T14:55:00Z

Jochen: /* How to use it */

Rifidi:jmeswt

2008-06-02T14:44:41Z

Jochen: /* How to use it */

Rifidi:jmeswt

2008-06-02T14:42:11Z

Jochen: /* How to use it */

Rifidi:jmeswt

2008-06-02T14:37:43Z

Jochen:

Rifidi:jmeswt

2008-06-02T14:37:27Z

Jochen: /* What's in it */