it.unibo.alchemist.model.biochemistry.actions.CellMove Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of alchemist-incarnation-biochemistry Show documentation
Alchemist incarnation for biochemistry simulator
There is a newer version: 35.0.2
Show newest version
/*
 * 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.biochemistry.actions;

import it.unibo.alchemist.model.actions.AbstractMoveNode;
import it.unibo.alchemist.model.positions.Euclidean2DPosition;
import it.unibo.alchemist.model.Environment;
import it.unibo.alchemist.model.Node;
import it.unibo.alchemist.model.Reaction;
import it.unibo.alchemist.model.biochemistry.CellProperty;
import it.unibo.alchemist.model.biochemistry.CircularCellProperty;

import java.util.Objects;

/**
 * An action moving cells (Nodes with a {@link CellProperty}) in the environment.
 */
public final class CellMove extends AbstractMoveNode {

    private static final long serialVersionUID = 1L;
    private final boolean inPercent;
    private final double delta;
    private final CellProperty cell;

    /**
     * Initialize an Action that move the cell of a given space delta, which can be expressed in percent of the cell's
     * diameter or in absolute.
     * If the cell has diameter 0, the only way to express delta is absolute.
     * There's no way to decide the direction of the cell by this {@link it.unibo.alchemist.model.Action}.
     * This is inferred by the polarization vector contained in the cell.
     * 
     * @param environment the {@link Environment}
     * @param node the {@link Node} in which the {@link it.unibo.alchemist.model.Action} is contained.
     *             This can be only a CellNode.
     * @param inPercent a boolean parameter which set the way of expressing delta: if is true the cell movement will be
     *                  (delta * cellDiameter), otherwise will be simply delta. If cellDiameter is zero, this
     *                  {@link it.unibo.alchemist.model.Action} will in both cases behave like
     *                  inPercent == false.
     * @param delta the distance at which the cell will be moved.
     */
    public CellMove(
            final Environment environment,
            final Node node,
            final boolean inPercent,
            final double delta
    ) {
        super(environment, node);
        this.inPercent = inPercent;
        cell = Objects.requireNonNull(
                node.asPropertyOrNull(CellProperty.class),
                "CellMove can be setted only in cells."
        );
        if (inPercent) {
            if (cell instanceof CircularCellProperty && ((CircularCellProperty) cell).getRadius() != 0) {
                this.delta = ((CircularCellProperty) cell).getDiameter() * delta;
            } else {
                throw new IllegalArgumentException(
                        "Can't set distance in percent of the cell's diameter if cell has not a diameter"
                );
            }
        } else {
            this.delta = delta;
        }
    }

    @Override
    public CellMove cloneAction(final Node node, final Reaction reaction) {
        return new CellMove(getEnvironment(), node, inPercent, delta);
    }

    @Override
    public Euclidean2DPosition getNextPosition() {
        return new Euclidean2DPosition(
            delta * cell.getPolarizationVersor().getCoordinate(0),
            delta * cell.getPolarizationVersor().getCoordinate(1)
        );
    }

    @Override
    public void execute() {
        super.execute();
        cell.setPolarizationVersor(getEnvironment().makePosition(0, 0));
    }
}