it.unibo.alchemist.model.interfaces.Obstacle.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemist-interfaces Show documentation

Interfaces of core and model components of Alchemist

There is a newer version: 20.0.1

/*
 * Copyright (C) 2010-2020, Danilo Pianini and contributors
 * listed in the main project's alchemist/build.gradle.kts file.
 *
 * This file is part of Alchemist, and is distributed under the terms of the
 * GNU General Public License, with a linking exception,
 * as described in the file LICENSE in the Alchemist distribution's top directory.
 */

package it.unibo.alchemist.model.interfaces

import it.unibo.alchemist.model.interfaces.geometry.Vector
import java.io.Serializable

/**
 * A generic obstacle in a vector space.
 *
 * @param V the vector type for the space in which this obstacle is placed.
 */
interface Obstacle> : Serializable {

    /**
     * The id for this obstacle.
     */
    val id: Int

    /**
     * Given a vector (starting point and end point) representing a requested
     * move, this method computes a new end point, representing a cut version of
     * the initial vector, modified in such a way that the end point is outside
     * the obstacle.
     *
     * @param start
     * starting point of the vector
     * @param end
     * ending point of the vector
     * @return the intersection point between the vector and the obstacle nearest
     * to the vector's starting point.
     */
    fun next(start: V, end: V): V

    /**
     * Given a vector (represented as a starting point and an end point), computes
     * the intersection point between the vector and the obstacle nearest to the
     * vector's starting point.
     *
     * @param start
     * starting point of the vector
     * @param end
     * ending point of the vector
     * @return the intersection point between the vector and the rectangle
     * nearest to the vector's starting point
     */
    fun nearestIntersection(start: V, end: V): V
}