src/net/habraun/sd/BroadPhase.scala

   1 /*
   2         Copyright (c) 2009 Hanno Braun <hanno@habraun.net>
   3
   4         Licensed under the Apache License, Version 2.0 (the "License");
   5         you may not use this file except in compliance with the License.
   6         You may obtain a copy of the License at
   7
   8                 http://www.apache.org/licenses/LICENSE-2.0
   9
  10         Unless required by applicable law or agreed to in writing, software
  11         distributed under the License is distributed on an "AS IS" BASIS,
  12         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13         See the License for the specific language governing permissions and
  14         limitations under the License.
  15 */
  16
  17
  18
  19 package net.habraun.sd
  20
  21
  22
  23 /**
  24  * The broad phase is the first of two phases of collision detection.
  25  * It is responsible for doing a rough and cheap test, determining what bodies _could_ collide, thus reducing
  26  * the number of body pairs the second phase (narrow phase) has to test.
  27  */
  28
  29 trait BroadPhase {
  30
  31         /**
  32          * Determines which of the given bodies could potentially collide.
  33          * Returns a list of body pairs that should be further tested by the narrow phase. The list of body pairs
  34          * must not contain duplicates.
  35          */
  36
  37         def detectPossibleCollisions(bodies: List[Body]): List[(Body, Body)]
  38 }