Milestone 3: RoboViz

This milestone includes the GUI component of the project, allowing visualization of the MAP and the AGENT's TRAJECTORY through the environment.

The deliverables for this milestone are:

GUI source code

The complete Java source code for the visualization component, as described in Section , including RoboVizand, optionally, GridWorldEditor.

Other Java source files

Any additional files necessary to compile and run the full RoboVizprogram, including Java sources from Milestones 1 and 2.

Test code

Any test code used in developing and testing RoboViz. Note that testing GUI code is extremely difficult and there is no commonly accepted methodology for it. (At least, using tools that are available to us.) So you are not required to provide tests for the GUI itself. However, you are still expected to provide tests for other code in your delivery, and to manually test your GUI to ensure that it is as bug-free as possible.

API Documentation

The submission MUST include the full, compiled JavaDoc documentation for all submitted Java modules. This documentation MUST include full descriptions of every public or protected method, field, sub-class, enclosed class, or constructor employed by these modules. This documentation hierarchy MUST be included in a sub-directory named documentation/ within the submission jar file. You MAY use the @inheritDoc Javadoc tag to include some of the documentation from the cs351_f05_p2_support-v1.jardocumentation, but you MUST explicitly state in the API documentation any deviation from, addition to, or different assumptions than the original specifications.

User documentation

The submission MUST include a USERDOC document that describes how to run your RoboViz(and possibly GridWorldEditor) tool(s). This documentation MUST describe how to start each program, how to load/save an environment and a TRAJECTORY file, how to replay a TRAJECTORY, etc. It MUST also describe the expected results of running the program (screenshots are very helpful here). This document MUST be named USERDOC.extension, but it MAY be be a plain text, HTML, PDF, or PostScript document (with the appropriate extension). It MUST NOT be a Microsoft Word or other nonportable format document.

In addition, the handin MAY include any or all of the following:

This file documents any updates to elements of previous handins including what modules/files have changed, what substantial functional changes were made to those modules/files, and whether the instructors are asked to reevaluate those modules/files.

This file documents any know missing features or incomplete tests. It SHOULD also document what tests you would have liked to include, but didn't, along with a description of why you did not include them.

This file includes any other notes or documentation necessary to use or understand the submission that are not already included in other documentation.