Changeset 6182 for trunk/gui/scripts/vtkglyphviewer.tcl

Timestamp:

Mar 22, 2016 10:56:21 PM (8 years ago)

Author:

ldelgass

Message:

Add custom range support to glyph viewer

File:

• trunk/gui/scripts/vtkglyphviewer.tcl (modified) (23 diffs)

trunk/gui/scripts/vtkglyphviewer.tcl

@@ -72 +72 @@
     private method Connect {}
     private method CurrentDatasets {args}
+    private method DisableMouseRotationBindings {}
     private method Disconnect {}
     private method DoResize {}
@@ -86 +87 @@
     private method IsValidObject { dataobj }
     private method LeaveLegend {}
+    private method LegendPointToValue { x y }
+    private method LegendRangeAction { option args }
+    private method LegendRangeValidate { widget which value }
     private method LegendTitleAction { option }
     private method MotionLegend { x y }
+    private method MouseOver2Which {}
     private method Pan {option x y}
     private method PanCamera {}
@@ -103 +108 @@
     private method SetCurrentFieldName { dataobj }
     private method SetLegendTip { x y }
+    private method SetMinMaxGauges { min max }
     private method SetObjectStyle { dataobj comp }
     private method SetOrientation { side }
@@ -110 +116 @@
     private method SetupMouseZoomBindings {}
     private method Slice {option args}
+    private method ToggleCustomRange { args }
     private method ViewToQuaternion {} {
         return [list $_view(-qw) $_view(-qx) $_view(-qy) $_view(-qz)]
@@ -117 +124 @@
     private variable _arcball ""
 
-    private variable _dlist ""     ;    # list of data objects
-    private variable _obj2ovride   ;    # maps dataobj => style override
-    private variable _datasets     ;    # contains all the dataobj-component
-                                   ;    # datasets in the server
-    private variable _colormaps    ;    # contains all the colormaps
-                                   ;    # in the server.
+    private variable _dlist "";         # list of data objects
+    private variable _obj2ovride;       # maps dataobj => style override
+    private variable _datasets;         # contains all the dataobj-component
+                                        # datasets in the server
+    private variable _colormaps;        # contains all the colormaps
+                                        # in the server.
     # The name of the current colormap used.  The colormap is global to all
     # heightmaps displayed.
     private variable _currentColormap ""
 
-    private variable _click        ;    # info used for rotate operations
-    private variable _limits       ;    # autoscale min/max for all axes
-    private variable _view         ;    # view params for 3D view
+    private variable _click;            # info used for rotate operations
+    private variable _limits;           # autoscale min/max for all axes
+    private variable _view;             # view params for 3D view
     private variable _settings
     private variable _changed
     private variable _reset 1;          # Connection to server has been reset.
 
-    private variable _first ""     ;    # This is the topmost dataset.
+    private variable _first "";         # This is the topmost dataset.
     private variable _start 0
     private variable _title ""
@@ -149 +156 @@
     private variable _curFldName ""
     private variable _curFldLabel ""
+    private variable _curFldComp 3
+    private variable _mouseOver "";     # what called LegendRangeAction:
+                                        # vmin or vmax
+    private variable _customRangeClick 1; # what called ToggleCustomRange
 
     private common _downloadPopup;      # download options from popup
@@ -228 +239 @@
         -colormap               BCGYR
         -colormapvisible        1
+        -customrange            0
+        -customrangemin         0
+        -customrangemax         1
         -cutplaneedges          0
         -cutplanelighting       1
@@ -304 +318 @@
     }
 
+    # add an editor for adjusting the legend min and max values
+    itk_component add editor {
+        Rappture::Editor $itk_interior.editor \
+            -activatecommand [itcl::code $this LegendRangeAction activate] \
+            -validatecommand [itcl::code $this LegendRangeAction validate] \
+            -applycommand [itcl::code $this LegendRangeAction apply]
+    }
+
     set c $itk_component(view)
     bind $c <Configure> [itcl::code $this EventuallyResize %w %h]
@@ -446 +468 @@
     bind $itk_component(view) <ButtonRelease-1> \
         [itcl::code $this Rotate release %x %y]
+}
+
+itcl::body Rappture::VtkGlyphViewer::DisableMouseRotationBindings {} {
+    # Bindings for rotation via mouse
+    bind $itk_component(view) <ButtonPress-1> ""
+    bind $itk_component(view) <B1-Motion> ""
+    bind $itk_component(view) <ButtonRelease-1> ""
 }
 
@@ -722 +751 @@
             if { ![info exists _limits($fname)] } {
                 set _limits($fname) $lim
+
+                # set reasonable defaults for
+                # customrangevmin and customrangevmax
+                foreach {min max} $lim break
+                SetMinMaxGauges $min $max
+                set _settings(-customrangemin) $min
+                set _settings(-customrangemax) $max
+
                 continue
             }
             foreach {min max} $lim break
             foreach {fmin fmax} $_limits($fname) break
+            if { ! $_settings(-customrange) } {
+                SetMinMaxGauges $fmin $fmax
+            }
             if { $fmin > $min } {
                 set fmin $min
@@ -1046 +1086 @@
         # These are settings that rely on a dataset being loaded.
         InitSettings \
-            -field \
+            -field -range \
             -glyphedges -glyphlighting -glyphnormscale -glyphopacity \
             -glyphorient -glyphscale -glyphscalemode -glyphshape -glyphwireframe
@@ -1071 +1111 @@
         set _reset 0
     }
+    #DrawLegend
 
     # Actually write the commands to the server socket.  If it fails, we don't
@@ -1417 +1458 @@
                 set _curFldName $fname
                 set _curFldLabel $label
+                set _curFldComp $components
             } else {
                 puts stderr "unknown field \"$fname\""
                 return
             }
-            #if { ![info exists _limits($_curFldName)] } {
-            #    SendCmd "dataset maprange all"
-            #} else {
-            #    SendCmd "dataset maprange explicit $_limits($_curFldName) $_curFldName"
-            #}
+            if { ![info exists _limits($_curFldName)] } {
+                SendCmd "dataset maprange all"
+            } else {
+                if { $_settings(-customrange) } {
+                    set vmin [$itk_component(min) value]
+                    set vmax [$itk_component(max) value]
+                } else {
+                    foreach { vmin vmax } $_limits($_curFldName) break
+                    # set the min / max gauges with limits from the field
+                    # the legend's min and max text will be updated
+                    # when the legend is redrawn in DrawLegend
+                    SetMinMaxGauges $vmin $vmax
+                }
+                SendCmd "dataset maprange explicit $vmin $vmax $_curFldName point_data $_curFldComp"
+            }
             #SendCmd "cutplane colormode $_colorMode $_curFldName"
             SendCmd "glyphs colormode $_colorMode $_curFldName"
@@ -1520 +1572 @@
                 }
             }
+        }
+        "-range" {
+            if { $_settings(-customrange) } {
+                set vmin [$itk_component(min) value]
+                set vmax [$itk_component(max) value]
+            } else {
+                foreach { vmin vmax } $_limits($_curFldName) break
+            }
+            SendCmd "dataset maprange explicit $vmin $vmax $_curFldName point_data $_curFldComp"
+            DrawLegend
         }
         "-xcutplanevisible" - "-ycutplanevisible" - "-zcutplanevisible" {
@@ -1628 +1690 @@
 
 itcl::body Rappture::VtkGlyphViewer::BuildGlyphTab {} {
-
     set fg [option get $itk_component(hull) font Font]
     #set bfg [option get $itk_component(hull) boldFont Font]
@@ -1781 +1842 @@
     bind $inner.colormap <<Value>> \
         [itcl::code $this AdjustSetting -colormap]
+
+    # add widgets for setting a custom range on the legend
+
+    itk_component add crange {
+        checkbutton $inner.crange \
+            -text "Use Custom Range:" \
+            -variable [itcl::scope _settings(-customrange)] \
+            -command [itcl::code $this ToggleCustomRange] \
+            -font "Arial 9"
+    }
+
+    itk_component add l_min {
+        label $inner.l_min -text "Min" -font "Arial 9"
+    }
+    itk_component add min {
+        Rappture::Gauge $inner.min -font "Arial 9" \
+            -validatecommand [itcl::code $this LegendRangeValidate "" vmin]
+    }
+    bind $itk_component(min) <<Value>> \
+        [itcl::code $this AdjustSetting -range]
+
+    itk_component add l_max {
+        label $inner.l_max -text "Max" -font "Arial 9"
+    }
+    itk_component add max {
+        Rappture::Gauge $inner.max -font "Arial 9" \
+            -validatecommand [itcl::code $this LegendRangeValidate "" vmax]
+    }
+    bind $itk_component(max) <<Value>> \
+        [itcl::code $this AdjustSetting -range]
+
+    $itk_component(min) configure -state disabled
+    $itk_component(max) configure -state disabled
 
     blt::table $inner \
@@ -1803 +1897 @@
         12,0 $inner.legend      -anchor w -pady 2 \
         13,0 $inner.opacity_l   -anchor w -pady 2 \
-        13,1 $inner.opacity     -anchor w -pady 2 -fill x
+        13,1 $inner.opacity     -anchor w -pady 2 -fill x \
+        14,0 $inner.crange      -anchor w -pady 2 -cspan 2 \
+        15,0 $inner.l_min       -anchor w -pady 2 \
+        15,1 $inner.min         -anchor w -pady 2 -fill x \
+        16,0 $inner.l_max       -anchor w -pady 2 \
+        16,1 $inner.max         -anchor w -pady 2 -fill x \
 
     blt::table configure $inner r* c* -resize none
-    blt::table configure $inner r14 c1 -resize expand
+    blt::table configure $inner r17 c1 -resize expand
 }
 
@@ -2409 +2508 @@
 }
 
+# ----------------------------------------------------------------------
+# USAGE: LegendPointToValue <x> <y>
+#
+# Convert an x,y point on the legend to a numeric field value.
+# ----------------------------------------------------------------------
+itcl::body Rappture::VtkGlyphViewer::LegendPointToValue { x y } {
+    set fname $_curFldName
+
+    set font "Arial 8"
+    set lineht [font metrics $font -linespace]
+
+    set ih [image height $_image(legend)]
+    set iy [expr $y - ($lineht + 2)]
+
+    # Compute the value of the point
+    if { [info exists _limits($fname)] } {
+        if { $_settings(-customrange) } {
+            set vmin [$itk_component(min) value]
+            set vmax [$itk_component(max) value]
+        } else {
+            foreach { vmin vmax } $_limits($fname) break
+        }
+        set t [expr 1.0 - (double($iy) / double($ih-1))]
+        set value [expr $t * ($vmax - $vmin) + $vmin]
+    } else {
+        set value 0.0
+    }
+    return $value
+}
+
 #
 # SetLegendTip --
@@ -2453 +2582 @@
 
     # Compute the value of the point
-    if { [info exists _limits($_curFldName)] } {
-        foreach { vmin vmax } $_limits($_curFldName) break
-        set t [expr 1.0 - (double($iy) / double($ih-1))]
-        set value [expr $t * ($vmax - $vmin) + $vmin]
-    } else {
-        set value 0.0
-    }
+    set value [LegendPointToValue $x $y]
+
+    # Setup the location of the tooltip
     set tx [expr $x + 15]
     set ty [expr $y - 5]
+
+    # Setup the text for the tooltip
     Rappture::Tooltip::text $c [format "$title %g" $value]
+
+    # Show the tooltip
     Rappture::Tooltip::tooltip show $c +$tx,+$ty
 }
@@ -2590 +2719 @@
     $c itemconfigure title -text $title
     if { [info exists _limits($_curFldName)] } {
-        foreach { vmin vmax } $_limits($_curFldName) break
+        if { $_settings(-customrange) } {
+            set vmin [$itk_component(min) value]
+            set vmax [$itk_component(max) value]
+        } else {
+            foreach { vmin vmax } $_limits($_curFldName) break
+        }
         $c itemconfigure vmin -text [format %g $vmin]
         $c itemconfigure vmax -text [format %g $vmax]
@@ -2608 +2742 @@
     $c raise sensor
     $c coords vmin $x [expr {$h - 2}]
+
+    $c bind vmin <ButtonPress> [itcl::code $this LegendRangeAction popup vmin]
+    $c bind vmin <Enter> [itcl::code $this LegendRangeAction enter vmin]
+    $c bind vmin <Leave> [itcl::code $this LegendRangeAction leave vmin]
+
+    $c bind vmax <ButtonPress> [itcl::code $this LegendRangeAction popup vmax]
+    $c bind vmax <Enter> [itcl::code $this LegendRangeAction enter vmax]
+    $c bind vmax <Leave> [itcl::code $this LegendRangeAction leave vmax]
 }
 
@@ -2648 +2790 @@
             error "bad option \"$option\": should be post, enter, leave or save"
         }
+    }
+}
+
+# ----------------------------------------------------------------------
+# USAGE: LegendRangeValidate <widget> <which> <value>
+#
+# Used internally to validate a legend range min/max value.
+# Returns a boolean value telling if <value> was accepted (1) or rejected (0)
+# If the value is rejected, a tooltip/warning message is popped up
+# near the widget that asked for the validation, specified by <widget>
+#
+# <widget> is the widget where a tooltip/warning message should show up on
+# <which> is either "vmin" or "vmax".
+# <value> is the value to be validated.
+# ----------------------------------------------------------------------
+itcl::body Rappture::VtkGlyphViewer::LegendRangeValidate {widget which value} {
+    #check for a valid value
+    if {[string is double $value] != 1} {
+        set msg "should be valid number"
+        if {$widget != ""} {
+            Rappture::Tooltip::cue $widget $msg
+        } else {
+            # error "bad value \"$value\": $msg"
+            error $msg
+        }
+        return 0
+    }
+
+    switch -- $which {
+        vmin {
+            # check for min > max
+            if {$value > [$itk_component(max) value]} {
+                set msg "min > max, change max first"
+                if {$widget != ""} {
+                    Rappture::Tooltip::cue $widget $msg
+                } else {
+                    # error "bad value \"$value\": $msg"
+                    error $msg
+                }
+                return 0
+            }
+        }
+        vmax {
+            # check for max < min
+            if {$value < [$itk_component(min) value]} {
+                set msg "max < min, change min first"
+                if {$widget != ""} {
+                    Rappture::Tooltip::cue $widget $msg
+                } else {
+                    # error "bad value \"$value\": $msg"
+                    error $msg
+                }
+                return 0
+            }
+        }
+        default {
+            error "bad option \"$which\": should be vmin, vmax"
+        }
+    }
+}
+
+itcl::body Rappture::VtkGlyphViewer::MouseOver2Which {} {
+    switch -- $_mouseOver {
+        vmin {
+            set which min
+        }
+        vmax {
+            set which max
+        }
+        default {
+            error "bad _mouseOver \"$_mouseOver\": should be vmin, vmax"
+        }
+    }
+    return $which
+}
+
+# ----------------------------------------------------------------------
+# USAGE: LegendRangeAction enter <which>
+# USAGE: LegendRangeAction leave <which>
+#
+# USAGE: LegendRangeAction popup <which>
+# USAGE: LegendRangeAction activate
+# USAGE: LegendRangeAction validate <value>
+# USAGE: LegendRangeAction apply <value>
+#
+# Used internally to handle the mouseover and popup entry for the field range
+# inputs.  The enter option is invoked when the user moves the mouse over the
+# min or max field range. The leave option is invoked when the user moves the
+# mouse away from the min or max field range. The popup option is invoked when
+# the user click's on a field range. The popup option stores internally which
+# widget is requesting a popup ( in the _mouseOver variable) and calls the
+# activate command of the widget. The widget's activate command calls back to
+# this method to get the xywh dimensions of the popup editor. After the user
+# changes focus or sets the value in the editor, the editor calls this methods
+# validate and apply options to set the value.
+# ----------------------------------------------------------------------
+itcl::body Rappture::VtkGlyphViewer::LegendRangeAction {option args} {
+    set c $itk_component(view)
+
+    switch -- $option {
+        enter {
+            set which [lindex $args 0]
+            $c itemconfigure $which -fill red
+        }
+        leave {
+            set which [lindex $args 0]
+            $c itemconfigure $which -fill $itk_option(-plotforeground)
+        }
+        popup {
+            DisableMouseRotationBindings
+            set which [lindex $args 0]
+            set _mouseOver $which
+            $itk_component(editor) activate
+        }
+        activate {
+            foreach { x1 y1 x2 y2 } [$c bbox $_mouseOver] break
+            set which [MouseOver2Which]
+            set info(text) [$itk_component($which) value]
+            set info(x) [expr $x1 + [winfo rootx $c]]
+            set info(y) [expr $y1 + [winfo rooty $c]]
+            set info(w) [expr $x2 - $x1]
+            set info(h) [expr $y2 - $y1]
+            return [array get info]
+        }
+        validate {
+            if {[llength $args] != 1} {
+                error "wrong # args: should be \"editor validate value\""
+            }
+
+            set value [lindex $args 0]
+            if {[LegendRangeValidate $itk_component(editor) $_mouseOver $value] == 0} {
+                return 0
+            }
+
+            # value was good, apply it
+            # reset the mouse rotation bindings
+            SetupMouseRotationBindings
+        }
+        apply {
+            if {[llength $args] != 1} {
+                error "wrong # args: should be \"editor apply value\""
+            }
+            set value [string trim [lindex $args 0]]
+
+            set which [MouseOver2Which]
+
+            # only set custom range if value changed
+            if {[$itk_component($which) value] != $value} {
+                # set the flag stating the custom range came from the legend
+                # change the value in the gauge
+                # turn on crange to enable the labels and gauges
+                # call AdjustSetting -range (inside ToggleCustomRange)
+                # to update drawing and legend
+                set _customRangeClick 0
+                $itk_component($which) value $value
+                $itk_component(crange) select
+                ToggleCustomRange
+            }
+        }
+        default {
+            error "bad option \"$option\": should be enter, leave, activate, validate, apply"
+        }
+    }
+}
+
+# ----------------------------------------------------------------------
+# USAGE: ToggleCustomRange
+#
+# Called whenever the custom range is turned on or off. Used to save
+# the custom min and custom max set by the user. When the -customrange
+# setting is turned on, the range min and range max gauges are set
+# with the last value set by the user, or the default range if no
+# previous min and max were set.
+#
+# When the custom range is turned on, we check how it was turned on
+# by querying _customRangeClick. If the variable is 1, this means
+# the user clicked the crange checkbutton and we should pull the
+# custom range values from our backup variables. If the variable is 0,
+# the custom range was enabled through the user manipulating the
+# min and max value in the legend.
+# ----------------------------------------------------------------------
+itcl::body Rappture::VtkGlyphViewer::ToggleCustomRange {args} {
+    if { ! $_settings(-customrange) } {
+        # custom range was turned off
+
+        # disable the min/max labels and gauge widgets
+        $itk_component(l_min) configure -state disabled
+        $itk_component(min) configure -state disabled
+        $itk_component(l_max) configure -state disabled
+        $itk_component(max) configure -state disabled
+
+        # backup the custom range
+        set _settings(-customrangemin) [$itk_component(min) value]
+        set _settings(-customrangemax) [$itk_component(max) value]
+
+        # set the gauges to dataset's min and max
+        foreach { vmin vmax } $_limits($_curFldName) break
+        SetMinMaxGauges $vmin $vmax
+    } else {
+        # custom range was turned on
+
+        # enable the min/max labels and gauge widgets
+        $itk_component(l_min) configure -state normal
+        $itk_component(min) configure -state normal
+        $itk_component(l_max) configure -state normal
+        $itk_component(max) configure -state normal
+
+        # if the custom range is being turned on by clicking the
+        # checkbox, restore the min and max gauges from the backup
+        # variables. otherwise, new values for the min and max
+        # widgets will be set later from the legend's editor.
+        if { $_customRangeClick } {
+            SetMinMaxGauges $_settings(-customrangemin) $_settings(-customrangemax)
+        }
+
+        # reset the click flag
+        set _customRangeClick 1
+    }
+    AdjustSetting -range
+}
+
+# ----------------------------------------------------------------------
+# USAGE: SetMinMaxGauges <min> <max>
+#
+# Set the min and max gauges in the correct order, avoiding the
+# error where you try to set the min > max before updating the max or
+# set the max < min before updating the min.
+#
+# There are five range cases to consider with our current range validation.
+# For example:
+# [2,3] -> [0,1]       : update min first, max last
+# [2,3] -> [4,5]       : update max first, min last
+# [2,3] -> [0,2.5]     : update min or max first
+# [2,3] -> [2.5,5]     : update min or max first
+# [2,3] -> [2.25,2.75] : update min or max first
+#
+# In 4 of the cases we can update min first and max last, so we only
+# need to check the case where old max < new min, where we update
+# max first and min last.
+# ----------------------------------------------------------------------
+itcl::body Rappture::VtkGlyphViewer::SetMinMaxGauges {min max} {
+
+    if { [$itk_component(max) value] < $min} {
+        # old max < new min
+        # shift range toward right
+        # extend max first, then update min
+        $itk_component(max) value $max
+        $itk_component(min) value $min
+    } else {
+        # extend min first, then update max
+        $itk_component(min) value $min
+        $itk_component(max) value $max
     }
 }
@@ -2725 +3119 @@
                 set _curFldName $fname
                 set _curFldLabel $label
+                set _curFldComp $components
             }
         }
     }
     $itk_component(field) value $_curFldLabel
-}
+    if { $_settings(-customrange) } {
+        set limits [list [$itk_component(min) value] [$itk_component(max) value]]
+        SendCmd "dataset maprange explicit $limits $_curFldName point_data $_curFldComp"
+    } else {
+        if { ![info exists _limits($_curFldName)] } {
+            SendCmd "dataset maprange all"
+        } else {
+            set limits $_limits($_curFldName)
+            SendCmd "dataset maprange explicit $limits $_curFldName point_data $_curFldComp"
+        }
+    }
+}