org.jeospace.navigation
Class ShadowSibling

java.lang.Object
  org.jeospace.navigation.ShadowSibling

All Implemented Interfaces:

Position

public class ShadowSibling

extends java.lang.Object

implements Position

A Position implementation that provides shadow coordinates for a sibling orbital body. Used for following (shadowing) a sibling orbiter - such as following another planet in the solar system from the Earth.

Version:

$Revision: 1.2 $

Author:

Rex Melton

See Also:

Cartesian, Polar, Length

Constructor Summary

ShadowSibling(KineticBody source, KineticBody target, Length distance)
Constructor

Method Summary

void	enablePosition(boolean enabled) Set the state of the object to produce updated positioning data.
void	get(Cartesian cartesian) Return the positioning data in the argument object.
Polar	getPolar() Return the positioning data in a Polar coordinate object.
void	updatePosition(double julianDay) Process any position changes for the next simulation frame.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShadowSibling

public ShadowSibling(KineticBody source,
                     KineticBody target,
                     Length distance)

Constructor

Parameters:

source - the body from which to calculate the shadowed position

target - the body to shadow

distance - the fixed distance from the source to place the shadow position. If distance is null, then the actual distance to the target will be used.

Method Detail

updatePosition

public void updatePosition(double julianDay)

Process any position changes for the next simulation frame.

Specified by:

updatePosition in interface Position

Parameters:

julianDay - the Julian day for which to calculate the position

enablePosition

public void enablePosition(boolean enabled)

Set the state of the object to produce updated positioning data. By default, the state of this object is initialized to true.

Specified by:

enablePosition in interface Position

Parameters:

enabled - true if the object should update it's positioning data in response to update( ) calls, false if the object should NOT update it's positioning data in response to update( ) calls.

get

public void get(Cartesian cartesian)

Return the positioning data in the argument object.

Specified by:

get in interface Position

Parameters:

cartesian - the Cartesian coordinate object to initialize with the current positioning data.

getPolar

public Polar getPolar()

Return the positioning data in a Polar coordinate object.

Specified by:

getPolar in interface Position

Returns:

the positioning data in a Polar coordinate object.