Package org.xj3d.impl.core.eventmodel

Class DefaultNavigationManager

java.lang.Object

org.xj3d.impl.core.eventmodel.DefaultNavigationManager

All Implemented Interfaces:

NavigationStateListener, NavigationManager

public class DefaultNavigationManager
extends Object
implements NavigationManager, NavigationStateListener

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.

Note: This code does not current handle the navigation info nodes. It only deals with the string type list as that is all we currently have available from the browser internals.

Version:

$Revision: 1.3 $

Author:

Justin Couch

Field Summary

Fields inherited from interface org.web3d.browser.NavigationStateListener

EXAMINE_STATE, FLY_STATE, NO_STATE, PAN_STATE, TILT_STATE, WALK_STATE

Constructor Summary

Constructors

Constructor	Description
DefaultNavigationManager(BrowserCore core)	Create a new instance of this manager that works with the given browser core representation.

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	navigationListChanged(String[] modes, int numTypes)	Notification that the list of valid navigation modes has changed.
void	navigationStateChanged(int idx)	Notification that the navigation state has changed to the new state.
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 navigation info.
void	shutdown()	Shutdown the node manager now.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultNavigationManager

public DefaultNavigationManager(BrowserCore core)

Create a new instance of this manager that works with the given browser core representation.

Parameters:

core - The browser core to work with

Method Details

setNavigationInfo

public void setNavigationInfo(VRMLNavigationInfoNodeType nav)

Set the current navigation info.

Specified by:

setNavigationInfo in interface NavigationManager

Parameters:

nav - The new current navigation info.

getNavigationInfo

public 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.

Specified by:

getNavigationInfo in interface NavigationManager

Returns:

The current active navigation info node or null

getActiveNavigationTypes

public 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.

Specified by:

getActiveNavigationTypes in interface NavigationManager

Returns:

The list of all the available types

setActiveNavigationIndex

public 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.

Specified by:

setActiveNavigationIndex in interface NavigationManager

Parameters:

idx - The index to set as the active type

Throws:

IllegalArgumentException - The index is greater than the available list size

getActiveNavgiationIndex

public 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.

Specified by:

getActiveNavgiationIndex in interface NavigationManager

Returns:

The index of the active type

clear

public 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.

Specified by:

clear in interface NavigationManager

shutdown

public 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

Specified by:

shutdown in interface NavigationManager

setErrorReporter

public 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.

Specified by:

setErrorReporter in interface NavigationManager

Parameters:

reporter - The instance to use or null

getActiveNavInfos

public List<VRMLNavigationInfoNodeType> getActiveNavInfos()

Gets the viewpoints for the currently active layer.

Specified by:

getActiveNavInfos in interface NavigationManager

Returns:

A list of the viewpoint nodes

addNavigationListener

public 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.

Specified by:

addNavigationListener in interface NavigationManager

Parameters:

l - The listener instance to add

removeNavigationListener

public void removeNavigationListener(NavigationStatusListener l)

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

Specified by:

removeNavigationListener in interface NavigationManager

Parameters:

l - The listener instance to remove

navigationStateChanged

public void navigationStateChanged(int idx)

Notification that the navigation state has changed to the new state.

Specified by:

navigationStateChanged in interface NavigationStateListener

Parameters:

idx - The new state expressed as an index into the current navModes list.

navigationListChanged

public void navigationListChanged(String[] modes,
 int numTypes)

Notification that the list of valid navigation modes has changed.

Specified by:

navigationListChanged in interface NavigationStateListener

Parameters:

modes - The new modes

numTypes - The number of elements in the list