GUI Design Specification

The GUI is built using PyQt 4. For more information, see the PyQt4 documentation.

Hierarchy

• guimain

  • RRGuiMain(object)
  • CoreControllerDummy()

• guimainwindow

  • RRMainWindow(QMainWindow)

• guistage

  • RRStage(QWidget)
  • MusicianWidget(QWidget)

• guicontrolspanel

  • RRControlsPanel(QWidget)
  • RRPlayButton(QPushButton)
  • RRDeleteIcon(QLabel)
  • RRTempoSlider(QWidget)
  • RRTimeSelector(QWidget)
  • TimeSpinBox(QSpinBox)
  • RRKeySelector(QWidget)

• guiaddpanel

  • RRAddPanel(QWidget)
  • MusicianDummy(object)

• guimusicianinfopanel

  • RRMusicianInfoPanel(QWidget)
  • RRMWidgetDetail(QWidget)

Diagram

To be added.

Interface

• RRGuiMain.__init__(self) - creates the main GUI coordinator and initializes certain variables. Only one coordinator should be created per runtime. Throws a RuntimeError if called more than once.
• RRGuiMain.run(self) - Creates all GUI widgets and enters the Qt event loop on the current thread. Returns when the Qt event loop ends, which is when the program should clean up and exit.
• Interfaces with the CoreController. All method calls going to the CoreController occur on the Qt event thread, so to ensure a responsive interface the calls must return quickly.

Design Description

The RobotRock GUI is broken down into sub-components in order to allow localized changes to code, and to aid in understanding. Each component of the GUI takes as a constructor parameter a reference to the RRGuiMain object, which is used for coordination and communication between different components of the GUI.

• guimain

  Main entry point for the gui, as well as overall gui coordinator. Includes references to logging facilities, the core controller, and provides resource lookup.

• guimainwindow

  The main window for the RobotRock GUI. Creates and displays subcomponents RRStage, RRAddPanel, RRControlsPanel, and RRMusicianInfoPanel

• guistage

  The stage on which the musicians are added, moved around, and deleted. Contains class RRStage, which is responsible for drawing the stage background and axes, and class MusicianWidget, responsible for drawing of various musicians.

• guicontrolspanel

  A widget containing general controls, including a play/pause button, tempo slider, trash icon, and key changer in a vertical layout.

• guiaddpanel

  A widget that has controls for adding new musicians.

• guimusicianinfopanel

  displays information about the currently selected musician widget.

References

• CoreController