Modules.SetViewer package

Submodules

Modules.SetViewer.SetViewer module

class Modules.SetViewer.SetViewer.SetViewer(**kwargs)

Bases: Modules.SetViewer.BaseGUI.BaseGUI.BaseGUI

GUI Controller/SetViewer for sets.

Parameters

  • setlist (list) – List of complex set objects.

  • title (str) – Title of the window.

  • colormap (str) – Default colormap to apply to the GUI figure.

  • iterations (int) – Max number of iterations to simulate.

  • dimensions (tuple) (int, int) – used to initialize respective width and height of the root widget.

  • max_interval_delay (int) – Max delay between frame animation.

  • julia_constant (complex) (real, imag) – specific constant to use for simulating the Julia set.

  • maintain_ratio (bool) – Whether to attempt maintaining the aspect ratio when initialized.

sets

Dictionary of complex set objects, key being the name of the set.

Type

dict[str, complexset]

maintain_ratio

Whether to attempt maintaining the aspect ratio when initialized.

Type

bool

simulation

The simulation subcomponent in the sidepanel.

Type

tkinter.widget

picture

The picture subcomponent in the sidepanel.

Type

tkinter.widget

xy_frame

The xy frame subcomponent in the sidepanel.

Type

tkinter.widget

julia_constant

The Julia constant subcomponent in the sidepanel.

Type

tkinter.widget

anim

The render function for the set generation animation.

Type

function

after_id

The string ID to keep track of animation.

Type

str

animation_checkbox_clicked(widget: tkinter.Widget)

Handler for when the animation checkbox has been ticked or unticked.

Parameters

widget (tkinter.widget) – The animation checkbox container.

canvas_onclick(widget: tkinter.Widget, event)

Handler for clicking the canvas. Current implementation is left click for zoom in and right click for zoom out.

Parameters

  • widget (tkinter.widget) – The widget that was clicked (canvas).

  • event (matplotlib.backend_bases.mouseevent) – Event data regarding where on the canvas was clicked.

color_map_changed(widget: tkinter.Widget)

Handler for when a different colormap has been selected.

Parameters

widget (tkinter.widget) – The colormap container.

continue_btn_clicked(widget: tkinter.Button)

Handler for clicking the continue button.

Parameters

widget (tkinter.button) – The button that was clicked (continue button).

generate(reset=True)

Main initial generation function for generating complex sets.

Parameters

reset (bool, optional) – Whether to reset the progress already generated, ex: set to False if generation is paused.

Returns

If there was an error setting the coordinate range of the set. None: If generation succeeded.

Return type

coordinaterange.exception

generate_btn_clicked(widget: tkinter.Button)

Onclick event for the generation button.

Parameters

widget (tkinter.button) – The generation button.

imag_part_changed(widget: tkinter.Widget)

Handler for when the value of the imaginary part widget has been changed.

Parameters

widget (tkinter.widget) – The imaginary part container widget.

pause_btn_clicked(widget: tkinter.Button)

Handler for clicking the pause button.

Parameters

widget (tkinter.button) – The button that was clicked (pause button).

real_part_changed(widget: tkinter.Widget)

Handler for when the value of the real part widget has been changed.

Parameters

widget (tkinter.widget) – The real part container widget.

property selected_set

The selected set to be generated.

Type

selected_set (complexset)

show()

Show the GUI.

stop_generation(clear=True)

Stop the iterative generation of the current set being generated.

Parameters

clear (bool, optional) – Whether to clear the progress bar after stopping the generation.

update_progress(clear=False)

Update the progress bar value.

Parameters

clear (bool, optional) – Whether to clear the progress bar after stopping the generation.

Module contents