synergynet3

Class SynergyNetApp

java.lang.Object

synergynet3.SynergyNetApp

All Implemented Interfaces:

IMultiplicityApp, IMediaSearcher, IScreenShotter

Direct Known Subclasses:

EarlyYearsApp, FlickGameApp, FlickStudyApp, MuseumApp, MysteriesApp, NumberNet, TestVideoApp, TrackedApp

public abstract class SynergyNetApp
extends java.lang.Object
implements IMultiplicityApp, IScreenShotter, IMediaSearcher

Class to be extended by all applications which wish to utilise SynergyNet 3's database, network flick, screenshot, audio playback, media detection and student menu systems.

Field Summary

Fields

Modifier and Type	Field and Description
static SynergyNetPosition	localDevicePosition The position of the current device's interface in its physical environment.
static boolean	MEDIA_SEARCH If set to false no threads for searching identified drives will be started.
static boolean	networkFlickEnabled Indicates whether items on the display can be transmitted to other tables through the network flick feature.
static boolean	NETWORKING If set to false no calls to SynergyNetCluster will be made, allowing for apps to be used without OpenFire running.
static boolean	ONE_MEDIA_AT_A_TIME If set to true only one piece of media will be able play at a time.
static AppSystemSync	sync Manages network cluster listeners.

Constructor Summary

Constructors

Constructor and Description
SynergyNetApp()

Method Summary

Methods

Modifier and Type	Method and Description
void	bringAllStudentsToTop() Brings all student menus and menu icons to the top of the environment.
void	createScreenShotItem(com.jme3.math.Vector2f loc, float rot) Initiates the screenshot renderer to capture an image of the current environment and call utiliseScreenshot with the image file it creates.
void	disableNetworkFlick() Disables network flick listeners from initiating a transfer.
void	enableNetworkFlick() Initiates the announcement to the network that it is now accepting items from network flicks.
StudentMenu	generateStudentMenu(StudentRepresentation student) Creates a student menu for a given student representation.
java.util.ArrayList<java.lang.Class<? extends FeedbackItem>>	getFeedbackTypes() Returns an array of the feedback types current used in an application extending SynergyNetApp.
java.lang.String	getFriendlyAppName() Sets the name of an application.
static java.lang.String	getTableIdentity() Gets the string representing the device's identity in the network cluster.
StudentMenu	login(java.lang.String studentID) Will log in a student with the supplied ID.
void	loginAll(java.util.ArrayList<java.lang.String[]> IDs) Adds a list of student IDs to the start up roster.
void	logout(java.lang.String studentID) Logs out a specific student from the environment and removes their menu.
void	logoutAll() Logs out all students in the environment and removes their menus.
void	logoutAllOfClass(java.lang.String className) Logs out all students belonging to a specific class.
void	modifyMenus(StudentMenu menu) Can be overridden by applications extending SynergyNetApp to modify the options made available by student menus.
void	onContentFromProjectorArrival(java.util.ArrayList<ContentTransferedMessage> messages) Retrieves details from the supplied message to recreate the transfered item
void	onDestroy() Actions to be performed when the SynergyNetApp window is closed.
void	onFind(java.io.File[] files) Called by the media searching threads when images or audio recordings are found on removable devices or the device's corresponding cache folder.
void	onFlickArrival(FlickMessage message) Retrieves details from the supplied message to recreate the flicked item and to ensure it appears onscreen in the manner expected, i.e.
void	reloadRemovableMediaCache() Forces media searching threads to recreate items for any previously discovered image or audio files found on any removable media drives.
void	reloadServerCache() Forces media searching threads to recreate items for any previously discovered image or audio files found on the current device's corresponding cache folder.
void	removeAdditionalMedia() Removes any items which are not part of the current application from the environment.
void	removeVirtualTable(SynergyNetPosition message) Removes a device which should no longer be accessible.
void	sendContentsToProjectors(java.lang.String[] projectorsToSendTo) Send current contents of the app to a the list of projectors provided.
void	sendScreenShotToProjectors(java.lang.String[] projectorsToSendTo) Send screenshot of current contents of the app to a the list of projectors provided.
void	shouldStart(MultiTouchInputComponent input, IQueueOwner iqo) Executed at the start of each application which extended the SynergyNetApp.
void	shouldStop() Called when a SynergyNetApp extending application is closed through traditional means.
void	toggleFreeze() Adds or removes the blue item to represent a frozen workspace.
void	updateVirtualTable(SynergyNetPosition message) Retrieves details from the supplied message to create a virtual representation of the device of screen in relation to its real life position.
void	utiliseScreenshot(java.io.File screenShotFile, com.jme3.math.Vector2f loc, float rot) Creates a manipulable screenshot item using an image file and adds it to the environment.

Methods inherited from class java.lang.Object

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

Field Detail

localDevicePosition

public static SynergyNetPosition localDevicePosition

The position of the current device's interface in its physical environment.

MEDIA_SEARCH

public static boolean MEDIA_SEARCH

If set to false no threads for searching identified drives will be started.

networkFlickEnabled

public static boolean networkFlickEnabled

Indicates whether items on the display can be transmitted to other tables through the network flick feature.

NETWORKING

public static boolean NETWORKING

If set to false no calls to SynergyNetCluster will be made, allowing for apps to be used without OpenFire running.

ONE_MEDIA_AT_A_TIME

public static boolean ONE_MEDIA_AT_A_TIME

If set to true only one piece of media will be able play at a time.

sync

public static AppSystemSync sync

Manages network cluster listeners.

Constructor Detail

SynergyNetApp

public SynergyNetApp()

Method Detail

getTableIdentity

public static java.lang.String getTableIdentity()

Gets the string representing the device's identity in the network cluster.

Returns:

String representing the identity of the device.

bringAllStudentsToTop

public void bringAllStudentsToTop()

Brings all student menus and menu icons to the top of the environment.

createScreenShotItem

public void createScreenShotItem(com.jme3.math.Vector2f loc,
                        float rot)

Initiates the screenshot renderer to capture an image of the current environment and call utiliseScreenshot with the image file it creates.

Parameters:

loc - Location at which the screenshot created should appear.

rot - Rotation at which the screenshot created should appear.

disableNetworkFlick

public void disableNetworkFlick()

Disables network flick listeners from initiating a transfer.

enableNetworkFlick

public void enableNetworkFlick()

Initiates the announcement to the network that it is now accepting items from network flicks. Enables network flick listeners from initiating a transfer.

generateStudentMenu

public StudentMenu generateStudentMenu(StudentRepresentation student)

Creates a student menu for a given student representation.

Parameters:

student - The student representation to create a student menu for.

Returns:

The student menu item created for the corresponding student.

getFeedbackTypes

public java.util.ArrayList<java.lang.Class<? extends FeedbackItem>> getFeedbackTypes()

Returns an array of the feedback types current used in an application extending SynergyNetApp.

Returns:

ArrayList of the feedback type classes.

getFriendlyAppName

public java.lang.String getFriendlyAppName()

Sets the name of an application.

Specified by:

getFriendlyAppName in interface IMultiplicityApp

Returns:

String representing the application's full name.

login

public StudentMenu login(java.lang.String studentID)

Will log in a student with the supplied ID. When a student is logged in their representation is retrieved from the database service using their ID and a menu for the student is created and positioned randomly in the environment. When a student logs in their personal gallery is also created and populated using details from their database entry.

Parameters:

studentID - ID of the student to be logged in.

Returns:

The student menu item created for the corresponding student.

loginAll

public void loginAll(java.util.ArrayList<java.lang.String[]> IDs)

Adds a list of student IDs to the start up roster. When a SynergyNetApp extending application starts up it will login all students current on the roster.

Parameters:

IDs - Array of the student IDs.

logout

public void logout(java.lang.String studentID)

Logs out a specific student from the environment and removes their menu. When logging out their details, such as items and feedback stored in their personal gallery, are updated in the database.

Parameters:

studentID - ID of the student to be logged out.

logoutAll

public void logoutAll()

Logs out all students in the environment and removes their menus.

logoutAllOfClass

public void logoutAllOfClass(java.lang.String className)

Logs out all students belonging to a specific class.

Parameters:

className - Name of the class for which all students belonging to it should be logged out.

modifyMenus

public void modifyMenus(StudentMenu menu)
                 throws ContentTypeNotBoundException

Can be overridden by applications extending SynergyNetApp to modify the options made available by student menus.

Throws:

ContentTypeNotBoundException

onContentFromProjectorArrival

public void onContentFromProjectorArrival(java.util.ArrayList<ContentTransferedMessage> messages)

Retrieves details from the supplied message to recreate the transfered item

Parameters:

message - Structured message detailing the details of an item's arrival.

onDestroy

public void onDestroy()

Actions to be performed when the SynergyNetApp window is closed.

Specified by:

onDestroy in interface IMultiplicityApp

onFind

public void onFind(java.io.File[] files)

Called by the media searching threads when images or audio recordings are found on removable devices or the device's corresponding cache folder. Items for each discovered files are created. If the items are not already present they are passed on.

Specified by:

onFind in interface IMediaSearcher

Parameters:

files - The files discovered to be used in the app if not already present.

onFlickArrival

public void onFlickArrival(FlickMessage message)

Retrieves details from the supplied message to recreate the flicked item and to ensure it appears onscreen in the manner expected, i.e. aligning with its flick vector from its source device.

Parameters:

message - Structured message detailing the details of an item's arrival.

reloadRemovableMediaCache

public void reloadRemovableMediaCache()

Forces media searching threads to recreate items for any previously discovered image or audio files found on any removable media drives.

reloadServerCache

public void reloadServerCache()

Forces media searching threads to recreate items for any previously discovered image or audio files found on the current device's corresponding cache folder.

removeAdditionalMedia

public void removeAdditionalMedia()

Removes any items which are not part of the current application from the environment.

removeVirtualTable

public void removeVirtualTable(SynergyNetPosition message)

Removes a device which should no longer be accessible.

Parameters:

message - Structured message detailing the device representation to be removed.

sendContentsToProjectors

public void sendContentsToProjectors(java.lang.String[] projectorsToSendTo)

Send current contents of the app to a the list of projectors provided. * @param projectorsToSendTo List of projectors identities to send contents to.

sendScreenShotToProjectors

public void sendScreenShotToProjectors(java.lang.String[] projectorsToSendTo)

Send screenshot of current contents of the app to a the list of projectors provided. * @param projectorsToSendTo List of projectors identities to send screenshots to.

shouldStart

public void shouldStart(MultiTouchInputComponent input,
               IQueueOwner iqo)

Executed at the start of each application which extended the SynergyNetApp. This method first tidies any unused files from the synergynet cache. The method then sets up the default feedback types to be used in SynergyNetApps and records the display dimensions. The screen capture function is then initialised and login menus are created for any waiting students. Following this the controller which listens for appropriate changes in the HazelCast Cluster is initialised. The application's main environment construction is then called and finally the media searching threads are started.

Specified by:

shouldStart in interface IMultiplicityApp

Parameters:

input - The multi-touch input providing component.

iqo - Queue owner.

shouldStop

public void shouldStop()

Called when a SynergyNetApp extending application is closed through traditional means. All students present art logged out, the media searches are stopped and the table announces its removal to the network. Any unused files are then removed from the cache.

Specified by:

shouldStop in interface IMultiplicityApp

toggleFreeze

public void toggleFreeze()

Adds or removes the blue item to represent a frozen workspace.

updateVirtualTable

public void updateVirtualTable(SynergyNetPosition message)

Retrieves details from the supplied message to create a virtual representation of the device of screen in relation to its real life position. This virtual device can then be used to detect when a flicked item should be transferred.

Parameters:

message - Structured message detailing a device's position.

utiliseScreenshot

public void utiliseScreenshot(java.io.File screenShotFile,
                     com.jme3.math.Vector2f loc,
                     float rot)

Creates a manipulable screenshot item using an image file and adds it to the environment. The screenshot item is registered as feedback eligible and made capable of being network flicked when created.

Specified by:

utiliseScreenshot in interface IScreenShotter

Parameters:

screenShotFile - Image file to create the screenshot item from.

loc - Location at which the screenshot created should appear.

rot - Rotation at which the screenshot created should appear.