org.jeospace.navigation
Interface Position

All Known Subinterfaces:

PositionControl, PositionInterpolator

All Known Implementing Classes:

DefaultPosition, NavigationControl, OrbitInterpolator, ShadowChild, ShadowParent, ShadowSibling, SphericalInterpolator

public interface Position

Defines the requirements for providing positioning data to a simulation component.

Version:

$Revision: 1.2 $

Author:

Rex Melton

See Also:

Cartesian, Polar

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 timeValue) Process any position changes for the next simulation frame.

Method Detail

updatePosition

public void updatePosition(double timeValue)

Process any position changes for the next simulation frame.

Parameters:

timeValue - the time value for which to calculate the position

enablePosition

public void enablePosition(boolean enabled)

Set the state of the object to produce updated positioning data.

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.

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.

Returns:

the positioning data in a Polar coordinate object.