edu.wpi.rail.jrosbridge.messages.std

Class ColorRGBA

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.std.ColorRGBA

public class ColorRGBA
extends Message

The std_msgs/ColorRGBA message.

Version:

April 1, 2014

Author:

Russell Toris -- rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_A The name of the a field for the message.
static String	FIELD_B The name of the b field for the message.
static String	FIELD_G The name of the g field for the message.
static String	FIELD_R The name of the r field for the message.
static String	TYPE The message type.

Fields inherited from class edu.wpi.rail.jrosbridge.messages.Message

EMPTY_MESSAGE

Fields inherited from class edu.wpi.rail.jrosbridge.JsonWrapper

EMPTY_JSON

Constructor Summary

Constructors

Constructor and Description
ColorRGBA() Create a new ColorRGBA with all 0s for colors and an alpha value of 1.
ColorRGBA(float r, float g, float b) Create a new ColorRGBA with the given color values (alpha will be 1).
ColorRGBA(float r, float g, float b, float a) Create a new ColorRGBA with the given color values.

Method Summary

Methods

Modifier and Type	Method and Description
ColorRGBA	clone() Create a clone of this ColorRGBA.
static ColorRGBA	fromColor(Color c) Create a new ColorRGBA based on the color information in the Java Color object.
static ColorRGBA	fromJsonObject(javax.json.JsonObject jsonObject) Create a new ColorRGBA based on the given JSON object.
static ColorRGBA	fromJsonString(String jsonString) Create a new ColorRGBA based on the given JSON string.
static ColorRGBA	fromMessage(Message m) Create a new ColorRGBA based on the given Message.
float	getA() Get the a value of this color.
float	getB() Get the b value of this color.
float	getG() Get the g value of this color.
float	getR() Get the r value of this color.
Color	toColor() Convert this color message to a new Java Color object.

Methods inherited from class edu.wpi.rail.jrosbridge.messages.Message

getMessageType, setMessageType

Methods inherited from class edu.wpi.rail.jrosbridge.JsonWrapper

equals, hashCode, toJsonObject, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FIELD_R

public static final String FIELD_R

The name of the r field for the message.

See Also:

Constant Field Values

FIELD_G

public static final String FIELD_G

The name of the g field for the message.

See Also:

Constant Field Values

FIELD_B

public static final String FIELD_B

The name of the b field for the message.

See Also:

Constant Field Values

FIELD_A

public static final String FIELD_A

The name of the a field for the message.

See Also:

Constant Field Values

TYPE

public static final String TYPE

The message type.

See Also:

Constant Field Values

Constructor Detail

ColorRGBA

public ColorRGBA()

Create a new ColorRGBA with all 0s for colors and an alpha value of 1.

ColorRGBA

public ColorRGBA(float r,
         float g,
         float b)

Create a new ColorRGBA with the given color values (alpha will be 1).

Parameters:

r - The r value of the color.

g - The g value of the color.

b - The b value of the color.

ColorRGBA

public ColorRGBA(float r,
         float g,
         float b,
         float a)

Create a new ColorRGBA with the given color values.

Parameters:

r - The r value of the color.

g - The g value of the color.

b - The b value of the color.

a - The a value of the color.

Method Detail

getR

public float getR()

Get the r value of this color.

Returns:

The r value of this color.

getG

public float getG()

Get the g value of this color.

Returns:

The g value of this color.

getB

public float getB()

Get the b value of this color.

Returns:

The b value of this color.

getA

public float getA()

Get the a value of this color.

Returns:

The a value of this color.

toColor

public Color toColor()

Convert this color message to a new Java Color object.

Returns:

A new Java color object based on this message.

clone

public ColorRGBA clone()

Create a clone of this ColorRGBA.

Overrides:

clone in class Message

fromColor

public static ColorRGBA fromColor(Color c)

Create a new ColorRGBA based on the color information in the Java Color object.

Parameters:

c - The Java Color object containing the color information.

Returns:

A new ColorRGBA message based on the given color information.

fromJsonString

public static ColorRGBA fromJsonString(String jsonString)

Create a new ColorRGBA based on the given JSON string. Any missing values will be set to their defaults.

Parameters:

jsonString - The JSON string to parse.

Returns:

A ColorRGBA message based on the given JSON string.

fromMessage

public static ColorRGBA fromMessage(Message m)

Create a new ColorRGBA based on the given Message. Any missing values will be set to their defaults.

Parameters:

m - The Message to parse.

Returns:

A ColorRGBA message based on the given Message.

fromJsonObject

public static ColorRGBA fromJsonObject(javax.json.JsonObject jsonObject)

Create a new ColorRGBA based on the given JSON object. Any missing values will be set to their defaults.

Parameters:

jsonObject - The JSON object to parse.

Returns:

A ColorRGBA message based on the given JSON object.