org.gvsig.timesupport.animation

Interface TimeAnimationDataModel

All Known Implementing Classes:

TimeAnimationDataModelImpl

public interface TimeAnimationDataModel

Data model for animation. This is useful to configure the animation parameters. When the animation runs read the values of this object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCEPT
static int	CANCEL
static int	CLOSE
static int	PAUSE
static int	PLAY
static int	STOP

Method Summary

Methods

Modifier and Type	Method and Description
RelativeInstant	getEndTime() Gets the end date of the time window to visualize in each time instant.
RelativeInstant	getEndTimeWindow() Gets the end of the time window to visualize in each time instant.
RelativeInstant	getInitTime() Gets the initial date of the time window to visualize in each time instant.
RelativeInstant	getInitTimeWindow() Gets the begin of the time window to visualize in each time instant.
int	getIterations() Gets the number of iterations
int	getLoop() Gets the number of loops
RelativeInstant	getSliderPosition() Gets the slider position.
int	getSpeed() Gets the time step initial value in the text field
int[]	getStepByPartOfData() Gets an array of seven values.
int	getTimeStep() Gets the initial speed in milliseconds
int	getTimeStepScale() Returns a constant defined in TimeAnimation.
int	getWindowTime() Gets the window time.
int[]	getWindowTimeByPartOfData() Gets an array of seven values.
int	getWindowTimeScale() Returns a constant defined in TimeAnimation.
void	setIterations(int iterations) Sets the number of iterations
void	setLoop(int loop) Sets the number of loops
void	setSliderPosition(RelativeInstant position) Assigns the slider position.
void	setSpeed(int speed) Sets the speed of progress
void	setTimeInterval(RelativeInstant start, RelativeInstant end) Sets the time interval.
void	setTimeStep(int timeStep) Sets the animation speed
void	setTimeStepScale(int timeStepScale) Assigns a constant defined in TimeAnimation.
void	setTimeWindow(RelativeInstant start, RelativeInstant end) Sets the time window to visualize in each time instant.
void	setWindowTime(int windowTime) Assigns the window time.
void	setWindowTimeScale(int windowTimeScale) Assigns a constant defined in TimeAnimation.

Field Detail

PLAY

static final int PLAY

See Also:

Constant Field Values

STOP

static final int STOP

See Also:

Constant Field Values

PAUSE

static final int PAUSE

See Also:

Constant Field Values

CLOSE

static final int CLOSE

See Also:

Constant Field Values

ACCEPT

static final int ACCEPT

See Also:

Constant Field Values

CANCEL

static final int CANCEL

See Also:

Constant Field Values

Method Detail

setWindowTime

void setWindowTime(int windowTime)

Assigns the window time. The scale is the selected with the method setWindowScale.

Parameters:

windowTime - Window of time of each step

getWindowTime

int getWindowTime()

Gets the window time. The scale is the selected with the method setWindowScale.

getTimeStep

int getTimeStep()

Gets the initial speed in milliseconds

Parameters:

speed -

setTimeStep

void setTimeStep(int timeStep)

Sets the animation speed

Parameters:

speed - Speed in milliseconds

getWindowTimeScale

int getWindowTimeScale()

Returns a constant defined in TimeAnimation. This constant represents the scale of time of the window (year, month, day, ...)

Returns:

setWindowTimeScale

void setWindowTimeScale(int windowTimeScale)

Assigns a constant defined in TimeAnimation. This constant represents the scale of time of the window (year, month, day, ...)

getTimeStepScale

int getTimeStepScale()

Returns a constant defined in TimeAnimation. This constant represents the scale of time of the time step (year, month, day, ...)

Returns:

setTimeStepScale

void setTimeStepScale(int timeStepScale)

Assigns a constant defined in TimeAnimation. This constant represents the scale of time of the time step (year, month, day, ...)

getSpeed

int getSpeed()

Gets the time step initial value in the text field

Parameters:

timeStep -

setSpeed

void setSpeed(int speed)

Sets the speed of progress

Parameters:

speed -

getIterations

int getIterations()

Gets the number of iterations

Returns:

setIterations

void setIterations(int iterations)

Sets the number of iterations

Parameters:

iterations -

getLoop

int getLoop()

Gets the number of loops

Returns:

setLoop

void setLoop(int loop)

Sets the number of loops

setTimeWindow

void setTimeWindow(RelativeInstant start,
                 RelativeInstant end)

Sets the time window to visualize in each time instant. The time window is the amount of data to show in each step. At the beginning this window goes from the initial data time. When the animation has been started this window is moving along the time line.

Parameters:

start - Instant in which the animation starts

end - Instant in which the animation ends

getEndTimeWindow

RelativeInstant getEndTimeWindow()

Gets the end of the time window to visualize in each time instant. The time window is the amount of data to show in each step. At the beginning this window goes from the initial data time. When the animation has been started this window is moving along the time line.

Returns:

RelativeInstant

getInitTimeWindow

RelativeInstant getInitTimeWindow()

Gets the begin of the time window to visualize in each time instant. The time window is the amount of data to show in each step. At the beginning this window goes from the initial data time. When the animation has been started this window is moving along the time line.

Returns:

RelativeInstant

setTimeInterval

void setTimeInterval(RelativeInstant start,
                   RelativeInstant end)

Sets the time interval. The time interval contains two date. The start date is the moment in which the animation starts and in the end date the animation ends.

Parameters:

timeWindowValue -

getInitTime

RelativeInstant getInitTime()

Gets the initial date of the time window to visualize in each time instant. The time window is the amount of data to show in each step.

Returns:

RelativeInstant

getEndTime

RelativeInstant getEndTime()

Gets the end date of the time window to visualize in each time instant. The time window is the amount of data to show in each step.

Returns:

RelativeInstant

getWindowTimeByPartOfData

int[] getWindowTimeByPartOfData()

Gets an array of seven values. Each element of this array represents the number of years, months, days, hours, minutes, seconds and milliseconds of a window time.

getStepByPartOfData

int[] getStepByPartOfData()

Gets an array of seven values. Each element of this array represents the number of years, months, days, hours, minutes, seconds and milliseconds of a step.

getSliderPosition

RelativeInstant getSliderPosition()

Gets the slider position. This position is specified in real time.

Returns:

RelativeInstant

setSliderPosition

void setSliderPosition(RelativeInstant position)

Assigns the slider position. This position is specified in real time.

Parameters:

position -