us.ihmc.euclid.interfaces

Interface GeometricallyComparable<T>

Type Parameters:

T - the final type of the geometry implementing this interface.

All Known Subinterfaces:

GeometryObject<T>

All Known Implementing Classes:

AffineTransform, AxisAngle, AxisAngle32, Matrix3D, Point2D, Point2D32, Point3D, Point3D32, Quaternion, Quaternion32, QuaternionBasedTransform, RigidBodyTransform, RotationMatrix, RotationScaleMatrix, Vector2D, Vector2D32, Vector3D, Vector3D32, Vector4D, Vector4D32

public interface GeometricallyComparable<T>

By implementing GeometricallyComparable, geometries can implement a custom comparison with the aim of evaluating the similarity between two geometries of the same type.

It is important to note the difference between this interface and EpsilonComparable, implementations of which provide a component-based comparison mostly useful to assert that for instance components properly send over a network.

Method Summary

Modifier and Type	Method and Description
boolean	geometricallyEquals(T other, double epsilon) Tests if this and other represent the same geometry to an epsilon.

Method Detail

geometricallyEquals

boolean geometricallyEquals(T other,
                            double epsilon)

Tests if this and other represent the same geometry to an epsilon.

The implementation of this test depends on the type of geometry. For instance, two points will be considered geometrically equal if they are at a distance from each other that is less or equal than epsilon.

Parameters:

other - the other geometry object to compare against this. Not modified.

epsilon - tolerance to use when comparing the two objects, usually refers to a distance.

Returns:

true if the two objects represent the same geometry, false otherwise.