org.web3d.vrml.nodes.loader
Class AbstractLoadManager

java.lang.Object
  org.web3d.vrml.nodes.loader.AbstractLoadManager

All Implemented Interfaces:

ExternalLoadManager, org.web3d.vrml.nodes.loader.LoadConstants, VRMLUrlListener

Direct Known Subclasses:

MemCacheLoadManager, SimpleLoadManager

public abstract class AbstractLoadManager

extends java.lang.Object

implements ExternalLoadManager, org.web3d.vrml.nodes.loader.LoadConstants, VRMLUrlListener

Common base implementation of a load manager.

Properties

The following properties are used by this class

• org.web3d.vrml.nodes.loader.sort_order A space separated list containing one or more of the words scripts, inlines, textures, externprotos, audio and others. The declaration order is the sort order for values to be fetched within a given scene. Any values not declared are placed at the end of the list in any arbitrary order.
• org.web3d.vrml.nodes.loader.cache.mem.size The amount of memory in Kilobytes (integer value) to allocate to in-memory file caching. If the value is zero or less, no caching is performed.

Note Sort order is not implemented yet.

Version:

$Revision: 1.13 $

Author:

Justin Couch

Field Summary

static java.lang.String	MEM_ALLOC_PROP Property name defining how much memory should be used
static java.lang.String	SORT_AUDIO Script object for sorting
static java.lang.String	SORT_INLINE Script object for sorting
static java.lang.String	SORT_ORDER_PROP Property name defining the sort order
static java.lang.String	SORT_OTHER Script object for sorting
static java.lang.String	SORT_PROTO Script object for sorting
static java.lang.String	SORT_SCRIPT Script object for sorting
static java.lang.String	SORT_TEXTURE Script object for sorting

Constructor Summary

protected

AbstractLoadManager() Create a new load manager initialised with the content loading threads ready to work.

Method Summary

void	clear() Force clearing all state from this manager now.
protected abstract org.web3d.vrml.nodes.loader.FileCache	getCache() Request to fetch the cache used by the derived type.
int	getNumberInProgress() Get the number of items that need to be loaded.
void	queueExternProtoLoad(VRMLExternProtoDeclare proto) Queue for loading a single externproto implementation.
void	queueNodesLoad(NodeArray nodes) Queue an arbitrary collection of nodes for loading.
void	queueSceneLoad(BasicScene scene) Start loading the contents of the given scene.
void	setErrorReporter(ErrorReporter reporter) Register an error reporter with the engine so that any errors generated by the loading of script code can be reported in a nice, pretty fashion.
void	shutdown() Notification that the manager needs to shut down all the currently running threads.
void	stopSceneLoad(BasicScene scene) Stop the named scene from loading.
void	urlChanged(VRMLNodeType node, int index) Notification that the Url content for this node has changed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SORT_ORDER_PROP

public static final java.lang.String SORT_ORDER_PROP

Property name defining the sort order

See Also:

Constant Field Values

SORT_SCRIPT

public static final java.lang.String SORT_SCRIPT

Script object for sorting

See Also:

Constant Field Values

SORT_INLINE

public static final java.lang.String SORT_INLINE

Script object for sorting

See Also:

Constant Field Values

SORT_TEXTURE

public static final java.lang.String SORT_TEXTURE

Script object for sorting

See Also:

Constant Field Values

SORT_PROTO

public static final java.lang.String SORT_PROTO

Script object for sorting

See Also:

Constant Field Values

SORT_AUDIO

public static final java.lang.String SORT_AUDIO

Script object for sorting

See Also:

Constant Field Values

SORT_OTHER

public static final java.lang.String SORT_OTHER

Script object for sorting

See Also:

Constant Field Values

MEM_ALLOC_PROP

public static final java.lang.String MEM_ALLOC_PROP

Property name defining how much memory should be used

See Also:

Constant Field Values

Constructor Detail

AbstractLoadManager

protected AbstractLoadManager()

Create a new load manager initialised with the content loading threads ready to work.

Method Detail

setErrorReporter

public void setErrorReporter(ErrorReporter reporter)

Register an error reporter with the engine so that any errors generated by the loading of script code can be reported in a nice, pretty fashion. Setting a value of null will clear the currently set reporter. If one is already set, the new value replaces the old.

Specified by:

setErrorReporter in interface ExternalLoadManager

Parameters:

reporter - The instance to use or null

queueExternProtoLoad

public void queueExternProtoLoad(VRMLExternProtoDeclare proto)

Queue for loading a single externproto implementation. Used as a way of getting externprotos in to load from the scripting APIs and their createProto or createVRMLFromString methods that have queued up content to load but have no other way of pushing it into the system.

Specified by:

queueExternProtoLoad in interface ExternalLoadManager

Parameters:

proto - The proto declaration that needs to be queued up

queueSceneLoad

public void queueSceneLoad(BasicScene scene)

Start loading the contents of the given scene. If there are other scenes already loading, this is placed in the queue behind them. If the scene does not contain any external nodes or is null then it is not queued for loading.

Specified by:

queueSceneLoad in interface ExternalLoadManager

Parameters:

scene - The new scene to queue up

queueNodesLoad

public void queueNodesLoad(NodeArray nodes)

Queue an arbitrary collection of nodes for loading.

Specified by:

queueNodesLoad in interface ExternalLoadManager

Parameters:

nodes - Array of nodes to add

stopSceneLoad

public void stopSceneLoad(BasicScene scene)

Stop the named scene from loading. If there are any loads in progress this action forces them to stop. If this is not a known scene then the request is ignored.

Specified by:

stopSceneLoad in interface ExternalLoadManager

Parameters:

scene - The scene to stop loading

clear

public void clear()

Force clearing all state from this manager now. This is used to indicate that a new world is about to be loaded and everything should be cleaned out now.

Specified by:

clear in interface ExternalLoadManager

urlChanged

public void urlChanged(VRMLNodeType node,
                       int index)

Notification that the Url content for this node has changed

Specified by:

urlChanged in interface VRMLUrlListener

Parameters:

index - The index of the field that has changed

getNumberInProgress

public int getNumberInProgress()

Get the number of items that need to be loaded.

Returns:

The number of items queued.

shutdown

public void shutdown()

Notification that the manager needs to shut down all the currently running threads. Normally called when the application is exiting, so it is not expected that the manager needs to act sanely after this method has been called.

Specified by:

shutdown in interface ExternalLoadManager

getCache

protected abstract org.web3d.vrml.nodes.loader.FileCache getCache()

Request to fetch the cache used by the derived type.

Returns:

The file cache instance