The grid-formation Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The grid-formation Reference Manual

This is the grid-formation Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 05:55:09 2022 GMT+0.

Table of Contents


1 Introduction

grid-formation

Simple cellular grid formations and algorithms.

Install

(ql:quickload :grid-formation)

License

Copyright © 2020-2022 Michael Fiano mail@mfiano.net.

Licensed under the MIT License.


2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 grid-formation

Simple cellular grid formations and algorithms.

Author

Michael Fiano <mail@mfiano.net>

Home Page

https://git.mfiano.net/mfiano/grid-formation

License

MIT

Version

0.1.0

Dependencies
  • mfiano-utils (system).
  • origin (system).
Source

grid-formation.asd.

Child Components

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

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

grid-formation.asd.

Parent Component

grid-formation (system).

Public Interface

initialize-instance (method).

Internals

3.1.4 grid-formation/quad.lisp

Dependency

grid.lisp (file).

Source

grid-formation.asd.

Parent Component

grid-formation (system).

Public Interface

initialize-instance (method).

Internals

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

Dependency

quad.lisp (file).

Source

grid-formation.asd.

Parent Component

grid-formation (system).

Internals

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

Dependency

quad-4-way.lisp (file).

Source

grid-formation.asd.

Parent Component

grid-formation (system).

Internals

3.1.7 grid-formation/hex.lisp

Dependency

quad-8-way.lisp (file).

Source

grid-formation.asd.

Parent Component

grid-formation (system).

Internals

3.1.8 grid-formation/hex-rows.lisp

Dependency

hex.lisp (file).

Source

grid-formation.asd.

Parent Component

grid-formation (system).

Public Interface

initialize-instance (method).

Internals

3.1.9 grid-formation/hex-columns.lisp

Dependency

hex-rows.lisp (file).

Source

grid-formation.asd.

Parent Component

grid-formation (system).

Public Interface

initialize-instance (method).

Internals

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 grid-formation

Source

package.lisp.

Use List

common-lisp.

Internals

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


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


Next: , Previous: , Up: Internals   [Contents][Index]

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.


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.2 Generic functions

Generic Reader: cell-origin (object)
Package

grid-formation.

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

automatically generated reader method

Source

grid.lisp.

Target Slot

%cell-origin.

Generic Reader: cell-size (object)
Package

grid-formation.

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

automatically generated reader method

Source

grid.lisp.

Target Slot

%cell-size.

Generic Reader: corner-directions (object)
Package

grid-formation.

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

grid-formation.

Source

grid.lisp.

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

grid-formation.

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

automatically generated reader method

Source

grid.lisp.

Target Slot

%edge-directions.

Generic Reader: forward (object)
Package

grid-formation.

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

grid-formation.

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

grid-formation.

Source

grid.lisp.

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

grid-formation.

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

grid-formation.

Source

grid.lisp.

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

grid-formation.

Source

grid.lisp.

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

grid-formation.

Source

grid.lisp.

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

grid-formation.

Source

grid.lisp.

Methods
Method: nudge ((grid hex-grid) hex)
Source

hex.lisp.

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

quad.lisp.

Generic Reader: offset (object)
Package

grid-formation.

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

grid-formation.

Source

grid.lisp.

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

grid-formation.

Source

grid.lisp.

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

grid-formation.

Methods
Reader Method: size ((grid grid))

automatically generated reader method

Source

grid.lisp.

Target Slot

%size.

Generic Function: to-cell (grid hex)
Package

grid-formation.

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

grid-formation.

Source

grid.lisp.

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)

Previous: , Up: Internals   [Contents][Index]

5.2.3 Classes

Class: grid
Package

grid-formation.

Source

grid.lisp.

Direct subclasses
Direct methods
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

grid-formation.

Source

hex.lisp.

Direct superclasses

grid.

Direct subclasses
Direct methods
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

grid-formation.

Source

hex-columns.lisp.

Direct superclasses

hex-grid.

Direct methods
Class: hex-grid/rows
Package

grid-formation.

Source

hex-rows.lisp.

Direct superclasses

hex-grid.

Direct methods
Class: quad-grid
Package

grid-formation.

Source

quad.lisp.

Direct superclasses

grid.

Direct subclasses
Direct methods
Class: quad-grid/4-way
Package

grid-formation.

Source

quad-4-way.lisp.

Direct superclasses

quad-grid.

Direct methods
Class: quad-grid/8-way
Package

grid-formation.

Source

quad-8-way.lisp.

Direct superclasses

quad-grid.

Direct methods

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   C   D   E   F   G   H   I   M   N   O   S   T  
Index Entry  Section

C
cell-origin: Private generic functions
cell-origin: Private generic functions
cell-p: Private ordinary functions
cell-size: Private generic functions
cell-size: Private generic functions
check-cell: Private ordinary functions
corner-directions: Private generic functions
corner-directions: Private generic functions

D
distance: Private generic functions
distance: Private generic functions
distance: Private generic functions
distance: Private generic functions
distance: Private generic functions

E
edge-directions: Private generic functions
edge-directions: Private generic functions

F
forward: Private generic functions
forward: Private generic functions
from-cell: Private generic functions
from-cell: Private generic functions
from-cell: Private generic functions
from-point: Private generic functions
from-point: Private generic functions
from-point: Private generic functions
Function, cell-p: Private ordinary functions
Function, check-cell: Private ordinary functions
Function, hex-offset: Private ordinary functions
Function, hex-round: Private ordinary functions
Function, make-grid: Private ordinary functions
Function, make-hex: Private ordinary functions
Function, neighbor: Private ordinary functions
Function, neighbors: Private ordinary functions
Function, neighbors-p: Private ordinary functions

G
Generic Function, cell-origin: Private generic functions
Generic Function, cell-size: Private generic functions
Generic Function, corner-directions: Private generic functions
Generic Function, distance: Private generic functions
Generic Function, edge-directions: Private generic functions
Generic Function, forward: Private generic functions
Generic Function, from-cell: Private generic functions
Generic Function, from-point: Private generic functions
Generic Function, inverse: Private generic functions
Generic Function, neighbor-by-index: Private generic functions
Generic Function, neighbor-directions: Private generic functions
Generic Function, neighbor-offsets: Private generic functions
Generic Function, nudge: Private generic functions
Generic Function, offset: Private generic functions
Generic Function, select-line: Private generic functions
Generic Function, select-range: Private generic functions
Generic Function, size: Private generic functions
Generic Function, to-cell: Private generic functions
Generic Function, to-point: Private generic functions

H
hex-offset: Private ordinary functions
hex-round: Private ordinary functions

I
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
inverse: Private generic functions
inverse: Private generic functions

M
make-grid: Private ordinary functions
make-hex: Private ordinary functions
Method, cell-origin: Private generic functions
Method, cell-size: Private generic functions
Method, corner-directions: Private generic functions
Method, distance: Private generic functions
Method, distance: Private generic functions
Method, distance: Private generic functions
Method, distance: Private generic functions
Method, edge-directions: Private generic functions
Method, forward: Private generic functions
Method, from-cell: Private generic functions
Method, from-cell: Private generic functions
Method, from-point: Private generic functions
Method, from-point: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, inverse: Private generic functions
Method, neighbor-by-index: Private generic functions
Method, neighbor-by-index: Private generic functions
Method, neighbor-by-index: Private generic functions
Method, neighbor-directions: Private generic functions
Method, neighbor-directions: Private generic functions
Method, neighbor-directions: Private generic functions
Method, neighbor-directions: Private generic functions
Method, neighbor-offsets: Private generic functions
Method, neighbor-offsets: Private generic functions
Method, neighbor-offsets: Private generic functions
Method, nudge: Private generic functions
Method, nudge: Private generic functions
Method, offset: Private generic functions
Method, select-line: Private generic functions
Method, select-line: Private generic functions
Method, select-line: Private generic functions
Method, select-range: Private generic functions
Method, select-range: Private generic functions
Method, select-range: Private generic functions
Method, size: Private generic functions
Method, to-cell: Private generic functions
Method, to-cell: Private generic functions
Method, to-point: Private generic functions
Method, to-point: Private generic functions
Method, to-point: Private generic functions

N
neighbor: Private ordinary functions
neighbor-by-index: Private generic functions
neighbor-by-index: Private generic functions
neighbor-by-index: Private generic functions
neighbor-by-index: Private generic functions
neighbor-directions: Private generic functions
neighbor-directions: Private generic functions
neighbor-directions: Private generic functions
neighbor-directions: Private generic functions
neighbor-directions: Private generic functions
neighbor-offsets: Private generic functions
neighbor-offsets: Private generic functions
neighbor-offsets: Private generic functions
neighbor-offsets: Private generic functions
neighbors: Private ordinary functions
neighbors-p: Private ordinary functions
nudge: Private generic functions
nudge: Private generic functions
nudge: Private generic functions

O
offset: Private generic functions
offset: Private generic functions

S
select-line: Private generic functions
select-line: Private generic functions
select-line: Private generic functions
select-line: Private generic functions
select-range: Private generic functions
select-range: Private generic functions
select-range: Private generic functions
select-range: Private generic functions
size: Private generic functions
size: Private generic functions

T
to-cell: Private generic functions
to-cell: Private generic functions
to-cell: Private generic functions
to-point: Private generic functions
to-point: Private generic functions
to-point: Private generic functions
to-point: Private generic functions

Jump to:   C   D   E   F   G   H   I   M   N   O   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   F   G   H   P   Q   S  
Index Entry  Section

C
Class, grid: Private classes
Class, hex-grid: Private classes
Class, hex-grid/columns: Private classes
Class, hex-grid/rows: Private classes
Class, quad-grid: Private classes
Class, quad-grid/4-way: Private classes
Class, quad-grid/8-way: Private classes

F
File, grid-formation.asd: The grid-formation/grid-formation․asd file
File, grid.lisp: The grid-formation/grid․lisp file
File, hex-columns.lisp: The grid-formation/hex-columns․lisp file
File, hex-rows.lisp: The grid-formation/hex-rows․lisp file
File, hex.lisp: The grid-formation/hex․lisp file
File, package.lisp: The grid-formation/package․lisp file
File, quad-4-way.lisp: The grid-formation/quad-4-way․lisp file
File, quad-8-way.lisp: The grid-formation/quad-8-way․lisp file
File, quad.lisp: The grid-formation/quad․lisp file

G
grid: Private classes
grid-formation: The grid-formation system
grid-formation: The grid-formation package
grid-formation.asd: The grid-formation/grid-formation․asd file
grid.lisp: The grid-formation/grid․lisp file

H
hex-columns.lisp: The grid-formation/hex-columns․lisp file
hex-grid: Private classes
hex-grid/columns: Private classes
hex-grid/rows: Private classes
hex-rows.lisp: The grid-formation/hex-rows․lisp file
hex.lisp: The grid-formation/hex․lisp file

P
Package, grid-formation: The grid-formation package
package.lisp: The grid-formation/package․lisp file

Q
quad-4-way.lisp: The grid-formation/quad-4-way․lisp file
quad-8-way.lisp: The grid-formation/quad-8-way․lisp file
quad-grid: Private classes
quad-grid/4-way: Private classes
quad-grid/8-way: Private classes
quad.lisp: The grid-formation/quad․lisp file

S
System, grid-formation: The grid-formation system

Jump to:   C   F   G   H   P   Q   S