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

Go to download
package us.ihmc.euclid.referenceFrame.interfaces;

import us.ihmc.euclid.referenceFrame.ReferenceFrame;
import us.ihmc.euclid.tuple4D.interfaces.Vector4DReadOnly;

/**
 * Read-only interface for a 4D vector expressed in a given reference frame.
 * 
 * In addition to representing a {@link Vector4DReadOnly}, a {@link ReferenceFrame} is associated to
 * a {@code FrameVector4DReadOnly}. This allows, for instance, to enforce, at runtime, that
 * operations on vectors occur in the same coordinate system.
 * 
 * 
 * Because a {@code FrameVector4DReadOnly} extends {@code Vector4DReadOnly}, it is compatible with
 * methods only requiring {@code Vector4DReadOnly}. However, these methods do NOT assert that the
 * operation occur in the proper coordinate system. Use this feature carefully and always prefer
 * using methods requiring {@code FrameVector4DReadOnly}.
 * 
 */
public interface FrameVector4DReadOnly extends Vector4DReadOnly, FrameTuple4DReadOnly
{
}