us.ihmc.euclid.referenceFrame.interfaces.FrameUnitVector2DBasics Maven / Gradle / Ivy

Go to download

package us.ihmc.euclid.referenceFrame.interfaces;

/**
 * Write and read interface for 2 dimensional unit-length vector expressed in a changeable reference
 * frame, i.e. the reference frame in which this vector is expressed can be changed.
 * 
 * This unit vector shares the same API as a regular vector 2D while ensuring it is normalized when
 * accessing directly or indirectly its individual components, i.e. when invoking either
 * {@link #getX()} or {@link #getY()}.
 * 
 * 
 * When the values of this vector are set to zero, the next time it is normalized it will be reset
 * to (1.0, 0.0).
 * 
 *
 * @author Sylvain Bertrand
 */
public interface FrameUnitVector2DBasics extends FrameVector2DBasics, FixedFrameUnitVector2DBasics
{
}