OverlappingPairCache.java

/*
 * Java port of Bullet (c) 2008 Martin Dvorak <jezek2@advel.cz>
 *
 * Bullet Continuous Collision Detection and Physics Library
 * Copyright (c) 2003-2008 Erwin Coumans  http://www.bulletphysics.com/
 *
 * This software is provided 'as-is', without any express or implied warranty.
 * In no event will the authors be held liable for any damages arising from
 * the use of this software.
 * 
 * Permission is granted to anyone to use this software for any purpose, 
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 * 
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */

package com.bulletphysics.collision.broadphase;

import com.bulletphysics.util.ObjectArrayList;

/**
 * OverlappingPairCache provides an interface for overlapping pair management (add,
 * remove, storage), used by the {@link BroadphaseInterface} broadphases.
 *
 * @author jezek2
 */
public abstract class OverlappingPairCache extends OverlappingPairCallback {

	public abstract ObjectArrayList<BroadphasePair> getOverlappingPairArray();
	
	public abstract void cleanOverlappingPair(BroadphasePair pair, Dispatcher dispatcher);
	
	public abstract int getNumOverlappingPairs();
	
	public abstract void cleanProxyFromPairs(BroadphaseProxy proxy, Dispatcher dispatcher);
	
	public abstract void setOverlapFilterCallback(OverlapFilterCallback overlapFilterCallback);
	
	public abstract void processAllOverlappingPairs(OverlapCallback callback, Dispatcher dispatcher);
	
	public abstract BroadphasePair findPair(BroadphaseProxy proxy0, BroadphaseProxy proxy1);
	
	public abstract boolean hasDeferredRemoval();

	public abstract void setInternalGhostPairCallback(OverlappingPairCallback ghostPairCallback);
	
}