synergynet3.behaviours.networkflick.messages

Class FlickMessage

java.lang.Object

synergynet3.web.shared.messages.PerformActionMessage

synergynet3.behaviours.networkflick.messages.FlickMessage

All Implemented Interfaces:

java.io.Serializable

public class FlickMessage
extends PerformActionMessage
implements java.io.Serializable

Structured message representing the item, its target and trajectory when transferred through a network flick.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class synergynet3.web.shared.messages.PerformActionMessage

PerformActionMessage.MESSAGESTATE

Constructor Summary

Constructors

Constructor and Description
FlickMessage() Empty Constructor used to initialise value in the network cluster.
FlickMessage(java.lang.String targetTableID, java.lang.String sourceTableID, GalleryItemDatabaseFormat galleryItem, float x, float y, float targetAngle, float targetScale, float xDir, float yDir) Create a structured network flick message for transmission through the cluster.

Method Summary

Methods

Modifier and Type	Method and Description
GalleryItemDatabaseFormat	getGalleryItem() Get the object representing the flicked item and its attached feedback.
float	getRotation() Get the rotation of the flicked item on arrival.
float	getScale() Get the scale of the flicked item on arrival.
java.lang.String	getSourceTableID() Get the source table's ID in the cluster.
java.lang.String	getTargetTableID() Get the target table's ID in the cluster.
float	getXDir() Get the X value of the flicked item's direction on arrival.
float	getXinMetres() Get the X value of the flicked item's arrival location.
float	getYDir() Get the Y value of the flicked item's direction on arrival.
float	getYinMetres() Get the Y value of the flicked item's arrival location.
void	setGalleryItem(GalleryItemDatabaseFormat galleryItem) Set the object representing the flicked item and its attached feedback.
void	setRotation(float rotation) Set the rotation of the flicked item on arrival.
void	setScale(float scale) Set the scale of the flicked item on arrival.
void	setSourceTableID(java.lang.String sourceTableID) Set the source table's ID in the cluster.
void	setTargetTableID(java.lang.String targetTableID) Set the target table's ID in the cluster.
void	setXDir(float xDir) Set the X value of the flicked item's direction on arrival.
void	setXinMetres(float x) Set the X value of the flicked item's arrival location.
void	setYDir(float yDir) Set the Y value of the flicked item's direction on arrival.
void	setYinMetres(float y) Set the Y value of the flicked item's arrival location.

Methods inherited from class synergynet3.web.shared.messages.PerformActionMessage

getMessageID, getMessageState, messageAlreadyReceived, regenerateID

Methods inherited from class java.lang.Object

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

Constructor Detail

FlickMessage

public FlickMessage()

Empty Constructor used to initialise value in the network cluster.

FlickMessage

public FlickMessage(java.lang.String targetTableID,
            java.lang.String sourceTableID,
            GalleryItemDatabaseFormat galleryItem,
            float x,
            float y,
            float targetAngle,
            float targetScale,
            float xDir,
            float yDir)

Create a structured network flick message for transmission through the cluster.

Parameters:

targetTableIdentity - Target table's identity in the cluster.

galleryItem - Object representing the flicked item and its attached feedback.

x - The X value of the flicked item's arrival location.

y - The Y value of the flicked item's arrival location.

targetAngle - Rotation of the flicked item on arrival.

targetScale - Scale of the flicked item on arrival.

xDir - The X value of the flicked item's direction on arrival.

yDir - The Y value of the flicked item's direction on arrival.

flickID - The unique ID of the flick message.

Method Detail

getGalleryItem

public GalleryItemDatabaseFormat getGalleryItem()

Get the object representing the flicked item and its attached feedback.

Returns:

Object representing the flicked item and its attached feedback.

getRotation

public float getRotation()

Get the rotation of the flicked item on arrival.

Returns:

The rotation of the flicked item on arrival.

getScale

public float getScale()

Get the scale of the flicked item on arrival.

Returns:

The scale of the flicked item on arrival.

getSourceTableID

public java.lang.String getSourceTableID()

Get the source table's ID in the cluster.

Returns:

String representing the source table's ID.

getTargetTableID

public java.lang.String getTargetTableID()

Get the target table's ID in the cluster.

Returns:

String representing the target table's ID.

getXDir

public float getXDir()

Get the X value of the flicked item's direction on arrival.

Returns:

The X value of the flicked item's direction on arrival.

getXinMetres

public float getXinMetres()

Get the X value of the flicked item's arrival location.

Returns:

The X value of the flicked item's arrival location.

getYDir

public float getYDir()

Get the Y value of the flicked item's direction on arrival.

Returns:

The Y value of the flicked item's direction on arrival.

getYinMetres

public float getYinMetres()

Get the Y value of the flicked item's arrival location.

Returns:

The Y value of the flicked item's arrival location.

setGalleryItem

public void setGalleryItem(GalleryItemDatabaseFormat galleryItem)

Set the object representing the flicked item and its attached feedback.

Parameters:

galleryItem - Object representing the flicked item and its attached feedback.

setRotation

public void setRotation(float rotation)

Set the rotation of the flicked item on arrival.

Parameters:

rotation - The rotation of the flicked item on arrival.

setScale

public void setScale(float scale)

Set the scale of the flicked item on arrival.

Parameters:

scale - The scale of the flicked item on arrival.

setSourceTableID

public void setSourceTableID(java.lang.String sourceTableID)

Set the source table's ID in the cluster.

Parameters:

sourceTableID - The source table's ID

setTargetTableID

public void setTargetTableID(java.lang.String targetTableID)

Set the target table's ID in the cluster.

Parameters:

targetTableID - The target table's ID

setXDir

public void setXDir(float xDir)

Set the X value of the flicked item's direction on arrival.

Parameters:

xDir - The X value of the flicked item's direction on arrival.

setXinMetres

public void setXinMetres(float x)

Set the X value of the flicked item's arrival location.

Parameters:

x - The X value of the flicked item's arrival location.

setYDir

public void setYDir(float yDir)

Set the Y value of the flicked item's direction on arrival.

Parameters:

yDir - The Y value of the flicked item's direction on arrival.

setYinMetres

public void setYinMetres(float y)

Set the Y value of the flicked item's arrival location.

Parameters:

y - The Y value of the flicked item's arrival location.