Package org.xj3d.sai

Interface Xj3DStatusListener

public interface Xj3DStatusListener

Listener for basic status information from the browser internals.

Status information is not the same as messages that are reported using the error reporter interface. These are for simple single-line messages.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Method Summary

Modifier and Type	Method	Description
void	loadUpdate(int numInProgress)	Notification of the number of content items that are in the load queue for the current scene.
void	progressUpdate(String id, String msg, float perc)	Notification of a progress update.
void	updateFramesPerSecond(float fps)	Notification that the calculated frames per second has changed to this new value.
void	updateStatusMessage(String msg)	Notification that a single line status message has changed to the new string.

Method Details

updateStatusMessage

void updateStatusMessage(String msg)

Notification that a single line status message has changed to the new string. A null string means to clear the currently displayed message.

Parameters:

msg - The new message string to display for the status

updateFramesPerSecond

void updateFramesPerSecond(float fps)

Notification that the calculated frames per second has changed to this new value. It is expected that this is called frequently.

Parameters:

fps -

progressUpdate

void progressUpdate(String id,
 String msg,
 float perc)

Notification of a progress update. There may be several items in progression at once (e.g. multithreaded texture and scripting loading) so implementers should work appropriately for this situation. To keep this aligned, each item that is reporting progress will have a unique ID string (for this session) associated with it so you can keep track of the multiples. Once 100% has been reached you can assume that the tracking is complete for that object.

Parameters:

id - A unique ID string for the given item

msg - A message to accompany the update

perc - A percentage from 0-100 of the progress completion

loadUpdate

void loadUpdate(int numInProgress)

Notification of the number of content items that are in the load queue for the current scene. The listener is called at the end of each frame. When this number reaches zero, that is a clue that the current scene has completed loading it's externals, such as textures and scripts.

Parameters:

numInProgress - The number of items remaining in the load queue.