src/mtspace.h

   1 /*!
   2  * \file src/mtspace.h
   3  *
   4  * \brief Prototypes for "empty space" routines (needed for via-space
   5  * tracking in the auto-router.
   6  *
   7  * mtspace data structures are built on r-trees.
   8  *
   9  * This file, mtspace.h, was written and is
  10  *
  11  * Copyright (c) 2001 C. Scott Ananian.
  12  *
  13  * <hr>
  14  *
  15  * <h1><b>Copyright.</b></h1>\n
  16  *
  17  * PCB, interactive printed circuit board design
  18  *
  19  * Copyright (C) 1994,1995,1996 Thomas Nau
  20  *
  21  * Copyright (C) 1998,1999,2000,2001 harry eaton
  22  *
  23  * This program is free software; you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation; either version 2 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program; if not, write to the Free Software
  35  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  36  *
  37  * Contact addresses for paper mail and Email:
  38  *
  39  * harry eaton, 6697 Buttonhole Ct, Columbia, MD 21044 USA
  40  *
  41  * haceaton@aplcomm.jhuapl.edu
  42  *
  43  */
  44
  45 #ifndef PCB_MTSPACE_H
  46 #define PCB_MTSPACE_H
  47
  48 #include "global.h"
  49 #include "vector.h"             /* for vector_t in mtspace_query_rect prototype */
  50
  51 typedef struct mtspace mtspace_t;
  52 typedef enum
  53 { FIXED, ODD, EVEN } mtspace_type_t;
  54 typedef struct vetting vetting_t;
  55
  56 mtspace_t *mtspace_create (void);
  57 void mtspace_destroy (mtspace_t ** mtspacep);
  58
  59 /* -- mutation -- */
  60
  61 void mtspace_add (mtspace_t * mtspace,
  62                   const BoxType * box, mtspace_type_t which, Coord
  63                   keepaway);
  64 void mtspace_remove (mtspace_t * mtspace,
  65                      const BoxType * box, mtspace_type_t which,
  66                      Coord keepaway);
  67
  68
  69 vetting_t *mtspace_query_rect (mtspace_t * mtspace, const BoxType * region,
  70                                Coord radius, Coord keepaway,
  71                                vetting_t * work,
  72                                vector_t * free_space_vec,
  73                                vector_t * lo_conflict_space_vec,
  74                                vector_t * hi_conflict_space_vec,
  75                                bool is_odd, bool with_conflicts,
  76                                CheapPointType *desired);
  77
  78 void mtsFreeWork (vetting_t **);
  79 int mtsBoxCount (vetting_t *);
  80
  81 #endif /* ! PCB_MTSPACE_H */