walker.blue.path.lib.floor

Class FloorConnector

java.lang.Object

walker.blue.path.lib.base.AbstractPathfinderNode

walker.blue.path.lib.node.GridNode

walker.blue.path.lib.floor.FloorConnector

All Implemented Interfaces:

java.lang.Comparable<AbstractPathfinderNode>

public class FloorConnector
extends GridNode

This class inherits from GridNode and holds extra information needed to connect different floors in a 3D grid together. This class represents either a staircase, elevator, or anything that connects two floors together in a building.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FloorConnector.Type Enum holding the possible different types of a floor connector.

Field Summary

Fields inherited from class walker.blue.path.lib.node.GridNode

traversable

Fields inherited from class walker.blue.path.lib.base.AbstractPathfinderNode

g, h, location, parent

Constructor Summary

Constructors

Constructor and Description
FloorConnector(int x, int y, int z, boolean traversable) Constructor taking in individual x, y, and z coordinates as well as a traversable boolean.
FloorConnector(int x, int y, int z, boolean traversable, FloorConnector.Type type) Constructor uniquely accepting a floor connector type.
FloorConnector(int x, int y, int z, boolean traversable, java.util.List<FloorConnector> connections) Constructor uniquely accepting the connections for the floor connector.
FloorConnector(int x, int y, int z, boolean traversable, java.util.List<FloorConnector> connections, FloorConnector.Type type) Constructor uniquely accepting both the type and connectiong for the floor connector.

Method Summary

Modifier and Type	Method and Description
boolean	addAllConnections(java.util.Collection<? extends FloorConnector> c) Adds a collection of FloorConnectors to the current connections list.
boolean	addConnection(FloorConnector connection) Adds a connection to the current connections list.
boolean	equals(java.lang.Object o) Uses the super class's equals method to determine equality.
java.util.List<FloorConnector>	getConnections() Access method to get the connections of the floor connector.
int	getIndex() Access method to get the index.
FloorConnector.Type	getType() Access method to get the type.
java.lang.String	getTypeString() Returns the type of the floor connector as a String.
int	hashCode()
void	setIndex(int index) Sets the index for the floor connector
void	setType(FloorConnector.Type type) Sets the type for the floor connector
java.lang.String	toString() Returns a formatted String holding the location of the node.

Methods inherited from class walker.blue.path.lib.node.GridNode

isTraversable

Methods inherited from class walker.blue.path.lib.base.AbstractPathfinderNode

compareTo, getG, getH, getLocation, getParent, setG, setH, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

FloorConnector

public FloorConnector(int x,
                      int y,
                      int z,
                      boolean traversable)

Constructor taking in individual x, y, and z coordinates as well as a traversable boolean. as the

Parameters:

x - the x coordinate of the node

y - the y coordinate of the node

z - the z coordinate of the node

traversable - the value determining whether the node an be traversed

FloorConnector

public FloorConnector(int x,
                      int y,
                      int z,
                      boolean traversable,
                      FloorConnector.Type type)

Constructor uniquely accepting a floor connector type.

Parameters:

x - the x coordinate of the node

y - the y coordinate of the node

z - the z coordinate of the node

traversable - the value determining whether the node an be traversed

type - the type of the floor connector

FloorConnector

public FloorConnector(int x,
                      int y,
                      int z,
                      boolean traversable,
                      java.util.List<FloorConnector> connections)

Constructor uniquely accepting the connections for the floor connector.

Parameters:

x - the x coordinate of the node

y - the y coordinate of the node

z - the z coordinate of the node

traversable - the value determining whether the node an be traversed

connections - the connections that are connected to this node

FloorConnector

public FloorConnector(int x,
                      int y,
                      int z,
                      boolean traversable,
                      java.util.List<FloorConnector> connections,
                      FloorConnector.Type type)

Constructor uniquely accepting both the type and connectiong for the floor connector.

Parameters:

x - the x coordinate of the node

y - the y coordinate of the node

z - the z coordinate of the node

traversable - the value determining whether the node an be traversed

connections - the connections that are connected to this node

type - the type of the floor connector

Method Detail

getIndex

public int getIndex()

Access method to get the index.

Returns:

index

setIndex

public void setIndex(int index)

Sets the index for the floor connector

Parameters:

index - value to set the index member

getType

public FloorConnector.Type getType()

Access method to get the type.

Returns:

type

setType

public void setType(FloorConnector.Type type)

Sets the type for the floor connector

Parameters:

type - value to set the type member

getTypeString

public java.lang.String getTypeString()

Returns the type of the floor connector as a String.

Returns:

floor connector type as a String

getConnections

public java.util.List<FloorConnector> getConnections()

Access method to get the connections of the floor connector.

Returns:

a list of connected FloorConnectors

addConnection

public boolean addConnection(FloorConnector connection)

Adds a connection to the current connections list.

Parameters:

connection - FloorConnector to be added to the current connections

Returns:

true on success, false otherwise

addAllConnections

public boolean addAllConnections(java.util.Collection<? extends FloorConnector> c)

Adds a collection of FloorConnectors to the current connections list.

Parameters:

c - the collection of FloorConnectors to be added

Returns:

true on success, false otherwise

equals

public boolean equals(java.lang.Object o)

Uses the super class's equals method to determine equality.

Overrides:

equals in class GridNode

Parameters:

o - the other object

Returns:

true if equal, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Description copied from class: AbstractPathfinderNode

Returns a formatted String holding the location of the node.

Overrides:

toString in class GridNode

Returns:

String