agi.foundation.geometry

(agi.foundation.core-2024r3.jar)

Class VectorDisplacement

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.Vector

agi.foundation.geometry.VectorDisplacement

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

Direct Known Subclasses:

GpsLineOfSightVector, VectorApparentDisplacement, VectorRefractedDisplacement, VectorTrueDisplacement

public abstract class VectorDisplacement
extends Vector

The base class for a vector representing the directed displacement from an initial point to a final point as the two points move over time.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VectorDisplacement() Initializes a new instance.
protected	VectorDisplacement(Point initialPoint, Point finalPoint) Initializes a new instance.
protected	VectorDisplacement(VectorDisplacement existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(Vector other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(VectorDisplacement other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
Point	getFinalPoint() Gets the point which defines the ending of the displacement vector.
Point	getInitialPoint() Gets the point which defines the beginning of the displacement vector.
void	setFinalPoint(Point value) Sets the point which defines the ending of the displacement vector.
void	setInitialPoint(Point value) Sets the point which defines the beginning of the displacement vector.

Methods inherited from class agi.foundation.geometry.Vector

add, add, checkForSameDefinition, createVectorDerivative, cross, divide, divide, divide, divide, dot, getEvaluator, getEvaluator, getScalarElement, getScalarElement, getService, multiply, multiply, multiply, multiply, multiply, multiply, subtract, subtract

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VectorDisplacement

protected VectorDisplacement()

Initializes a new instance.

VectorDisplacement

protected VectorDisplacement(Point initialPoint,
                             Point finalPoint)

Initializes a new instance.

Parameters:

initialPoint - The point which defines the beginning of the displacement vector.

finalPoint - The point which defines the ending of the displacement vector.

VectorDisplacement

protected VectorDisplacement(@Nonnull
                             VectorDisplacement existingInstance,
                             @Nonnull
                             CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final boolean checkForSameDefinition(Vector other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class Vector

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(VectorDisplacement other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the VectorDisplacement.checkForSameDefinition(agi.foundation.geometry.Vector) method.

Overrides:

computeCurrentDefinitionHashCode in class Vector

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getInitialPoint

public final Point getInitialPoint()

Gets the point which defines the beginning of the displacement vector.

setInitialPoint

public final void setInitialPoint(Point value)

Sets the point which defines the beginning of the displacement vector.

getFinalPoint

public final Point getFinalPoint()

Gets the point which defines the ending of the displacement vector.

setFinalPoint

public final void setFinalPoint(Point value)

Sets the point which defines the ending of the displacement vector.