net.algart.model3d.common.movement.model
Interface InteractionRule

All Known Subinterfaces:

SymmetricInteractionRule

All Known Implementing Classes:

EarthGravitationRule, ElasticBallByBunkerWallInteractionRule, ElasticBallsInteractionRule, PhysicalMediumResistanceRule

public interface InteractionRule

Abstract physical interaction, which can be described by Newton's laws. It is supposed that the interaction is fully specified by 3D vector of the force, by which one item (byItem) acts to the other (toItem). So, this interaction does not describe any object rotations: it is applicable only for point or spherical particles.

AlgART Laboratory 2010

Since:

JDK 1.5

Version:

1.0

Author:

Daniel Alievsky

isApplicable

boolean isApplicable(Item toItem,
                     Item byItem)

Checks whether this interaction type is applicable to the given items. If this method returns false, there is a guarantee that calculateForce(double[], Item, Item, double) method fills its result (first 3 elements of resultXYZ array) by 0.0. If this method returns true, then with high probability calculateForce(double[], Item, Item, double) method returns a non-zero force.

The arguments of this method can be null; in this case, this method returns false.

Parameters:

toItem - the item to which byItem acts; can be null, then this method returns false.

byItem - the acting item; can be null, then this method returns false.

Returns:

true if this interaction type can be used for this pair; false if byItem cannot act to toItem.

calculateForce

boolean calculateForce(double[] resultXYZ,
                       Item toItem,
                       Item byItem,
                       double time)

Calculates the force F=(F_x,F_y,F_z) of the action of byItem to toItem and returns it in first 3 elements of resultXYZ array (x-component F_x resultXYZ[0], y-component F_y in resultXYZ[1], z-component F_z in resultXYZ[2]). Returns false if the force is zero. Usually returns true is the force is non-zero, by it is allowed to return true even if it is zero.

This method must work correctly (return false and zero resulting force) also in all situations, when isApplicable(Item, Item) method returns false.

Parameters:

resultXYZ - resulting force (x-component in resultXYZ[0], y-component in resultXYZ[1], z-component in resultXYZ[2]).

toItem - the item to which byItem acts.

byItem - the acting item.

time - the current time (some interaction can change behaviour in time).

Returns:

if false, there is a guarantee that returned force is zero.

Throws:

java.lang.NullPointerException - if one of the arguments is null.

java.lang.IndexOutOfBoundsException - if result.length<3; it is not checked at the very beginning, so, in a case of this exception, some elements of result array can be still filled (the method is non-atomic regarding this failure).