/*******************************************************************************
* Copyright 2011 See AUTHORS file.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
******************************************************************************/
package com.badlogic.gdx.physics.box2d;
import com.badlogic.gdx.math.Vector2;
/**
* Callback class for ray casts.
* @see World#rayCast(RayCastCallback, Vector2, Vector2)
* @author mzechner
*
*/
public interface RayCastCallback {
/** Called for each fixture found in the query. You control how the ray cast
proceeds by returning a float:
return -1: ignore this fixture and continue
return 0: terminate the ray cast
return fraction: clip the ray to this point
return 1: don't clip the ray and continue
@param fixture the fixture hit by the ray
@param point the point of initial intersection
@param normal the normal vector at the point of intersection
@return -1 to filter, 0 to terminate, fraction to clip the ray for
closest hit, 1 to continue
**/
public float reportRayFixture(Fixture fixture, Vector2 point, Vector2 normal, float fraction);
}