com.mindlin.clientBridge.api

Class DrawCommand

java.lang.Object

com.mindlin.clientBridge.api.DrawCommand

All Implemented Interfaces:

JSONifiable

public class DrawCommand
extends Object
implements JSONifiable

A command for the GUI that will draw an element to the screen.
Also contains methods to convert to/from JSON
You shouldn't need to use any of the public vars, but they're there because why not?

Author:

mailmindlin

Field Summary

Fields

Modifier and Type	Field and Description
int	ACTION Integers for different commands. x1/y1 are usually (x,y) for the upper-left corner. x2/y2 are either the width/height or the lower-right corner cords. ACTION is one of the above final actions.
int	c Integers for different commands. x1/y1 are usually (x,y) for the upper-left corner. x2/y2 are either the width/height or the lower-right corner cords. ACTION is one of the above final actions.
static int	DRAW_BTN
static int	DRAW_DEF_BACKGROUND
static int	DRAW_RECT
static int	DRAW_TEXT
static int	DRAW_TEXTURED_RECT
int	id Integers for different commands. x1/y1 are usually (x,y) for the upper-left corner. x2/y2 are either the width/height or the lower-right corner cords. ACTION is one of the above final actions.
String	s
int	x1 Integers for different commands. x1/y1 are usually (x,y) for the upper-left corner. x2/y2 are either the width/height or the lower-right corner cords. ACTION is one of the above final actions.
int	x2 Integers for different commands. x1/y1 are usually (x,y) for the upper-left corner. x2/y2 are either the width/height or the lower-right corner cords. ACTION is one of the above final actions.
int	y1 Integers for different commands. x1/y1 are usually (x,y) for the upper-left corner. x2/y2 are either the width/height or the lower-right corner cords. ACTION is one of the above final actions.
int	y2 Integers for different commands. x1/y1 are usually (x,y) for the upper-left corner. x2/y2 are either the width/height or the lower-right corner cords. ACTION is one of the above final actions.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	build(JSONObject commands) Builds the object.
boolean	build(String s) Build itself such that for Object o that implements JSONifiable, the following conditions will be true: o.build(o.serialize(false))==o o.build(o.serialize(true))==o
static DrawCommand	compileButton(int x, int y, int w, int id, String s) Generates a DrawCommand for drawing a button. Use in the gui.initCommands only, or you get wierd results.
static DrawCommand	compileRect(int x1, int y1, int x2, int y2, int c) Generates a DrawCommand for drawing a rectangle.
static DrawCommand	compileText(String text, int x, int y, int c) Generates a DrawCommand for drawing a string.
static DrawCommand	compileTexturedRect(int x, int y, int w, int h, int c) Generates a DrawCommand for drawing a textured rectangle.
int	getAction() Gets the action of the drawcommand
static ArrayList<DrawCommand>	parseJSON(JSONArray commands) Parses a JSONArray to generate an ArrayList of DrawCommands.
static JSONArray	serialize(ArrayList<DrawCommand> arr, boolean compress)
JSONObject	serialize(boolean compress) Converts DrawCommand to JSONObject
JSONObject	toJSON() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

DRAW_TEXT

public static final int DRAW_TEXT

See Also:

Constant Field Values

DRAW_RECT

public static final int DRAW_RECT

See Also:

Constant Field Values

DRAW_TEXTURED_RECT

public static final int DRAW_TEXTURED_RECT

See Also:

Constant Field Values

DRAW_DEF_BACKGROUND

public static final int DRAW_DEF_BACKGROUND

See Also:

Constant Field Values

DRAW_BTN

public static final int DRAW_BTN

See Also:

Constant Field Values

x1

public int x1

Integers for different commands.
x1/y1 are usually (x,y) for the upper-left corner.
x2/y2 are either the width/height or the lower-right corner cords.
ACTION is one of the above final actions.

x2

public int x2

Integers for different commands.
x1/y1 are usually (x,y) for the upper-left corner.
x2/y2 are either the width/height or the lower-right corner cords.
ACTION is one of the above final actions.

y1

public int y1

Integers for different commands.
x1/y1 are usually (x,y) for the upper-left corner.
x2/y2 are either the width/height or the lower-right corner cords.
ACTION is one of the above final actions.

y2

public int y2

Integers for different commands.
x1/y1 are usually (x,y) for the upper-left corner.
x2/y2 are either the width/height or the lower-right corner cords.
ACTION is one of the above final actions.

ACTION

public int ACTION

Integers for different commands.
x1/y1 are usually (x,y) for the upper-left corner.
x2/y2 are either the width/height or the lower-right corner cords.
ACTION is one of the above final actions.

c

public int c

Integers for different commands.
x1/y1 are usually (x,y) for the upper-left corner.
x2/y2 are either the width/height or the lower-right corner cords.
ACTION is one of the above final actions.

id

public int id

Integers for different commands.
x1/y1 are usually (x,y) for the upper-left corner.
x2/y2 are either the width/height or the lower-right corner cords.
ACTION is one of the above final actions.

s

public String s

Method Detail

compileText

public static DrawCommand compileText(String text,
                      int x,
                      int y,
                      int c)

Generates a DrawCommand for drawing a string.

Parameters:

text -

x -

y -

c -

Returns:

Compiled DrawCommand

compileRect

public static DrawCommand compileRect(int x1,
                      int y1,
                      int x2,
                      int y2,
                      int c)

Generates a DrawCommand for drawing a rectangle.
For some reason, it doesn't work.

Parameters:

x1 -

y1 -

x2 -

y2 -

c -

Returns:

Compiled DrawCommand

compileTexturedRect

public static DrawCommand compileTexturedRect(int x,
                              int y,
                              int w,
                              int h,
                              int c)

Generates a DrawCommand for drawing a textured rectangle.

Parameters:

x -

y -

w -

h -

c -

Returns:

Compiled DrawCommand

compileButton

public static DrawCommand compileButton(int x,
                        int y,
                        int w,
                        int id,
                        String s)

Generates a DrawCommand for drawing a button.
Use in the gui.initCommands only, or you get wierd results.

Parameters:

x -

y -

w -

id -

s -

Returns:

Compiled DrawCommand

getAction

public int getAction()

Gets the action of the drawcommand

Returns:

ACTION

parseJSON

public static ArrayList<DrawCommand> parseJSON(JSONArray commands)

Parses a JSONArray to generate an ArrayList of DrawCommands.

Parameters:

commands -

Returns:

ArrayList of commands

build

public boolean build(JSONObject commands)

Builds the object.

Specified by:

build in interface JSONifiable

Parameters:

commands - JSONObject representing a serialized version of this object

Returns:

success in building (no errors)

build

public boolean build(String s)

Description copied from interface: JSONifiable

Build itself such that for Object o that implements JSONifiable, the following conditions will be true:
o.build(o.serialize(false))==o
o.build(o.serialize(true))==o

Specified by:

build in interface JSONifiable

Parameters:

s - (JSON string from serialize())

Returns:

success (of building)

serialize

public JSONObject serialize(boolean compress)

Converts DrawCommand to JSONObject

Specified by:

serialize in interface JSONifiable

Returns:

JSONObject representation

serialize

public static JSONArray serialize(ArrayList<DrawCommand> arr,
                  boolean compress)

toJSON

@Deprecated
public JSONObject toJSON()

Deprecated.

Converts DrawCommand to JSONObject.
Replaced by serialize(boolean)

Returns:

JSONObject representation

See Also:

serialize(boolean)