Merge pull request #1273 from chaosphere2112/toolbar_layout_fixes

Toolbar layout fixes

Author: David Lonie

Packages/vcs/Lib/vtk_ui/button.py

@@ -135,12 +135,20 @@ def add_state(self, label=None, image=None, bgcolor=None, fgcolor=None, opacity=
         self.states.append(ButtonState(label=label, image=image, bgcolor=bgcolor, fgcolor=fgcolor, opacity=opacity))
 
     def place(self):
+
         width, height = self.get_dimensions()
         x, y = self.get_position()
         bounds = (x, x + width, y - height, y, 0, 0)
-
         self.repr.SetPlaceFactor(1)
         self.repr.PlaceWidget(bounds)
+        self.repr.Modified()
+        if self.showing():
+            # This One Weird Hack will make your Buttons Go In the Right Place - Developers hate it!
+            # Buttons weren't always getting properly placed (toolbars in toolbars being the canonical example)
+            # This makes them show up correctly. Weird, but it works.
+            h_state = self.repr.GetHighlightState()
+            self.repr.Highlight((h_state + 1) % 3)
+            self.repr.Highlight(h_state)
 
         text_width, text_height = self.text_widget.get_dimensions()
         swidth, sheight = self.interactor.GetRenderWindow().GetSize()
@@ -289,7 +297,7 @@ def in_bounds(self, x, y):
     def __advance__(self, point):
         state = self.repr.GetState()
         self.set_state( (state + 1) % len(self.states) )
-        #self.clicked(self.widget, "StateChangedEvent") Do we need to call this? I bet we don't.
+        self.clicked(self.widget, "StateChangedEvent")
 
     def clicked(self, obj, event):
         state = self.get_state()
@@ -332,10 +340,7 @@ def __init__(self, interactor, label, on=None, off=None, corner_radius=5, width=
         self.label = label
 
     def get_text(self):
-        if self.get_state() == 0:
-            return self.label.get_text()[len(on_prefix):]
-        else:
-            return self.label.get_text()[len(off_prefix):]
+        return self.label
 
     def toggle(self, state):
         if state == 1:

Packages/vcs/Lib/vtk_ui/toolbar.py

@@ -2,7 +2,7 @@
 
 class Toolbar(object):
 
-    def __init__(self, interactor, label, vertical=True, left=10, top=10, open_label="Open", on_open=None, close_label="Close", button_margin=5, parent=None, save=None):
+    def __init__(self, interactor, label, vertical=True, left=10, top=10, open_label="Open", on_open=None, close_label="Close", on_close=None, button_margin=5, parent=None, save=None):
 
         self.save = save
         self.interactor = interactor
@@ -12,13 +12,13 @@ def __init__(self, interactor, label, vertical=True, left=10, top=10, open_label
         self.top = top
         self.label = ToggleButton(self.interactor, label, on=self.__on__, off=self.__off__, on_prefix=open_label, off_prefix=close_label, left=self.left - self.margin, top=self.top)
         self.on_open = on_open
+        self.on_close = on_close
         self.vertical = vertical
 
         self.open = False
 
         # Increment this as widgets are added
         self.width, self.height = self.label.get_dimensions()
-        self.height += button_margin
 
         self.widgets = []
         self.bars = {}
@@ -47,13 +47,15 @@ def __delleft(self):
 
     def __on__(self):
         self.open = True
+        self.show_widgets()
         if self.on_open is not None:
             self.on_open()
-        self.show_widgets()
 
     def __off__(self):
         self.open = False
         self.hide_widgets()
+        if self.on_close is not None:
+            self.on_close()
 
     def copy(self, interactor):
         t = Toolbar(interactor, self.label.label, vertical=self.vertical, left=self.left - self.margin, top=self.top, button_margin=self.margin)
@@ -87,9 +89,6 @@ def place(self):
             self.width += self.margin
 
         for widget in self.widgets:
-
-            widget_width, widget_height = widget.get_dimensions()
-
             if self.vertical:
                 widget.left = self.left
                 widget.top = self.top + self.height
@@ -107,6 +106,7 @@ def place(self):
                 self.height += widget_height + self.margin
             else:
                 self.width += widget_width + self.margin
+        self.label.manager.queue_render()
 
     def get_dimensions(self):
         """
@@ -136,11 +136,10 @@ def hide(self):
         self.hide_widgets()
 
     def show_widgets(self):
+        self.place()
         for widget in self.widgets:
             widget.show()
 
-        self.place()
-
     def hide_widgets(self):
         """
         Hides all widgets in this toolbar
@@ -182,7 +181,6 @@ def add_button(self, labels, **kwargs):
             kwargs["top"] = self.top
 
         b = Button(self.interactor, **kwargs)
-
         if self.open:
             b.show()
 
@@ -192,6 +190,7 @@ def add_button(self, labels, **kwargs):
             self.width = kwargs["left"] + b.get_dimensions()[0]
 
         self.widgets.append(b)
+
         return b
 
 
@@ -211,6 +210,18 @@ def add_toolbar(self, label, **kwargs):
 
         if "vertical" not in kwargs:
             kwargs["vertical"] = self.vertical
+        _open = kwargs.get("on_open", None)
+        def hook_open():
+            self.place()
+            if _open:
+                _open()
+        _close = kwargs.get("on_close", None)
+        def hook_close():
+            self.place()
+            if _close:
+                _close()
+        kwargs["on_open"] = hook_open
+        kwargs["on_close"] = hook_close
 
         toolbar = Toolbar(self.interactor, label, **kwargs)
 

testing/vcs/vtk_ui/CMakeLists.txt

@@ -177,3 +177,43 @@ cdat_add_test(test_vtk_ui_textbox_blank_text
   "${PYTHON_EXECUTABLE}"
   ${TEST_DIR}/test_vtk_ui_textbox_blank_text.py
 )
+
+cdat_add_test(test_vtk_ui_toolbar_label
+  "${PYTHON_EXECUTABLE}"
+  ${TEST_DIR}/test_vtk_ui_toolbar_label.py
+  ${BASELINE_DIR}/test_vtk_ui_toolbar_label.png
+)
+
+cdat_add_test(test_vtk_ui_toolbar_open
+  "${PYTHON_EXECUTABLE}"
+  ${TEST_DIR}/test_vtk_ui_toolbar_open.py
+  ${BASELINE_DIR}/test_vtk_ui_toolbar_open.png
+)
+
+cdat_add_test(test_vtk_ui_toolbar_close
+  "${PYTHON_EXECUTABLE}"
+  ${TEST_DIR}/test_vtk_ui_toolbar_close.py
+  ${BASELINE_DIR}/test_vtk_ui_toolbar_close.png
+)
+
+cdat_add_test(test_vtk_ui_toggle_button_get_text
+  "${PYTHON_EXECUTABLE}"
+  ${TEST_DIR}/test_vtk_ui_toggle_button_get_text.py
+)
+
+cdat_add_test(test_vtk_ui_toolbar_in_toolbar_open
+  "${PYTHON_EXECUTABLE}"
+  ${TEST_DIR}/test_vtk_ui_toolbar_in_toolbar_open.py
+  ${BASELINE_DIR}/test_vtk_ui_toolbar_in_toolbar_open.png
+)
+
+cdat_add_test(test_vtk_ui_toolbar_in_toolbar_closed
+  "${PYTHON_EXECUTABLE}"
+  ${TEST_DIR}/test_vtk_ui_toolbar_in_toolbar_closed.py
+  ${BASELINE_DIR}/test_vtk_ui_toolbar_in_toolbar_closed.png
+)
+
+cdat_add_test(test_vtk_ui_button_state_advance
+  "${PYTHON_EXECUTABLE}"
+  ${TEST_DIR}/test_vtk_ui_button_state_advance.py
+)

testing/vcs/vtk_ui/test_vtk_ui_button_state_advance.py

@@ -0,0 +1,32 @@
+"""
+Test button state change
+"""
+import vcs.vtk_ui
+
+
+from vtk_ui_test import vtk_ui_test
+
+class test_vtk_ui_button_state_advance(vtk_ui_test):
+    def do_test(self):
+        self.win.SetSize(100, 100)
+        states = [vcs.vtk_ui.ButtonState(label="State %d" % i, fgcolor=(.1 * i + .5, .1 * i + .5, .1 * i + .5), bgcolor=(.5 - .1 * i,.5 - .1 * i,.5 - .1 * i)) for i in range(5)]
+
+        b = vcs.vtk_ui.Button(self.inter, states=states, action=self.pass_me, left=0, top=0)
+        b.show()
+
+        b.set_state(1)
+        b.repr.NextState()
+        b.widget.InvokeEvent("StateChangedEvent")
+
+
+    def pass_me(self, state):
+        if state == 2:
+            print "Button action executed"
+            self.passed = 0
+        else:
+            print state, "Action passed inaccurate state"
+            from sys import exit
+            sys.exit(1)
+
+if __name__ == "__main__":
+    test_vtk_ui_button_state_advance().test()

testing/vcs/vtk_ui/test_vtk_ui_toggle_button_get_text.py

@@ -0,0 +1,16 @@
+"""
+Test toggle_button get text
+"""
+import vcs.vtk_ui
+
+
+from vtk_ui_test import vtk_ui_test
+
+class test_vtk_ui_toggle_button_get_text(vtk_ui_test):
+	def do_test(self):
+		b = vcs.vtk_ui.ToggleButton(self.inter, "Simple label")
+		b.set_state(1)
+		assert b.get_text() == "Simple label"
+		b.set_state(0)
+		assert b.get_text() == "Simple label"
+		self.passed = 0

testing/vcs/vtk_ui/test_vtk_ui_toolbar_close.py

@@ -0,0 +1,24 @@
+"""
+Test toolbar placement and basic appearance
+"""
+import vcs.vtk_ui
+
+
+from vtk_ui_test import vtk_ui_test
+
+class test_vtk_ui_toolbar_close(vtk_ui_test):
+	def do_test(self):
+		self.win.SetSize(200, 100)
+
+		toolbar = vcs.vtk_ui.Toolbar(self.inter, "Test Bar")
+		toolbar.add_button(["Test Button"])
+		toolbar.add_button(["Other Test"])
+		toolbar.label.__advance__(1)
+		toolbar.label.__advance__(0)
+		assert toolbar.open == False
+		toolbar.show()
+
+		self.test_file = "test_vtk_ui_toolbar_close.png"
+
+if __name__ == "__main__":
+	test_vtk_ui_toolbar_close().test()

testing/vcs/vtk_ui/test_vtk_ui_toolbar_in_toolbar_closed.py

@@ -0,0 +1,29 @@
+"""
+Test toolbar placement inside toolbar
+"""
+import vcs.vtk_ui
+
+
+from vtk_ui_test import vtk_ui_test
+
+class test_vtk_ui_toolbar_in_toolbar_closed(vtk_ui_test):
+	def do_test(self):
+		self.win.SetSize(200, 250)
+
+		toolbar = vcs.vtk_ui.Toolbar(self.inter, "Test Bar")
+		tb = toolbar.add_toolbar("Sub-bar")
+		tb.add_button(["first"])
+		tb.add_button(["second"])
+		toolbar.add_button(["Test Button"])
+		toolbar.add_button(["Other Test"])
+		toolbar.show()
+
+		# Open both toolbars
+		toolbar.label.__advance__(1)
+		tb.label.__advance__(1)
+		tb.label.__advance__(0)
+
+		self.test_file = "test_vtk_ui_toolbar_in_toolbar_closed.png"
+
+if __name__ == "__main__":
+	test_vtk_ui_toolbar_in_toolbar_closed().test()

testing/vcs/vtk_ui/test_vtk_ui_toolbar_in_toolbar_open.py

@@ -0,0 +1,28 @@
+"""
+Test toolbar placement inside toolbar
+"""
+import vcs.vtk_ui
+
+
+from vtk_ui_test import vtk_ui_test
+
+class test_vtk_ui_toolbar_in_toolbar_open(vtk_ui_test):
+	def do_test(self):
+		self.win.SetSize(200, 250)
+
+		toolbar = vcs.vtk_ui.Toolbar(self.inter, "Test Bar")
+		tb = toolbar.add_toolbar("Sub-bar")
+		tb.add_button(["first"])
+		tb.add_button(["second"])
+		toolbar.add_button(["Test Button"])
+		toolbar.add_button(["Other Test"])
+		toolbar.show()
+
+		# Open both toolbars
+		toolbar.label.__advance__(1)
+		tb.label.__advance__(1)
+
+		self.test_file = "test_vtk_ui_toolbar_in_toolbar_open.png"
+
+if __name__ == "__main__":
+	test_vtk_ui_toolbar_in_toolbar_open().test()

testing/vcs/vtk_ui/test_vtk_ui_toolbar_label.py

@@ -0,0 +1,23 @@
+"""
+Test toolbar placement and basic appearance
+"""
+import vcs.vtk_ui
+
+
+from vtk_ui_test import vtk_ui_test
+
+class test_vtk_ui_toolbar_label(vtk_ui_test):
+	def do_test(self):
+		self.win.SetSize(200, 100)
+
+		toolbar = vcs.vtk_ui.Toolbar(self.inter, "Test Bar")
+		# Should default to closed; these will help make sure
+		toolbar.add_button(["Test Button"])
+		toolbar.add_button(["Other Test"])
+		assert toolbar.open == False
+		toolbar.show()
+
+		self.test_file = "test_vtk_ui_toolbar_label.png"
+
+if __name__ == "__main__":
+	test_vtk_ui_toolbar_label().test()

testing/vcs/vtk_ui/test_vtk_ui_toolbar_open.py

@@ -0,0 +1,24 @@
+"""
+Test toolbar placement and basic appearance
+"""
+import vcs.vtk_ui
+
+
+from vtk_ui_test import vtk_ui_test
+
+class test_vtk_ui_toolbar_open(vtk_ui_test):
+	def do_test(self):
+		self.win.SetSize(200, 100)
+
+		toolbar = vcs.vtk_ui.Toolbar(self.inter, "Test Bar")
+		toolbar.add_button(["Test Button"])
+		toolbar.add_button(["Other Test"])
+		toolbar.label.__advance__(1)
+		assert toolbar.open == True
+		toolbar.show()
+
+
+		self.test_file = "test_vtk_ui_toolbar_open.png"
+
+if __name__ == "__main__":
+	test_vtk_ui_toolbar_open().test()