ContactFilter.java

/*
 * JBox2D - A Java Port of Erin Catto's Box2D
 * 
 * JBox2D homepage: http://jbox2d.sourceforge.net/ 
 * Box2D homepage: http://www.box2d.org
 * 
 * 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 org.jbox2d.dynamics;

import org.jbox2d.collision.shapes.Shape;

// Updated to rev 143 of b2WorldCallbacks.h/cpp
// See also DefaultContactFilter.java

/**
 * Implement this class to provide collision filtering. In other words, you can implement
 * this class if you want finer control over contact creation.
 */
public interface ContactFilter {
	/**
	 * Default contact filter, using groupIndex, maskBits and categoryBits as detailed
	 * in Box2d manual.
	 */
	public static final ContactFilter DEFAULT_FILTER = new DefaultContactFilter();

	/**
	 * Return true if contact calculations should be performed between these two shapes.
	 * <BR><BR><em>Warning</em>: for performance reasons this is only called when the AABBs begin to overlap.
	 */
	public boolean shouldCollide(Shape shape1, Shape shape2);
	
	/** Return true if the given shape should be considered for ray intersection */
	public boolean rayCollide(Object userData, Shape shape);
}