Source code for pyvisor.GUI.tab_behaviours.single_animal_tab

from typing import List

from PyQt5.QtWidgets import (QWidget, QGridLayout,
                             QVBoxLayout, QHBoxLayout,
                             QPushButton, QLineEdit, QColorDialog)

from .behaviour_widget import BehaviourWidget
from ..model.animal import Animal
from ..model.gui_data_interface import GUIDataInterface
from ..model.behaviour import Behaviour




class SingleAnimalTab(QWidget):
    """Sub-tab for a single animal's behaviour definitions.

    Shows a grid of :class:`BehaviourWidget` instances with
    controls to add, remove, copy, rename, and bulk-colour
    behaviours.
    """

    def __init__(self, parent,
                 animal: Animal,
                 index_in_parent_tab_widget,
                 gui_data_interface: GUIDataInterface):

        super().__init__(parent)
        self.parent_animal_tab_widget = parent
        self.index = index_in_parent_tab_widget
        self.animal = animal
        self.gui_data_interface = gui_data_interface
        self.current_pos = 0
        self.behav_widgets = []  # type: List[BehaviourWidget]
        self.init_UI()

    @property
    def name(self):
        return self.animal.name



    def init_UI(self):        
        hbox = self._init_main_layout()

        self._init_add_button()
        self._initialize_behaviours()

        # ----------------------
        #   left button vbox
        # ----------------------

        self.vbox_buttons_left = QVBoxLayout()
        hbox.insertLayout(0, self.vbox_buttons_left)
        
        # ---- button edit name
        self.btn_edit_name = QPushButton(self.name)
        self.btn_edit_name.clicked.connect(self.rename)
        self.vbox_buttons_left.addWidget(self.btn_edit_name)

        # ---- button copy animal
        btn_copy_animal = QPushButton('copy animal')
        btn_copy_animal.setToolTip("Create a new animal with the same behaviours.")
        btn_copy_animal.clicked.connect(self.copy_this_tab)
        self.vbox_buttons_left.addWidget(btn_copy_animal)

        # ---- button set animal colour
        btn_set_color = QPushButton('set animal colour')
        btn_set_color.setToolTip("Set one colour for all behaviours of this animal.")
        btn_set_color.clicked.connect(self._set_animal_colour)
        self.vbox_buttons_left.addWidget(btn_set_color)

        # ---- btn remove
        btn_remove_animal = QPushButton('remove this animal')
        btn_remove_animal.setToolTip("Permanently remove this animal and all its behaviours.")
        btn_remove_animal.clicked.connect(self.remove_this_tab)    
        btn_remove_animal.setObjectName("removeAnimal")
        self.vbox_buttons_left.addWidget(btn_remove_animal)
        self.vbox_buttons_left.addStretch(1)


    def _initialize_behaviours(self):
        for key in self.animal.behaviours:
            behav = self.animal[key]
            self.add_behaviour_widget(behav)

    def _init_add_button(self):
        self.button_add = QPushButton('add behaviour')
        self.button_add.clicked.connect(self._add_new_behaviour)
        self.grid.addWidget(self.button_add, *self.get_current_pos())

    def _add_new_behaviour(self):
        name = self.animal.get_unique_name()
        new_behav = Behaviour(self.animal.number, name=name)
        self.gui_data_interface.add_behaviour(self.animal, new_behav)
        self.add_behaviour_widget(new_behav)

    def _init_main_layout(self):
        vbox = QVBoxLayout()
        hbox = QHBoxLayout()
        self.grid = QGridLayout()
        hbox.addLayout(self.grid)
        hbox.addStretch(1)
        vbox.addLayout(hbox)
        vbox.addStretch(1)
        self.setLayout(vbox)
        return hbox

    def _generate_new_name(self):
        return self._generate_unique_name(1)

    def _generate_unique_name(self, subscript):
        name = "behaviour_" + str(subscript)
        if self._is_unique(name):
            return name
        return self._generate_unique_name(subscript + 1)

    def _is_unique(self, name):
        for d in self.behaviour_dicts:
            if d['name'] == name:
                return False
        return True



    def copy_this_tab(self):
        self.parent_animal_tab_widget.copy_tab(self.animal, self.index)




    def remove_this_tab(self):
        self.parent_animal_tab_widget.remove_tab(self.animal.number, self.index)
        self.gui_data_interface.remove_animal(self.animal)
        self.close()




    def add_behaviour_widget(self, behaviour: Behaviour):
        for bw in self.behav_widgets:
            if behaviour.name == 'delete':
                break
            if bw.behaviour.name == 'delete':
                continue
            bw.compatible_behaviour_widget.add_checkbox(behaviour, state=False)
        behav_widget = BehaviourWidget(self, behaviour, self.current_pos,
                                       self.gui_data_interface)
        self.behav_widgets.append(behav_widget)
        self.grid.addWidget(behav_widget, *self.get_current_pos())
        self.current_pos += 1
        self.grid.addWidget(self.button_add, *self.get_current_pos())        




    def get_behav_widget_by_name(self, name):
        for w in self.behav_widgets:
            if w.name.name == name:
                return w
        raise KeyError("BehaviourWidget with name {} not found.".format(name))




    def get_current_pos(self):
        return self.get_grid_pos(self.current_pos)




    @staticmethod
    def get_grid_pos(i):
        return [i // 3, i % 3]




    def remove_widget(self, i, behaviour: Behaviour):
        item = self.behav_widgets.pop(i)
        self.grid.removeWidget(item)
        self.current_pos -= 1

        for j in range(i, len(self.behav_widgets)):
            w = self.behav_widgets[j]
            w.index = j
            self.grid.addWidget(w, *self.get_grid_pos(w.index))            
        self.grid.addWidget(self.button_add, *self.get_grid_pos(len(self.behav_widgets)))

        self.gui_data_interface.remove_behaviour(behaviour)




    def rename(self):
        self.vbox_buttons_left.removeWidget(self.btn_edit_name)
        self.name_edit = QLineEdit(self.name)
        self.name_edit.returnPressed.connect(self.rename_finished)
        self.vbox_buttons_left.insertWidget(0, self.name_edit)


    def _set_animal_colour(self):
        """Set a single colour for all behaviours of this animal."""
        color = QColorDialog.getColor()
        if not color.isValid():
            return
        color_name = str(color.name())
        for behav in self.animal.behaviours.values():
            if behav.name == 'delete':
                continue
            self.gui_data_interface.set_icon_color(behav, color_name)
        # refresh the displayed widgets
        for bw in self.behav_widgets:
            if bw.behaviour.name == 'delete':
                continue
            bw.btn_color.setStyleSheet(
                "QWidget { background-color: %s}" % color_name)
            bw._set_icon_from_tmp_file()



    def rename_finished(self):
        self.btn_edit_name.setText(self.name_edit.text())
        new_name = str(self.name_edit.text())
        self.gui_data_interface.change_animal_name(self.animal, new_name)
        self.vbox_buttons_left.removeWidget(self.name_edit)
        self.vbox_buttons_left.insertWidget(0, self.btn_edit_name)
        self.name_edit.hide()
        self.parent_animal_tab_widget.rename_tab(self.index, self.name)