com.azalient.api.a
Interface IWindow

public interface IWindow

A handle to the objects and methods related to actions available on the main Commuter window, such as opening and saving files, starting and stopping the simulation, controlling the graphical view. This interface also provides handles to the windows and dialogs raised form the main Commuter menu.

Method Summary

void	addRenderer(IRenderer renderer) Add a renderer object that will be called when the Open GL window is redrawn
void	addShutdownListener(IShutdownListener sl) Add a listener that will be called on shut down
void	busyCursor(boolean enabled) Toggle the cursor between busy/not busy
FileV	comparisonFile() Get a handle to the currently open comparison FileView
void	continuous() Change to continuous mode for the simulation clock
IPage[]	currentPages() Get an array of the pages in the currently open file
JFrame	frame() Get a handle to the top-level frame for the main window.
void	hudFadingMessage(String msg) Set the message that is displayed at the bottom of the main window, and that fades away with redraws
void	importNetwork(String path, String importSaveAs) Import a road model from a SCATS data base
void	importQP(String path, boolean automatic) Import a road model from QP format
JMenu	menu(String name) Get a handle to the menu with the given (localised) name
void	moveBy(IXyz p) Move the cursor and viewpoint by the given vector (x,y,z)
void	moveFlush() Flush the move-viewpoint pipeline
void	moveTo(IXyz p) Move the cursor gradually to the given point
void	moveTo(IXyz[] pa) Move the cursor gradually to the given series of points
void	moveToView(IView sv) Move to the given view, after flushing the move-viewpoint pipeline
void	newView() Create a new view object at the current viewpoint
void	open() Browse to an AZA file, then open it
void	open(File file) Open the given AZA file
FileV	openFile() Get a handle to the currently open FileVIew structure
JDesktopPane	pluginDesktop() Return a handle to the desktop pane on the Tools/Plugins tab.
JFrame	profileWindow() Deprecated.
void	redrawLater() Queue a redraw of the openGL view in a worker thread
void	redrawNow() Redraw the openGL view as soon as possible
void	removeRenderer(IRenderer renderer) Remove a renderer object (see addRenderer)
void	removeShutdownListener(IShutdownListener sl) Remove a listener that will be called on shut down
IShape.RenderMode	renderMode() Return the render mode: Flat, Solid, etc
void	renderMode(IShape.RenderMode rm) Set the render mode: Flat, Solid, etc
IShape.RenderNormals	renderNormals() Return the value of normal calculation for shading
boolean	restore() Attempt to restore the current model to the last (hidden) backup file
void	rewind() Rewind the clock to the start of the Simulation term
void	rotateBy(IAngle a, IXyz c) Rotate the view by the given angle about the given point
void	rotateTo(IAngle a) Rotate the view gradually to the given angle
void	runAtRealTime(boolean b) Toggle real-time mode for the simulation clock
boolean	runningAtRealTime() Return true if the simulator is running at real-time
boolean	runningInBatchMode() Return true if the simulator is running in batch mode (no OpenGL window)
void	save() Save the current model
Action	saveAction() Return a handle to the save action, which can be added to user windows, if required
void	saveAs() Raise a file chooser to select a new file name, and save the current model there
JFrame	showBehaviours() Raise the Behaviours window, and return a reference to it.
JFrame	showDemandDivisions() Raise the Demand Divisions window, and return a reference to it.
JFrame	showFleets() Raise the Fleets window, and return a reference to it.
JFrame	showLogicalDivisions() Deprecated.
JFrame	showPeople() Raise the Person Types window, and return a reference to it.
JFrame	showProfiles() Raise the Profiles window, and return a reference to it.
JFrame	showRouteClasses() Raise the Route Classes window, and return a reference to it.
JFrame	showServiceWindow() Raise the Services window, and return a reference to it.
JFrame	showShapeWindow() Raise the Shapes window, and return a reference to it.
JFrame	showSS2Window() Raise the Stand x Service window, and return a reference to it.
JFrame	showTerms() Raise the Terms window, and return a reference to it.
JFrame	showTrailWindow() Raise the Trails window, and return a reference to it.
JFrame	showTransports() Raise the Transport Types window, and return a reference to it.
JFrame	showVehicles() Raise the Vehicle Types window, and return a reference to it.
void	shutDown(boolean restart) Shut down the application, with or without a re-start
void	singleStep() Change to single step mode for the simulation clock
ISurfaceColourer	surfaceColourer() Return a handle to the surface colouring tool
JTabbedPane	tabbedPane(int position) Return tabbed pane on main window, using SwingConstants.LEFT or RIGHT
void	tiltTo(double d) Change the tilt to the given angle in degrees
IViewport	viewport() Return a handle to the viewport
void	viewTo(IView view) Move to the given view, without flushing the move-viewpoint pipeline
com.azalient.privat.IWindowInternals	wi() A handle to the (intentionally undocumented) internals of the main window
void	zoomTo(double d) Change the zoom gradually to the given height

Method Detail

viewport

IViewport viewport()

Return a handle to the viewport

surfaceColourer

ISurfaceColourer surfaceColourer()

Return a handle to the surface colouring tool

open

void open()

Browse to an AZA file, then open it

open

void open(File file)

Open the given AZA file

save

void save()

Save the current model

saveAs

void saveAs()

Raise a file chooser to select a new file name, and save the current model there

rewind

void rewind()

Rewind the clock to the start of the Simulation term

singleStep

void singleStep()

Change to single step mode for the simulation clock

continuous

void continuous()

Change to continuous mode for the simulation clock

runAtRealTime

void runAtRealTime(boolean b)

Toggle real-time mode for the simulation clock

redrawNow

void redrawNow()

Redraw the openGL view as soon as possible

redrawLater

void redrawLater()

Queue a redraw of the openGL view in a worker thread

moveTo

void moveTo(IXyz p)

Move the cursor gradually to the given point

moveTo

void moveTo(IXyz[] pa)

Move the cursor gradually to the given series of points

rotateTo

void rotateTo(IAngle a)

Rotate the view gradually to the given angle

zoomTo

void zoomTo(double d)

Change the zoom gradually to the given height

tiltTo

void tiltTo(double d)

Change the tilt to the given angle in degrees

viewTo

void viewTo(IView view)

Move to the given view, without flushing the move-viewpoint pipeline

moveToView

void moveToView(IView sv)

Move to the given view, after flushing the move-viewpoint pipeline

newView

void newView()

Create a new view object at the current viewpoint

moveBy

void moveBy(IXyz p)

Move the cursor and viewpoint by the given vector (x,y,z)

rotateBy

void rotateBy(IAngle a,
              IXyz c)

Rotate the view by the given angle about the given point

moveFlush

void moveFlush()

Flush the move-viewpoint pipeline

busyCursor

void busyCursor(boolean enabled)

Toggle the cursor between busy/not busy

renderMode

void renderMode(IShape.RenderMode rm)

Set the render mode: Flat, Solid, etc

addRenderer

void addRenderer(IRenderer renderer)

Add a renderer object that will be called when the Open GL window is redrawn

removeRenderer

void removeRenderer(IRenderer renderer)

Remove a renderer object (see addRenderer)

importQP

void importQP(String path,
              boolean automatic)

Import a road model from QP format

importNetwork

void importNetwork(String path,
                   String importSaveAs)

Import a road model from a SCATS data base

hudFadingMessage

void hudFadingMessage(String msg)

Set the message that is displayed at the bottom of the main window, and that fades away with redraws

shutDown

void shutDown(boolean restart)

Shut down the application, with or without a re-start

addShutdownListener

void addShutdownListener(IShutdownListener sl)

Add a listener that will be called on shut down

removeShutdownListener

void removeShutdownListener(IShutdownListener sl)

Remove a listener that will be called on shut down

runningAtRealTime

boolean runningAtRealTime()

Return true if the simulator is running at real-time

runningInBatchMode

boolean runningInBatchMode()

Return true if the simulator is running in batch mode (no OpenGL window)

restore

boolean restore()

Attempt to restore the current model to the last (hidden) backup file

saveAction

Action saveAction()

Return a handle to the save action, which can be added to user windows, if required

renderNormals

IShape.RenderNormals renderNormals()

Return the value of normal calculation for shading

renderMode

IShape.RenderMode renderMode()

Return the render mode: Flat, Solid, etc

openFile

FileV openFile()

Get a handle to the currently open FileVIew structure

comparisonFile

FileV comparisonFile()

Get a handle to the currently open comparison FileView

currentPages

IPage[] currentPages()

Get an array of the pages in the currently open file

frame

JFrame frame()

Get a handle to the top-level frame for the main window. This can be used as a parent for dialogs

menu

JMenu menu(String name)

Get a handle to the menu with the given (localised) name

pluginDesktop

JDesktopPane pluginDesktop()

Return a handle to the desktop pane on the Tools/Plugins tab. This can be used to add internal frames

See Also:

JInternalFrame

tabbedPane

JTabbedPane tabbedPane(int position)

Return tabbed pane on main window, using SwingConstants.LEFT or RIGHT

showTerms

JFrame showTerms()

Raise the Terms window, and return a reference to it.

showBehaviours

JFrame showBehaviours()

Raise the Behaviours window, and return a reference to it.

showPeople

JFrame showPeople()

Raise the Person Types window, and return a reference to it.

showVehicles

JFrame showVehicles()

Raise the Vehicle Types window, and return a reference to it.

showTransports

JFrame showTransports()

Raise the Transport Types window, and return a reference to it.

showRouteClasses

JFrame showRouteClasses()

Raise the Route Classes window, and return a reference to it.

showDemandDivisions

JFrame showDemandDivisions()

Raise the Demand Divisions window, and return a reference to it.

showFleets

JFrame showFleets()

Raise the Fleets window, and return a reference to it.

showProfiles

JFrame showProfiles()

Raise the Profiles window, and return a reference to it.

showTrailWindow

JFrame showTrailWindow()

Raise the Trails window, and return a reference to it.

showServiceWindow

JFrame showServiceWindow()

Raise the Services window, and return a reference to it.

showSS2Window

JFrame showSS2Window()

Raise the Stand x Service window, and return a reference to it.

showShapeWindow

JFrame showShapeWindow()

Raise the Shapes window, and return a reference to it.

wi

com.azalient.privat.IWindowInternals wi()

A handle to the (intentionally undocumented) internals of the main window

showLogicalDivisions

JFrame showLogicalDivisions()

Deprecated.

profileWindow

JFrame profileWindow()

Deprecated.