alchemist/it.unibo.alchemist.model.physics/PhysicsEnvironment

PhysicsEnvironment

interface PhysicsEnvironment<T, P : Position<P>, Vector<P>, A : Transformation<P>, F : GeometricShapeFactory<P, A>> : EuclideanEnvironment<T, P>

An environment supporting physics and nodes shapes. Note: due to the high number of parameters it's highly recommended not to use this interface directly, but to create an apposite interface extending this one instead.

Parameters

factory of shapes compatible with this environment

Inheritors

Physics2DEnvironment

PhysicsEnvironmentWithObstacles

Properties

open val origin: P

abstract val shapeFactory: F

A factory of shapes compatible with this environment.

Functions

addGlobalReaction

abstract fun addGlobalReaction(p0: GlobalReaction<T>)

abstract fun addLayer(p0: Molecule, p1: Layer<T, P>)

abstract fun addNode(p0: Node<T>, p1: P): Boolean

abstract fun addTerminator(p0: Predicate<Environment<T, P>>)

farthestPositionReachable

abstract fun farthestPositionReachable(node: Node<T>, desiredPosition: P, hitboxRadius: Double = getShape(node).radius): P

Computes the farthest position reachable by a node towards a desiredPosition, avoiding node overlapping. If no node is located in between, desiredPosition is returned. Otherwise, the first position where the node collides with someone else is returned. For collision purposes, hitboxes are used: each node is given a circular hitbox of radius equal to its shape's radius (shapeless nodes can't cause overlapping). The client can specify a different radius for the hitbox of the moving node.

open fun forEach(p0: Consumer<in Node<T>>)

abstract fun getDimensions(): Int

getDistanceBetweenNodes

abstract fun getDistanceBetweenNodes(p0: Node<T>, p1: Node<T>): Double

getGlobalReactions

abstract fun getGlobalReactions(): ListSet<GlobalReaction<T>>

abstract fun getHeading(node: Node<T>): P

Gets the heading of a node as a direction vector.

@Nonnull

abstract fun getIncarnation(): Incarnation<T, P>

abstract fun getLayer(p0: Molecule): Optional<Layer<T, P>>

abstract fun getLayers(): ListSet<Layer<T, P>>

abstract fun getLinkingRule(): LinkingRule<T, P>

getNeighborhood

abstract fun getNeighborhood(p0: Node<T>): Neighborhood<T>

abstract fun getNodeByID(p0: Int): Node<T>

abstract fun getNodeCount(): Int

abstract fun getNodes(): ListSet<Node<T>>

abstract fun getNodesWithin(shape: Shape<P, A>): List<Node<T>>

Gets all nodes whose shape.intersect is true for the given shape.

getNodesWithinRange

abstract fun getNodesWithinRange(p0: P, p1: Double): ListSet<Node<T>>

abstract fun getNodesWithinRange(p0: Node<T>, p1: Double): ListSet<Node<T>>

abstract fun getOffset(): DoubleArray

@Nonnull

abstract fun getPosition(p0: Node<T>): P

abstract fun getShape(node: Node<T>): Shape<P, A>

Gets the shape of a node relatively to its position and heading in the environment.

abstract fun getSimulation(): Simulation<T, P>

abstract fun getSize(): DoubleArray

getSizeInDistanceUnits

abstract fun getSizeInDistanceUnits(): DoubleArray

abstract fun isTerminated(): Boolean

abstract operator override fun iterator(): MutableIterator<Node<T>>

abstract fun makePosition(vararg p0: Number): P

abstract fun makePosition(vararg coordinates: Double): P

open fun moveNode(node: Node<T>, direction: P)

moveNodeToPosition

@Nonnull

abstract fun moveNodeToPosition(@Nonnull p0: Node<T>, @Nonnull p1: P)

fun <R> Iterable<R>.randomElement(randomGenerator: RandomGenerator): R

Returns a random element of the Iterable using the provided randomGenerator.

removeGlobalReaction

abstract fun removeGlobalReaction(p0: GlobalReaction<T>)

abstract fun removeNode(p0: Node<T>)

abstract fun setHeading(node: Node<T>, direction: P)

Sets the heading of a node.

abstract fun setLinkingRule(p0: LinkingRule<T, P>)

abstract fun setSimulation(p0: Simulation<T, P>)

fun <R> Iterable<R>.shuffled(randomGenerator: RandomGenerator): Iterable<R>

Fisher–Yates shuffle algorithm using a RandomGenerator. More information on Wikipedia.

open fun spliterator(): Spliterator<Node<T>>

subscriptionMonitor

fun <T, P : Position<out P>> Environment<T, P>.subscriptionMonitor(): EnvironmentSubscriptionMonitor<T, P>

Returns the EnvironmentSubscriptionMonitor of this Environment.

toGraphQLEnvironmentSurrogate

fun <T, P : Position<out P>> Environment<T, P>.toGraphQLEnvironmentSurrogate(): EnvironmentSurrogate<T, P>

Converts an Environment to a EnvironmentSurrogate.