org.xith3d.resources
Interface LoadingScreenUpdater

All Known Implementing Classes:
DelayedLoadingScreenUpdater, LoadingScreen

public interface LoadingScreenUpdater

This interface is implemented by LoadingScreen. It makes LoadingScreen independent of the actual implementation. So just use this interface as parameter type in your game's loading methods.

See Also:
LoadingScreen

Method Summary
 void init(int maxValue, java.lang.String caption, java.lang.String backgroundTexture)
          Initializes the progress, caption and background image.
 void init(int maxValue, java.lang.String caption, Texture2D backgroundTexture)
          Initializes the progress, caption and background image.
 void update()
          Updates the progress value incremented by one and leaves the caption unchanged.
 void update(int incValue)
          Updates the progress value and leaves the caption unchanged.
 void update(int incValue, java.lang.String caption)
          Updates the progress value and caption.
 void update(int incValue, java.lang.String caption, java.lang.String backgroundTexture)
          Updates the progress value, caption and background image.
 void update(int incValue, java.lang.String caption, Texture2D backgroundTexture)
          Updates the progress value, caption and background image.
 void update(int incValue, Texture2D backgroundTexture)
          Updates the progress value and background image.
 void update(java.lang.String caption)
          Updates the progress value incremented by one and sets the new caption.
 void update(Texture2D backgroundTexture)
          Increases the progress value by one and updates the background image.
 void updateOnly(java.lang.String caption)
          Updates the caption only.
 void updateOnly(Texture2D backgroundTexture)
          Updates the background image only.
 

Method Detail

init

void init(int maxValue,
          java.lang.String caption,
          Texture2D backgroundTexture)
Initializes the progress, caption and background image. The progress value is resetted to zero.

Parameters:
maxValue - the new maximum progress value
caption - the new caption (or null to keep the old one)
backgroundTexture - the new background Texture (or null to keep the old one)

init

void init(int maxValue,
          java.lang.String caption,
          java.lang.String backgroundTexture)
Initializes the progress, caption and background image. The progress value is resetted to zero.

Parameters:
maxValue - the new maximum progress value
caption - the new caption (or null to keep the old one)
backgroundTexture - the new background Texture (or null to keep the old one)

update

void update(int incValue,
            java.lang.String caption,
            Texture2D backgroundTexture)
Updates the progress value, caption and background image.

Parameters:
incValue - the value to add to the current progress value
caption - the new caption (or null to keep the old one)
backgroundTexture - the new background Texture (or null to keep the old one)

update

void update(int incValue,
            Texture2D backgroundTexture)
Updates the progress value and background image.

Parameters:
incValue - the value to add to the current progress value
backgroundTexture - the new background Texture (or null to keep the old one)

update

void update(Texture2D backgroundTexture)
Increases the progress value by one and updates the background image.

Parameters:
backgroundTexture - the new background Texture (or null to keep the old one)

updateOnly

void updateOnly(Texture2D backgroundTexture)
Updates the background image only.

Parameters:
backgroundTexture - the new background Texture (or null to keep the old one)

update

void update(int incValue,
            java.lang.String caption,
            java.lang.String backgroundTexture)
Updates the progress value, caption and background image.

Parameters:
incValue - the value to add to the current progress value
caption - the new caption (or null to keep the old one)
backgroundTexture - the new background Texture (or null to keep the old one)

update

void update(int incValue,
            java.lang.String caption)
Updates the progress value and caption.

Parameters:
incValue - the value to add to the current progress value
caption - the new caption (or null to keep the old one)

update

void update(int incValue)
Updates the progress value and leaves the caption unchanged.

Parameters:
incValue - the value to add to the current progress value

updateOnly

void updateOnly(java.lang.String caption)
Updates the caption only.

Parameters:
caption - the new caption (or null to keep the old one)

update

void update(java.lang.String caption)
Updates the progress value incremented by one and sets the new caption.

Parameters:
caption - the new caption (or null to keep the old one)

update

void update()
Updates the progress value incremented by one and leaves the caption unchanged.