squidpony.squidgrid.mapping

Class GrowingTreeMazeGenerator

java.lang.Object

squidpony.squidgrid.mapping.GrowingTreeMazeGenerator

All Implemented Interfaces:

IDungeonGenerator

public class GrowingTreeMazeGenerator
extends java.lang.Object
implements IDungeonGenerator

A maze generator that can be configured using a GrowingTreeMazeGenerator.ChoosingMethod, which can be customized for the app. Based in part on code from Jamis Buck's blog. This defaults to newest for its ChoosingMethod, but random is also good to try; you can specify a ChoosingMethod with generate(ChoosingMethod).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GrowingTreeMazeGenerator.ChoosingMethod A way to configure how generate(ChoosingMethod) places paths through the maze.

Field Summary

Fields

Modifier and Type	Field and Description
char[][]	dungeon
GrowingTreeMazeGenerator.ChoosingMethod	newest Produces high-quality mazes that are very similar to those produced by a recursive back-tracking algorithm.
GrowingTreeMazeGenerator.ChoosingMethod	oldest Produces mostly straight corridors that dead-end at the map's edge; probably only useful with mix(ChoosingMethod, double, ChoosingMethod, double).
GrowingTreeMazeGenerator.ChoosingMethod	random Produces chaotic, jumbled spans of corridors, often with dead-ends, that are similar to those produced by Prim's algorithm.

Constructor Summary

Constructors

Constructor and Description
GrowingTreeMazeGenerator(int width, int height)
GrowingTreeMazeGenerator(int width, int height, IRNG rng)

Method Summary

Modifier and Type	Method and Description
char[][]	generate() Builds and returns a 2D char array maze by using newest with generate(ChoosingMethod).
char[][]	generate(GrowingTreeMazeGenerator.ChoosingMethod choosing) Builds and returns a 2D char array maze using the provided chooser method object.
char[][]	getDungeon() Gets the most recently-produced dungeon as a 2D char array, usually produced by calling generate() or some similar method present in a specific implementation.
GrowingTreeMazeGenerator.ChoosingMethod	mix(GrowingTreeMazeGenerator.ChoosingMethod methodA, double chanceA, GrowingTreeMazeGenerator.ChoosingMethod methodB, double chanceB) Mixes two ChoosingMethod values, like newest and random, given a weight for each, and produces a new ChoosingMethod that randomly (respecting weight) picks one of those ChoosingMethods each time it is used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

dungeon

public char[][] dungeon

newest

public final GrowingTreeMazeGenerator.ChoosingMethod newest

Produces high-quality mazes that are very similar to those produced by a recursive back-tracking algorithm.
Example:

 ┌─────┬───────┬───┬─────────┬─────┬───┐
 │.....│.......│...│.........│.....│...│
 │.────┘.┌──.│.│.│.└───┐.┌──.│.──┐.│.│.│
 │.......│...│.│.│.....│.│...│...│.│.│.│
 │.──────┤.──┤.│.└─┬──.│.└─┐.└─┐.│.│.│.│
 │.......│...│.│...│...│...│...│.│.│.│.│
 ├─────┐.├──.│.└─┐.└─┐.├──.├─┐.│.│.│.│.│
 │.....│.│...│...│...│.│...│.│...│...│.│
 │.│.──┘.│.──┼───┼──.│.│.──┤.└───┼───┘.│
 │.│.....│...│...│...│.│...│.....│.....│
 │.└─┬───┴─┐.└─┐.│.┌─┘.│.│.└───┐.│.──┬─┤
 │...│.....│...│...│...│.│.....│.│...│.│
 ├──.│.┌──.│.──┴───┤.──┴─┤.──┐.│.└─┐.│.│
 │...│.│...│.......│.....│...│.│...│.│.│
 │.┌─┴─┘.│.├─┐.│.┌─┴───┐.├───┘.│.│.│.│.│
 │.│.....│.│.│.│.│.....│.│.....│.│.│.│.│
 │.│.┌───┘.│.│.└─┘.──┐.│.│.┌───┘.│.│.│.│
 │...│.......│.......│.....│.....│.....│
 └───┴───────┴───────┴─────┴─────┴─────┘
 

oldest

public final GrowingTreeMazeGenerator.ChoosingMethod oldest

Produces mostly straight corridors that dead-end at the map's edge; probably only useful with mix(ChoosingMethod, double, ChoosingMethod, double).
Example:

 ┌─┬─┬─┬─┬─┬─┬─┬───────────────────────┐
 │.│.│.│.│.│.│.│.......................│
 │.│.│.│.│.│.│.│.──────────────────────┤
 │.│.│.│.│.│.│.│.......................│
 │.│.│.│.│.│.│.│.──────────────────────┤
 │.│.│.│.│.│.│.│.......................│
 │.│.│.│.│.│.│.│.──────────────────────┤
 │.........│.│.│.......................│
 ├────────.│.│.│.──────────────────────┤
 │.....................................│
 ├────────────.│.──────────────────────┤
 │.............│.......................│
 ├────────────.│.──────────────────────┤
 │.............│.......................│
 ├────────────.│.│.────────────────────┤
 │.............│.│.....................│
 ├────────.│.│.│.│.────────────────────┤
 │.........│.│.│.│.....................│
 └─────────┴─┴─┴─┴─────────────────────┘
 

random

public final GrowingTreeMazeGenerator.ChoosingMethod random

Produces chaotic, jumbled spans of corridors, often with dead-ends, that are similar to those produced by Prim's algorithm. This works well when mixed with newest using mix(ChoosingMethod, double, ChoosingMethod, double), and not as well when mixed with oldest.
Example:

 ┌─────────────┬───────────┬───────────┐
 │.............│...........│...........│
 ├─┬─┬─┬────.┌─┘.┌─┐.──┐.──┤.──┐.──┐.│.│
 │.│.│.│.....│...│.│...│...│...│...│.│.│
 │.│.│.└─┬──.│.┌─┘.└─┐.└─┬─┘.──┴───┤.│.│
 │.│.│...│...│.│.....│...│.........│.│.│
 │.│.└─┐.└─┐.│.│.┌─┬─┤.┌─┤.──┐.────┴─┼─┤
 │.....│...│.....│.│.│.│.│...│.......│.│
 ├────.├──.└──.──┘.│.└─┘.│.──┴─┐.│.──┘.│
 │.....│...........│...........│.│.....│
 ├────.└──.│.│.│.──┘.──────────┴─┴─┐.──┤
 │.........│.│.│...................│...│
 ├──────.│.│.│.│.────────────────┐.└─┬─┤
 │.......│.│.│.│.................│...│.│
 ├────.│.│.│.│.├─┬─┐.│.│.│.──┐.──┴───┘.│
 │.....│.│.│.│.│.│.│.│.│.│...│.........│
 │.┌──.├─┴─┴─┘.│.│.└─┴─┴─┴─┐.└─┐.│.│.│.│
 │.│...│...................│...│.│.│.│.│
 └─┴───┴───────────────────┴───┴─┴─┴─┴─┘
 

Constructor Detail

GrowingTreeMazeGenerator

public GrowingTreeMazeGenerator(int width,
                                int height)

GrowingTreeMazeGenerator

public GrowingTreeMazeGenerator(int width,
                                int height,
                                IRNG rng)

Method Detail

getDungeon

public char[][] getDungeon()

Gets the most recently-produced dungeon as a 2D char array, usually produced by calling generate() or some similar method present in a specific implementation. This normally passes a direct reference and not a copy, so you can normally modify the returned array to propagate changes back into this IDungeonGenerator.

Specified by:

getDungeon in interface IDungeonGenerator

Returns:

the most recently-produced dungeon/map as a 2D char array

generate

public char[][] generate()

Builds and returns a 2D char array maze by using newest with generate(ChoosingMethod).

Specified by:

generate in interface IDungeonGenerator

Returns:

dungeon, after filling it with a maze

generate

public char[][] generate(GrowingTreeMazeGenerator.ChoosingMethod choosing)

Builds and returns a 2D char array maze using the provided chooser method object. The most maze-like dungeons use newest, the least maze-like use oldest, and the most jumbled use random or a mix of others using mix(ChoosingMethod, double, ChoosingMethod, double).

Parameters:

choosing - the callback object for making the split decision

Returns:

dungeon, after filling it with a maze

mix

public GrowingTreeMazeGenerator.ChoosingMethod mix(GrowingTreeMazeGenerator.ChoosingMethod methodA,
                                                   double chanceA,
                                                   GrowingTreeMazeGenerator.ChoosingMethod methodB,
                                                   double chanceB)

Mixes two ChoosingMethod values, like newest and random, given a weight for each, and produces a new ChoosingMethod that randomly (respecting weight) picks one of those ChoosingMethods each time it is used.

Parameters:

methodA - the first ChoosingMethod to mix; must not be null

chanceA - the weight to favor choosing methodA

methodB - the second ChoosingMethod to mix; must not be null

chanceB - the weight to favor choosing methodB

Returns:

a ChoosingMethod that randomly picks between methodA and methodB each time it is used