org.apache.commons.geometry.euclidean.twod.Linecastable2D Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-geometry-euclidean Show documentation
Show all versions of commons-geometry-euclidean Show documentation
Geometric primitives for euclidean space.
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.commons.geometry.euclidean.twod;
import java.util.List;
/** Interface for objects that support linecast operations in Euclidean 2D space.
*
*
* Linecasting is a process that takes a line or convex line subset and intersects it with
* the boundaries of a region. This is similar to
* raycasting used
* for collision detection with the exception that the intersecting element can be a
* line or convex line subset and not just a ray.
*
*/
public interface Linecastable2D {
/** Intersect the given line against the boundaries in this instance, returning a
* list of all intersections in order of increasing position along the line. An empty
* list is returned if no intersections are discovered.
* @param line line the line to intersect
* @return a list of computed intersections in order of increasing position
* along the line
*/
default List linecast(final Line line) {
return linecast(line.span());
}
/** Intersect the given line subset against the boundaries in this instance, returning
* a list of all intersections in order of increasing position along the line. An empty
* list is returned if no intersections are discovered.
* @param subset line subset to intersect
* @return a list of computed intersections in order of increasing position
* along the line
*/
List linecast(LineConvexSubset subset);
/** Intersect the given line against the boundaries in this instance, returning
* the first intersection found when traveling in the direction of the line from
* infinity.
* @param line the line to intersect
* @return the first intersection found or null if no intersection
* is found
*/
default LinecastPoint2D linecastFirst(final Line line) {
return linecastFirst(line.span());
}
/** Intersect the given line subset against the boundaries in this instance, returning
* the first intersection found when traveling in the direction of the line subset
* from its start location.
* @param subset line subset to intersect
* @return the first intersection found or null if no intersection
* is found
*/
LinecastPoint2D linecastFirst(LineConvexSubset subset);
}