mirror of
https://github.com/bec-project/bec_widgets.git
synced 2025-07-13 19:21:50 +02:00
docs: add documentation for 2D positioner box
This commit is contained in:
BIN
docs/assets/widget_screenshots/positioner_box_2d.png
Normal file
BIN
docs/assets/widget_screenshots/positioner_box_2d.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 8.2 KiB |
60
docs/user/widgets/positioner_box/positioner_box_2d.md
Normal file
60
docs/user/widgets/positioner_box/positioner_box_2d.md
Normal file
@ -0,0 +1,60 @@
|
||||
(user.widgets.positioner_box_2d)=
|
||||
|
||||
# Positioner Box Widget
|
||||
|
||||
````{tab} Overview
|
||||
|
||||
The [`PositionerBox2D`](/api_reference/_autosummary/bec_widgets.cli.client.PositionerBox2D) widget is very similar to the ['PositionerBox'](/user/widgets/positioner_box/positioner_box) but allows controlling two positioners at the same time, in a horizontal and vertical orientation respectively. It is intended primarily for controlling axes which have a perpendicular relationship like that. In other cases, it may be better to use a `PositionerGroup` instead.
|
||||
|
||||
The `PositionerBox2D` has the same features as the standard `PositionerBox`, but additionally, step buttons which move the positioner by the selected step size, and tweak buttons which move by a tenth of the selected step size.
|
||||
|
||||
````
|
||||
|
||||
````{tab} Examples
|
||||
|
||||
The `PositionerBox2D` widget can be integrated within a GUI application either through direct code instantiation or by using `QtDesigner`. Below are examples demonstrating how to create and use the `PositionerBox2D` widget.
|
||||
|
||||
## Example 1 - Creating a PositionerBox in Code
|
||||
|
||||
In this example, we demonstrate how to create a `PositionerBox2D` widget in code and configure it for a specific device.
|
||||
|
||||
```python
|
||||
from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
|
||||
from bec_widgets.widgets.positioner_box import PositionerBox2D
|
||||
|
||||
class MyGui(QWidget):
|
||||
def __init__(self):
|
||||
super().__init__()
|
||||
self.setLayout(QVBoxLayout(self)) # Initialize the layout for the widget
|
||||
|
||||
# Create and add the PositionerBox to the layout
|
||||
self.positioner_box_2d = PositionerBox(device_hor="horizontal_motor", device_ver="vertical_motor")
|
||||
self.layout().addWidget(self.positioner_box_2d)
|
||||
|
||||
# Example of how this custom GUI might be used:
|
||||
app = QApplication([])
|
||||
my_gui = MyGui()
|
||||
my_gui.show()
|
||||
app.exec_()
|
||||
```
|
||||
|
||||
## Example 2 - Selecting a Device via GUI
|
||||
|
||||
Users can select the positioner device by clicking the button under the device label, which opens a dialog for device selection.
|
||||
|
||||
## Example 3 - Customizing PositionerBox in QtDesigner
|
||||
|
||||
The `PositionerBox2D` widget can be added to a GUI through `QtDesigner`. Once integrated, you can configure the default device and customize the widget’s appearance and behavior directly within the designer.
|
||||
|
||||
```python
|
||||
# After adding the widget to a form in QtDesigner, you can configure the device:
|
||||
self.positioner_box.set_positioner_hor("samx")
|
||||
self.positioner_box.set_positioner_verr("samy")
|
||||
```
|
||||
````
|
||||
|
||||
````{tab} API
|
||||
```{eval-rst}
|
||||
.. include:: /api_reference/_autosummary/bec_widgets.cli.client.PositionerBox2D.rst
|
||||
```
|
||||
````
|
@ -102,6 +102,14 @@ Find and drag devices.
|
||||
Control individual device.
|
||||
```
|
||||
|
||||
```{grid-item-card} Positioner Box 2D
|
||||
:link: user.widgets.positioner_box_2d
|
||||
:link-type: ref
|
||||
:img-top: /assets/widget_screenshots/positioner_box_2d.png
|
||||
|
||||
Control two individual devices on perpendicular axes.
|
||||
```
|
||||
|
||||
```{grid-item-card} Ring Progress Bar
|
||||
:link: user.widgets.ring_progress_bar
|
||||
:link-type: ref
|
||||
@ -260,6 +268,7 @@ buttons_appearance/buttons_appearance.md
|
||||
buttons_queue/button_queue.md
|
||||
device_browser/device_browser.md
|
||||
positioner_box/positioner_box.md
|
||||
positioner_box/positioner_box_2d.md
|
||||
text_box/text_box.md
|
||||
website/website.md
|
||||
toggle/toggle.md
|
||||
|
Reference in New Issue
Block a user