The grid-formation Reference Manual

Child Components

package.lisp (file).
grid.lisp (file).
quad.lisp (file).
quad-4-way.lisp (file).
quad-8-way.lisp (file).
hex.lisp (file).
hex-rows.lisp (file).
hex-columns.lisp (file).

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

3.1.1 `grid-formation/grid-formation.asd`

Source: grid-formation.asd.
Parent Component: grid-formation (system).
ASDF Systems: grid-formation.

3.1.2 `grid-formation/package.lisp`

Source: grid-formation.asd.
Parent Component: grid-formation (system).
Packages: grid-formation.

3.1.3 `grid-formation/grid.lisp`

Dependency

package.lisp (file).

Source

Parent Component

grid-formation (system).

Public Interface

initialize-instance (method).

Internals

cell-origin (reader method).
cell-p (function).
cell-size (reader method).
check-cell (function).
corner-directions (reader method).
distance (generic function).
edge-directions (reader method).
from-point (generic function).
grid (class).
make-grid (function).
neighbor (function).
neighbor-by-index (generic function).
neighbor-directions (generic function).
neighbor-offsets (generic function).
neighbors (function).
neighbors-p (function).
nudge (generic function).
select-line (generic function).
select-range (generic function).
size (reader method).
to-point (generic function).

3.1.4 `grid-formation/quad.lisp`

Dependency

grid.lisp (file).

Source

Parent Component

grid-formation (system).

Public Interface

initialize-instance (method).

Internals

from-point (method).
neighbor-by-index (method).
nudge (method).
quad-grid (class).
select-line (method).
select-range (method).
to-point (method).

3.1.5 `grid-formation/quad-4-way.lisp`

Dependency

quad.lisp (file).

Source

Parent Component

grid-formation (system).

Internals

distance (method).
neighbor-directions (method).
neighbor-offsets (method).
quad-grid/4-way (class).

3.1.6 `grid-formation/quad-8-way.lisp`

Dependency

quad-4-way.lisp (file).

Source

Parent Component

grid-formation (system).

Internals

distance (method).
neighbor-directions (method).
neighbor-offsets (method).
quad-grid/8-way (class).

3.1.7 `grid-formation/hex.lisp`

Dependency

quad-8-way.lisp (file).

Source

Parent Component

grid-formation (system).

Internals

distance (method).
forward (reader method).
from-cell (generic function).
from-point (method).
hex-grid (class).
hex-offset (function).
hex-round (function).
inverse (reader method).
make-hex (function).
neighbor-by-index (method).
neighbor-offsets (method).
nudge (method).
offset (reader method).
select-line (method).
select-range (method).
to-cell (generic function).
to-point (method).

3.1.8 `grid-formation/hex-rows.lisp`

Dependency

hex.lisp (file).

Source

Parent Component

grid-formation (system).

Public Interface

initialize-instance (method).

Internals

from-cell (method).
hex-grid/rows (class).
neighbor-directions (method).
to-cell (method).

3.1.9 `grid-formation/hex-columns.lisp`

Dependency

hex-rows.lisp (file).

Source

Parent Component

grid-formation (system).

Public Interface

initialize-instance (method).

Internals

from-cell (method).
hex-grid/columns (class).
neighbor-directions (method).
to-cell (method).

4 Packages

Packages are listed by definition order.

grid-formation

4.1 `grid-formation`

Source

package.lisp.

Use List

common-lisp.

Internals

cell-origin (generic reader).
cell-p (function).
cell-size (generic reader).
check-cell (function).
corner-directions (generic reader).
distance (generic function).
edge-directions (generic reader).
forward (generic reader).
from-cell (generic function).
from-point (generic function).
grid (class).
hex-grid (class).
hex-grid/columns (class).
hex-grid/rows (class).
hex-offset (function).
hex-round (function).
inverse (generic reader).
make-grid (function).
make-hex (function).
neighbor (function).
neighbor-by-index (generic function).
neighbor-directions (generic function).
neighbor-offsets (generic function).
neighbors (function).
neighbors-p (function).
nudge (generic function).
offset (generic reader).
quad-grid (class).
quad-grid/4-way (class).
quad-grid/8-way (class).
select-line (generic function).
select-range (generic function).
size (generic reader).
to-cell (generic function).
to-point (generic function).

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

5.1 Public Interface

Standalone methods

5.1.1 Standalone methods

Method: initialize-instance :after ((instance quad-grid) &key) ¶

Source: quad.lisp.

Method: initialize-instance :after ((instance grid) &key size) ¶

Source: grid.lisp.

Method: initialize-instance :after ((instance hex-grid/rows) &key) ¶

Source: hex-rows.lisp.

Method: initialize-instance :after ((instance hex-grid/columns) &key) ¶

Source: hex-columns.lisp.

5.2 Internals

Ordinary functions
Generic functions
Classes

5.2.1 Ordinary functions

Function: cell-p (grid cell) ¶

Package: grid-formation.
Source: grid.lisp.

Function: check-cell (grid cell) ¶

Package: grid-formation.
Source: grid.lisp.

Function: hex-offset (grid) ¶

Package: grid-formation.
Source: hex.lisp.

Function: hex-round (hex) ¶

Package: grid-formation.
Source: hex.lisp.

Function: make-grid (type &rest args) ¶

Package: grid-formation.
Source: grid.lisp.

Function: make-hex (x y) ¶

Package: grid-formation.
Source: hex.lisp.

Function: neighbor (grid cell direction) ¶

Package: grid-formation.
Source: grid.lisp.

Function: neighbors (grid cell) ¶

Package: grid-formation.
Source: grid.lisp.

Function: neighbors-p (grid cell1 cell2) ¶

Package: grid-formation.
Source: grid.lisp.

5.2.2 Generic functions

Generic Reader: cell-origin (object) ¶

Package

Methods

Reader Method: cell-origin ((grid grid)) ¶

automatically generated reader method

Source: grid.lisp.
Target Slot: %cell-origin.

Generic Reader: cell-size (object) ¶

Package

Methods

Reader Method: cell-size ((grid grid)) ¶

automatically generated reader method

Source: grid.lisp.
Target Slot: %cell-size.

Generic Reader: corner-directions (object) ¶

Package

Methods

Reader Method: corner-directions ((grid grid)) ¶

automatically generated reader method

Source: grid.lisp.
Target Slot: %corner-directions.

Generic Function: distance (grid cell1 cell2) ¶

Package

Source

Methods

Method: distance ((grid hex-grid) cell1 cell2) ¶

Source: hex.lisp.

Method: distance ((grid quad-grid/8-way) cell1 cell2) ¶

Source: quad-8-way.lisp.

Method: distance ((grid quad-grid/4-way) cell1 cell2) ¶

Source: quad-4-way.lisp.

Method: distance :before (grid cell1 cell2) ¶

Generic Reader: edge-directions (object) ¶

Package

Methods

Reader Method: edge-directions ((grid grid)) ¶

automatically generated reader method

Source: grid.lisp.
Target Slot: %edge-directions.

Generic Reader: forward (object) ¶

Package

Methods

Reader Method: forward ((hex-grid hex-grid)) ¶

automatically generated reader method

Source: hex.lisp.
Target Slot: %forward.

Generic Function: from-cell (grid cell) ¶

Package

Source

hex.lisp.

Methods

Method: from-cell ((grid hex-grid/columns) cell) ¶

Source: hex-columns.lisp.

Method: from-cell ((grid hex-grid/rows) cell) ¶

Source: hex-rows.lisp.

Generic Function: from-point (grid point) ¶

Package

Source

Methods

Method: from-point ((grid hex-grid) point) ¶

Source: hex.lisp.

Method: from-point ((grid quad-grid) point) ¶

Source: quad.lisp.

Generic Reader: inverse (object) ¶

Package

Methods

Reader Method: inverse ((hex-grid hex-grid)) ¶

automatically generated reader method

Source: hex.lisp.
Target Slot: %inverse.

Generic Function: neighbor-by-index (grid cell index) ¶

Package

Source

Methods

Method: neighbor-by-index ((grid hex-grid) cell index) ¶

Source: hex.lisp.

Method: neighbor-by-index ((grid quad-grid) cell index) ¶

Source: quad.lisp.

Method: neighbor-by-index :before (grid cell index) ¶

Generic Function: neighbor-directions (grid) ¶

Package

Source

Methods

Method: neighbor-directions ((grid hex-grid/columns)) ¶

Source: hex-columns.lisp.

Method: neighbor-directions ((grid hex-grid/rows)) ¶

Source: hex-rows.lisp.

Method: neighbor-directions ((grid quad-grid/8-way)) ¶

Source: quad-8-way.lisp.

Method: neighbor-directions ((grid quad-grid/4-way)) ¶

Source: quad-4-way.lisp.

Generic Function: neighbor-offsets (grid) ¶

Package

Source

Methods

Method: neighbor-offsets ((grid hex-grid)) ¶

Source: hex.lisp.

Method: neighbor-offsets ((grid quad-grid/8-way)) ¶

Source: quad-8-way.lisp.

Method: neighbor-offsets ((grid quad-grid/4-way)) ¶

Source: quad-4-way.lisp.

Generic Function: nudge (grid cell) ¶

Package

Source

Methods

Method: nudge ((grid hex-grid) hex) ¶

Source: hex.lisp.

Method: nudge ((grid quad-grid) cell) ¶

Source: quad.lisp.

Generic Reader: offset (object) ¶

Package

Methods

Reader Method: offset ((hex-grid hex-grid)) ¶

automatically generated reader method

Source: hex.lisp.
Target Slot: %offset.

Generic Function: select-line (grid cell1 cell2) ¶

Package

Source

Methods

Method: select-line ((grid hex-grid) cell1 cell2) ¶

Source: hex.lisp.

Method: select-line ((grid quad-grid) cell1 cell2) ¶

Source: quad.lisp.

Method: select-line :before (grid cell1 cell2) ¶

Generic Function: select-range (grid cell range) ¶

Package

Source

Methods

Method: select-range ((grid hex-grid) cell range) ¶

Source: hex.lisp.

Method: select-range ((grid quad-grid) cell range) ¶

Source: quad.lisp.

Method: select-range :before (grid cell range) ¶

Generic Reader: size (object) ¶

Package

Methods

Reader Method: size ((grid grid)) ¶

automatically generated reader method

Source: grid.lisp.
Target Slot: %size.

Generic Function: to-cell (grid hex) ¶

Package

Source

hex.lisp.

Methods

Method: to-cell ((grid hex-grid/columns) hex) ¶

Source: hex-columns.lisp.

Method: to-cell ((grid hex-grid/rows) hex) ¶

Source: hex-rows.lisp.

Generic Function: to-point (grid cell) ¶

Package

Source

Methods

Method: to-point ((grid hex-grid) cell) ¶

Source: hex.lisp.

Method: to-point ((grid quad-grid) cell) ¶

Source: quad.lisp.

Method: to-point :before (grid cell) ¶

5.2.3 Classes

Class: grid ¶

Package

Source

Direct subclasses

hex-grid.
quad-grid.

Direct methods

cell-origin.
cell-size.
corner-directions.
edge-directions.
initialize-instance.
size.

Direct slots

Slot: %size ¶

Initargs: :size
Readers: size.
Writers: This slot is read-only.

Slot: %cell-size ¶

Initargs: :cell-size
Readers: cell-size.
Writers: This slot is read-only.

Slot: %cell-origin ¶

Initargs: :cell-origin
Readers: cell-origin.
Writers: This slot is read-only.

Slot: %edge-directions ¶

Readers: edge-directions.
Writers: This slot is read-only.

Slot: %corner-directions ¶

Readers: corner-directions.
Writers: This slot is read-only.

Class: hex-grid ¶

Package

Source

hex.lisp.

Direct superclasses

grid.

Direct subclasses

hex-grid/columns.
hex-grid/rows.

Direct methods

distance.
forward.
from-point.
inverse.
neighbor-by-index.
neighbor-offsets.
nudge.
offset.
select-line.
select-range.
to-point.

Direct slots

Slot: %forward ¶

Readers: forward.
Writers: This slot is read-only.

Slot: %inverse ¶

Readers: inverse.
Writers: This slot is read-only.

Slot: %offset ¶

Initform: :even
Initargs: :offset
Readers: offset.
Writers: This slot is read-only.

Class: hex-grid/columns ¶

Package

Source

hex-columns.lisp.

Direct superclasses

hex-grid.

Direct methods

from-cell.
initialize-instance.
neighbor-directions.
to-cell.

Class: hex-grid/rows ¶

Package

Source

hex-rows.lisp.

Direct superclasses

hex-grid.

Direct methods

from-cell.
initialize-instance.
neighbor-directions.
to-cell.

Class: quad-grid ¶

Package

Source

quad.lisp.

Direct superclasses

grid.

Direct subclasses

quad-grid/4-way.
quad-grid/8-way.

Direct methods

from-point.
initialize-instance.
neighbor-by-index.
nudge.
select-line.
select-range.
to-point.

Class: quad-grid/4-way ¶

Package

Source

quad-4-way.lisp.

Direct superclasses

quad-grid.

Direct methods

distance.
neighbor-directions.
neighbor-offsets.

Class: quad-grid/8-way ¶

Package