Package org.xj3d.core.eventmodel

Interface NavigationManager

All Known Implementing Classes:

DefaultNavigationManager

public interface NavigationManager

An abstract representation of a class that would be responsible for performing Viewpoint management.

This interface represents a further abstracted view of viewpoint management handling beyond the BrowserCore. This gives you all the handling that is normally seen at a user interface level. You should use one or the other, but not both as implementations of this class will also interact with BrowserCore.

Version:

$Revision: 1.3 $

Author:

Alan Hudson

Method Summary

Modifier and Type	Method	Description
void	addNavigationListener(NavigationStatusListener l)	Add a listener for viewpoint status messages.
void	clear()	Force clearing all currently managed nodes from this manager now.
int	getActiveNavgiationIndex()	Fetch the index into the navigation type array of the actual type of navigation being used by the system.
List<String>	getActiveNavigationTypes()	Get the list of active navigation modes for the current active navigation layer.
List<VRMLNavigationInfoNodeType>	getActiveNavInfos()	Gets the viewpoints for the currently active layer.
VRMLNavigationInfoNodeType	getNavigationInfo()	Get the current active navigation info node.
void	removeNavigationListener(NavigationStatusListener l)	Remove a listener for viewpoint status messages.
void	setActiveNavigationIndex(int idx)	Set the active navigation index of the current list.
void	setErrorReporter(org.j3d.util.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	setNavigationInfo(VRMLNavigationInfoNodeType nav)	Set the current bound navigation info to an arbitrary instance.
void	shutdown()	Shutdown the node manager now.

Method Details

setNavigationInfo

void setNavigationInfo(VRMLNavigationInfoNodeType nav)

Set the current bound navigation info to an arbitrary instance. This only works in the layer that the navigation info is a part of. If the layer is not the active layer, you will probably not see any response from this manager.

Parameters:

nav - The new current navigation info.

getNavigationInfo

VRMLNavigationInfoNodeType getNavigationInfo()

Get the current active navigation info node. If there isn't one (eg there is no world loaded at all). Active is defined for the current active navigation layer.

Returns:

The current active navigation info node or null

getActiveNavigationTypes

List<String> getActiveNavigationTypes()

Get the list of active navigation modes for the current active navigation layer. This is a list of all the available options, not the single type that is currently being used right now. To find out which one of these modes is active, use getActiveNavgiationIndex(). This is a read-only list.

Returns:

The list of all the available types

setActiveNavigationIndex

void setActiveNavigationIndex(int idx)
                       throws IllegalArgumentException

Set the active navigation index of the current list. If the index is -1 then all navigation is disabled. An index of out bounds for the current list throws an exception.

Parameters:

idx - The index to set as the active type

Throws:

IllegalArgumentException - The index is greater than the available list size

getActiveNavgiationIndex

int getActiveNavgiationIndex()

Fetch the index into the navigation type array of the actual type of navigation being used by the system. If no type is active or the type list includes "NONE" then this will return -1.

Returns:

The index of the active type

shutdown

void shutdown()

Shutdown the node manager now. If this is using any external resources it should remove those now as the entire application is about to die

clear

void clear()

Force clearing all currently managed nodes 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.

setErrorReporter

void setErrorReporter(org.j3d.util.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.

Parameters:

reporter - The instance to use or null

getActiveNavInfos

List<VRMLNavigationInfoNodeType> getActiveNavInfos()

Gets the viewpoints for the currently active layer.

Returns:

A list of the viewpoint nodes

addNavigationListener

void addNavigationListener(NavigationStatusListener l)

Add a listener for viewpoint status messages. Adding the same listener instance more than once will be silently ignored. Null values are ignored.

Parameters:

l - The listener instance to add

removeNavigationListener

void removeNavigationListener(NavigationStatusListener l)

Remove a listener for viewpoint status messages. If this listener is not currently registered, the request will be silently ignored.

Parameters:

l - The listener instance to remove