it.unibo.alchemist.model.physics.properties.PhysicalPedestrian.kt Maven / Gradle / Ivy
Show all versions of alchemist-physics Show documentation
/*
* Copyright (C) 2010-2023, Danilo Pianini and contributors
* listed, for each module, in the respective subproject's 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.physics.properties
import it.unibo.alchemist.model.Node
import it.unibo.alchemist.model.Position
import it.unibo.alchemist.model.geometry.GeometricShapeFactory
import it.unibo.alchemist.model.geometry.Shape
import it.unibo.alchemist.model.geometry.Transformation
import it.unibo.alchemist.model.geometry.Vector
/**
* A pedestrian's capability to experience physical forces.
*/
interface PhysicalPedestrian : PhysicalProperty
where P : Position, P : Vector
,
A : Transformation
,
F : GeometricShapeFactory {
/**
* Whether the pedestrian has fallen and it is thus an obstacle.
*/
val isFallen: Boolean
/**
* Turn this [node] into a fallen pedestrian if it [shouldFall].
*/
fun checkAndPossiblyFall()
/**
* Determines if this pedestrian subject to [pushingForces] should fall.
* According to the work of [Pelechano et al](https://bit.ly/3e3C7Tb)
* this should happen when the majority of pushing forces affecting one individual are
* approximately in the same direction and the sum of forces have a magnitude high
* enough to make it lose equilibrium.
*/
fun shouldFall(pushingForces: List): Boolean
/**
* The comfort ray of this pedestrian, this is added to the radius of its [Shape] to obtain the [comfortArea].
*/
val comfortRay: Double
/**
* The comfort area of this pedestrian, it's a circle of radius [Shape].radius + [comfortRay].
*/
val comfortArea: Shape
/**
* Rectangle of influence. When a pedestrian enters this area, the node could experience a tangential
* avoidance force. See [avoid].
*/
val rectangleOfInfluence: Shape
/**
* Computes the repulsion force caused by a node that entered the [comfortArea]. This is derived from the work
* of [Pelechano et al](https://bit.ly/3e3C7Tb).
*/
fun repulse(other: Node): P
/**
* Computes the repulsion force caused by a node that entered the [rectangleOfInfluence]. This is derived from
* the work of [Pelechano et al](https://bit.ly/3e3C7Tb).
*/
fun avoid(other: Node): P
/**
* Computes the total repulsion force this node is subject to.
*/
fun repulsionForces(): List
/**
* Computes the total avoidance force this node is subject to.
*/
fun avoidanceForces(): List
/**
* Computes the avoidance force from a fallen pedestrian.
*/
fun fallenAgentAvoidanceForces(): List
/**
* Adds a listener to be called when [node] falls.
*/
fun onFall(listener: (Node) -> Unit)
}