app.ui package

Subpackages

• app.ui.creators package
  • Submodules
  • app.ui.creators.project_creator module
    • ProjectCreator
      • ProjectCreator.project_folder
      • ProjectCreator.menu_bar
      • ProjectCreator.text_editor_scene
      • ProjectCreator.open_button
      • ProjectCreator.create_button
      • ProjectCreator.default_config_checkbox
      • ProjectCreator.import_config_button
      • ProjectCreator.config_group
      • ProjectCreator.frame_format
      • ProjectCreator.resolution_x
      • ProjectCreator.resolution_y
      • ProjectCreator.camera_location_x
      • ProjectCreator.camera_location_y
      • ProjectCreator.camera_location_z
      • ProjectCreator.camera_rotation_alpha
      • ProjectCreator.camera_rotation_beta
      • ProjectCreator.camera_rotation_gamma
      • ProjectCreator.light_location_x
      • ProjectCreator.light_location_y
      • ProjectCreator.light_location_z
      • ProjectCreator.light_power
      • ProjectCreator.stl_enable
      • ProjectCreator.reflect_xy
      • ProjectCreator.reflect_yz
      • ProjectCreator.reflect_xz
      • ProjectCreator.ok_button
      • ProjectCreator.about_button_fun()
      • ProjectCreator.add_camera_controls()
      • ProjectCreator.center()
      • ProjectCreator.create_new_config()
      • ProjectCreator.create_scene()
      • ProjectCreator.create_the_project()
      • ProjectCreator.import_scene()
      • ProjectCreator.initUI()
      • ProjectCreator.on_scene_created()
      • ProjectCreator.process_default_config()
      • ProjectCreator.setup_camera_settings()
      • ProjectCreator.setup_central_widget()
      • ProjectCreator.setup_config_group()
      • ProjectCreator.setup_config_options()
      • ProjectCreator.setup_light_settings()
      • ProjectCreator.setup_other_settings()
      • ProjectCreator.setup_resolution_inputs()
      • ProjectCreator.setup_scene_import()
      • ProjectCreator.setup_video_settings()
      • ProjectCreator.toggle_checkboxes()
  • app.ui.creators.scene_creator module
    • SceneCreator
      • SceneCreator.sceneCreated
      • SceneCreator.menu_bar
      • SceneCreator.main_widget
      • SceneCreator.sprites_list_layout
      • SceneCreator.sprite_list
      • SceneCreator.text_editor_scene
      • SceneCreator.open_button
      • SceneCreator.create_button
      • SceneCreator.window
      • SceneCreator.initUI()
      • SceneCreator.about_button_fun()
      • SceneCreator.add_sprite()
      • SceneCreator.center()
      • SceneCreator.create_sprite()
      • SceneCreator.drop_sprite()
      • SceneCreator.import_sprite()
      • SceneCreator.initUI()
      • SceneCreator.okay_button_fun()
      • SceneCreator.save_sprite()
      • SceneCreator.sceneCreated
  • app.ui.creators.sprite_creator module
    • SpriteCreator
      • SpriteCreator.SpriteCreated
      • SpriteCreator.menu_bar
      • SpriteCreator.sprite_name
      • SpriteCreator.sprite_stl_path
      • SpriteCreator.vtkWidget
      • SpriteCreator.ren
      • SpriteCreator.translation_transform
      • SpriteCreator.rotation_transform
      • SpriteCreator.flexibility_transform
      • SpriteCreator.enable_checkbox
      • SpriteCreator.position_x
      • SpriteCreator.position_y
      • SpriteCreator.position_z
      • SpriteCreator.angle_input_alpha
      • SpriteCreator.angle_input_beta
      • SpriteCreator.angle_input_gamma
      • SpriteCreator.inverse_kinematics
      • SpriteCreator.SpriteCreated
      • SpriteCreator.about_button_fun()
      • SpriteCreator.calculate_inverse_kinematics()
      • SpriteCreator.center()
      • SpriteCreator.enable_checkbox_fun()
      • SpriteCreator.finish_button_fun()
      • SpriteCreator.flexibility_transform_fun()
      • SpriteCreator.init_angle_group()
      • SpriteCreator.init_finish_controls()
      • SpriteCreator.init_initial_conditions()
      • SpriteCreator.init_menu()
      • SpriteCreator.init_position_group()
      • SpriteCreator.init_sprite_inputs()
      • SpriteCreator.init_transformations()
      • SpriteCreator.init_ui()
      • SpriteCreator.initial_condition_changed()
      • SpriteCreator.open_file()
      • SpriteCreator.open_m_values_fun()
      • SpriteCreator.open_position_file()
      • SpriteCreator.open_rotation_alpha()
      • SpriteCreator.open_rotation_beta()
      • SpriteCreator.open_rotation_gamma()
      • SpriteCreator.process_inv_data()
      • SpriteCreator.rotation_transform_fun()
      • SpriteCreator.translation_transform_fun()
  • Module contents
• app.ui.editor package
  • Submodules
  • app.ui.editor.project_editor module
    • ProjectWindow
      • ProjectWindow.project_folder
      • ProjectWindow.menu_bar
      • ProjectWindow.right_group
      • ProjectWindow.topleftgroup
      • ProjectWindow.bottomleftgroup
      • ProjectWindow.scene_data
      • ProjectWindow.angles
      • ProjectWindow.__init__()
      • ProjectWindow.process_project()
      • ProjectWindow.center()
      • ProjectWindow.showErrorDialog()
      • ProjectWindow.showAlertDialog()
      • ProjectWindow.change_render_config()
      • ProjectWindow.about_button_fun()
      • ProjectWindow.about_button_fun()
      • ProjectWindow.center()
      • ProjectWindow.change_render_config()
      • ProjectWindow.process_project()
      • ProjectWindow.showAlertDialog()
      • ProjectWindow.showErrorDialog()
  • Module contents

Submodules

app.ui.main_window module

class app.ui.main_window.MainWindow

Bases: QMainWindow

MainWindow Class

The main window of the FlapKine application, providing the interface to create and open projects, access menu items, and navigate the application.

menu_bar

Custom menu bar widget containing the application’s menu actions.

Type:

MenuBar

b_new

Button for creating a new project.

Type:

QPushButton

b_open

Button for opening an existing project.

Type:

QPushButton

__init__():

Initializes the main window, sets the window title, icon, and connects menu actions.

initUI():

Initializes the user interface layout, including the title, buttons, and central widget.

center():

Centers the window on the screen.

create_new_project():

Opens a dialog to select a directory to create a new project and launches the ProjectCreator window.

open_existing_project():

Opens a dialog to select an existing project directory and launches the ProjectWindow.

maximize_button_fun():

Maximizes the window and re-centers it on the screen.

minimize_button_fun():

Minimizes the window.

restore_button_fun():

Restores the window to its normal size.

exit_button_fun():

Closes the main window.

show_about():

Displays an “About” dialog containing information about the FlapKine application.

about_button_fun()

Displays an ‘About FlapKine’ information dialog.

Shows details about the developer, version, and purpose of the application.

center()

Centers the main window on the screen.

This method calculates the center position of the screen based on the screen resolution and window size, and moves the main window to that position. It ensures that the window is always positioned centrally when opened or restored.

Components Used:

• Screen resolution: Obtained using QDesktopWidget().screenGeometry()

• Window size: Retrieved using the geometry() method of the main window

• Window move: The move() method is used to set the calculated central position

create_new_project()

Opens the ProjectCreator window for creating a new project.

This method prompts the user to select a directory where the new project will be saved. Once a directory is selected, it initializes the ProjectCreator window with the chosen directory and shows it. The main window is then closed.

Components Involved:

• QFileDialog.getSaveFileName(): Used to prompt the user to select a save location for the new project.

• ProjectCreator: A separate window responsible for the project creation interface.

• show(): Displays the new ProjectCreator window.

• close(): Closes the current main window after initiating the new project creation.

initUI()

Initializes the user interface for the FlapKine main window.

Sets up the geometry, central widget, and layout for the main window. Configures the primary color based on the foreground role, and adds UI components including a title label and buttons for creating a new project or opening an existing project. The layout and buttons are arranged in a vertical box layout (QVBoxLayout), with central alignment.

Components Initialized:

• Window geometry: Position set to (200, 200), size (400, 250)

• Central widget: Contains the title label and buttons

• Title label: “Welcome to FlapKine”, styled with font size 18px and bold weight

• Buttons:

  • New Project: Triggered via create_new_project() method

  • Open Project: Triggered via open_existing_project() method

• Layout: Vertical box layout (QVBoxLayout) with central alignment for the components

open_existing_project()

Opens an existing project by selecting a directory.

This method allows the user to select an existing project directory using a file dialog. Once a directory is selected, it displays the path in a message box. It then opens the ProjectWindow for the selected directory and displays it. The main window is closed to focus on the project editor.

Components Involved:

• QFileDialog.getExistingDirectory(): Prompts the user to select an existing project directory.

• ProjectWindow: A separate window responsible for managing and editing the selected project.

• show(): Displays the ProjectWindow window.

• close(): Closes the current main window after opening the existing project.

Module contents