fr.lri.smarties.libserver

Class Smarties

java.lang.Object

java.util.Observable

fr.lri.smarties.libserver.Smarties

public class Smarties
extends Observable

Smarties central class.

Since:

1.0.0

Version:

1.3.1

Author:

Olivier Chapuis

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT_SMARTIES Default port that mobile devices should use to send message to the server (you should note really care ...
static int	SMARTIES_DEVICE_ORIENTATION_LANDSCAPE
static int	SMARTIES_DEVICE_ORIENTATION_PORTRAIT
static int	SMARTIES_OSC_OUT_PORT Default port that the server should use to send message to the mobile devices (you should note really care ...
static int	SMARTIES_PUCK_STATUS_FREE
static int	SMARTIES_PUCK_STATUS_LOCKED
static int	SMARTIES_PUCK_STATUS_SELECTED
static int	SMARTIES_SOUND_ALARM
static int	SMARTIES_SOUND_NONE
static int	SMARTIES_SOUND_NOTIFICATION
static int	SMARTIES_SOUND_RINGTONE

Constructor Summary

Constructors

Constructor and Description
Smarties(int aw, int ah, int tilew, int tileh) Create a Smarties object for running with an application of the given size running (eventually) with a wall/large display consituted by a tile of screen.
Smarties(int port, int aw, int ah, int tilew, int tileh) Create a Smarties object using an other port than the default "incoming" Smarties port DEFAULT_PORT_SMARTIES (WARNING the mobile clients should be aware of that!)

Method Summary

Modifier and Type	Method and Description
void	addItemInWidgetList(int wid, String item, int pos) Add an item in the list of items of a SmartiesWidget that contains a list of items (PopupMenu, Spinner, etc.), the change is persistent, i.e., affect the widget for novel connection.
SmartiesWidget	addWidget(int type, String label, float x, float y, float w, float h) Add a widget of a given type, given size and at a given position in the widget area of the mobile clients.
void	createOnePuckByDevice(boolean v) Set to true so that the server create automatically a new puck for each new connected client.
SmartiesPuck	createPuck(SmartiesDevice d, float x, float y, boolean select) Create a puck at position x,y that is become selected on device d (if not null and select is true).
void	deletePuck(int id) Definitively delete the SmartiesPuck with identifier id.
void	deletePuck(SmartiesPuck p) Definitively delete the SmartiesPuck p.
SmartiesDevice	getDevice(String ip) Return the SmartiesDevice with IP address ip or null if there is no device with such an IP address.
Map<String,SmartiesDevice>	getDevicesMapping() Return a map from the IP addresses to the SmartiesDevice's.
SmartiesPuck	getPuck(int id) Return the SmartiesPuck with identifier id or null if there is no puck with such an identifier.
Map<Integer,SmartiesPuck>	getPuckMapping() Return a map from the identifiers to the SmartiesPuck's.
SmartiesWidget	getWidget(int wid) Return the SmartiesWidget with the given identifier.
void	initWidgets(int wgridw, int wgridh) Define the size of the grid with which the geometry of the widgets are defined.
void	movePuck(int id, float x, float y) Move the SmartiesPuck with identifier id.
void	movePuck(SmartiesPuck p, float x, float y) Move the SmartiesPuck p.
void	removeItemInWidgetList(int wid, int pos) Remove an item in the list of items of a SmartiesWidget that contains a list of items (PopupMenu, Spinner, etc.), the change is persistent, i.e., affect the widget for novel connection.
void	replaceWidgetItemsList(int wid, Vector<String> items) Replace the list of items of a SmartiesWidget that contains a list of items (PopupMenu, Spinner, etc.).
void	Run() Start listenning and sending message to the mobile clients
void	sendNotification(int soundType, int soundDuration, int vibration, String str) Send a notification to all the devices.
void	sendNotification(int soundType, int soundDuration, int vibration, String str, SmartiesDevice dev) Send a notification to the device dev or to all the devices if dev is null.
void	sendNotification(int soundType, int soundDuration, int vibration, String str, String ip) Send a notification to the device with IP ip or to all the devices if ip is null.
void	sendPuckColor(SmartiesPuck p, String ip, int color) Send (and set) to the device with IP adress ip, or to all the devices if ip is null, the color for the puck p (in hexadecimal, e.g.
void	sendPuckCursorType(SmartiesPuck p, String ip, int cursor_type) Send (and set) to the device with IP adress ip, or to all the devices if ip is null, the cursor type of the puck p.
void	sendWidgetCheckedItems(int wid, Vector<Boolean> checked_items) Send/change the checked items of the widget (e.g., multi-choice popup) with identifier wid for all the devices (the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetCheckedItems(int wid, Vector<Boolean> checked_items, SmartiesDevice dev) Send/change the checked values of the widget (e.g., multi-choice popup) with identifier wid for the device dev, or for all the devices if dev is null (if dev is null the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetCheckedItems(int wid, Vector<Boolean> checked_items, String ip) Send/change the checked items of the widget (e.g., multi-choice popup) with identifier wid for the device with IP address ip, or for all the devices if ip is null (if ip is null the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetFontSize(int wid, int size) Send/change the font size for the widget with identifier wid for all the devices (the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetFontSize(int wid, int size, SmartiesDevice dev) Send/change the font size for the widget with identifier wid for device dev, or for all the devices if dev is null (if dev is null the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetFontSize(int wid, int size, String ip) Send/change the font size for the widget with identifier wid for the device with IP address ip, or for all the devices if ip is null (if ip is null the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetItem(int wid, int item) Send/change the selected item of the widget with identifier wid for all the devices.
void	sendWidgetItem(int wid, int item, SmartiesDevice dev) Send/change the selected item of the widget with identifier wid for the device dev, or for all the devices if dev is null (if dev is null the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetItem(int wid, int item, String ip) Send/change the selected item of the widget with identifier wid for the device with IP address ip, or for all the devices if ip is null.
void	sendWidgetLabel(int wid, String str) Send/change the label of the widget with identifier wid for all the devices (the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetLabel(int wid, String str, SmartiesDevice dev) Send/change the label of the widget with identifier wid for device dev, or for all the devices if dev is null (if dev is null the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetLabel(int wid, String str, String ip) Send/change the label of the widget with identifier wid for the device with IP address ip, or for all the devices (if ip is null (if ip is null the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetOnState(int wid, boolean onstate) Send/change the on/off value of the widget (e.g., a toggle button) with identifier wid for all the devices (the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetOnState(int wid, boolean onstate, SmartiesDevice dev) Send/change the on/off value of the widget (e.g., a toggle button) with identifier wid for the device dev, or for all the devices if dev is null (if dev is null the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetOnState(int wid, boolean onstate, String ip) Send/change the on/off value of the widget (e.g., a toggle button) with identifier wid for the device with IP address ip, or for all the devices if ip is null (if ip is null the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetState(int wid, int state) Send/change the state (enabled/disabled/hidden) of the widget with identifier wid for all the devices (the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetState(int wid, int state, SmartiesDevice dev) Send/change the state (enabled/disabled/hidden) of the widget with identifier wid for the device dev, or for all the devices if dev is null (if dev is null the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetState(int wid, int state, String ip) Send/change the state (enabled/disabled/hidden) of the widget with identifier wid for the device with IP address ip, or for all the devices if ip is null (if ip is null the change is persistent, i.e., affect the widget for novel connection).
void	sendWidgetValue(int wid, int value) Send/change the value of the widget (e.g., a slider) with identifier wid for all the devices (the change is persistent, i.e., affect the widget for novel connection) .
void	sendWidgetValue(int wid, int value, SmartiesDevice dev) Send/change the value of the widget (e.g., a slider) with identifier wid for the device dev, or for all the devices if dev is null.
void	sendWidgetValue(int wid, int value, String ip) Send/change the value of the widget (e.g., a slider) with identifier wid for the device with IP address ip, or for all the devices if ip is null (if ip is null the change is persistent, i.e., affect the widget for novel connection).
void	setAccelerationParameters(float maxCDgainFactor, float minCDgainMM) Set the acceleration parameters for indirect one finger touch for all connected device (and all future devices that will connect to the server).
void	setAccelerationParameters(float maxCDgainFactor, float minCDgainMM, SmartiesDevice dev) Set the acceleration parameters for indirect one finger touch for the device dev (or all connected device if dev is null).
void	setDeviceOrientation(int v) Set the orientation of the clients, could be Smarties.SMARTIES_DEVICE_ORIENTATION_LANDSCAPE or Smarties.SMARTIES_DEVICE_ORIENTATION_PORTRAIT.
void	setHideLockedPucks(boolean v) Instruct all connected device (and all future devices that will connect to the server) to hide or not the locked pucks.
void	setHideLockedPucks(boolean v, SmartiesDevice dev) Instruct the device dev (or all connected device if dev is null) to hide or not the locked pucks.
void	setInterfaceButtons(boolean pb, boolean sb, boolean di, boolean si) Define the standard interface buttons and icons that appear in the clients interface.
void	setPureTouchpad(boolean v) Set to true to only have the touchpad area in the clients.
void	setPureWidgetArea(boolean v) Set to true to only have the widget area in the clients (no touchpad!).
void	setRawTouchEventsConf(boolean v) Disable/Enable the multi-touch raw events for all the devices (and all future devices that will connect to the server).
void	setRawTouchEventsConf(boolean v, SmartiesDevice dev) Disable/Enable the multi-touch raw events for the device dev or for all the devices if dev is null.
void	setSharingPolicyCustom() Set the Sharing policy to "custom"
void	setSharingPolicyMedium() Set the Sharing policy to "medium"
void	setSharingPolicyPermissive() Set the Sharing policy to "medium"
void	setSharingPolicyStrict() Set the Sharing policy to "strict"
void	setSmartiesTouchEventsConf(boolean v) Disable/Enable the multi-touch "high-level" Smarties events for all the devices (and all future devices that will connect to the server).
void	setSmartiesTouchEventsConf(boolean v, SmartiesDevice dev) Disable/Enable the multi-touch "high-level" Smarties events for the device dev or for all the devices if dev is null.
void	showKeyboard(int id, SmartiesDevice d) Ask the SmartiesDevice dev to map a keyboard.
void	showKeyboard(int id, SmartiesDevice d, int num_keys) Ask the SmartiesDevice dev to map a keyboard and to unmap it after a certain number of keys has been typed.
void	showKeyboard(int id, String ip) Ask the device with IP address ip to map a keyboard.
void	showKeyboard(int id, String ip, int num_keys) Ask the device with IP address ip to map a keyboard and to unmap it after a certain number of keys has been typed.

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PORT_SMARTIES

public static final int DEFAULT_PORT_SMARTIES

Default port that mobile devices should use to send message to the server (you should note really care ... but only one application could use this port on the server). 57110

See Also:

Constant Field Values

SMARTIES_OSC_OUT_PORT

public static final int SMARTIES_OSC_OUT_PORT

Default port that the server should use to send message to the mobile devices (you should note really care ... but only one application could use this port on a given mobile device). 57120

See Also:

Constant Field Values

SMARTIES_PUCK_STATUS_FREE

public static final int SMARTIES_PUCK_STATUS_FREE

See Also:

Constant Field Values

SMARTIES_PUCK_STATUS_LOCKED

public static final int SMARTIES_PUCK_STATUS_LOCKED

See Also:

Constant Field Values

SMARTIES_PUCK_STATUS_SELECTED

public static final int SMARTIES_PUCK_STATUS_SELECTED

See Also:

Constant Field Values

SMARTIES_DEVICE_ORIENTATION_LANDSCAPE

public static final int SMARTIES_DEVICE_ORIENTATION_LANDSCAPE

See Also:

Constant Field Values

SMARTIES_DEVICE_ORIENTATION_PORTRAIT

public static final int SMARTIES_DEVICE_ORIENTATION_PORTRAIT

See Also:

Constant Field Values

SMARTIES_SOUND_NONE

public static final int SMARTIES_SOUND_NONE

See Also:

Constant Field Values

SMARTIES_SOUND_NOTIFICATION

public static final int SMARTIES_SOUND_NOTIFICATION

See Also:

Constant Field Values

SMARTIES_SOUND_RINGTONE

public static final int SMARTIES_SOUND_RINGTONE

See Also:

Constant Field Values

SMARTIES_SOUND_ALARM

public static final int SMARTIES_SOUND_ALARM

See Also:

Constant Field Values

Constructor Detail

Smarties

public Smarties(int port,
                int aw,
                int ah,
                int tilew,
                int tileh)

Create a Smarties object using an other port than the default "incoming" Smarties port DEFAULT_PORT_SMARTIES (WARNING the mobile clients should be aware of that!)

Parameters:

port - port number

aw - full screen/window/wall width

ah - full screen/window/wall height

tilew - number of screens in the horizontal direction

tileh - number of screens in the vertical direction

See Also:

Smarties(int aw, int ah, int tilew, int tileh)

Smarties

public Smarties(int aw,
                int ah,
                int tilew,
                int tileh)

Create a Smarties object for running with an application of the given size running (eventually) with a wall/large display consituted by a tile of screen.

The "geometry" of the tile (that could be 1x1) is only used to draw a grid in the mobile clients (at least for now) ... its not essential.

Parameters:

aw - full screen/window/wall width

ah - full screen/window/wall height

tilew - number of screens in the horizontal direction

tileh - number of screens in the verctical direction

Method Detail

getPuck

public SmartiesPuck getPuck(int id)

Return the SmartiesPuck with identifier id or null if there is no puck with such an identifier.

Parameters:

id - identifier

Returns:

a SmartiesPuck or null

getPuckMapping

public Map<Integer,SmartiesPuck> getPuckMapping()

Return a map from the identifiers to the SmartiesPuck's.

Returns:

a map from the integers to the SmartiesPuck's

getDevice

public SmartiesDevice getDevice(String ip)

Return the SmartiesDevice with IP address ip or null if there is no device with such an IP address.

Parameters:

ip - IP address

Returns:

a SmartiesDevice or null

getDevicesMapping

public Map<String,SmartiesDevice> getDevicesMapping()

Return a map from the IP addresses to the SmartiesDevice's.

Returns:

a map from strings to the SmartiesDevice's

movePuck

public void movePuck(int id,
                     float x,
                     float y)

Move the SmartiesPuck with identifier id.

The position is relative, i.e., specified by a point in [0,1]x[0,1]. The point (0,0) is top-left.

Parameters:

id - identifier

x - x coordinate

y - y coordinate

movePuck

public void movePuck(SmartiesPuck p,
                     float x,
                     float y)

Move the SmartiesPuck p.

The position is relative, i.e., specified by a point in [0,1]x[0,1]. The point (0,0) is top-left.

Parameters:

p - the puck to move

x - x coordinate

y - y coordinate

deletePuck

public void deletePuck(int id)

Definitively delete the SmartiesPuck with identifier id.

Parameters:

id - identifier

deletePuck

public void deletePuck(SmartiesPuck p)

Definitively delete the SmartiesPuck p.

Parameters:

p - the SmartiesPuck

sendPuckCursorType

public void sendPuckCursorType(SmartiesPuck p,
                               String ip,
                               int cursor_type)

Send (and set) to the device with IP adress ip, or to all the devices if ip is null, the cursor type of the puck p.

Parameters:

p - the SmartiesPuck

ip - an IP address or null

cursor_type - the cursor type

sendPuckColor

public void sendPuckColor(SmartiesPuck p,
                          String ip,
                          int color)

Send (and set) to the device with IP adress ip, or to all the devices if ip is null, the color for the puck p (in hexadecimal, e.g. 0xAF50FF)

Parameters:

p - the SmartiesPuck

ip - an IP address or null

color - the color

createPuck

public SmartiesPuck createPuck(SmartiesDevice d,
                               float x,
                               float y,
                               boolean select)

Create a puck at position x,y that is become selected on device d (if not null and select is true). This puck will be sent to all the running device.

The position is relative, i.e., specified by a point in [0,1]x[0,1]. The point (0,0) is top-left. WAENING: this will not generate a SMARTIES_EVENTS_TYPE_CREATE event

Parameters:

d - a SmatiesDevice or null

x - x coordinate

y - y coordinate

select - make the new puck selected in device d (if not null)

Returns:

the created puck

showKeyboard

public void showKeyboard(int id,
                         String ip,
                         int num_keys)

Ask the device with IP address ip to map a keyboard and to unmap it after a certain number of keys has been typed.

If the number of keys is 0, then the keyboard will be not automatically unmapped.

Parameters:

id - identifier of a puck

ip - IP address

num_keys - number of key for umapping

showKeyboard

public void showKeyboard(int id,
                         String ip)

Ask the device with IP address ip to map a keyboard.

Parameters:

id - identifier of a puck

ip - IP address

showKeyboard

public void showKeyboard(int id,
                         SmartiesDevice d,
                         int num_keys)

Ask the SmartiesDevice dev to map a keyboard and to unmap it after a certain number of keys has been typed.

If the number of keys is 0, then the keyboard will be not automatically unmapped.

Parameters:

id - identifier of a puck

d - the SmartiesDevice

num_keys - number of key for umapping

showKeyboard

public void showKeyboard(int id,
                         SmartiesDevice d)

Ask the SmartiesDevice dev to map a keyboard.

Parameters:

id - identifier of a puck

d - the SmartiesDevice

sendWidgetLabel

public void sendWidgetLabel(int wid,
                            String str,
                            SmartiesDevice dev)

Send/change the label of the widget with identifier wid for device dev, or for all the devices if dev is null (if dev is null the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

str - the new label

dev - a SmartiesDevice or null

sendWidgetLabel

public void sendWidgetLabel(int wid,
                            String str,
                            String ip)

Send/change the label of the widget with identifier wid for the device with IP address ip, or for all the devices (if ip is null (if ip is null the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

str - the new label

ip - IP address or null

sendWidgetLabel

public void sendWidgetLabel(int wid,
                            String str)

Send/change the label of the widget with identifier wid for all the devices (the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

str - the new label

sendWidgetFontSize

public void sendWidgetFontSize(int wid,
                               int size,
                               SmartiesDevice dev)

Send/change the font size for the widget with identifier wid for device dev, or for all the devices if dev is null (if dev is null the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

size - the new font size in dp

dev - a SmartiesDevice or null

sendWidgetFontSize

public void sendWidgetFontSize(int wid,
                               int size,
                               String ip)

Send/change the font size for the widget with identifier wid for the device with IP address ip, or for all the devices if ip is null (if ip is null the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

size - the new font size

ip - IP address or null

sendWidgetFontSize

public void sendWidgetFontSize(int wid,
                               int size)

Send/change the font size for the widget with identifier wid for all the devices (the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

size - the new font size

sendWidgetItem

public void sendWidgetItem(int wid,
                           int item,
                           SmartiesDevice dev)

Send/change the selected item of the widget with identifier wid for the device dev, or for all the devices if dev is null (if dev is null the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

item - the selected item (first item is 0)

dev - a SmartiesDevice or null

sendWidgetItem

public void sendWidgetItem(int wid,
                           int item,
                           String ip)

Send/change the selected item of the widget with identifier wid for the device with IP address ip, or for all the devices if ip is null.

Parameters:

wid - widget identifier

item - the selected item (first item is 0)

ip - IP address or null

sendWidgetItem

public void sendWidgetItem(int wid,
                           int item)

Send/change the selected item of the widget with identifier wid for all the devices.

Parameters:

wid - widget identifier

item - the selected item (first item is 0)

sendWidgetValue

public void sendWidgetValue(int wid,
                            int value,
                            SmartiesDevice dev)

Send/change the value of the widget (e.g., a slider) with identifier wid for the device dev, or for all the devices if dev is null.

Parameters:

wid - widget identifier

value - the value (from 0 to 100)

dev - a SmartiesDevice or null

sendWidgetValue

public void sendWidgetValue(int wid,
                            int value,
                            String ip)

Send/change the value of the widget (e.g., a slider) with identifier wid for the device with IP address ip, or for all the devices if ip is null (if ip is null the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

value - the value (from 0 to 100)

ip - IP address or null

sendWidgetValue

public void sendWidgetValue(int wid,
                            int value)

Send/change the value of the widget (e.g., a slider) with identifier wid for all the devices (the change is persistent, i.e., affect the widget for novel connection) .

Parameters:

wid - widget identifier

value - the value (from 0 to 100)

sendWidgetOnState

public void sendWidgetOnState(int wid,
                              boolean onstate,
                              SmartiesDevice dev)

Send/change the on/off value of the widget (e.g., a toggle button) with identifier wid for the device dev, or for all the devices if dev is null (if dev is null the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

onstate - on (true), off (false)

dev - a SmartiesDevice or null

sendWidgetOnState

public void sendWidgetOnState(int wid,
                              boolean onstate,
                              String ip)

Send/change the on/off value of the widget (e.g., a toggle button) with identifier wid for the device with IP address ip, or for all the devices if ip is null (if ip is null the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

onstate - on (true), off (false)

ip - IP address or null

sendWidgetOnState

public void sendWidgetOnState(int wid,
                              boolean onstate)

Send/change the on/off value of the widget (e.g., a toggle button) with identifier wid for all the devices (the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

onstate - on (true), off (false)

replaceWidgetItemsList

public void replaceWidgetItemsList(int wid,
                                   Vector<String> items)

Replace the list of items of a SmartiesWidget that contains a list of items (PopupMenu, Spinner, etc.). (the change is persistent, i.e., affect the widget for novel connection)

You might need to re-set the selected item(s) with sendWidgetItem.

Parameters:

wid - the id of the SmartiesWidget

items - the new items list

See Also:

sendWidgetItem(int wid, int item)

addItemInWidgetList

public void addItemInWidgetList(int wid,
                                String item,
                                int pos)

Add an item in the list of items of a SmartiesWidget that contains a list of items (PopupMenu, Spinner, etc.), the change is persistent, i.e., affect the widget for novel connection.

You might need to re-set the selected item(s) with sendWidgetItem.

Parameters:

wid - the id of the SmartiesWidget

item - the new item

pos - position in the list, -1 will append the item

See Also:

sendWidgetItem(int wid, int item)

removeItemInWidgetList

public void removeItemInWidgetList(int wid,
                                   int pos)

Remove an item in the list of items of a SmartiesWidget that contains a list of items (PopupMenu, Spinner, etc.), the change is persistent, i.e., affect the widget for novel connection.

You might need to re-set the selected item(s) with sendWidgetItem.

Parameters:

wid - the id of the SmartiesWidget

pos - position of the item to be removed, -1 will remove the last item

See Also:

sendWidgetItem(int wid, int item)

sendWidgetCheckedItems

public void sendWidgetCheckedItems(int wid,
                                   Vector<Boolean> checked_items,
                                   SmartiesDevice dev)

Send/change the checked values of the widget (e.g., multi-choice popup) with identifier wid for the device dev, or for all the devices if dev is null (if dev is null the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

checked_items - Vector of booleans

dev - a SmartiesDevice or null

sendWidgetCheckedItems

public void sendWidgetCheckedItems(int wid,
                                   Vector<Boolean> checked_items,
                                   String ip)

Send/change the checked items of the widget (e.g., multi-choice popup) with identifier wid for the device with IP address ip, or for all the devices if ip is null (if ip is null the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

checked_items - what is checked or not

ip - IP address or null

sendWidgetCheckedItems

public void sendWidgetCheckedItems(int wid,
                                   Vector<Boolean> checked_items)

Send/change the checked items of the widget (e.g., multi-choice popup) with identifier wid for all the devices (the change is persistent, i.e., affect the widget for novel connection).

Parameters:

wid - widget identifier

checked_items - what is checked or not

sendWidgetState

public void sendWidgetState(int wid,
                            int state,
                            SmartiesDevice dev)

Send/change the state (enabled/disabled/hidden) of the widget with identifier wid for the device dev, or for all the devices if dev is null (if dev is null the change is persistent, i.e., affect the widget for novel connection).

The possible state are SmartiesWidget.SMARTIES_WIDGET_STATE_ENABLED, SmartiesWidget.SMARTIES_WIDGET_STATE_DISABLED or SmartiesWidget.SMARTIES_WIDGET_STATE_HIDDEN,

Parameters:

wid - widget identifier

state - the state

dev - a SmartiesDevice or null

See Also:

SmartiesWidget.SMARTIES_WIDGET_STATE_ENABLED, SmartiesWidget.SMARTIES_WIDGET_STATE_DISABLED, SmartiesWidget.SMARTIES_WIDGET_STATE_HIDDEN

sendWidgetState

public void sendWidgetState(int wid,
                            int state,
                            String ip)

Send/change the state (enabled/disabled/hidden) of the widget with identifier wid for the device with IP address ip, or for all the devices if ip is null (if ip is null the change is persistent, i.e., affect the widget for novel connection).

The possible state are SmartiesWidget.SMARTIES_WIDGET_STATE_ENABLED, SmartiesWidget.SMARTIES_WIDGET_STATE_DISABLED or SmartiesWidget.SMARTIES_WIDGET_STATE_HIDDEN,

Parameters:

wid - widget identifier

state - the state

ip - IP address or null

See Also:

SmartiesWidget.SMARTIES_WIDGET_STATE_ENABLED, SmartiesWidget.SMARTIES_WIDGET_STATE_DISABLED, SmartiesWidget.SMARTIES_WIDGET_STATE_HIDDEN

sendWidgetState

public void sendWidgetState(int wid,
                            int state)

Send/change the state (enabled/disabled/hidden) of the widget with identifier wid for all the devices (the change is persistent, i.e., affect the widget for novel connection).

The possible state are SmartiesWidget.SMARTIES_WIDGET_STATE_ENABLED, SmartiesWidget.SMARTIES_WIDGET_STATE_DISABLED or SmartiesWidget.SMARTIES_WIDGET_STATE_HIDDEN,

Parameters:

wid - widget identifier

state - the state

See Also:

SmartiesWidget.SMARTIES_WIDGET_STATE_ENABLED, SmartiesWidget.SMARTIES_WIDGET_STATE_DISABLED, SmartiesWidget.SMARTIES_WIDGET_STATE_HIDDEN

sendNotification

public void sendNotification(int soundType,
                             int soundDuration,
                             int vibration,
                             String str,
                             SmartiesDevice dev)

Send a notification to the device dev or to all the devices if dev is null. The notification will play a sound of type soundType (see the SMARTIES_SOUND_* variables) during soundDuration ms, will vibrate during vibration ms, and if str is not null or empty the device(s) will pop up a simple "OK" dialog. A press on the OK button of the dialog will stop the sound and vibration notification. Using SMARTIES_SOUND_NONE or a soundDuration of 0 and a vibration of 0 will also stop a running notification.

Parameters:

soundType - sound type see the SMARTIES_SOUND_*

soundDuration - sound duration in ms (0 to cancel a sound notification)

vibration - vibration duration in ms (0 to cancel a vibration notification)

str - text to be displayed in the notification dialog (null or "" for no dialog)

dev - device

sendNotification

public void sendNotification(int soundType,
                             int soundDuration,
                             int vibration,
                             String str,
                             String ip)

Send a notification to the device with IP ip or to all the devices if ip is null. The notification will play a sound of type soundType (see the SMARTIES_SOUND_* variables) during soundDuration ms, will vibrate during vibration ms, and if str is not null or empty the device(s) will pop up a simple "OK" dialog. A press on the OK button of the dialog will stop the sound and vibration notification. Using SMARTIES_SOUND_NONE or a soundDuration of 0 and a vibration of 0 will also stop a running notification.

Parameters:

soundType - sound type see the SMARTIES_SOUND_*

soundDuration - sound duration in ms (0 to cancel a sound notification)

vibration - vibration duration in ms (0 to cancel a vibration notification)

str - text to be displayed in the notification dialog (null or "" for no dialog)

ip - IP address or null

sendNotification

public void sendNotification(int soundType,
                             int soundDuration,
                             int vibration,
                             String str)

Send a notification to all the devices. The notification will play a sound of type soundType (see the SMARTIES_SOUND_* variables) during soundDuration ms, will vibrate during vibration ms, and if str is not null or empty the device(s) will pop up a simple "OK" dialog. A press on the OK button of the dialog will stop the sound and vibration notification. Using SMARTIES_SOUND_NONE or a soundDuration of 0 and a vibration of 0 will also stop a running notification.

Parameters:

soundType - sound type see the SMARTIES_SOUND_*

soundDuration - sound duration in ms (0 to cancel a sound notification)

vibration - vibration duration in ms (0 to cancel a vibration notification)

str - text to be displayed in the notification dialog (null or "" for no dialog)

initWidgets

public void initWidgets(int wgridw,
                        int wgridh)

Define the size of the grid with which the geometry of the widgets are defined.

Note that a mobile client can/might take adavantage of this to adjust the size of the widget area. The default values are 1 and 1.

Parameters:

wgridw - width of the grid

wgridh - height of the grid

See Also:

addWidget(int type, String label, float x, float y, float w, float h)

addWidget

public SmartiesWidget addWidget(int type,
                                String label,
                                float x,
                                float y,
                                float w,
                                float h)

Add a widget of a given type, given size and at a given position in the widget area of the mobile clients.

See SmartiesWidget for the list of the possible widget types. Depending on the widget type, you have to directly use the returned SmartiesWidget to finish its initialisation (e.g., list of items, the attached callback, etc.).

The position and the size (that could be floats) are relative to the grid [1, wgridw+1] x [1, wgridh+1] (by default [1, 2] x [1, 2]) that is defined using the initWidgets(int, int) method -- (1,1) is top-left.

This function is not dynamic and should be call before Run(), if it is call after only the newly connected devices will display the added widget.

Parameters:

type - the widget type, see SmartiesWidget

label - the label of the widget

x - x position in the grid

y - y position in the grid

w - width of the widget in the grid

h - height of the widget in the grid

Returns:

the created SmartiesWidget

See Also:

SmartiesWidget

getWidget

public SmartiesWidget getWidget(int wid)

Return the SmartiesWidget with the given identifier.

Parameters:

wid - widget identifier

Returns:

SmartiesWidget

See Also:

addWidget(int type, String label, float x, float y, float w, float h)

setPureTouchpad

public void setPureTouchpad(boolean v)

Set to true to only have the touchpad area in the clients. For now should be called before Run

Parameters:

v - true for a pure touchpad (default to false)

createOnePuckByDevice

public void createOnePuckByDevice(boolean v)

Set to true so that the server create automatically a new puck for each new connected client.

Parameters:

v - see above

setInterfaceButtons

public void setInterfaceButtons(boolean pb,
                                boolean sb,
                                boolean di,
                                boolean si)

Define the standard interface buttons and icons that appear in the clients interface. For now should be called before Run and only work with SmartiesV2 client.

Parameters:

pb - the create puck button. Set to false to remove it (default is true).

sb - the share button. Set to false to remove it (default is true).

di - the delete icon. Set to false to remove it (default is true).

si - the store icon. Set to false to remove it (default is true).

setPureWidgetArea

public void setPureWidgetArea(boolean v)

Set to true to only have the widget area in the clients (no touchpad!). For now should be called before Run and only work with SmartiesV2 client.

Parameters:

v - see above

setDeviceOrientation

public void setDeviceOrientation(int v)

Set the orientation of the clients, could be Smarties.SMARTIES_DEVICE_ORIENTATION_LANDSCAPE or Smarties.SMARTIES_DEVICE_ORIENTATION_PORTRAIT. This override the configuration set by user with the menu of the clients. For now should be called before Run and only work with SmartiesV2 client.

Parameters:

v - see above

setSharingPolicyMedium

public void setSharingPolicyMedium()

Set the Sharing policy to "medium"

setSharingPolicyStrict

public void setSharingPolicyStrict()

Set the Sharing policy to "strict"

setSharingPolicyPermissive

public void setSharingPolicyPermissive()

Set the Sharing policy to "medium"

setSharingPolicyCustom

public void setSharingPolicyCustom()

Set the Sharing policy to "custom"

Let the application developer to manage the lock/unlock status of the pucks by itself.

setSmartiesTouchEventsConf

public void setSmartiesTouchEventsConf(boolean v,
                                       SmartiesDevice dev)

Disable/Enable the multi-touch "high-level" Smarties events for the device dev or for all the devices if dev is null. By default these events are enabled.

Parameters:

v - true enable, false disable

dev - the device or null for all the device

setSmartiesTouchEventsConf

public void setSmartiesTouchEventsConf(boolean v)

Disable/Enable the multi-touch "high-level" Smarties events for all the devices (and all future devices that will connect to the server). By default these events are enabled.

Parameters:

v - true enable, false disable

setRawTouchEventsConf

public void setRawTouchEventsConf(boolean v,
                                  SmartiesDevice dev)

Disable/Enable the multi-touch raw events for the device dev or for all the devices if dev is null. By default these events are disabled.

Parameters:

v - true enable, false disable

dev - the device or null for all the device

setRawTouchEventsConf

public void setRawTouchEventsConf(boolean v)

Disable/Enable the multi-touch raw events for all the devices (and all future devices that will connect to the server). By default these events are disabled.

Parameters:

v - true enable, false disable

setHideLockedPucks

public void setHideLockedPucks(boolean v,
                               SmartiesDevice dev)

Instruct the device dev (or all connected device if dev is null) to hide or not the locked pucks. Default is to do not hide these pucks.

Parameters:

v - true hide, false do not hide

dev - the device or null for all the device

setHideLockedPucks

public void setHideLockedPucks(boolean v)

Instruct all connected device (and all future devices that will connect to the server) to hide or not the locked pucks. Default is to do not hide these pucks.

Parameters:

v - true hide, false do not hide

setAccelerationParameters

public void setAccelerationParameters(float maxCDgainFactor,
                                      float minCDgainMM,
                                      SmartiesDevice dev)

Set the acceleration parameters for indirect one finger touch for the device dev (or all connected device if dev is null).

100/maxCDgainFact is the portion in % of the width of the mobile that should be passed through to pass through the full wall width at a reasonably fast speed (0.37 pixels by ms). A priori the default is maxCDgainFactor = 1.0. Lesser/Bigger values provide a more gentle/aggressive ("slow/fast") acceleration function, and should lead to less/more clutching for long distance pointing.

minCDgainMM is the number of pixels moved in the wall for a movement of 1 mm in the mobile device at very low speed. A priori the default is minCDgainMM = 1.0. Smaller values allow to more easily access small targets. Bigger values make this less easy, but will make the acceleration function smoother.

A priori the defaults are maxCDgainFactor = 1.0 and minCDgainMM = 1.0. Give a value of -1 to to reset a default value.

setAccelerationParameters

public void setAccelerationParameters(float maxCDgainFactor,
                                      float minCDgainMM)

Set the acceleration parameters for indirect one finger touch for all connected device (and all future devices that will connect to the server).

100/maxCDgainFact is the portion in % of the width of the mobile that should be passed through to pass through the full wall width at a reasonably fast speed (0.37 pixels by ms). A priori the default is maxCDgainFactor = 1.0. Lesser/Bigger values provide a more gentle/aggressive ("slow/fast") acceleration function, and should lead to less/more clutching for long distance pointing.

minCDgainMM is the number of pixels moved in the wall for a movement of 1 mm in the mobile device at very low speed. A priori the default is minCDgainMM = 1.0. Smaller values allow to more easily access small targets. Bigger values make this less easy, but will make the acceleration function smoother.

A priori the defaults are maxCDgainFactor = 1.0 and minCDgainMM = 1.0. Give a value of -1 to to reset a default value.

Run

public void Run()

Start listenning and sending message to the mobile clients