auto_layout_gen.py

# Copyright 2017 Integrity Software and Games, LLC
#
# ##### BEGIN GPL LICENSE BLOCK ######
# This file is part of UltiMaze.
#
# UltiMaze is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# UltiMaze is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with UltiMaze.  If not, see <http://www.gnu.org/licenses/>.
# ##### END GPL LICENSE BLOCK #####

"""
Generates maze layout.

Available Functions:
    add_loops - Adds the ability to walk in circles by removing walls
    make_list_maze - Constructs a python list maze based on maze gen settings
"""

import random

import bpy
from . import maze_tools
from .addon_name import get_addon_name


def add_loops(maze):
    """Adds the ability to walk in circles by removing walls.

    Args:
        maze - python list in the format:
            [[(space in maze - x, y), is path, is walkable, active path],
            [(space in maze - x, y), is path, is walkable, active path], ...]

    Returns:
        updated maze
    """
    chance = bpy.context.scene.mg.loops_chance
    for row in range(maze.width):
        for column in range(maze.height):
            directions = maze.find_touching_path_dirs(row, column)
            if directions == ['N', 'S'] or directions == ['W', 'E']:
                random_num = random.randint(1, chance)
                if random_num == 1:
                    maze.make_path(row, column)
    return maze


def make_list_maze():
    """Constructs a python list maze based on maze gen settings.

    Returns:
        maze - python list in the format:
            [[(space in maze - x, y), is path],
            [(space in maze - x, y), is path], ...]
    """
    scene = bpy.context.scene
    mg = scene.mg
    x_dim = mg.mg_width
    y_dim = mg.mg_height
    debug = bpy.context.user_preferences.addons[get_addon_name()].preferences.debug_mode

    if mg.algorithm == 'BREADTH_FIRST':
        m = maze_tools.BreadthFirstMaze(debug=debug,
                                        width=x_dim,
                                        height=y_dim,
                                        bias_direction=mg.bias_direction,
                                        bias=mg.bias)

    elif mg.algorithm == 'DEPTH_FIRST':
        m = maze_tools.DepthFirstMaze(debug=debug,
                                      width=x_dim,
                                      height=y_dim,
                                      bias_direction=mg.bias_direction,
                                      bias=mg.bias)

    elif mg.algorithm == 'PRIMS':
        m = maze_tools.PrimsMaze(debug=debug,
                                 width=x_dim,
                                 height=y_dim,
                                 bias_direction=mg.bias_direction,
                                 bias=mg.bias)

    elif mg.algorithm == 'BINARY_TREE':
        m = maze_tools.BinaryTreeMaze(debug=debug,
                                      width=x_dim,
                                      height=y_dim,
                                      directions=mg.binary_dir,
                                      tileable=mg.tileable)

    elif mg.algorithm == 'KRUSKALS':
        m = maze_tools.KruskalsMaze(debug=debug,
                                    width=x_dim,
                                    height=y_dim)

    elif mg.algorithm == 'ELLERS':
        m = maze_tools.EllersMaze(debug=debug,
                                  width=x_dim,
                                  height=y_dim,
                                  bias=mg.bias)

    maze = m.get()

    return maze