fr.cnes.sirius.patrius.frames

Class TranslatedFrame

java.lang.Object

fr.cnes.sirius.patrius.frames.Frame

fr.cnes.sirius.patrius.frames.TranslatedFrame

All Implemented Interfaces:

PVCoordinatesProvider, Serializable

public class TranslatedFrame
extends Frame

Frame which differs from a reference frame by translation provided by a PVCoordinatesProvider. Provided PVCoordinatesProvider represents the center of this frame.
Typically this can be used to translate a frame, with keeping the axis aligned with parent frame.

Since:

4.8

Author:

Emmanuel Bignon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TranslatedFrame(Frame parent, PVCoordinatesProvider center, String name) Constructor.

Method Summary

Modifier and Type	Method and Description
PVCoordinatesProvider	getCenter() Returns the center of this frame.

Methods inherited from class fr.cnes.sirius.patrius.frames.Frame

getAncestor, getDepth, getFirstCommonPseudoInertialAncestor, getFirstPseudoInertialAncestor, getFrozenFrame, getName, getNativeFrame, getParent, getPVCoordinates, getRoot, getTransformJacobian, getTransformProvider, getTransformTo, getTransformTo, getTransformTo, getTransformTo, isChildOf, isPseudoInertial, setName, setReferential, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslatedFrame

public TranslatedFrame(Frame parent,
                       PVCoordinatesProvider center,
                       String name)

Constructor.

Parameters:

parent - parent frame (must be non-null)

center - center of this frame

name - name of the frame

Throws:

IllegalArgumentException - if the parent frame is null

Method Detail

getCenter

public PVCoordinatesProvider getCenter()

Returns the center of this frame.

Returns:

the center of this frame