"""UI components module."""
__all__ = ["TextBox2D", "LineSlider2D", "LineDoubleSlider2D",
"RingSlider2D", "RangeSlider", "Checkbox", "Option", "RadioButton",
"ComboBox2D", "ListBox2D", "ListBoxItem2D", "FileMenu2D"]
import os
from collections import OrderedDict
from numbers import Number
from string import printable
import numpy as np
from fury.data import read_viz_icons
from fury.ui.core import UI, Rectangle2D, TextBlock2D, Disk2D
from fury.ui.containers import Panel2D
from fury.ui.helpers import TWO_PI, clip_overflow
from fury.ui.core import Button2D
[docs]class TextBox2D(UI):
"""An editable 2D text box that behaves as a UI component.
Currently supports:
- Basic text editing.
- Cursor movements.
- Single and multi-line text boxes.
- Pre text formatting (text needs to be formatted beforehand).
Attributes
----------
text : str
The current text state.
actor : :class:`vtkActor2d`
The text actor.
width : int
The number of characters in a single line of text.
height : int
The number of lines in the textbox.
window_left : int
Left limit of visible text in the textbox.
window_right : int
Right limit of visible text in the textbox.
caret_pos : int
Position of the caret in the text.
init : bool
Flag which says whether the textbox has just been initialized.
"""
[docs] def __init__(self, width, height, text="Enter Text", position=(100, 10),
color=(0, 0, 0), font_size=18, font_family='Arial',
justification='left', bold=False,
italic=False, shadow=False):
"""Init this UI element.
Parameters
----------
width : int
The number of characters in a single line of text.
height : int
The number of lines in the textbox.
text : str
The initial text while building the actor.
position : (float, float)
(x, y) in pixels.
color : (float, float, float)
RGB: Values must be between 0-1.
font_size : int
Size of the text font.
font_family : str
Currently only supports Arial.
justification : str
left, right or center.
bold : bool
Makes text bold.
italic : bool
Makes text italicised.
shadow : bool
Adds text shadow.
"""
super(TextBox2D, self).__init__(position=position)
self.message = text
self.text.message = text
self.text.font_size = font_size
self.text.font_family = font_family
self.text.justification = justification
self.text.bold = bold
self.text.italic = italic
self.text.shadow = shadow
self.text.color = color
self.text.background_color = (1, 1, 1)
self.width = width
self.height = height
self.window_left = 0
self.window_right = 0
self.caret_pos = 0
self.init = True
def _setup(self):
"""Setup this UI component.
Create the TextBlock2D component used for the textbox.
"""
self.text = TextBlock2D()
# Add default events listener for this UI component.
self.text.on_left_mouse_button_pressed = self.left_button_press
self.text.on_key_press = self.key_press
def _get_actors(self):
"""Get the actors composing this UI component."""
return self.text.actors
def _add_to_scene(self, scene):
"""Add all subcomponents or VTK props that compose this UI component.
Parameters
----------
scene : scene
"""
self.text.add_to_scene(scene)
def _set_position(self, coords):
"""Set the lower-left corner position of this UI component.
Parameters
----------
coords: (float, float)
Absolute pixel coordinates (x, y).
"""
self.text.position = coords
def _get_size(self):
return self.text.size
[docs] def set_message(self, message):
"""Set custom text to textbox.
Parameters
----------
message: str
The custom message to be set.
"""
self.message = message
self.text.message = message
self.init = False
self.window_right = len(self.message)
self.window_left = 0
self.caret_pos = self.window_right
[docs] def width_set_text(self, text):
"""Add newlines to text where necessary.
This is needed for multi-line text boxes.
Parameters
----------
text : str
The final text to be formatted.
Returns
-------
str
A multi line formatted text.
"""
multi_line_text = ""
for i, t in enumerate(text):
multi_line_text += t
if (i + 1) % self.width == 0:
multi_line_text += "\n"
return multi_line_text.rstrip("\n")
[docs] def handle_character(self, key, key_char):
"""Handle button events.
# TODO: Need to handle all kinds of characters like !, +, etc.
Parameters
----------
character : str
"""
if key_char != '' and key_char in printable:
self.add_character(key_char)
elif key.lower() == "return":
self.render_text(False)
return True
if key.lower() == "backspace":
self.remove_character()
elif key.lower() == "left":
self.move_left()
elif key.lower() == "right":
self.move_right()
self.render_text()
return False
[docs] def move_caret_right(self):
"""Move the caret towards right."""
self.caret_pos = min(self.caret_pos + 1, len(self.message))
[docs] def move_caret_left(self):
"""Move the caret towards left."""
self.caret_pos = max(self.caret_pos - 1, 0)
[docs] def right_move_right(self):
"""Move right boundary of the text window right-wards."""
if self.window_right <= len(self.message):
self.window_right += 1
[docs] def right_move_left(self):
"""Move right boundary of the text window left-wards."""
if self.window_right > 0:
self.window_right -= 1
[docs] def left_move_right(self):
"""Move left boundary of the text window right-wards."""
if self.window_left <= len(self.message):
self.window_left += 1
[docs] def left_move_left(self):
"""Move left boundary of the text window left-wards."""
if self.window_left > 0:
self.window_left -= 1
[docs] def add_character(self, character):
"""Insert a character into the text and moves window and caret.
Parameters
----------
character : str
"""
if len(character) > 1 and character.lower() != "space":
return
if character.lower() == "space":
character = " "
self.message = (self.message[:self.caret_pos] +
character +
self.message[self.caret_pos:])
self.move_caret_right()
if (self.window_right -
self.window_left == self.height * self.width - 1):
self.left_move_right()
self.right_move_right()
[docs] def remove_character(self):
"""Remove a character and moves window and caret accordingly."""
if self.caret_pos == 0:
return
self.message = (self.message[:self.caret_pos - 1] +
self.message[self.caret_pos:])
self.move_caret_left()
if len(self.message) < self.height * self.width - 1:
self.right_move_left()
if (self.window_right -
self.window_left == self.height * self.width - 1):
if self.window_left > 0:
self.left_move_left()
self.right_move_left()
[docs] def move_left(self):
"""Handle left button press."""
self.move_caret_left()
if self.caret_pos == self.window_left - 1:
if (self.window_right -
self.window_left == self.height * self.width - 1):
self.left_move_left()
self.right_move_left()
[docs] def move_right(self):
"""Handle right button press."""
self.move_caret_right()
if self.caret_pos == self.window_right + 1:
if (self.window_right -
self.window_left == self.height * self.width - 1):
self.left_move_right()
self.right_move_right()
[docs] def showable_text(self, show_caret):
"""Chop out text to be shown on the screen.
Parameters
----------
show_caret : bool
Whether or not to show the caret.
"""
if show_caret:
ret_text = (self.message[:self.caret_pos] +
"_" +
self.message[self.caret_pos:])
else:
ret_text = self.message
ret_text = ret_text[self.window_left:self.window_right + 1]
return ret_text
[docs] def render_text(self, show_caret=True):
"""Render text after processing.
Parameters
----------
show_caret : bool
Whether or not to show the caret.
"""
text = self.showable_text(show_caret)
if text == "":
text = "Enter Text"
self.text.message = self.width_set_text(text)
[docs] def edit_mode(self):
"""Turn on edit mode."""
if self.init:
self.message = ""
self.init = False
self.caret_pos = 0
self.render_text()
[docs] def left_button_press(self, i_ren, _obj, _textbox_object):
"""Handle left button press for textbox.
Parameters
----------
i_ren: :class:`CustomInteractorStyle`
obj: :class:`vtkActor`
The picked actor
_textbox_object: :class:`TextBox2D`
"""
i_ren.add_active_prop(self.text.actor)
self.edit_mode()
i_ren.force_render()
[docs] def key_press(self, i_ren, _obj, _textbox_object):
"""Handle Key press for textboxself.
Parameters
----------
i_ren: :class:`CustomInteractorStyle`
obj: :class:`vtkActor`
The picked actor
_textbox_object: :class:`TextBox2D`
"""
key = i_ren.event.key
key_char = i_ren.event.key_char
is_done = self.handle_character(key, key_char)
if is_done:
i_ren.remove_active_prop(self.text.actor)
i_ren.force_render()
[docs]class LineSlider2D(UI):
"""A 2D Line Slider.
A sliding handle on a line with a percentage indicator.
Attributes
----------
line_width : int
Width of the line on which the disk will slide.
length : int
Length of the slider.
track : :class:`Rectangle2D`
The line on which the slider's handle moves.
handle : :class:`Disk2D`
The moving part of the slider.
text : :class:`TextBlock2D`
The text that shows percentage.
shape : string
Describes the shape of the handle.
Currently supports 'disk' and 'square'.
default_color : (float, float, float)
Color of the handle when in unpressed state.
active_color : (float, float, float)
Color of the handle when it is pressed.
"""
[docs] def __init__(self, center=(0, 0),
initial_value=50, min_value=0, max_value=100,
length=200, line_width=5,
inner_radius=0, outer_radius=10, handle_side=20,
font_size=16, orientation="horizontal", text_alignment='',
text_template="{value:.1f} ({ratio:.0%})", shape="disk"):
"""Init this UI element.
Parameters
----------
center : (float, float)
Center of the slider's center.
initial_value : float
Initial value of the slider.
min_value : float
Minimum value of the slider.
max_value : float
Maximum value of the slider.
length : int
Length of the slider.
line_width : int
Width of the line on which the disk will slide.
inner_radius : int
Inner radius of the handles (if disk).
outer_radius : int
Outer radius of the handles (if disk).
handle_side : int
Side length of the handles (if sqaure).
font_size : int
Size of the text to display alongside the slider (pt).
orientation : str
horizontal or vertical
text_alignment : str
define text alignment on a slider. Left (default)/ right for the
vertical slider or top/bottom (default) for an horizontal slider.
text_template : str, callable
If str, text template can contain one or multiple of the
replacement fields: `{value:}`, `{ratio:}`.
If callable, this instance of `:class:LineSlider2D` will be
passed as argument to the text template function.
shape : string
Describes the shape of the handle.
Currently supports 'disk' and 'square'.
"""
self.shape = shape
self.orientation = orientation.lower().strip()
self.align_dict = {'horizontal': ['top', 'bottom'],
'vertical': ['left', 'right']}
self.default_color = (1, 1, 1)
self.active_color = (0, 0, 1)
self.alignment = text_alignment.lower()
super(LineSlider2D, self).__init__()
if self.orientation == "horizontal":
self.alignment = 'bottom' if not self.alignment else self.alignment
self.track.width = length
self.track.height = line_width
elif self.orientation == "vertical":
self.alignment = 'left' if not self.alignment else self.alignment
self.track.width = line_width
self.track.height = length
else:
raise ValueError("Unknown orientation")
if self.alignment not in self.align_dict[self.orientation]:
raise ValueError("Unknown alignment: choose from '{}' or '{}'".
format(*self.align_dict[self.orientation]))
if shape == "disk":
self.handle.inner_radius = inner_radius
self.handle.outer_radius = outer_radius
elif shape == "square":
self.handle.width = handle_side
self.handle.height = handle_side
self.center = center
self.min_value = min_value
self.max_value = max_value
self.text.font_size = font_size
self.text_template = text_template
# Offer some standard hooks to the user.
self.on_change = lambda ui: None
self.value = initial_value
self.update()
def _setup(self):
"""Setup this UI component.
Create the slider's track (Rectangle2D), the handle (Disk2D) and
the text (TextBlock2D).
"""
# Slider's track
self.track = Rectangle2D()
self.track.color = (1, 0, 0)
# Slider's handle
if self.shape == "disk":
self.handle = Disk2D(outer_radius=1)
elif self.shape == "square":
self.handle = Rectangle2D(size=(1, 1))
self.handle.color = self.default_color
# Slider Text
self.text = TextBlock2D(justification="center",
vertical_justification="top")
# Add default events listener for this UI component.
self.track.on_left_mouse_button_pressed = self.track_click_callback
self.track.on_left_mouse_button_dragged = self.handle_move_callback
self.track.on_left_mouse_button_released = \
self.handle_release_callback
self.handle.on_left_mouse_button_dragged = self.handle_move_callback
self.handle.on_left_mouse_button_released = \
self.handle_release_callback
def _get_actors(self):
"""Get the actors composing this UI component."""
return self.track.actors + self.handle.actors + self.text.actors
def _add_to_scene(self, scene):
"""Add all subcomponents or VTK props that compose this UI component.
Parameters
----------
scene : scene
"""
self.track.add_to_scene(scene)
self.handle.add_to_scene(scene)
self.text.add_to_scene(scene)
def _get_size(self):
# Consider the handle's size when computing the slider's size.
width = None
height = None
if self.orientation == "horizontal":
width = self.track.width + self.handle.size[0]
height = max(self.track.height, self.handle.size[1])
else:
width = max(self.track.width, self.handle.size[0])
height = self.track.height + self.handle.size[1]
return np.array([width, height])
def _set_position(self, coords):
"""Set the lower-left corner position of this UI component.
Parameters
----------
coords: (float, float)
Absolute pixel coordinates (x, y).
"""
# Offset the slider line by the handle's radius.
track_position = coords + self.handle.size / 2.
if self.orientation == "horizontal":
# Offset the slider line height by half the slider line width.
track_position[1] -= self.track.size[1] / 2.
else:
# Offset the slider line width by half the slider line height.
track_position[0] += self.track.size[0] / 2.
self.track.position = track_position
self.handle.position = self.handle.position.astype(float)
self.handle.position += coords - self.position
# Position the text below the handle.
if self.orientation == "horizontal":
align = 35 if self.alignment == 'top' else -10
self.text.position = (self.handle.center[0],
self.handle.position[1] + align)
else:
align = 70 if self.alignment == 'right' else -35
self.text.position = (self.handle.position[0] + align,
self.handle.center[1] + 2)
@property
def bottom_y_position(self):
return self.track.position[1]
@property
def top_y_position(self):
return self.track.position[1] + self.track.size[1]
@property
def left_x_position(self):
return self.track.position[0]
@property
def right_x_position(self):
return self.track.position[0] + self.track.size[0]
[docs] def set_position(self, position):
"""Set the disk's position.
Parameters
----------
position : (float, float)
The absolute position of the disk (x, y).
"""
# Move slider disk.
if self.orientation == "horizontal":
x_position = position[0]
x_position = max(x_position, self.left_x_position)
x_position = min(x_position, self.right_x_position)
self.handle.center = (x_position, self.track.center[1])
else:
y_position = position[1]
y_position = max(y_position, self.bottom_y_position)
y_position = min(y_position, self.top_y_position)
self.handle.center = (self.track.center[0], y_position)
self.update() # Update information.
@property
def value(self):
return self._value
@value.setter
def value(self, value):
value_range = self.max_value - self.min_value
self.ratio = (value - self.min_value) / value_range
@property
def ratio(self):
return self._ratio
@ratio.setter
def ratio(self, ratio):
position_x = self.left_x_position + ratio * self.track.width
position_y = self.bottom_y_position + ratio * self.track.height
self.set_position((position_x, position_y))
[docs] def format_text(self):
"""Return formatted text to display along the slider."""
if callable(self.text_template):
return self.text_template(self)
return self.text_template.format(ratio=self.ratio, value=self.value)
[docs] def update(self):
"""Update the slider."""
# Compute the ratio determined by the position of the slider disk.
disk_position_x = None
disk_position_y = None
if self.orientation == "horizontal":
length = float(self.right_x_position - self.left_x_position)
if length != self.track.width:
raise ValueError("Disk position outside the slider line")
disk_position_x = self.handle.center[0]
self._ratio = (disk_position_x - self.left_x_position) / length
else:
length = float(self.top_y_position - self.bottom_y_position)
if length != self.track.height:
raise ValueError("Disk position outside the slider line")
disk_position_y = self.handle.center[1]
self._ratio = (disk_position_y - self.bottom_y_position) / length
# Compute the selected value considering min_value and max_value.
value_range = self.max_value - self.min_value
self._value = self.min_value + self.ratio * value_range
# Update text.
text = self.format_text()
self.text.message = text
# Move the text below the slider's handle.
if self.orientation == "horizontal":
self.text.position = (disk_position_x, self.text.position[1])
else:
self.text.position = (self.text.position[0], disk_position_y)
self.on_change(self)
[docs] def track_click_callback(self, i_ren, _vtkactor, _slider):
"""Update disk position and grab the focus.
Parameters
----------
i_ren : :class:`CustomInteractorStyle`
vtkactor : :class:`vtkActor`
The picked actor
_slider : :class:`LineSlider2D`
"""
position = i_ren.event.position
self.set_position(position)
i_ren.force_render()
i_ren.event.abort() # Stop propagating the event.
[docs] def handle_move_callback(self, i_ren, _vtkactor, _slider):
"""Handle movement.
Parameters
----------
i_ren : :class:`CustomInteractorStyle`
vtkactor : :class:`vtkActor`
The picked actor
slider : :class:`LineSlider2D`
"""
self.handle.color = self.active_color
position = i_ren.event.position
self.set_position(position)
i_ren.force_render()
i_ren.event.abort() # Stop propagating the event.
[docs] def handle_release_callback(self, i_ren, _vtkactor, _slider):
"""Change color when handle is released.
Parameters
----------
i_ren : :class:`CustomInteractorStyle`
vtkactor : :class:`vtkActor`
The picked actor
slider : :class:`LineSlider2D`
"""
self.handle.color = self.default_color
i_ren.force_render()
[docs]class LineDoubleSlider2D(UI):
"""A 2D Line Slider with two sliding rings.
Useful for setting min and max values for something.
Currently supports:
- Setting positions of both disks.
Attributes
----------
line_width : int
Width of the line on which the disk will slide.
length : int
Length of the slider.
track : :class:`vtkActor`
The line on which the handles move.
handles : [:class:`vtkActor`, :class:`vtkActor`]
The moving slider disks.
text : [:class:`TextBlock2D`, :class:`TextBlock2D`]
The texts that show the values of the disks.
shape : string
Describes the shape of the handle.
Currently supports 'disk' and 'square'.
default_color : (float, float, float)
Color of the handles when in unpressed state.
active_color : (float, float, float)
Color of the handles when they are pressed.
"""
[docs] def __init__(self, line_width=5, inner_radius=0, outer_radius=10,
handle_side=20, center=(450, 300), length=200,
initial_values=(0, 100), min_value=0, max_value=100,
font_size=16, text_template="{value:.1f}",
orientation="horizontal", shape="disk"):
"""Init this UI element.
Parameters
----------
line_width : int
Width of the line on which the disk will slide.
inner_radius : int
Inner radius of the handles (if disk).
outer_radius : int
Outer radius of the handles (if disk).
handle_side : int
Side length of the handles (if sqaure).
center : (float, float)
Center of the slider.
length : int
Length of the slider.
initial_values : (float, float)
Initial values of the two handles.
min_value : float
Minimum value of the slider.
max_value : float
Maximum value of the slider.
font_size : int
Size of the text to display alongside the slider (pt).
text_template : str, callable
If str, text template can contain one or multiple of the
replacement fields: `{value:}`, `{ratio:}`.
If callable, this instance of `:class:LineDoubleSlider2D` will be
passed as argument to the text template function.
orientation : str
horizontal or vertical
shape : string
Describes the shape of the handle.
Currently supports 'disk' and 'square'.
"""
self.shape = shape
self.default_color = (1, 1, 1)
self.active_color = (0, 0, 1)
self.orientation = orientation.lower()
super(LineDoubleSlider2D, self).__init__()
if self.orientation == "horizontal":
self.track.width = length
self.track.height = line_width
elif self.orientation == "vertical":
self.track.width = line_width
self.track.height = length
else:
raise ValueError("Unknown orientation")
self.center = center
if shape == "disk":
self.handles[0].inner_radius = inner_radius
self.handles[0].outer_radius = outer_radius
self.handles[1].inner_radius = inner_radius
self.handles[1].outer_radius = outer_radius
elif shape == "square":
self.handles[0].width = handle_side
self.handles[0].height = handle_side
self.handles[1].width = handle_side
self.handles[1].height = handle_side
self.min_value = min_value
self.max_value = max_value
self.text[0].font_size = font_size
self.text[1].font_size = font_size
self.text_template = text_template
# Setting the handle positions will also update everything.
self._values = [initial_values[0], initial_values[1]]
self._ratio = [None, None]
self.left_disk_value = initial_values[0]
self.right_disk_value = initial_values[1]
self.bottom_disk_value = initial_values[0]
self.top_disk_value = initial_values[1]
def _setup(self):
"""Setup this UI component.
Create the slider's track (Rectangle2D), the handles (Disk2D) and
the text (TextBlock2D).
"""
# Slider's track
self.track = Rectangle2D()
self.track.color = (1, 0, 0)
# Handles
self.handles = []
if self.shape == "disk":
self.handles.append(Disk2D(outer_radius=1))
self.handles.append(Disk2D(outer_radius=1))
elif self.shape == "square":
self.handles.append(Rectangle2D(size=(1, 1)))
self.handles.append(Rectangle2D(size=(1, 1)))
self.handles[0].color = self.default_color
self.handles[1].color = self.default_color
# Slider Text
self.text = [TextBlock2D(justification="center",
vertical_justification="top"),
TextBlock2D(justification="center",
vertical_justification="top")
]
# Add default events listener for this UI component.
self.track.on_left_mouse_button_dragged = self.handle_move_callback
self.handles[0].on_left_mouse_button_dragged = \
self.handle_move_callback
self.handles[1].on_left_mouse_button_dragged = \
self.handle_move_callback
self.handles[0].on_left_mouse_button_released = \
self.handle_release_callback
self.handles[1].on_left_mouse_button_released = \
self.handle_release_callback
def _get_actors(self):
"""Get the actors composing this UI component."""
return (self.track.actors + self.handles[0].actors +
self.handles[1].actors + self.text[0].actors +
self.text[1].actors)
def _add_to_scene(self, scene):
"""Add all subcomponents or VTK props that compose this UI component.
Parameters
----------
scene : scene
"""
self.track.add_to_scene(scene)
self.handles[0].add_to_scene(scene)
self.handles[1].add_to_scene(scene)
self.text[0].add_to_scene(scene)
self.text[1].add_to_scene(scene)
def _get_size(self):
# Consider the handle's size when computing the slider's size.
width = None
height = None
if self.orientation == "horizontal":
width = self.track.width + 2 * self.handles[0].size[0]
height = max(self.track.height, self.handles[0].size[1])
else:
width = max(self.track.width, self.handles[0].size[0])
height = self.track.height + 2 * self.handles[0].size[1]
return np.array([width, height])
def _set_position(self, coords):
"""Set the lower-left corner position of this UI component.
Parameters
----------
coords: (float, float)
Absolute pixel coordinates (x, y).
"""
# Offset the slider line by the handle's radius.
track_position = coords + self.handles[0].size / 2.
if self.orientation == "horizontal":
# Offset the slider line height by half the slider line width.
track_position[1] -= self.track.size[1] / 2.
else:
# Offset the slider line width by half the slider line height.
track_position[0] -= self.track.size[0] / 2.
self.track.position = track_position
self.handles[0].position = self.handles[0].position.astype(float)
self.handles[1].position = self.handles[1].position.astype(float)
self.handles[0].position += coords - self.position
self.handles[1].position += coords - self.position
if self.orientation == "horizontal":
# Position the text below the handles.
self.text[0].position = (self.handles[0].center[0],
self.handles[0].position[1] - 20)
self.text[1].position = (self.handles[1].center[0],
self.handles[1].position[1] - 20)
else:
# Position the text to the left of the handles.
self.text[0].position = (self.handles[0].center[0] - 35,
self.handles[0].position[1])
self.text[1].position = (self.handles[1].center[0] - 35,
self.handles[1].position[1])
@property
def bottom_y_position(self):
return self.track.position[1]
@property
def top_y_position(self):
return self.track.position[1] + self.track.size[1]
@property
def left_x_position(self):
return self.track.position[0]
@property
def right_x_position(self):
return self.track.position[0] + self.track.size[0]
[docs] def value_to_ratio(self, value):
"""Convert the value of a disk to the ratio.
Parameters
----------
value : float
"""
value_range = self.max_value - self.min_value
return (value - self.min_value) / value_range
[docs] def ratio_to_coord(self, ratio):
"""Convert the ratio to the absolute coordinate.
Parameters
----------
ratio : float
"""
if self.orientation == "horizontal":
return self.left_x_position + ratio * self.track.width
return self.bottom_y_position + ratio * self.track.height
[docs] def coord_to_ratio(self, coord):
"""Convert the x coordinate of a disk to the ratio.
Parameters
----------
coord : float
"""
if self.orientation == "horizontal":
return (coord - self.left_x_position) / float(self.track.width)
return (coord - self.bottom_y_position) / float(self.track.height)
[docs] def ratio_to_value(self, ratio):
"""Convert the ratio to the value of the disk.
Parameters
----------
ratio : float
"""
value_range = self.max_value - self.min_value
return self.min_value + ratio * value_range
[docs] def set_position(self, position, disk_number):
"""Set the disk's position.
Parameters
----------
position : (float, float)
The absolute position of the disk (x, y).
disk_number : int
The index of disk being moved.
"""
if self.orientation == "horizontal":
x_position = position[0]
if disk_number == 0 and x_position >= self.handles[1].center[0]:
x_position = self.ratio_to_coord(
self.value_to_ratio(self._values[1] - 1))
if disk_number == 1 and x_position <= self.handles[0].center[0]:
x_position = self.ratio_to_coord(
self.value_to_ratio(self._values[0] + 1))
x_position = max(x_position, self.left_x_position)
x_position = min(x_position, self.right_x_position)
self.handles[disk_number].center = \
(x_position, self.track.center[1])
else:
y_position = position[1]
if disk_number == 0 and y_position >= self.handles[1].center[1]:
y_position = self.ratio_to_coord(
self.value_to_ratio(self._values[1] - 1))
if disk_number == 1 and y_position <= self.handles[0].center[1]:
y_position = self.ratio_to_coord(
self.value_to_ratio(self._values[0] + 1))
y_position = max(y_position, self.bottom_y_position)
y_position = min(y_position, self.top_y_position)
self.handles[disk_number].center = \
(self.track.center[0], y_position)
self.update(disk_number)
@property
def bottom_disk_value(self):
"""Return the value of the bottom disk."""
return self._values[0]
@bottom_disk_value.setter
def bottom_disk_value(self, bottom_disk_value):
"""Set the value of the bottom disk.
Parameters
----------
bottom_disk_value : float
New value for the bottom disk.
"""
self.bottom_disk_ratio = self.value_to_ratio(bottom_disk_value)
@property
def top_disk_value(self):
"""Return the value of the top disk."""
return self._values[1]
@top_disk_value.setter
def top_disk_value(self, top_disk_value):
"""Set the value of the top disk.
Parameters
----------
top_disk_value : float
New value for the top disk.
"""
self.top_disk_ratio = self.value_to_ratio(top_disk_value)
@property
def left_disk_value(self):
"""Return the value of the left disk."""
return self._values[0]
@left_disk_value.setter
def left_disk_value(self, left_disk_value):
"""Set the value of the left disk.
Parameters
----------
left_disk_value : float
New value for the left disk.
"""
self.left_disk_ratio = self.value_to_ratio(left_disk_value)
@property
def right_disk_value(self):
"""Return the value of the right disk."""
return self._values[1]
@right_disk_value.setter
def right_disk_value(self, right_disk_value):
"""Set the value of the right disk.
Parameters
----------
right_disk_value : float
New value for the right disk.
"""
self.right_disk_ratio = self.value_to_ratio(right_disk_value)
@property
def bottom_disk_ratio(self):
"""Return the ratio of the bottom disk."""
return self._ratio[0]
@bottom_disk_ratio.setter
def bottom_disk_ratio(self, bottom_disk_ratio):
"""Set the ratio of the bottom disk.
Parameters
----------
bottom_disk_ratio : float
New ratio for the bottom disk.
"""
position_x = self.ratio_to_coord(bottom_disk_ratio)
position_y = self.ratio_to_coord(bottom_disk_ratio)
self.set_position((position_x, position_y), 0)
@property
def top_disk_ratio(self):
"""Return the ratio of the top disk."""
return self._ratio[1]
@top_disk_ratio.setter
def top_disk_ratio(self, top_disk_ratio):
"""Set the ratio of the top disk.
Parameters
----------
top_disk_ratio : float
New ratio for the top disk.
"""
position_x = self.ratio_to_coord(top_disk_ratio)
position_y = self.ratio_to_coord(top_disk_ratio)
self.set_position((position_x, position_y), 1)
@property
def left_disk_ratio(self):
"""Return the ratio of the left disk."""
return self._ratio[0]
@left_disk_ratio.setter
def left_disk_ratio(self, left_disk_ratio):
"""Set the ratio of the left disk.
Parameters
----------
left_disk_ratio : float
New ratio for the left disk.
"""
position_x = self.ratio_to_coord(left_disk_ratio)
position_y = self.ratio_to_coord(left_disk_ratio)
self.set_position((position_x, position_y), 0)
@property
def right_disk_ratio(self):
"""Return the ratio of the right disk."""
return self._ratio[1]
@right_disk_ratio.setter
def right_disk_ratio(self, right_disk_ratio):
"""Set the ratio of the right disk.
Parameters
----------
right_disk_ratio : float
New ratio for the right disk.
"""
position_x = self.ratio_to_coord(right_disk_ratio)
position_y = self.ratio_to_coord(right_disk_ratio)
self.set_position((position_x, position_y), 1)
[docs] def format_text(self, disk_number):
"""Return formatted text to display along the slider.
Parameters
----------
disk_number : int
Index of the disk.
"""
if callable(self.text_template):
return self.text_template(self)
return self.text_template.format(value=self._values[disk_number])
[docs] def on_change(self, slider):
pass
[docs] def update(self, disk_number):
"""Update the slider.
Parameters
----------
disk_number : int
Index of the disk to be updated.
"""
# Compute the ratio determined by the position of the slider disk.
if self.orientation == "horizontal":
self._ratio[disk_number] = self.coord_to_ratio(
self.handles[disk_number].center[0])
else:
self._ratio[disk_number] = self.coord_to_ratio(
self.handles[disk_number].center[1])
# Compute the selected value considering min_value and max_value.
self._values[disk_number] = self.ratio_to_value(
self._ratio[disk_number])
# Update text.
text = self.format_text(disk_number)
self.text[disk_number].message = text
if self.orientation == "horizontal":
self.text[disk_number].position = (
self.handles[disk_number].center[0],
self.text[disk_number].position[1])
else:
self.text[disk_number].position = (
self.text[disk_number].position[0],
self.handles[disk_number].center[1])
self.on_change(self)
[docs] def handle_move_callback(self, i_ren, vtkactor, _slider):
"""Handle movement.
Parameters
----------
i_ren : :class:`CustomInteractorStyle`
vtkactor : :class:`vtkActor`
The picked actor
_slider : :class:`LineDoubleSlider2D`
"""
position = i_ren.event.position
if vtkactor == self.handles[0].actors[0]:
self.set_position(position, 0)
self.handles[0].color = self.active_color
elif vtkactor == self.handles[1].actors[0]:
self.set_position(position, 1)
self.handles[1].color = self.active_color
i_ren.force_render()
i_ren.event.abort() # Stop propagating the event.
[docs] def handle_release_callback(self, i_ren, vtkactor, _slider):
"""Change color when handle is released.
Parameters
----------
i_ren : :class:`CustomInteractorStyle`
vtkactor : :class:`vtkActor`
The picked actor
_slider : :class:`LineDoubleSlider2D`
"""
if vtkactor == self.handles[0].actors[0]:
self.handles[0].color = self.default_color
elif vtkactor == self.handles[1].actors[0]:
self.handles[1].color = self.default_color
i_ren.force_render()
[docs]class RingSlider2D(UI):
"""A disk slider.
A disk moves along the boundary of a ring.
Goes from 0-360 degrees.
Attributes
----------
mid_track_radius: float
Distance from the center of the slider to the middle of the track.
previous_value: float
Value of Rotation of the actor before the current value.
track : :class:`Disk2D`
The circle on which the slider's handle moves.
handle : :class:`Disk2D`
The moving part of the slider.
text : :class:`TextBlock2D`
The text that shows percentage.
default_color : (float, float, float)
Color of the handle when in unpressed state.
active_color : (float, float, float)
Color of the handle when it is pressed.
"""
[docs] def __init__(self, center=(0, 0),
initial_value=180, min_value=0, max_value=360,
slider_inner_radius=40, slider_outer_radius=44,
handle_inner_radius=0, handle_outer_radius=10,
font_size=16,
text_template="{ratio:.0%}"):
"""Init this UI element.
Parameters
----------
center : (float, float)
Position (x, y) of the slider's center.
initial_value : float
Initial value of the slider.
min_value : float
Minimum value of the slider.
max_value : float
Maximum value of the slider.
slider_inner_radius : int
Inner radius of the base disk.
slider_outer_radius : int
Outer radius of the base disk.
handle_outer_radius : int
Outer radius of the slider's handle.
handle_inner_radius : int
Inner radius of the slider's handle.
font_size : int
Size of the text to display alongside the slider (pt).
text_template : str, callable
If str, text template can contain one or multiple of the
replacement fields: `{value:}`, `{ratio:}`, `{angle:}`.
If callable, this instance of `:class:RingSlider2D` will be
passed as argument to the text template function.
"""
self.default_color = (1, 1, 1)
self.active_color = (0, 0, 1)
super(RingSlider2D, self).__init__()
self.track.inner_radius = slider_inner_radius
self.track.outer_radius = slider_outer_radius
self.handle.inner_radius = handle_inner_radius
self.handle.outer_radius = handle_outer_radius
self.center = center
self.min_value = min_value
self.max_value = max_value
self.text.font_size = font_size
self.text_template = text_template
# Offer some standard hooks to the user.
self.on_change = lambda ui: None
self._value = initial_value
self.value = initial_value
self._previous_value = initial_value
self._angle = 0
self._ratio = self.angle / TWO_PI
def _setup(self):
"""Setup this UI component.
Create the slider's circle (Disk2D), the handle (Disk2D) and
the text (TextBlock2D).
"""
# Slider's track.
self.track = Disk2D(outer_radius=1)
self.track.color = (1, 0, 0)
# Slider's handle.
self.handle = Disk2D(outer_radius=1)
self.handle.color = self.default_color
# Slider Text
self.text = TextBlock2D(justification="center",
vertical_justification="middle")
# Add default events listener for this UI component.
self.track.on_left_mouse_button_pressed = self.track_click_callback
self.track.on_left_mouse_button_dragged = self.handle_move_callback
self.track.on_left_mouse_button_released = \
self.handle_release_callback
self.handle.on_left_mouse_button_dragged = self.handle_move_callback
self.handle.on_left_mouse_button_released = \
self.handle_release_callback
def _get_actors(self):
"""Get the actors composing this UI component."""
return self.track.actors + self.handle.actors + self.text.actors
def _add_to_scene(self, scene):
"""Add all subcomponents or VTK props that compose this UI component.
Parameters
----------
scene : scene
"""
self.track.add_to_scene(scene)
self.handle.add_to_scene(scene)
self.text.add_to_scene(scene)
def _get_size(self):
return self.track.size + self.handle.size
def _set_position(self, coords):
"""Set the lower-left corner position of this UI component.
Parameters
----------
coords: (float, float)
Absolute pixel coordinates (x, y).
"""
self.track.position = coords + self.handle.size / 2.
self.handle.position += coords - self.position
# Position the text in the center of the slider's track.
self.text.position = coords + self.size / 2.
@property
def mid_track_radius(self):
return (self.track.inner_radius + self.track.outer_radius) / 2.
@property
def value(self):
return self._value
@value.setter
def value(self, value):
value_range = self.max_value - self.min_value
self.ratio = (value - self.min_value) / value_range
@property
def previous_value(self):
return self._previous_value
@property
def ratio(self):
return self._ratio
@ratio.setter
def ratio(self, ratio):
self.angle = ratio * TWO_PI
@property
def angle(self):
"""Return Angle (in rad) the handle makes with x-axis."""
return self._angle
@angle.setter
def angle(self, angle):
self._angle = angle % TWO_PI # Wraparound
self.update()
[docs] def format_text(self):
"""Return formatted text to display along the slider. """
if callable(self.text_template):
return self.text_template(self)
return self.text_template.format(ratio=self.ratio, value=self.value,
angle=np.rad2deg(self.angle))
[docs] def update(self):
"""Update the slider. """
# Compute the ratio determined by the position of the slider disk.
self._ratio = self.angle / TWO_PI
# Compute the selected value considering min_value and max_value.
value_range = self.max_value - self.min_value
self._previous_value = self.value
self._value = self.min_value + self.ratio * value_range
# Update text disk actor.
x = self.mid_track_radius * np.cos(self.angle) + self.center[0]
y = self.mid_track_radius * np.sin(self.angle) + self.center[1]
self.handle.center = (x, y)
# Update text.
text = self.format_text()
self.text.message = text
self.on_change(self) # Call hook.
[docs] def move_handle(self, click_position):
"""Move the slider's handle.
Parameters
----------
click_position: (float, float)
Position of the mouse click.
"""
x, y = np.array(click_position) - self.center
angle = np.arctan2(y, x)
if angle < 0:
angle += TWO_PI
self.angle = angle
[docs] def track_click_callback(self, i_ren, _obj, _slider):
"""Update disk position and grab the focus.
Parameters
----------
i_ren : :class:`CustomInteractorStyle`
obj : :class:`vtkActor`
The picked actor
_slider : :class:`RingSlider2D`
"""
click_position = i_ren.event.position
self.move_handle(click_position=click_position)
i_ren.force_render()
i_ren.event.abort() # Stop propagating the event.
[docs] def handle_move_callback(self, i_ren, _obj, _slider):
"""Move the slider's handle.
Parameters
----------
i_ren : :class:`CustomInteractorStyle`
obj : :class:`vtkActor`
The picked actor
_slider : :class:`RingSlider2D`
"""
click_position = i_ren.event.position
self.handle.color = self.active_color
self.move_handle(click_position=click_position)
i_ren.force_render()
i_ren.event.abort() # Stop propagating the event.
[docs] def handle_release_callback(self, i_ren, _obj, _slider):
"""Change color when handle is released.
Parameters
----------
i_ren : :class:`CustomInteractorStyle`
vtkactor : :class:`vtkActor`
The picked actor
_slider : :class:`RingSlider2D`
"""
self.handle.color = self.default_color
i_ren.force_render()
[docs]class RangeSlider(UI):
"""A set of a LineSlider2D and a LineDoubleSlider2D.
The double slider is used to set the min and max value
for the LineSlider2D
Attributes
----------
range_slider_center : (float, float)
Center of the LineDoubleSlider2D object.
value_slider_center : (float, float)
Center of the LineSlider2D object.
range_slider : :class:`LineDoubleSlider2D`
The line slider which sets the min and max values
value_slider : :class:`LineSlider2D`
The line slider which sets the value
"""
[docs] def __init__(self, line_width=5, inner_radius=0, outer_radius=10,
handle_side=20, range_slider_center=(450, 400),
value_slider_center=(450, 300), length=200, min_value=0,
max_value=100, font_size=16, range_precision=1,
orientation="horizontal", value_precision=2, shape="disk"):
"""Init this class instance.
Parameters
----------
line_width : int
Width of the slider tracks
inner_radius : int
Inner radius of the handles.
outer_radius : int
Outer radius of the handles.
handle_side : int
Side length of the handles (if square).
range_slider_center : (float, float)
Center of the LineDoubleSlider2D object.
value_slider_center : (float, float)
Center of the LineSlider2D object.
length : int
Length of the sliders.
min_value : float
Minimum value of the double slider.
max_value : float
Maximum value of the double slider.
font_size : int
Size of the text to display alongside the sliders (pt).
range_precision : int
Number of decimal places to show the min and max values set.
orientation : str
horizontal or vertical
value_precision : int
Number of decimal places to show the value set on slider.
shape : string
Describes the shape of the handle.
Currently supports 'disk' and 'square'.
"""
self.min_value = min_value
self.max_value = max_value
self.inner_radius = inner_radius
self.outer_radius = outer_radius
self.handle_side = handle_side
self.length = length
self.line_width = line_width
self.font_size = font_size
self.shape = shape
self.orientation = orientation.lower()
self.range_slider_text_template = \
"{value:." + str(range_precision) + "f}"
self.value_slider_text_template = \
"{value:." + str(value_precision) + "f}"
self.range_slider_center = range_slider_center
self.value_slider_center = value_slider_center
super(RangeSlider, self).__init__()
def _setup(self):
"""Setup this UI component."""
self.range_slider = \
LineDoubleSlider2D(line_width=self.line_width,
inner_radius=self.inner_radius,
outer_radius=self.outer_radius,
handle_side=self.handle_side,
center=self.range_slider_center,
length=self.length, min_value=self.min_value,
max_value=self.max_value,
initial_values=(self.min_value,
self.max_value),
font_size=self.font_size, shape=self.shape,
orientation=self.orientation,
text_template=self.range_slider_text_template)
self.value_slider = \
LineSlider2D(line_width=self.line_width, length=self.length,
inner_radius=self.inner_radius,
outer_radius=self.outer_radius,
handle_side=self.handle_side,
center=self.value_slider_center,
min_value=self.min_value, max_value=self.max_value,
initial_value=(self.min_value + self.max_value) / 2,
font_size=self.font_size, shape=self.shape,
orientation=self.orientation,
text_template=self.value_slider_text_template)
# Add default events listener for this UI component.
self.range_slider.handles[0].on_left_mouse_button_dragged = \
self.range_slider_handle_move_callback
self.range_slider.handles[1].on_left_mouse_button_dragged = \
self.range_slider_handle_move_callback
def _get_actors(self):
"""Get the actors composing this UI component."""
return self.range_slider.actors + self.value_slider.actors
def _add_to_scene(self, scene):
"""Add all subcomponents or VTK props that compose this UI component.
Parameters
----------
scene : scene
"""
self.range_slider.add_to_scene(scene)
self.value_slider.add_to_scene(scene)
def _get_size(self):
return self.range_slider.size + self.value_slider.size
def _set_position(self, coords):
pass
[docs] def range_slider_handle_move_callback(self, i_ren, obj, _slider):
"""Update range_slider's handles.
Parameters
----------
i_ren : :class:`CustomInteractorStyle`
obj : :class:`vtkActor`
The picked actor
_slider : :class:`RangeSlider`
"""
position = i_ren.event.position
if obj == self.range_slider.handles[0].actors[0]:
self.range_slider.handles[0].color = \
self.range_slider.active_color
self.range_slider.set_position(position, 0)
self.value_slider.min_value = self.range_slider.left_disk_value
self.value_slider.update()
elif obj == self.range_slider.handles[1].actors[0]:
self.range_slider.handles[1].color = \
self.range_slider.active_color
self.range_slider.set_position(position, 1)
self.value_slider.max_value = self.range_slider.right_disk_value
self.value_slider.update()
i_ren.force_render()
i_ren.event.abort() # Stop propagating the event.
[docs]class Option(UI):
"""A set of a Button2D and a TextBlock2D to act as a single option
for checkboxes and radio buttons.
Clicking the button toggles its checked/unchecked status.
Attributes
----------
label : str
The label for the option.
font_size : int
Font Size of the label.
"""
[docs] def __init__(self, label, position=(0, 0), font_size=18, checked=False):
"""Init this class instance.
Parameters
----------
label : str
Text to be displayed next to the option's button.
position : (float, float)
Absolute coordinates (x, y) of the lower-left corner of
the button of the option.
font_size : int
Font size of the label.
checked : bool, optional
Boolean value indicates the initial state of the option
"""
self.label = label
self.font_size = font_size
self.checked = checked
self.button_size = (font_size * 1.2, font_size * 1.2)
self.button_label_gap = 10
super(Option, self).__init__(position)
# Offer some standard hooks to the user.
self.on_change = lambda obj: None
def _setup(self):
"""Setup this UI component."""
# Option's button
self.button_icons = []
self.button_icons.append(('unchecked',
read_viz_icons(fname="stop2.png")))
self.button_icons.append(('checked',
read_viz_icons(fname="checkmark.png")))
self.button = Button2D(icon_fnames=self.button_icons,
size=self.button_size)
self.text = TextBlock2D(text=self.label, font_size=self.font_size)
# Display initial state
if self.checked:
self.button.set_icon_by_name("checked")
# Add callbacks
self.button.on_left_mouse_button_clicked = self.toggle
self.text.on_left_mouse_button_clicked = self.toggle
def _get_actors(self):
"""Get the actors composing this UI component."""
return self.button.actors + self.text.actors
def _add_to_scene(self, scene):
"""Add all subcomponents or VTK props that compose this UI component.
Parameters
----------
scene : scene
"""
self.button.add_to_scene(scene)
self.text.add_to_scene(scene)
def _get_size(self):
width = self.button.size[0] + self.button_label_gap + self.text.size[0]
height = max(self.button.size[1], self.text.size[1])
return np.array([width, height])
def _set_position(self, coords):
"""Set the lower-left corner position of this UI component.
Parameters
----------
coords: (float, float)
Absolute pixel coordinates (x, y).
"""
num_newlines = self.label.count('\n')
self.button.position = coords + \
(0, num_newlines * self.font_size * 0.5)
offset = (self.button.size[0] + self.button_label_gap, 0)
self.text.position = coords + offset
[docs] def toggle(self, i_ren, _obj, _element):
if self.checked:
self.deselect()
else:
self.select()
self.on_change(self)
i_ren.force_render()
[docs] def select(self):
self.checked = True
self.button.set_icon_by_name("checked")
[docs] def deselect(self):
self.checked = False
self.button.set_icon_by_name("unchecked")
[docs]class Checkbox(UI):
"""A 2D set of :class:'Option' objects.
Multiple options can be selected.
Attributes
----------
labels : list(string)
List of labels of each option.
options : dict(Option)
Dictionary of all the options in the checkbox set.
padding : float
Distance between two adjacent options
"""
[docs] def __init__(self, labels, checked_labels=(), padding=1, font_size=18,
font_family='Arial', position=(0, 0)):
"""Init this class instance.
Parameters
----------
labels : list(str)
List of labels of each option.
checked_labels: list(str), optional
List of labels that are checked on setting up.
padding : float, optional
The distance between two adjacent options
font_size : int, optional
Size of the text font.
font_family : str, optional
Currently only supports Arial.
position : (float, float), optional
Absolute coordinates (x, y) of the lower-left corner of
the button of the first option.
"""
self.labels = list(reversed(labels))
self._padding = padding
self._font_size = font_size
self.font_family = font_family
self.checked_labels = list(checked_labels)
super(Checkbox, self).__init__(position)
self.on_change = lambda checkbox: None
def _setup(self):
"""Setup this UI component."""
self.options = OrderedDict()
button_y = self.position[1]
for label in self.labels:
option = Option(label=label,
font_size=self.font_size,
position=(self.position[0], button_y),
checked=(label in self.checked_labels))
line_spacing = option.text.actor.GetTextProperty().GetLineSpacing()
button_y = button_y + self.font_size * \
(label.count('\n') + 1) * (line_spacing + 0.1) + self.padding
self.options[label] = option
# Set callback
option.on_change = self._handle_option_change
def _get_actors(self):
"""Get the actors composing this UI component."""
actors = []
for option in self.options.values():
actors = actors + option.actors
return actors
def _add_to_scene(self, scene):
"""Add all subcomponents or VTK props that compose this UI component.
Parameters
----------
scene : scene
"""
for option in self.options.values():
option.add_to_scene(scene)
def _get_size(self):
option_width, option_height = self.options.values()[0].get_size()
height = len(self.labels) * (option_height + self.padding) \
- self.padding
return np.asarray([option_width, height])
def _handle_option_change(self, option):
"""Update whenever an option changes.
Parameters
----------
option : :class:`Option`
"""
if option.checked:
self.checked_labels.append(option.label)
else:
self.checked_labels.remove(option.label)
self.on_change(self)
def _set_position(self, coords):
"""Set the lower-left corner position of this UI component.
Parameters
----------
coords: (float, float)
Absolute pixel coordinates (x, y).
"""
button_y = coords[1]
for option_no, option in enumerate(self.options.values()):
option.position = (coords[0], button_y)
line_spacing = option.text.actor.GetTextProperty().GetLineSpacing()
button_y = (button_y + self.font_size
* (self.labels[option_no].count('\n') + 1)
* (line_spacing + 0.1) + self.padding)
@property
def font_size(self):
""" Gets the font size of text.
"""
return self._font_size
@property
def padding(self):
"""Get the padding between options."""
return self._padding
[docs]class ComboBox2D(UI):
"""UI element to create drop-down menus.
Attributes
----------
selection_box: :class: 'TextBox2D'
Display selection and placeholder text.
drop_down_button: :class: 'Button2D'
Button to show or hide menu.
drop_down_menu: :class: 'ListBox2D'
Container for item list.
"""
[docs] def __init__(self, items=[], position=(0, 0), size=(300, 200),
placeholder="Choose selection...", draggable=True,
selection_text_color=(0, 0, 0), selection_bg_color=(1, 1, 1),
menu_text_color=(0.2, 0.2, 0.2),
selected_color=(0.9, 0.6, 0.6),
unselected_color=(0.6, 0.6, 0.6),
scroll_bar_active_color=(0.6, 0.2, 0.2),
scroll_bar_inactive_color=(0.9, 0.0, 0.0), menu_opacity=1.,
reverse_scrolling=False, font_size=20, line_spacing=1.4):
"""Init class Instance.
Parameters
----------
items: list(string)
List of items to be displayed as choices.
position : (float, float)
Absolute coordinates (x, y) of the lower-left corner of this
UI component.
size : (int, int)
Width and height in pixels of this UI component.
placeholder : str
Holds the default text to be displayed.
draggable: {True, False}
Whether the UI element is draggable or not.
selection_text_color : tuple of 3 floats
Color of the selected text to be displayed.
selection_bg_color : tuple of 3 floats
Background color of the selection text.
menu_text_color : tuple of 3 floats.
Color of the options displayed in drop down menu.
selected_color : tuple of 3 floats.
Background color of the selected option in drop down menu.
unselected_color : tuple of 3 floats.
Background color of the unselected option in drop down menu.
scroll_bar_active_color : tuple of 3 floats.
Color of the scrollbar when in active use.
scroll_bar_inactive_color : tuple of 3 floats.
Color of the scrollbar when inactive.
reverse_scrolling: {True, False}
If True, scrolling up will move the list of files down.
font_size: int
The font size of selected text in pixels.
line_spacing: float
Distance between drop down menu's items in pixels.
"""
self.items = items.copy()
self.font_size = font_size
self.reverse_scrolling = reverse_scrolling
self.line_spacing = line_spacing
self.panel_size = size
self._selection = placeholder
self._menu_visibility = False
self._selection_ID = None
self.draggable = draggable
self.sel_text_color = selection_text_color
self.sel_bg_color = selection_bg_color
self.menu_txt_color = menu_text_color
self.selected_color = selected_color
self.unselected_color = unselected_color
self.scroll_active_color = scroll_bar_active_color
self.scroll_inactive_color = scroll_bar_inactive_color
self.menu_opacity = menu_opacity
# Define subcomponent sizes.
self.text_block_size = (int(0.8*size[0]), int(0.3*size[1]))
self.drop_menu_size = (size[0], int(0.7*size[1]))
self.drop_button_size = (int(0.2*size[0]), int(0.3*size[1]))
self._icon_files = [
('left', read_viz_icons(fname='circle-left.png')),
('down', read_viz_icons(fname='circle-down.png'))]
super(ComboBox2D, self).__init__()
self.position = position
def _setup(self):
"""Setup this UI component.
Create the ListBox filled with empty slots (ListBoxItem2D).
Create TextBox with placeholder text.
Create Button for toggling drop down menu.
"""
self.selection_box = TextBlock2D(
size=self.text_block_size, color=self.sel_text_color,
bg_color=self.sel_bg_color, text=self._selection)
self.drop_down_button = Button2D(
icon_fnames=self._icon_files, size=self.drop_button_size)
self.drop_down_menu = ListBox2D(
values=self.items, multiselection=False,
font_size=self.font_size, line_spacing=self.line_spacing,
text_color=self.menu_txt_color, selected_color=self.selected_color,
unselected_color=self.unselected_color,
scroll_bar_active_color=self.scroll_active_color,
scroll_bar_inactive_color=self.scroll_inactive_color,
background_opacity=self.menu_opacity,
reverse_scrolling=self.reverse_scrolling, size=self.drop_menu_size)
self.drop_down_menu.set_visibility(False)
self.panel = Panel2D(self.panel_size, opacity=0.0)
self.panel.add_element(self.selection_box, (0.001, 0.7))
self.panel.add_element(self.drop_down_button, (0.8, 0.7))
self.panel.add_element(self.drop_down_menu, (0, 0))
if self.draggable:
self.drop_down_button.on_left_mouse_button_dragged =\
self.left_button_dragged
self.drop_down_menu.panel.background.on_left_mouse_button_dragged\
= self.left_button_dragged
self.selection_box.on_left_mouse_button_dragged =\
self.left_button_dragged
self.selection_box.background.on_left_mouse_button_dragged =\
self.left_button_dragged
self.drop_down_button.on_left_mouse_button_pressed =\
self.left_button_pressed
self.drop_down_menu.panel.background.on_left_mouse_button_pressed\
= self.left_button_pressed
self.selection_box.on_left_mouse_button_pressed =\
self.left_button_pressed
self.selection_box.background.on_left_mouse_button_pressed =\
self.left_button_pressed
else:
self.panel.background.on_left_mouse_button_dragged =\
lambda i_ren, _obj, _comp: i_ren.force_render
self.drop_down_menu.panel.background.on_left_mouse_button_dragged\
= lambda i_ren, _obj, _comp: i_ren.force_render
# Handle mouse wheel events on the slots.
for slot in self.drop_down_menu.slots:
slot.add_callback(
slot.textblock.actor, "LeftButtonPressEvent",
self.select_option_callback)
slot.add_callback(
slot.background.actor, "LeftButtonPressEvent",
self.select_option_callback)
self.drop_down_button.on_left_mouse_button_clicked = \
self.menu_toggle_callback
# Offer some standard hooks to the user.
self.on_change = lambda ui: None
def _get_actors(self):
"""Get the actors composing this UI component."""
return self.panel.actors
[docs] def resize(self, size):
"""Resize ComboBox2D.
Parameters
----------
size : (int, int)
ComboBox size(width, height) in pixels.
"""
self.panel.resize(size)
self.text_block_size = (int(0.8*size[0]), int(0.3*size[1]))
self.drop_menu_size = (size[0], int(0.7*size[1]))
self.drop_button_size = (int(0.2*size[0]), int(0.3*size[1]))
self.panel.update_element(self.selection_box, (0.001, 0.7))
self.panel.update_element(self.drop_down_button, (0.8, 0.7))
self.panel.update_element(self.drop_down_menu, (0, 0))
self.drop_down_button.resize(self.drop_button_size)
self.drop_down_menu.resize(self.drop_menu_size)
self.selection_box.resize(self.text_block_size)
def _set_position(self, coords):
"""Set the lower-left corner position of this UI component.
Parameters
----------
coords: (float, float)
Absolute pixel coordinates (x, y).
"""
self.panel.position = coords
def _add_to_scene(self, scene):
"""Add all subcomponents or VTK props that compose this UI component.
Parameters
----------
scene : scene
"""
self.panel.add_to_scene(scene)
self.selection_box.font_size = self.font_size
def _get_size(self):
return self.panel.size
@property
def selected_text(self):
return self._selection
@property
def selected_text_index(self):
return self._selection_ID
[docs] def append_item(self, *items):
"""Append additional options to the menu.
Parameters
----------
items : n-d list, n-d tuple, Number or str
Additional options.
"""
for item in items:
if isinstance(item, (list, tuple)):
# Useful when n-d lists/tuples are used.
self.append_item(*item)
elif isinstance(item, (str, Number)):
self.items.append(str(item))
else:
raise TypeError("Invalid item instance {}".format(type(item)))
self.drop_down_menu.update_scrollbar()
if not self._menu_visibility:
self.drop_down_menu.scroll_bar.set_visibility(False)
[docs] def select_option_callback(self, i_ren, _obj, listboxitem):
"""Select the appropriate option
Parameters
----------
i_ren: :class:`CustomInteractorStyle`
obj: :class:`vtkActor`
The picked actor
listboxitem: :class:`ListBoxItem2D`
"""
# Set the Text of TextBlock2D to the text of listboxitem
self._selection = listboxitem.element
self._selection_ID = self.items.index(self._selection)
self.selection_box.message = self._selection
clip_overflow(self.selection_box,
self.selection_box.background.size[0])
self.drop_down_menu.set_visibility(False)
self._menu_visibility = False
self.drop_down_button.next_icon()
self.on_change(self)
i_ren.force_render()
i_ren.event.abort()
[docs]class ListBox2D(UI):
"""UI component that allows the user to select items from a list.
Attributes
----------
on_change: function
Callback function for when the selected items have changed.
"""
[docs] def __init__(self, values, position=(0, 0), size=(100, 300),
multiselection=True, reverse_scrolling=False,
font_size=20, line_spacing=1.4,
text_color=(0.2, 0.2, 0.2),
selected_color=(0.9, 0.6, 0.6),
unselected_color=(0.6, 0.6, 0.6),
scroll_bar_active_color=(0.6, 0.2, 0.2),
scroll_bar_inactive_color=(0.9, 0.0, 0.0),
background_opacity=1.):
"""Init class instance.
Parameters
----------
values: list of objects
Values used to populate this listbox. Objects must be castable
to string.
position : (float, float)
Absolute coordinates (x, y) of the lower-left corner of this
UI component.
size : (int, int)
Width and height in pixels of this UI component.
multiselection: {True, False}
Whether multiple values can be selected at once.
reverse_scrolling: {True, False}
If True, scrolling up will move the list of files down.
font_size: int
The font size in pixels.
line_spacing: float
Distance between listbox's items in pixels.
text_color : tuple of 3 floats
selected_color : tuple of 3 floats
unselected_color : tuple of 3 floats
scroll_bar_active_color : tuple of 3 floats
scroll_bar_inactive_color : tuple of 3 floats
background_opacity : float
"""
self.view_offset = 0
self.slots = []
self.selected = []
self.panel_size = size
self.font_size = font_size
self.line_spacing = line_spacing
self.slot_height = int(self.font_size * self.line_spacing)
self.text_color = text_color
self.selected_color = selected_color
self.unselected_color = unselected_color
self.background_opacity = background_opacity
# self.panel.resize(size)
self.values = values
self.multiselection = multiselection
self.last_selection_idx = 0
self.reverse_scrolling = reverse_scrolling
super(ListBox2D, self).__init__()
denom = len(self.values) - self.nb_slots
if not denom:
denom += 1
self.scroll_step_size = (self.slot_height * self.nb_slots -
self.scroll_bar.height) / denom
self.scroll_bar_active_color = scroll_bar_active_color
self.scroll_bar_inactive_color = scroll_bar_inactive_color
self.scroll_bar.color = self.scroll_bar_inactive_color
self.scroll_bar.opacity = self.background_opacity
self.position = position
self.scroll_init_position = 0
self.update()
# Offer some standard hooks to the user.
self.on_change = lambda: None
def _setup(self):
"""Setup this UI component.
Create the ListBox (Panel2D) filled with empty slots (ListBoxItem2D).
"""
self.margin = 10
size = self.panel_size
font_size = self.font_size
# Calculating the number of slots.
self.nb_slots = int((size[1] - 2 * self.margin) // self.slot_height)
# This panel facilitates adding slots at the right position.
self.panel = Panel2D(size=size, color=(1, 1, 1))
# Add a scroll bar
scroll_bar_height = self.nb_slots * (size[1] - 2 * self.margin) \
/ len(self.values)
self.scroll_bar = Rectangle2D(size=(int(size[0]/20),
scroll_bar_height))
if len(self.values) <= self.nb_slots:
self.scroll_bar.set_visibility(False)
self.panel.add_element(
self.scroll_bar, size - self.scroll_bar.size - self.margin)
# Initialisation of empty text actors
self.slot_width = size[0] - self.scroll_bar.size[0] - \
2 * self.margin - self.margin
x = self.margin
y = size[1] - self.margin
for _ in range(self.nb_slots):
y -= self.slot_height
item = ListBoxItem2D(list_box=self,
size=(self.slot_width, self.slot_height),
text_color=self.text_color,
selected_color=self.selected_color,
unselected_color=self.unselected_color,
background_opacity=self.background_opacity)
item.textblock.font_size = font_size
self.slots.append(item)
self.panel.add_element(item, (x, y + self.margin))
# Add default events listener for this UI component.
self.scroll_bar.on_left_mouse_button_pressed = \
self.scroll_click_callback
self.scroll_bar.on_left_mouse_button_released = \
self.scroll_release_callback
self.scroll_bar.on_left_mouse_button_dragged = \
self.scroll_drag_callback
# Handle mouse wheel events on the panel.
up_event = "MouseWheelForwardEvent"
down_event = "MouseWheelBackwardEvent"
if self.reverse_scrolling:
up_event, down_event = down_event, up_event # Swap events
self.add_callback(self.panel.background.actor, up_event,
self.up_button_callback)
self.add_callback(self.panel.background.actor, down_event,
self.down_button_callback)
# Handle mouse wheel events on the slots.
for slot in self.slots:
self.add_callback(slot.background.actor, up_event,
self.up_button_callback)
self.add_callback(slot.background.actor, down_event,
self.down_button_callback)
self.add_callback(slot.textblock.actor, up_event,
self.up_button_callback)
self.add_callback(slot.textblock.actor, down_event,
self.down_button_callback)
[docs] def resize(self, size):
pass
def _get_actors(self):
"""Get the actors composing this UI component."""
return self.panel.actors
def _add_to_scene(self, scene):
"""Add all subcomponents or VTK props that compose this UI component.
Parameters
----------
scene : scene
"""
self.panel.add_to_scene(scene)
for slot in self.slots:
clip_overflow(slot.textblock, self.slot_width)
def _get_size(self):
return self.panel.size
def _set_position(self, coords):
"""Position the lower-left corner of this UI component.
Parameters
----------
coords: (float, float)
Absolute pixel coordinates (x, y).
"""
self.panel.position = coords
[docs] def update(self):
"""Refresh listbox's content. """
view_start = self.view_offset
view_end = view_start + self.nb_slots
values_to_show = self.values[view_start:view_end]
# Populate slots according to the view.
for i, choice in enumerate(values_to_show):
slot = self.slots[i]
slot.element = choice
if slot.textblock.scene is not None:
clip_overflow(slot.textblock, self.slot_width)
slot.set_visibility(True)
if slot.element in self.selected:
slot.select()
else:
slot.deselect()
# Flush remaining slots.
for slot in self.slots[len(values_to_show):]:
slot.element = None
slot.set_visibility(False)
slot.deselect()
[docs] def clear_selection(self):
del self.selected[:]
[docs] def select(self, item, multiselect=False, range_select=False):
"""Select the item.
Parameters
----------
item: ListBoxItem2D's object
Item to select.
multiselect: {True, False}
If True and multiselection is allowed, the item is added to the
selection.
Otherwise, the selection will only contain the provided item unless
range_select is True.
range_select: {True, False}
If True and multiselection is allowed, all items between the last
selected item and the current one will be added to the selection.
Otherwise, the selection will only contain the provided item unless
multi_select is True.
"""
selection_idx = self.values.index(item.element)
if self.multiselection and range_select:
self.clear_selection()
step = 1 if selection_idx >= self.last_selection_idx else -1
for i in range(self.last_selection_idx,
selection_idx + step,
step):
self.selected.append(self.values[i])
elif self.multiselection and multiselect:
if item.element in self.selected:
self.selected.remove(item.element)
else:
self.selected.append(item.element)
self.last_selection_idx = selection_idx
else:
self.clear_selection()
self.selected.append(item.element)
self.last_selection_idx = selection_idx
self.on_change() # Call hook.
self.update()
[docs]class ListBoxItem2D(UI):
"""The text displayed in a listbox."""
[docs] def __init__(self, list_box, size,
text_color=(1.0, 0.0, 0.0),
selected_color=(0.4, 0.4, 0.4),
unselected_color=(0.9, 0.9, 0.9),
background_opacity=1.):
"""Init ListBox Item instance.
Parameters
----------
list_box : :class:`ListBox`
The ListBox reference this text belongs to.
size : tuple of 2 ints
The size of the listbox item.
text_color : tuple of 3 floats
unselected_color : tuple of 3 floats
selected_color : tuple of 3 floats
background_opacity : float
"""
super(ListBoxItem2D, self).__init__()
self._element = None
self.list_box = list_box
self.background.resize(size)
self.background_opacity = background_opacity
self.selected = False
self.text_color = text_color
self.textblock.color = self.text_color
self.selected_color = selected_color
self.unselected_color = unselected_color
self.background.opacity = self.background_opacity
self.deselect()
def _setup(self):
"""Setup this UI component.
Create the ListBoxItem2D with its background (Rectangle2D) and its
label (TextBlock2D).
"""
self.background = Rectangle2D()
self.textblock = TextBlock2D(justification="left",
vertical_justification="middle")
# Add default events listener for this UI component.
self.add_callback(self.textblock.actor, "LeftButtonPressEvent",
self.left_button_clicked)
self.add_callback(self.background.actor, "LeftButtonPressEvent",
self.left_button_clicked)
def _get_actors(self):
"""Get the actors composing this UI component."""
return self.background.actors + self.textblock.actors
def _add_to_scene(self, scene):
"""Add all subcomponents or VTK props that compose this UI component.
Parameters
----------
scene : scene
"""
self.background.add_to_scene(scene)
self.textblock.add_to_scene(scene)
def _get_size(self):
return self.background.size
def _set_position(self, coords):
"""Set the lower-left corner position of this UI component.
Parameters
----------
coords: (float, float)
Absolute pixel coordinates (x, y).
"""
self.textblock.position = coords
# Center background underneath the text.
position = coords
self.background.position = (position[0],
position[1] - self.background.size[1] / 2.)
[docs] def deselect(self):
self.background.color = self.unselected_color
self.textblock.bold = False
self.selected = False
[docs] def select(self):
self.textblock.bold = True
self.background.color = self.selected_color
self.selected = True
@property
def element(self):
return self._element
@element.setter
def element(self, element):
self._element = element
self.textblock.message = "" if self._element is None else str(element)