freerouting/src/main/java/eu/mihosoft/freerouting/autoroute/ExpansionDrill.java

/*
 *  Copyright (C) 2014  Alfons Wirtz
 *   website www.freerouting.net
 *
 *   This program 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.
 *
 *   This program 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 at <http://www.gnu.org/licenses/> 
 *   for more details.
 *
 * ExpansionDrill.java
 *
 * Created on 19. April 2004, 08:00
 */
package eu.mihosoft.freerouting.autoroute;

import eu.mihosoft.freerouting.geometry.planar.Point;
import eu.mihosoft.freerouting.geometry.planar.TileShape;

import java.util.Collection;
import java.util.Iterator;

/**
 * Layer change expansion object in the maze search algorithm.
 *
 * @author  alfons
 */
public class ExpansionDrill implements ExpandableObject
{

    /** Creates a new instance of Drill */
    public ExpansionDrill(TileShape p_shape, Point p_location, int p_first_layer, int p_last_layer)
    {
        shape = p_shape;
        location = p_location;
        first_layer = p_first_layer;
        last_layer = p_last_layer;
        int layer_count = p_last_layer - p_first_layer + 1;
        room_arr = new CompleteExpansionRoom[layer_count];
        maze_search_info_arr = new MazeSearchElement[layer_count];
        for (int i = 0; i < maze_search_info_arr.length; ++i)
        {
            maze_search_info_arr[i] = new MazeSearchElement();
        }
    }

    /**
     * Looks for the expansion room of this drill on each layer.
     * Creates a CompleteFreeSpaceExpansionRoom, if no expansion room is found.
     * Returns false, if that was not possible because of an obstacle at this.location
     * on some layer in the compensated search tree.
     */
    public boolean calculate_expansion_rooms(AutorouteEngine p_autoroute_engine)
    {
        TileShape search_shape = TileShape.get_instance(location);
        Collection<eu.mihosoft.freerouting.board.SearchTreeObject> overlaps =
                p_autoroute_engine.autoroute_search_tree.overlapping_objects(search_shape, -1);
        for (int i = this.first_layer; i <= this.last_layer; ++i)
        {
            CompleteExpansionRoom found_room = null;
            Iterator<eu.mihosoft.freerouting.board.SearchTreeObject> it = overlaps.iterator();
            while (it.hasNext())
            {
                eu.mihosoft.freerouting.board.SearchTreeObject curr_ob = it.next();
                if (!(curr_ob instanceof CompleteExpansionRoom))
                {
                    it.remove();
                    continue;
                }
                CompleteExpansionRoom curr_room = (CompleteExpansionRoom) curr_ob;
                if (curr_room.get_layer() == i)
                {
                    found_room = curr_room;
                    it.remove();
                    break;
                }
            }
            if (found_room == null)
            {
                // create a new expansion romm on this layer
                IncompleteFreeSpaceExpansionRoom new_incomplete_room =
                        new IncompleteFreeSpaceExpansionRoom(null, i, search_shape);
                Collection<CompleteFreeSpaceExpansionRoom> new_rooms = p_autoroute_engine.complete_expansion_room(new_incomplete_room);
                if (new_rooms.size() != 1)
                {
                    // the size may be 0 because of an obstacle in the compensated tree at this.location
                    return false;
                }
                Iterator<CompleteFreeSpaceExpansionRoom> it2 = new_rooms.iterator();
                if (it2.hasNext())
                {
                    found_room = it2.next();
                }
            }
            this.room_arr[i - first_layer] = found_room;
        }
        return true;
    }

    public TileShape get_shape()
    {
        return this.shape;
    }

    public int get_dimension()
    {
        return 2;
    }

    public CompleteExpansionRoom other_room(CompleteExpansionRoom p_room)
    {
        return null;
    }

    public int maze_search_element_count()
    {
        return this.maze_search_info_arr.length;
    }

    public MazeSearchElement get_maze_search_element(int p_no)
    {
        return this.maze_search_info_arr[p_no];
    }

    public void reset()
    {
        for (MazeSearchElement curr_info : maze_search_info_arr)
        {
            curr_info.reset();
        }
    }

    /*
     * Test draw of the the shape of this drill.
     */
    public void draw(java.awt.Graphics p_graphics,
                     eu.mihosoft.freerouting.boardgraphics.GraphicsContext p_graphics_context, double p_intensity)
    {
        java.awt.Color draw_color = p_graphics_context.get_hilight_color();
        p_graphics_context.fill_area(this.shape, p_graphics, draw_color, p_intensity);
        p_graphics_context.draw_boundary(this.shape, 0, draw_color, p_graphics, 1);
    }
    private final MazeSearchElement[] maze_search_info_arr;
    /** The shape of the drill. */
    private final TileShape shape;
    /** The location, where the drill is checked. */
    public final Point location;
    /** The first layer of the drill */
    public final int first_layer;
    /** The last layer of the drill */
    public final int last_layer;
    /** Array of dimension last_layer - first_layer + 1. */
    public final CompleteExpansionRoom[] room_arr;
}