restructure text edit and number edit

Author: Licini

src/compas_viewer/components/boundcomponent.py

@@ -0,0 +1,95 @@
+from typing import Callable
+from typing import Union
+from typing import Any
+from .component import Component
+
+
+class BoundComponent(Component):
+    """
+    Base class for components that are bound to object attributes.
+
+    This class provides common functionality for UI components that need to be bound
+    to an attribute of an object or dictionary. It handles getting and setting values
+    from the bound attribute and provides a callback mechanism for when values change.
+
+    Parameters
+    ----------
+    obj : Union[object, dict]
+        The object or dictionary containing the attribute to be bound.
+    attr : str
+        The name of the attribute/key to be bound.
+    callback : Callable[[Component, float], None]
+        A function to call when the value changes. Receives the component and new value.
+
+    Attributes
+    ----------
+    obj : Union[object, dict]
+        The object or dictionary containing the attribute being bound.
+    attr : str
+        The name of the attribute/key being bound.
+    callback : Callable[[Component, float], None]
+        The callback function to call when the value changes.
+
+    Example
+    -------
+    >>> class MyObject:
+    ...     def __init__(self):
+    ...         self.value = 10.0
+    >>> def my_callback(component, value):
+    ...     print(f"Value changed to: {value}")
+    >>> obj = MyObject()
+    >>> component = BoundComponent(obj, "value", my_callback)
+    >>> component.set_attr(20.0)
+    >>> print(component.get_attr())  # prints 20.0
+    """
+    
+    def __init__(self, obj: Union[object, dict], attr: str, callback: Callable[[Component, float], None]):
+        super().__init__()
+
+        self.obj = obj
+        self.attr = attr
+        self.callback = callback
+
+    def get_attr(self):
+        """
+        Get the current value of the bound attribute.
+
+        Returns
+        -------
+        float
+            The current value of the attribute.
+        """
+        if isinstance(self.obj, dict):
+            return self.obj[self.attr]
+        else:
+            return getattr(self.obj, self.attr)
+
+    def set_attr(self, value: float):
+        """
+        Set the value of the bound attribute.
+
+        Parameters
+        ----------
+        value : float
+            The new value to set.
+        """
+        if isinstance(self.obj, dict):
+            self.obj[self.attr] = value
+        else:
+            setattr(self.obj, self.attr, value)
+
+    def on_value_changed(self, value: Any):
+        """
+        Handle value changes for the bound attribute.
+
+        This method is called when the component's value changes. It updates the bound
+        attribute and calls the callback function if one was provided.
+
+        Parameters
+        ----------
+        value : float
+            The new value to set.
+        """
+        self.set_attr(value)
+        if self.callback is not None:
+            self.callback(self, value)

src/compas_viewer/components/double_edit.py

@@ -10,7 +10,7 @@
 
 from compas_viewer.components.color import ColorComboBox
 from compas_viewer.components.color import ColorDialog
-from compas_viewer.components.double_edit import DoubleEdit
+from compas_viewer.components.numberedit import NumberEdit
 from compas_viewer.components.label import LabelWidget
 from compas_viewer.components.textedit import TextEdit
 
@@ -144,7 +144,7 @@ def set_layout(self, items: list[dict], obj: Any) -> None:
 
                 if type == "double_edit":
                     value = action(obj)
-                    widget = DoubleEdit(title=sub_title, value=value, min_val=min_val, max_val=max_val)
+                    widget = NumberEdit(title=sub_title, value=value, min_val=min_val, max_val=max_val)
                 elif type == "label":
                     text = action(obj)
                     widget = LabelWidget(text=text, alignment="center")

src/compas_viewer/components/layout.py

@@ -0,0 +1,95 @@
+from PySide6.QtWidgets import QWidget
+from PySide6.QtWidgets import QHBoxLayout
+from PySide6.QtWidgets import QLabel
+from PySide6.QtWidgets import QDoubleSpinBox
+from typing import Callable
+from typing import Union
+from .component import Component
+from .boundcomponent import BoundComponent
+
+
+class NumberEdit(BoundComponent):
+    """
+    This component creates a labeled number spin box that can be bound to an object's attribute
+    (either a dictionary key or object attribute). When the value changes, it automatically
+    updates the bound attribute and optionally calls a callback function.
+
+    Parameters
+    ----------
+    obj : Union[object, dict]
+        The object or dictionary containing the attribute to be edited.
+    attr : str
+        The name of the attribute/key to be edited.
+    title : str, optional
+        The label text to be displayed next to the spin box. If None, uses the attr name.
+    min_val : float, optional
+        The minimum value allowed in the spin box. If None, uses the default minimum.
+    max_val : float, optional
+        The maximum value allowed in the spin box. If None, uses the default maximum.
+    step : float, optional
+        The step size for the spin box. Defaults to 0.1.
+    decimals : int, optional
+        The number of decimal places to display. Defaults to 1.
+    callback : Callable[[Component, float], None], optional
+        A function to call when the value changes. Receives the component and new value.
+
+    Attributes
+    ----------
+    obj : Union[object, dict]
+        The object or dictionary containing the attribute being edited.
+    attr : str
+        The name of the attribute/key being edited.
+    callback : Callable[[Component, float], None] or None
+        The callback function to call when the value changes.
+    widget : QWidget
+        The main widget containing the layout.
+    layout : QHBoxLayout
+        The horizontal layout containing the label and the spin box.
+    label : QLabel
+        The label displaying the title.
+    spinbox : QDoubleSpinBox
+        The double spin box for editing the floating-point number.
+
+    Example
+    -------
+    >>> class MyObject:
+    ...     def __init__(self):
+    ...         self.x = 5.0
+    >>> obj = MyObject()
+    >>> component = NumberEdit(obj, "x", title="X Coordinate", min_val=0.0, max_val=10.0)
+    """
+
+    def __init__(
+        self,
+        obj: Union[object, dict],
+        attr: str,
+        title: str = None,
+        min_val: float = None,
+        max_val: float = None,
+        step: float = 0.1,
+        decimals: int = 1,
+        callback: Callable[[Component, float], None] = None,
+    ):
+        super().__init__(obj, attr, callback=callback)
+
+        self.widget = QWidget()
+        self.layout = QHBoxLayout()
+
+        title = title if title is not None else attr
+        self.label = QLabel(title)
+        self.spinbox = QDoubleSpinBox()
+        self.spinbox.setDecimals(decimals)
+        self.spinbox.setSingleStep(step)
+        self.spinbox.setMaximumSize(85, 25)
+
+        self.spinbox.setValue(self.get_attr())
+
+        if min_val is not None:
+            self.spinbox.setMinimum(min_val)
+        if max_val is not None:
+            self.spinbox.setMaximum(max_val)
+
+        self.layout.addWidget(self.label)
+        self.layout.addWidget(self.spinbox)
+        self.widget.setLayout(self.layout)
+        self.spinbox.valueChanged.connect(self.on_value_changed)