❤
npm
Sign UpSign In

hexular

0.2.0 • Public • Published

Hexular

An extensible hexagonal CA platform.

(C) 2020 Graham Steele. Distributed under the Hexagonal Awareness License.

Contents

Overview

Hexular is an extensible hexagonal cellular automaton (CA) platform for JavaScript environments, presently built around several core concepts:

  • A model representing a grid of cells organized according to some topology. Hexular includes two built-in model classes:
  • Cells representing individual elements in a model topology. Each is associated with a particular state. Many included helper functions assume this state will be a natural number, but it can be anything.
  • Adapters as extensions for e.g. rendering a model's state. Namely, in the present implementation, CanvasAdapter, which displays a model on a user agent canvas context.

The Hexular function (defined globally in the DOM or exported by the standalone module) returns a new model instance when called directly, and also contains the following collection objects, providing ergonomic access to all functionality necessary for the end user to implement her own extensions via the Hexular API:

Some useful Model methods:

  • step() — Perform single state increment step
  • clear() — Clear all cell states

Adapters map a model to some space — e.g. a web canvas. Useful CanvasAdapter methods include:

Configuration

The Hexular function accepts an optional first argument giving a model class (e.g. Hexular.classes.models.OffsetTopology), and any number of settings arguments. Different settings are required by different model classes.

CubicModel is morphologically determined by its radius, which gives the number of rings of cells from the center to the edge. So, e.g., a seven-cell grid would have radius 2. Conversely, OffsetModel takes rows and cols arguments.

For additional model configuration options, please see the Model documentation.

Rules

Cell rules are given on a per-state basis, and applied individually to each cell. The rules are stored in the model.rules array, and can be reassigned at any time.

A valid rule is a function that take a cell as an argument, and return a value corresponding to the next desired state. Hexular is generally opinionated towards natural number states, but they can in principle be any values that can be coerced into a JavaScript object key. The rule function has access to the cell's current state, its neighbors' states (through cell.nbrs and the neighborhood-bound helper functions), and by extension the state of every cell in the grid — though in principle CAs should only consider cell states within some finite local neighborhood.

One could, if one were so inclined, create rules utilizing larger local neighborhoods, additional internal state data, etc.

Rule helpers

Cell instances have several helper methods to perform common rule calculations:

  • total — Returns sum of all neighboring states
  • count — Returns count of activated (nonzero) neighbors
  • histogram — Returns a numStates-sized array with counts of individual states across all neighbors

A cell's neighborhood property determines which cells to iterate over when a rule calls these methods. The default is a cell's immediate six neighbors, however this can be set to several more expansive options, including optionally a cell's own state. Rules can call these helper methods on neighborhoods specifically via the cell.with array, e.g.:

    cell.with[19].count

All cell neighborhoods can be set via model.setNeighborhood(n), where n is one of [6, 12, 18, 7, 13, 19].

Rule builder

The ruleBuilder function allows for "convenient" generation of elementary binary CA rules, analogous to Wolfram's Elementary Cellular Automaton rules. The function takes as an input either a single natural number (preferrably in the form of a BigInt), or an array of numbers each representing a single neighborhood state mask to add. It also accepts an optional options argument, which recognizes the following attributes, with defaults:

  • range = [1, 7]
  • miss = 0
  • match = 1
  • missRel = false
  • matchRel = false
  • rel = false

The range attribute determines which neighbors to consider when applying the rule, with the default being [1, 7] (corresponding to the immediate neighborhood N6). This can be changed to e.g. [0, 7] to include the home cell itself, or [1, 19] to consider the 18 nearest neighbors excluding the home cell. The individual state masks in the first argument array are thus 6 bits in the default case (0-63), or 7 bits in the latter case (0-127). The "rule number" produced will be up to 64 bits, or 18,446,744,073,709,551,616 possible combinations, for the 6-neighbor default, or up to 128 bits, or 340,282,366,920,938,463,463,374,607,431,768,211,456 possible combinations, for the 7-neighbor variant. If one were to consider the full [0, 19] neighborhood, one would have a 157,827-decimal-digit-long number of possible rules, which I will not repeat here.

So e.g.. we might use this function as follows to create a rule to activate if and only if two opposite pairs of neighbors are exclusively active:

    let fancyElementaryRule = Hexular.util.ruleBuilder([
      0b001001,
      0b010010,
      0b100100
    ]);

If we wanted to have the same rule subtract 1 from the current cell state on rule match, and keep the current state otherwise, we would modify it like this:

    let fancyElementaryRule = Hexular.util.ruleBuilder([
      0b001001,
      0b010010,
      0b100100
    ], {miss: 0,  match: -1, missRel: true, matchRel: true});

Note this would be a somewhat useless rule under most circumstances.

Please the relevant documentation for additional details on the ruleBuilder function.

Customization

Beyond modifying rules and neighborhoods, model behavior can be extended and modified in a number of ways:

Filters

Filters allow us to, e.g., perform a modulo operation on new cell states, to keep them confined to a certain range. This was historically the default behavior, but has now been spun out into a separate functionality that must be added explicitly to a new model:

    model.addFilter(Hexular.filters.modFilter)

Filters simply take a state value and an optional cell instance, and return a filtered state value.

Drawing hooks

We can also override or extend the default cell-drawing behavior of CanvasAdapter in arbitrary aesthetic ways, to create more complex renderings. For example opening the console in the Hexular Studio interface and running the following will add a tasteful red triangle between any three activated cells:

    Board.bgAdapter.onDrawCell.push(function(cell) {
      if (!cell.state)
        return;
      let slice = cell.with[6].nbrSlice;
      this.context.fillStyle = '#ff3300';
      for (let i = 0; i < 5; i++) {
        let n1 = slice[i];
        let n2 = slice[(i + 1) % 6];
        if (n1.state && n2.state && !n1.edge && !n2.edge) {
          this.context.beginPath();
          this.context.moveTo(...this.model.cellMap.get(cell));
          this.context.lineTo(...this.model.cellMap.get(n1));
          this.context.lineTo(...this.model.cellMap.get(n2));
          this.context.closePath();
          this.context.fill();
        }
      }
    });

Variations on these triangles and other examples can be found in the global Examples object in Hexular Studio.

Hexular Studio

The built-in demo site, Hexular Studio, can be run as-is with any static HTTP server, or built and run using NPM and Node:

  • Run npm install from the project directory
  • Run npm start

The principal Studio interface consists of a CubicModel instance centered on the page, with buttons and keyboard shortcuts implementing various functions. A number of settings can be set via URL parameters. Some debatably-important ones that presently aren't also configurable through the interface include:

  • showModelBackground=true
  • groundState=0
  • undoStackSize=64

URL parameters are overriden by themes and presets according to a somewhat complicated arrangement, and it's probably advisable to use the in-page configuration tools when possible. Generally things like tool settings and particular rule settings will persist for a current page session, while presets, rules, and themes will persist across multiple sessions. Both can be cleared by clicking the "Clear locally-stored settings" button under the three-dotted conifg menu.

Interface

Control flow, state, and configuration buttons run along the along the top of the window:

  • Record/Stop (Shift+Tab) — Start timer and record canvas to webm video
  • Start/Pause (Tab) — Step model at 100ms intervals (this may be slower for larger grids, depending on hardware, and can be set via the appearance modal)
  • Step (Space) — Perform individual step
  • Clear (Ctrl+C)
  • Configuration menu toggle (Alt)
    • Open model configuration modal (Ctrl+G)
    • Open rulebuilder modal (Ctrl+B)
    • Open custom code modal (Ctrl+F)
    • Open appearance modal (Ctrl+E)
    • Clear local settings (Ctrl+X)
  • Undo (Ctrl+Z)
  • Redo (Ctrl+Shift+Z)
  • Save snapshot (Q)
  • Load snapshot (A)
  • Show documentation (F1)

Several buttons concerning file I/O run along the left side:

  • Save image (Ctrl+Shift+S)
  • Toggle image capture mode (Ctrl+I)
  • Load model (Ctrl+O)
  • Save model (Ctrl+S)
  • Load local settings (Ctrl+Alt+O)
  • Save local settings (Ctrl+Alt+S)

Tool buttons and various editorial options run along the bottom:

  • Move tool (M)
  • Fill tool (G)
  • Brush tool (B)
  • Line tool (L)
  • Locked line tool (/)
  • Filled hex tool (F)
  • Outline hex tool (H)
  • Set tool size to 1 (1)
  • Set tool size to 2 (2)
  • Set tool size to 3 (3)
  • Re-scale and re-center model (R)
  • Toggle color mode (C) — Override the default color assignment on paint actions with specific state colors

Holding <Shift> will temporarily select the move tool by default, or whatever tool is given in the shiftTool parameter. Holding <Alt> temporarily expands the configuration menu.

Additionally, <Escape> toggles button and coordinate indicator visibility, or conversely closes the configuration modal if it is open. Scrolling a central mouse wheel or equivalent will zoom the canvas.

Cell states are changed by clicking and dragging with a paint tool selected. By default, the painting state is determined by the state of the initially-clicked cell, and is the successor to the current state modulo Board.instance.model.numStates. Right clicking, conversely, decrements the cell state by one, and ctrl+clicking clears to the ground state. Setting a specific state color can be effected by toggling the color mode button on the bottom right.

The basic flow of the program is to set one's preferred state using either the mouse or by importing a saved file, setting desired rules, &c. in the configuration modal, and then either starting the timer (tab) or incrementing the state one step at a time (space).

Prepopulated rules

Several predefined rules are given in client/library/rules.js. These are largely provided for convenience and aren't meant to be exhaustive. A number of built-in presets, or groups of rules and filters, are defined client/library/presets.js and can be selected from the model configuration modal in lieu of individual rules.

Studio configuration and customization

The model configuration modal consists of the following fields:

  • Slider input to set the number of available states, from 2-12
  • Preset dropdown menu
  • Bulk rule assignment dropdown with "select all" button
  • Individual dropdowns for each of the twelve possible states supported by the demo
  • Default rule dropdown menu — This should only really matter when running rules without modFilter (which may cause other undesirable effects such as corrupted model exports, &c., and should generally be thought of as voiding the warranty)
  • Cell neighborhood dropdown — Not all rules use the default neighborhood (those constructed using the ruleBuilder function do not for instance), but most built-in rules involving totals, counts, &c. will
  • A series of buttons to activate and deactivate particular built-in filters

In the configuration modal, rule assignment select menus are populated with the contents of the rules object loaded from demo/rules.js, merged with those already available in Hexular core. Custom rules may be added via the console, e.g.:

    Board.config.addRule(name, (cell) => cell.state == 3 ? 1 : 0)

We can also add our own rule presets via the console, e.g.:

    Board.config.addPreset('fancyPreset', new Preset(['binary23', 'binary34', 'stepUp'], {filters: {deltaFilter: true, modFilter: true}}))

Such modifications can also be effected via the custom code modal (Ctrl+F) using the same global objects, &c. Specifically, every board instance attaches the following to the global Board object:

  • Board.instance - The board itself
  • Board.config - Alias for Board.instance.config
  • Board.model - Alias for Board.instance.model
  • Board.bgAdater - Alias for Board.instance.bgAdapter
  • Board.fgAdapter - Alias for Board.instance.fgAdapter

Customization of the global Board.model model can be performed as described above and in the documentation.

Rulebuilder

The rulebuilder modal (Ctrl+B) exposes a somewhat-simplified interface for calling the ruleBuilder function discussed above, limited to the N6 neighborhood, and six possible miss and match states, with the default being to set cell state to 0 on misses, and 1 on matches.

Note that the miss and match rules can interact with deltaFilter in strange ways. For instance, a rule built using the default settings in this modal, coupled with deltaFilter, will have the same effect as one without the filter, but with the match rule set to "State + 1." Likewise, if we then add the filter back in, we will add the state twice on matches — which may or may not be desirable, but is sort of weird.

The rule is copied to a text field at the bottom of the modal, where it can be further edited before instantiation by e.g. adding custom miss and match values, or saved as part of a larger scripted customization. The JSON array generated in this field can be fed directly to theruleBuilder function using ES6 spread syntax (...).

Elementary rules constructed through the rulebuilder interface are only a small subset of possible rules using the core cell API, and they do not, by default, differentiate between nonzero cell states. Thus they are not suited for "noisy" rulesets where all or most cells are in a nonzero state (e.g., what one sees with the built-in preset "grayGoo"). There is however an optional attribute rel, exposed in the generated JSON field, which causes the rule to compare neighbor states relative to the current state, matching where a neighbor has an equal or greater nonzero value to the current state.

Note that, as with most persistent attributes in the demo interface, previous values will simply be overwritten — this allows one to e.g. iterate quickly when developing an experimental rule.

Timer hooks

We can add functions to be called at a given time index during play or recording via the board.addHook() method. For example, to turn cells with state 4 cyan after five seconds, we could run the following from the console or the custom code modal:

    Board.instance.addHook('timer', 5000, () => Board.config.setColor(3, '#33cccc'));

Timer hooks will be rerun at their appropriate time index after every stop/start event, but changes they make to e.g. the configuration object will persist until explicitly reset.

Other hooks include incrementStep, playStep, and step.

More information

Readme

Keywords

Package Sidebar

Install

npm i hexular

Repository

github.com/hexagrahamaton/hexular

Homepage

hexagrahamaton.github.io/hexular/

Weekly Downloads

0

Version

0.2.0

License

HAL

Unpacked Size

85.7 kB

Total Files

5

Last publish

Collaborators

  • isometrid
Try on RunKit
Report malware