GridRegion Class Reference

This class represents a region in which the Edges of the graph have a similar direction. More...

Public Member Functions
	GridRegion (double primaryAngle)
	Creates a GridRegion with the specified primary angle. More...
ArrayList< GridCell >	getCells ()
	Returns the GridCells belonging to the GridRegion. More...
void	addCell (GridCell cell)
	Adds a GridCell to the GridRegion. More...
double	getPrimaryAngle ()
	Returns the primary angle of the Edges passing through the GridRegion. More...
int	getMinX ()
	Returns the minimum x-coordinate of the GridRegion's bounding box. More...
int	getMinY ()
	Returns the minimum y-coordinate of the GridRegion's bounding box. More...
int	getMaxX ()
	Returns the maximum x-coordinate of the GridRegion's bounding box. More...
int	getMaxY ()
	Returns the maximum y-coordinate of the GridRegion's bounding box. More...
boolean	contains (Node node)
	Checks whether the specified Node is contained within the GridRegion. More...
Node	center ()
	Returns the center of the GridRegion's bounding box. More...
void	updatePrimaryAngle ()
	Re-evaluates the primary angle of the region by taking the average of the GridCells' primary angles.

Detailed Description

This class represents a region in which the Edges of the graph have a similar direction.

Author

Kurt Leimer

Definition at line 10 of file GridRegion.java.

Constructor & Destructor Documentation

GridRegion.GridRegion

(

double

primaryAngle)

Creates a GridRegion with the specified primary angle.

Parameters

primaryAngle

The primary angle of the Edges passing through the GridRegion.

Definition at line 24 of file GridRegion.java.

Member Function Documentation

void GridRegion.addCell

(

GridCell

cell)

Adds a GridCell to the GridRegion.

Parameters

cell	The GridCell that is added to the GridRegion.

Definition at line 45 of file GridRegion.java.

Node GridRegion.center

(

)

Returns the center of the GridRegion's bounding box.

Returns

the center of the GridRegion's bounding box.

Definition at line 117 of file GridRegion.java.

boolean GridRegion.contains

(

Node

node)

Checks whether the specified Node is contained within the GridRegion.

Parameters

node	The node which is checked.

Returns

true if the Node is contained in the GridRegion, false otherwise.

Definition at line 103 of file GridRegion.java.

ArrayList<GridCell> GridRegion.getCells

(

)

Returns the GridCells belonging to the GridRegion.

Returns

the GridCells belonging to the GridRegion.

Definition at line 37 of file GridRegion.java.

int GridRegion.getMaxX

(

)

Returns the maximum x-coordinate of the GridRegion's bounding box.

Returns

the maximum x-coordinate of the GridRegion's bounding box.

Definition at line 86 of file GridRegion.java.

int GridRegion.getMaxY

(

)

Returns the maximum y-coordinate of the GridRegion's bounding box.

Returns

the maximum y-coordinate of the GridRegion's bounding box.

Definition at line 94 of file GridRegion.java.

int GridRegion.getMinX

(

)

Returns the minimum x-coordinate of the GridRegion's bounding box.

Returns

the minimum x-coordinate of the GridRegion's bounding box.

Definition at line 70 of file GridRegion.java.

int GridRegion.getMinY

(

)

Returns the minimum y-coordinate of the GridRegion's bounding box.

Returns

the minimum y-coordinate of the GridRegion's bounding box.

Definition at line 78 of file GridRegion.java.

double GridRegion.getPrimaryAngle

(

)

Returns the primary angle of the Edges passing through the GridRegion.

Returns

the primary angle of the GridRegion.

Definition at line 62 of file GridRegion.java.

---

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

• /Users/neco/Desktop/GBEC/HomePage/src/GridRegion.java