dzzd
Interface IProgress

All Known Subinterfaces:

ICamera3D, ILight3D, IMaterial, IMesh3D, IScene3DObject, ISceneObject, ISolidSphere3D, ITexture, IURLTexture

public interface IProgress

Used for accessing to a Progress.
Progress give information about the current state of an object and transition between differents states.

Since:

1.0

Version:

1.0, 01/01/04

Author:

Bruno Augier

See Also:

IMesh3D, IScene3D, DzzD

Method Summary

int	getCurrentState() Gets current state.
int	getNextState() Gets next state.
int	getProgress() Gets progress between current state and next state.
boolean	isStateReached(int state) Gets current transistion state.
void	setProgress(int currentState, int nextState, int progress) Sets progress between two states.

Method Detail

setProgress

public void setProgress(int currentState,
                        int nextState,
                        int progress)

Sets progress between two states.

Parameters:

currentState - current state

nextState - next state

progress - progress between current state and next state in percent 0-100

getProgress

public int getProgress()

Gets progress between current state and next state.

Returns:

progress between states in percent 0-100

getCurrentState

public int getCurrentState()

Gets current state.

Returns:

current state

isStateReached

public boolean isStateReached(int state)

Gets current transistion state.
A reached state means that a transition between two states is finished.

Parameters:

state - state to test for

Returns:

true if current and next state equals given state

getNextState

public int getNextState()

Gets next state.

Returns:

next state