websocket.drawboard

Class DrawMessage

java.lang.Object

websocket.drawboard.DrawMessage

public final class DrawMessage
extends Object

A message that represents a drawing action. Note that we use primitive types instead of Point, Color etc. to reduce object allocation.

TODO: But a Color objects needs to be created anyway for drawing this onto a Graphics2D object, so this probably does not save much.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DrawMessage.ParseException

Constructor Summary

Constructors

Constructor and Description
DrawMessage(int type, byte colorR, byte colorG, byte colorB, byte colorA, double thickness, double x1, double x2, double y1, double y2, boolean lastInChain)

Method Summary

Methods

Modifier and Type	Method and Description
void	draw(Graphics2D g) Draws this DrawMessage onto the given Graphics2D.
byte	getColorA()
byte	getColorB()
byte	getColorG()
byte	getColorR()
double	getThickness()
int	getType() The type. 1: Brush 2: Line 3: Rectangle 4: Ellipse
double	getX1()
double	getX2()
double	getY1()
double	getY2()
boolean	isLastInChain() Specifies if this DrawMessage is the last one in a chain (e.g.
static DrawMessage	parseFromString(String str)
void	setColorA(byte colorA)
void	setColorB(byte colorB)
void	setColorG(byte colorG)
void	setColorR(byte colorR)
void	setLastInChain(boolean lastInChain)
void	setThickness(double thickness)
void	setType(int type)
void	setX1(double x1)
void	setX2(double x2)
void	setY1(double y1)
void	setY2(double y2)
String	toString() Converts this message into a String representation that can be sent over WebSocket. Since a DrawMessage consists only of numbers, we concatenate those numbers with a ",".

Methods inherited from class java.lang.Object

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

Constructor Detail

DrawMessage

public DrawMessage(int type,
           byte colorR,
           byte colorG,
           byte colorB,
           byte colorA,
           double thickness,
           double x1,
           double x2,
           double y1,
           double y2,
           boolean lastInChain)

Method Detail

getType

public int getType()

The type.
1: Brush
2: Line
3: Rectangle
4: Ellipse

setType

public void setType(int type)

getThickness

public double getThickness()

setThickness

public void setThickness(double thickness)

getColorR

public byte getColorR()

setColorR

public void setColorR(byte colorR)

getColorG

public byte getColorG()

setColorG

public void setColorG(byte colorG)

getColorB

public byte getColorB()

setColorB

public void setColorB(byte colorB)

getColorA

public byte getColorA()

setColorA

public void setColorA(byte colorA)

getX1

public double getX1()

setX1

public void setX1(double x1)

getX2

public double getX2()

setX2

public void setX2(double x2)

getY1

public double getY1()

setY1

public void setY1(double y1)

getY2

public double getY2()

setY2

public void setY2(double y2)

isLastInChain

public boolean isLastInChain()

Specifies if this DrawMessage is the last one in a chain (e.g. a chain of brush paths).
Currently it is unused.

setLastInChain

public void setLastInChain(boolean lastInChain)

draw

public void draw(Graphics2D g)

Draws this DrawMessage onto the given Graphics2D.

Parameters:

g -

toString

public String toString()

Converts this message into a String representation that can be sent over WebSocket.
Since a DrawMessage consists only of numbers, we concatenate those numbers with a ",".

Overrides:

toString in class Object

parseFromString

public static DrawMessage parseFromString(String str)
                                   throws DrawMessage.ParseException

Throws:

DrawMessage.ParseException