com.TeamHEC.LocomotionCommotion.Map

Class Connection

java.lang.Object

com.TeamHEC.LocomotionCommotion.Map.Connection

public class Connection
extends java.lang.Object

Author:

Matthew Taylor , Sam Watkins

Field Summary

Fields

Modifier and Type	Field and Description
boolean	selected

Constructor Summary

Constructors

Constructor and Description
Connection(MapObj startMapObj, MapObj endMapObj)
Connection(MapObj startMapObj, MapObj endMapObj, Line colour) A connection between two adjacent MapObjs in the Map.

Method Summary

Methods

Modifier and Type	Method and Description
Line	getColour()
MapObj	getDestination()
float	getLength()
com.badlogic.gdx.utils.Array<com.badlogic.gdx.scenes.scene2d.Actor>	getRouteBlips()
MapObj	getStartMapObj()
com.badlogic.gdx.math.Vector2	getVector()
boolean	isLocked()
boolean	isReverseOf(Connection connection)
void	setColour(Line lineColour) sets the colour of the connection to a new value
void	toggleLocked()
java.lang.String	toJSON() Generates a JSON String
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

selected

public boolean selected

Constructor Detail

Connection

public Connection(MapObj startMapObj,
          MapObj endMapObj,
          Line colour)

A connection between two adjacent MapObjs in the Map. Defines the distance between them (length0 and direction (vector)

Parameters:

startMapObj - Where the connection begins

endMapObj - Where the connection ends

colour - The colour of the connection

Connection

public Connection(MapObj startMapObj,
          MapObj endMapObj)

Method Detail

getLength

public float getLength()

Returns:

the length between the start and end of a connection

getVector

public com.badlogic.gdx.math.Vector2 getVector()

Returns:

A normalised vector of the direction needed to reach the end of the connection

getStartMapObj

public MapObj getStartMapObj()

Returns:

the start of a connection

getDestination

public MapObj getDestination()

Returns:

the destination of a connection

getRouteBlips

public com.badlogic.gdx.utils.Array<com.badlogic.gdx.scenes.scene2d.Actor> getRouteBlips()

Returns:

An Array of routeblips used when creating a route

getColour

public Line getColour()

Returns:

The colour of the connection

isLocked

public boolean isLocked()

Returns:

Whether or not the connection is currently inaccessible

toggleLocked

public void toggleLocked()

isReverseOf

public boolean isReverseOf(Connection connection)

Parameters:

connection - to be compared

Returns:

true if two connections are the same but reversed

setColour

public void setColour(Line lineColour)

sets the colour of the connection to a new value

Parameters:

lineColour - to be set

toJSON

public java.lang.String toJSON()

Generates a JSON String

Returns:

JSON string of this object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object