src/com/jme/bounding/CollisionTreeController.java

   1 /*
   2  * Copyright (c) 2003-2009 jMonkeyEngine
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  * * Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  *
  12  * * Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in the
  14  *   documentation and/or other materials provided with the distribution.
  15  *
  16  * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
  17  *   may be used to endorse or promote products derived from this software
  18  *   without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 package com.jme.bounding;
  34
  35 import java.util.List;
  36 import java.util.Map;
  37
  38 import com.jme.scene.TriMesh;
  39
  40 /**
  41  * CollisionTreeController defines an interface for determining which
  42  * collision tree to remove from a supplied cache. The desired size is
  43  * given for the controller to attempt to reduce the cache to, as well as
  44  * a list of protected elements that should <b>not</b> be removed from the
  45  * cache.
  46  * @author Mark Powell
  47  *
  48  */
  49 public interface CollisionTreeController {
  50         /**
  51          * clean will reduce the size of cache to the provided desiredSize. The
  52          * protectedList defines elements that should not be removed from the
  53          * cache.
  54          * @param cache the cache to reduce.
  55          * @param protectedList the list of elements to not remove.
  56          * @param desiredSize the desiredSize of the final cache.
  57          */
  58         void clean(Map<TriMesh, CollisionTree> cache,
  59                         List<TriMesh> protectedList, int desiredSize);
  60 }