game2dai.graph.GraphEdge Class Reference

Inheritance diagram for game2dai.graph.GraphEdge:

Public Member Functions
	GraphEdge (GraphNode from, GraphNode to)
	GraphEdge (GraphEdge edge)
	GraphEdge (GraphNode from, GraphNode to, double cost)
double	getCost ()
void	setCost (double cost)
GraphNode	from ()
GraphNode	to ()
int	compareTo (Object o)
String	toString ()

Protected Member Functions
	GraphEdge ()

Protected Attributes
GraphNode	from
GraphNode	to
double	cost = 1.0

Package Functions
	GraphEdge (GraphEdge edge, double costSoFar)

Detailed Description

This class is used to represent a directed edge between 2 nodes and the cost of traversing this edge.

Author

Peter Lager

Constructor & Destructor Documentation

GraphEdge() [1/5]

game2dai.graph.GraphEdge.GraphEdge ( )

protected

Make protected to prevent its use outside the class.

GraphEdge() [2/5]

game2dai.graph.GraphEdge.GraphEdge	(	GraphNode	from,
		GraphNode	to
	)

Create an edge of cost 1.0f

Parameters

from	'from' node
to	'to' node

GraphEdge() [3/5]

game2dai.graph.GraphEdge.GraphEdge

(

GraphEdge

edge

)

Copy constructor.

Parameters

edge

GraphEdge() [4/5]

game2dai.graph.GraphEdge.GraphEdge	(	GraphNode	from,
		GraphNode	to,
		double	cost
	)

Create an edge from 2 existing nodes. If the cost is 0.0 then calculate the cost based on the physical distance between the nodes.

Parameters

from	'from' node
to	'to' node
cost	traversal cost

GraphEdge() [5/5]

game2dai.graph.GraphEdge.GraphEdge ( GraphEdge  edge, double  costSoFar  )

package

This constructor is used to create new edges for use with the path finding algorithms Dijkstra and A*
It should not be used directly.

Parameters

edge	the existing edge
costSoFar	the cost to the destination node so far.

Member Function Documentation

compareTo()

int game2dai.graph.GraphEdge.compareTo

(

Object

o

)

Compare two graph edges.

from()

GraphNode game2dai.graph.GraphEdge.from

(

)

Returns

the 'from' node

getCost()

double game2dai.graph.GraphEdge.getCost

(

)

Returns

the cost

setCost()

void game2dai.graph.GraphEdge.setCost

(

double

cost

)

Change the traversal cost.

Parameters

cost	the new traversal cost.

to()

GraphNode game2dai.graph.GraphEdge.to

(

)

Returns

the 'to' node

---

The documentation for this class was generated from the following file:

• /Users/peter/git/ai4games-repos/AI_4_2D_Games/src/game2dai/graph/GraphEdge.java