GUI Documentation

The GUI module wraps PyQt5 to allow the developer displaying 2D scenes with only a few lines of code, with high costumizability and the ability to easily animate the objects in the scene.

We split the API documentation to the following parts:

• Main GUI class
  • GUI
    • GUI.add_circle_segment()
    • GUI.add_disc()
    • GUI.add_disc_robot()
    • GUI.add_polygon()
    • GUI.add_polygon_with_holes()
    • GUI.add_segment()
    • GUI.add_segment_angle()
    • GUI.add_text()
    • GUI.animation_finished()
    • GUI.animation_finished_action()
    • GUI.base_line_width
    • GUI.base_text_size
    • GUI.clear_scene()
    • GUI.empty_queue()
    • GUI.get_field()
    • GUI.graphicsView
    • GUI.height
    • GUI.is_queue_paused()
    • GUI.is_queue_playing()
    • GUI.labels
    • GUI.lineEdits
    • GUI.linear_translation_animation()
    • GUI.mainWindow
    • GUI.parallel_animation()
    • GUI.pause_animation()
    • GUI.pause_queue()
    • GUI.play_queue()
    • GUI.progressBars
    • GUI.pushButtons
    • GUI.queue_animation()
    • GUI.redraw()
    • GUI.scene
    • GUI.segment_angle_animation()
    • GUI.sequence
    • GUI.set_animation_finished_action()
    • GUI.set_button_text()
    • GUI.set_field()
    • GUI.set_label()
    • GUI.set_logic()
    • GUI.set_program_name()
    • GUI.set_progressbar_value()
    • GUI.setupUi()
    • GUI.stop_queue()
    • GUI.text_animation()
    • GUI.translation_animation()
    • GUI.value_animation()
    • GUI.visibility_animation()
    • GUI.width
    • GUI.zoom
• GUI Entities
  • RCircleSegment
  • RDisc
    • RDisc.x()
    • RDisc.y()
  • RDiscRobot
    • RDiscRobot.set_text()
    • RDiscRobot.x()
    • RDiscRobot.y()
  • RPolygon
    • RPolygon.points()
    • RPolygon.x()
    • RPolygon.y()
  • RPolygonWithHoles
    • RPolygonWithHoles.points()
    • RPolygonWithHoles.x()
    • RPolygonWithHoles.y()
  • RSegment_angle
    • RSegment_angle.angle()
    • RSegment_angle.x()
    • RSegment_angle.y()
  • RSegment
    • RSegment.x()
    • RSegment.y()
  • RText
• GUI Utils
  • GraphicsScenePlus
    • GraphicsScenePlus.left_click_signal
    • GraphicsScenePlus.mousePressEvent()
    • GraphicsScenePlus.right_click_signal
    • GraphicsScenePlus.wheelEvent()
  • Logger
    • Logger.append_text()
    • Logger.color
    • Logger.set_color()
  • Writer
    • Writer.append_text_signal
    • Writer.change_color_signal
    • Writer.set_color()
    • Writer.write()
  • MainWindowPlus
    • MainWindowPlus.dragEnterEvent()
    • MainWindowPlus.dragMoveEvent()
    • MainWindowPlus.dropEvent()
    • MainWindowPlus.keyPressEvent()
    • MainWindowPlus.signal_drop
  • Worker
    • Worker.run()
    • Worker.stop()
  • WorkerSignals
    • WorkerSignals.finished