synergynet3.projector.network

Class ProjectorTransferUtilities

java.lang.Object

synergynet3.projector.network.ProjectorTransferUtilities

public class ProjectorTransferUtilities
extends java.lang.Object

The Class ProjectorTransferUtilities.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToTransferableContents(IItem item, float width, float height, java.lang.String contentID) Adds the to transferable contents.
void	clearContents() Clear contents.
static ProjectorTransferUtilities	get() Retrieve, and initialise if needed, a static instance of this class.
java.util.HashMap<IItem,com.jme3.math.Vector2f>	getContentDimensions() Gets the content dimensions.
java.lang.String	getContentKey(IItem item) Gets the content key.
java.util.HashMap<java.lang.String,IItem>	getContents() Gets the contents.
java.util.HashMap<IItem,GalleryItemDatabaseFormat>	getContentTransferrableTypes() Gets the content transferrable types.
float	getDecelerationOnArrival() Gets the deceleration on arrival.
void	onContentArrival(java.util.ArrayList<ContentTransferedMessage> messages) Retrieves details from the supplied message to recreate the transfered item
java.util.ArrayList<ContentTransferedMessage>	prepareToTransferAllContents(java.lang.String[] devicesToSendTo) Prepare to transfer all contents.
void	removeFromTransferableContents(IItem item) Removes the from transferable contents.
void	setDecelerationOnArrival(float decelerationOnArrival) Sets the deceleration on arrival.
void	transferIndividualItem(IItem item, java.lang.String[] projectorsToSendTo, float width, float height) Transfer individual item.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static ProjectorTransferUtilities get()

Retrieve, and initialise if needed, a static instance of this class.

Returns:

An instance of this class to be accessed statically.

addToTransferableContents

public void addToTransferableContents(IItem item,
                             float width,
                             float height,
                             java.lang.String contentID)

Adds the to transferable contents.

Parameters:

item - the item

width - the width

height - the height

contentID - the content id

clearContents

public void clearContents()

Clear contents.

getContentDimensions

public java.util.HashMap<IItem,com.jme3.math.Vector2f> getContentDimensions()

Gets the content dimensions.

Returns:

the content dimensions

getContentKey

public java.lang.String getContentKey(IItem item)

Gets the content key.

Parameters:

item - the item

Returns:

the content key

getContents

public java.util.HashMap<java.lang.String,IItem> getContents()

Gets the contents.

Returns:

the contents

getContentTransferrableTypes

public java.util.HashMap<IItem,GalleryItemDatabaseFormat> getContentTransferrableTypes()

Gets the content transferrable types.

Returns:

the content transferrable types

getDecelerationOnArrival

public float getDecelerationOnArrival()

Gets the deceleration on arrival.

Returns:

the deceleration on arrival

onContentArrival

public void onContentArrival(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.

prepareToTransferAllContents

public java.util.ArrayList<ContentTransferedMessage> prepareToTransferAllContents(java.lang.String[] devicesToSendTo)

Prepare to transfer all contents.

Parameters:

devicesToSendTo - the devices to send to

Returns:

the array list

removeFromTransferableContents

public void removeFromTransferableContents(IItem item)

Removes the from transferable contents.

Parameters:

item - the item

setDecelerationOnArrival

public void setDecelerationOnArrival(float decelerationOnArrival)

Sets the deceleration on arrival.

Parameters:

decelerationOnArrival - the new deceleration on arrival

transferIndividualItem

public void transferIndividualItem(IItem item,
                          java.lang.String[] projectorsToSendTo,
                          float width,
                          float height)

Transfer individual item.

Parameters:

item - the item

projectorsToSendTo - the projectors to send to

width - the width

height - the height