Context Navigation

source: trunk/gui/scripts/deviceViewer1D.tcl @ 2417

Last change on this file since 2417 was 1929, checked in by gah, 14 years ago

File size: 29.7 KB

Line
1	# ----------------------------------------------------------------------
2	# COMPONENT: deviceViewer1D - visualizer for 1D device geometries
3	#
4	# This widget is a simple visualizer for 1D devices. It takes the
5	# Rappture XML representation for a 1D device and draws various
6	# facets of the data. Each facet shows the physical layout along
7	# with some other quantity. The "Electrical" facet shows electrical
8	# contacts. The "Doping" facet shows the doping profile, and so
9	# forth.
10	# ======================================================================
11	# AUTHOR: Michael McLennan, Purdue University
12	# Copyright (c) 2004-2005 Purdue Research Foundation
13	#
14	# See the file "license.terms" for information on usage and
15	# redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
16	# ======================================================================
17	package require Itk
18	package require Img
19	package require BLT
20
21	option add *DeviceViewer1D.padding 4 widgetDefault
22	option add *DeviceViewer1D.deviceSize 0.25i widgetDefault
23	option add *DeviceViewer1D.deviceOutline black widgetDefault
24	option add DeviceViewer1Dgraph.width 3i widgetDefault
25	option add DeviceViewer1Dgraph.height 2i widgetDefault
26
27	itcl::class Rappture::DeviceViewer1D {
28	inherit itk::Widget
29
30	itk_option define -device device Device ""
31
32	constructor {owner args} { # defined below }
33	destructor { # defined below }
34
35	public method add {dataobj {settings ""}}
36	public method get {}
37	public method delete {args}
38	public method parameters {title args} { # do nothing }
39
40	public method controls {option args}
41	public method download {option args}
42
43	protected method _loadDevice {}
44	protected method _loadParameters {frame path}
45	protected method _changeTabs {}
46	protected method _fixSize {}
47	protected method _fixAxes {}
48	protected method _align {}
49
50	protected method _marker {option {name ""} {path ""}}
51
52	protected method _controlCreate {container libObj path}
53	protected method _controlSet {widget libObj path}
54
55	private variable _owner "" ;# thing managing this control
56	private variable _dlist "" ;# list of dataobj objects
57	private variable _dobj2raise ;# maps dataobj => raise flag
58	private variable _device "" ;# XML library with <structure>
59	private variable _tab2fields ;# maps tab name => list of fields
60	private variable _field2parm ;# maps field path => parameter name
61	private variable _units "" ;# units for field being edited
62	private variable _marker ;# marker currently being edited
63	}
64
65	itk::usual DeviceViewer1D {
66	}
67
68	# ----------------------------------------------------------------------
69	# CONSTRUCTOR
70	# ----------------------------------------------------------------------
71	itcl::body Rappture::DeviceViewer1D::constructor {owner args} {
72	set _owner $owner
73
74	pack propagate $itk_component(hull) no
75
76	itk_component add tabs {
77	blt::tabset $itk_interior.tabs -borderwidth 0 -relief flat \
78	-side bottom -tearoff 0 \
79	-selectcommand [itcl::code $this _changeTabs]
80	} {
81	keep -activebackground -activeforeground
82	keep -background -cursor -font
83	rename -highlightbackground -background background Background
84	keep -highlightcolor -highlightthickness
85	keep -tabbackground -tabforeground
86	rename -selectbackground -background background Background
87	rename -selectforeground -foreground foreground Foreground
88	}
89	pack $itk_component(tabs) -expand yes -fill both
90
91	itk_component add -protected inner {
92	frame $itk_component(tabs).inner
93	}
94
95	itk_component add top {
96	frame $itk_component(inner).top
97	}
98	pack $itk_component(top) -fill x
99
100	itk_component add layout {
101	Rappture::DeviceLayout1D $itk_component(inner).layout
102	}
103	pack $itk_component(layout) -side top -fill x -pady 4
104
105	itk_component add graph {
106	blt::graph $itk_component(inner).graph \
107	-highlightthickness 0 -plotpadx 0 -plotpady 0
108	} {
109	keep -background -foreground -cursor -font
110	}
111	pack $itk_component(graph) -expand yes -fill both
112	$itk_component(graph) legend configure -hide yes
113
114	bind $itk_component(graph) <Configure> "
115	[list after cancel [list catch [itcl::code $this _align]]]
116	[list after 100 [list catch [itcl::code $this _align]]]
117	"
118
119	itk_component add geditor {
120	Rappture::Editor $itk_component(graph).editor \
121	-activatecommand [itcl::code $this _marker activate] \
122	-validatecommand [itcl::code $this _marker validate] \
123	-applycommand [itcl::code $this _marker apply]
124	}
125
126	itk_component add devcntls {
127	Rappture::Notebook $itk_component(inner).devcntls
128	}
129	pack $itk_component(devcntls) -side bottom -fill x
130
131	eval itk_initialize $args
132
133	after cancel [list catch [itcl::code $this _fixSize]]
134	after idle [list catch [itcl::code $this _fixSize]]
135	}
136
137	# ----------------------------------------------------------------------
138	# DESTRUCTOR
139	# ----------------------------------------------------------------------
140	itcl::body Rappture::DeviceViewer1D::destructor {} {
141	set _device ""
142	foreach name [array names _tab2fields] {
143	eval itcl::delete object $_tab2fields($name)
144	}
145	after cancel [list catch [itcl::code $this _fixAxes]]
146	after cancel [list catch [itcl::code $this _align]]
147	after cancel [list catch [itcl::code $this _loadDevice]]
148	}
149
150	# ----------------------------------------------------------------------
151	# USAGE: add <dataobj> ?<settings>?
152	#
153	# Clients use this to add a data object to the plot. The optional
154	# <settings> are used to configure the plot. Allowed settings are
155	# -color, -brightness, -width, -linestyle, and -raise. Only
156	# -brightness and -raise do anything.
157	# ----------------------------------------------------------------------
158	itcl::body Rappture::DeviceViewer1D::add {dataobj {settings ""}} {
159	array set params {
160	-color auto
161	-brightness 0
162	-width 1
163	-raise 0
164	-linestyle solid
165	-description ""
166	-param ""
167	}
168	foreach {opt val} $settings {
169	if {![info exists params($opt)]} {
170	error "bad settings \"$opt\": should be [join [lsort [array names params]] {, }]"
171	}
172	set params($opt) $val
173	}
174
175	set pos [lsearch -exact $dataobj $_dlist]
176
177	if {$pos < 0} {
178	if {![Rappture::library isvalid $dataobj]} {
179	error "bad value \"$dataobj\": should be Rappture::library object"
180	}
181
182	lappend _dlist $dataobj
183	set _dobj2raise($dataobj) $params(-raise)
184
185	after cancel [list catch [itcl::code $this _loadDevice]]
186	after idle [list catch [itcl::code $this _loadDevice]]
187	}
188	}
189
190	# ----------------------------------------------------------------------
191	# USAGE: get
192	#
193	# Clients use this to query the list of objects being plotted, in
194	# order from bottom to top of this result.
195	# ----------------------------------------------------------------------
196	itcl::body Rappture::DeviceViewer1D::get {} {
197	# put the dataobj list in order according to -raise options
198	set dlist $_dlist
199	foreach obj $dlist {
200	if {[info exists _dobj2raise($obj)] && $_dobj2raise($obj)} {
201	set i [lsearch -exact $dlist $obj]
202	if {$i >= 0} {
203	set dlist [lreplace $dlist $i $i]
204	lappend dlist $obj
205	}
206	}
207	}
208	return $dlist
209	}
210
211	# ----------------------------------------------------------------------
212	# USAGE: delete ?<dataobj> <dataobj> ...?
213	#
214	# Clients use this to delete a dataobj from the plot. If no dataobjs
215	# are specified, then all dataobjs are deleted.
216	# ----------------------------------------------------------------------
217	itcl::body Rappture::DeviceViewer1D::delete {args} {
218	if {[llength $args] == 0} {
219	set args $_dlist
220	}
221
222	# delete all specified dataobjs
223	set changed 0
224	foreach dataobj $args {
225	set pos [lsearch -exact $_dlist $dataobj]
226	if {$pos >= 0} {
227	set _dlist [lreplace $_dlist $pos $pos]
228	catch {unset _dobj2raise($dataobj)}
229	set changed 1
230	}
231	}
232
233	# if anything changed, then rebuild the plot
234	if {$changed} {
235	after cancel [list catch [itcl::code $this _loadDevice]]
236	after idle [list catch [itcl::code $this _loadDevice]]
237	}
238	}
239
240	# ----------------------------------------------------------------------
241	# USAGE: controls insert <pos> <xmlobj> <path>
242	#
243	# Clients use this to add a control to the internal panels of this
244	# widget. Such controls are usually placed at the top of the widget,
245	# but if possible, they are integrated directly onto the device
246	# layout or the field area.
247	# ----------------------------------------------------------------------
248	itcl::body Rappture::DeviceViewer1D::controls {option args} {
249	switch -- $option {
250	insert {
251	if {[llength $args] != 3} {
252	error "wrong # args: should be \"controls insert pos xmlobj path\""
253	}
254	set pos [lindex $args 0]
255	set xmlobj [lindex $args 1]
256	set path [lindex $args 2]
257	if {[string match structure.parameters $path]} {
258	} elseif {[string match structure.components* $path]} {
259	$itk_component(layout) controls insert $pos $xmlobj $path
260	}
261	}
262	default {
263	error "bad option \"$option\": should be insert"
264	}
265	}
266	}
267
268
269	# ----------------------------------------------------------------------
270	# USAGE: download coming
271	# USAGE: download controls <downloadCommand>
272	# USAGE: download now
273	#
274	# Clients use this method to create a downloadable representation
275	# of the plot. Returns a list of the form {ext string}, where
276	# "ext" is the file extension (indicating the type of data) and
277	# "string" is the data itself.
278	# ----------------------------------------------------------------------
279	itcl::body Rappture::DeviceViewer1D::download {option args} {
280	switch $option {
281	coming {
282	# nothing to do
283	}
284	controls {
285	# no controls for this download yet
286	return ""
287	}
288	now {
289	return "" ;# not implemented yet!
290	}
291	default {
292	error "bad option \"$option\": should be coming, controls, now"
293	}
294	}
295	}
296
297	# ----------------------------------------------------------------------
298	# USAGE: _loadDevice
299	#
300	# Used internally to search for fields and create corresponding
301	# tabs whenever a device is installed into this viewer.
302	# ----------------------------------------------------------------------
303	itcl::body Rappture::DeviceViewer1D::_loadDevice {} {
304	set _device [lindex [get] end]
305
306	#
307	# Release any info left over from the last device.
308	#
309	foreach name [array names _tab2fields] {
310	eval itcl::delete object $_tab2fields($name)
311	}
312	catch {unset _tab2fields}
313	catch {unset _field2parm}
314
315	if {[winfo exists $itk_component(top).cntls]} {
316	$itk_component(top).cntls delete 0 end
317	}
318
319	#
320	# Scan through the current device and extract the list of
321	# fields. Create a tab for each field.
322	#
323	if {$_device != ""} {
324	foreach nn [$_device children fields] {
325	set name [$_device get fields.$nn.about.label]
326	if {$name == ""} {
327	set name $nn
328	}
329
330	set fobj [Rappture::Field ::#auto $_device fields.$nn]
331	lappend _tab2fields($name) $fobj
332	}
333	}
334	set tabs [lsort [array names _tab2fields]]
335
336	if {[$itk_component(tabs) size] > 0} {
337	$itk_component(tabs) delete 0 end
338	}
339
340	if {[llength $tabs] <= 0} {
341	#
342	# No fields? Then we don't need to bother with tabs.
343	# Just pack the inner frame directly. If there are no
344	# fields, get rid of the graph.
345	#
346	pack $itk_component(inner) -expand yes -fill both
347	if {[llength $tabs] > 0} {
348	pack $itk_component(graph) -expand yes -fill both
349	} else {
350	pack forget $itk_component(graph)
351	$itk_component(layout) configure -leftmargin 0 -rightmargin 0
352	}
353	} else {
354	#
355	# Two or more fields? Then create a tab for each field
356	# and select the first one by default. Make sure the
357	# graph is packed.
358	#
359	pack forget $itk_component(inner)
360	pack $itk_component(graph) -expand yes -fill both
361
362	foreach name $tabs {
363	$itk_component(tabs) insert end $name \
364	-activebackground $itk_option(-background)
365	}
366	$itk_component(tabs) select 0
367	}
368
369	#
370	# Scan through and look for any parameters in the <structure>.
371	# Register any parameters associated with fields, so we can
372	# add them as active controls whenever we install new fields.
373	# Create controls for any remaining parameters, so the user
374	# can see that there's something to adjust.
375	#
376	if {$_device != ""} {
377	_loadParameters $itk_component(top) parameters
378	}
379
380	#
381	# Install the first tab
382	#
383	_changeTabs
384
385	#
386	# Fix the right margin of the graph so that it has enough room
387	# to display the right-hand edge of the device.
388	#
389	$itk_component(graph) configure \
390	-rightmargin [$itk_component(layout) extents bar3D]
391
392	after cancel [list catch [itcl::code $this _fixSize]]
393	after idle [list catch [itcl::code $this _fixSize]]
394	}
395
396	# ----------------------------------------------------------------------
397	# USAGE: _loadParameters <frame> <path>
398	#
399	# Used internally in _loadDevice to load child parameters at the
400	# specified <path> into the <frame>. If any of the children are
401	# groups, then this is called recursively to fill in the group
402	# children.
403	# ----------------------------------------------------------------------
404	itcl::body Rappture::DeviceViewer1D::_loadParameters {frame path} {
405	foreach cname [$_device children $path] {
406	set handled 0
407	set type [$_device element -as type $path.$cname]
408	if {$type == "about"} {
409	continue
410	}
411	if {$type == "number"} {
412	set name [$_device element -as id $path.$cname]
413
414	# look for a field that uses this parameter
415	set found ""
416	foreach fname [$_device children fields] {
417	foreach comp [$_device children fields.$fname] {
418	set v [$_device get fields.$fname.$comp.constant]
419	if {[string equal $v $name]} {
420	set found "fields.$fname.$comp"
421	break
422	}
423	}
424	if {"" != $found} break
425	}
426
427	if {"" != $found} {
428	set _field2parm($found) $name
429	set handled 1
430	}
431	}
432
433	#
434	# Any parameter that was not handled above should be handled
435	# here, by adding it to a control panel above the device
436	# layout area.
437	#
438	if {!$handled} {
439	if {![winfo exists $frame.cntls]} {
440	Rappture::Controls $frame.cntls $_owner
441	pack $frame.cntls -expand yes -fill both
442	}
443	$frame.cntls insert end $path.$cname
444
445	#
446	# If this is a group, then we must add its children
447	# recursively.
448	#
449	if {$type == "group"} {
450	set gr [$frame.cntls control -value end]
451	_loadParameters [$gr component inner] $path.$cname
452	}
453	}
454	}
455	}
456
457	# ----------------------------------------------------------------------
458	# USAGE: _changeTabs
459	#
460	# Used internally to change the field being displayed whenever a new
461	# tab is selected.
462	# ----------------------------------------------------------------------
463	itcl::body Rappture::DeviceViewer1D::_changeTabs {} {
464	set graph $itk_component(graph)
465
466	#
467	# Figure out which tab is selected and make the inner frame
468	# visible in that tab.
469	#
470	set i [$itk_component(tabs) index select]
471	if {$i != ""} {
472	set name [$itk_component(tabs) get $i]
473	$itk_component(tabs) tab configure $name \
474	-window $itk_component(inner) -fill both
475	} else {
476	set name [lindex [array names _tab2fields] 0]
477	}
478
479	#
480	# Update the graph to show the current field.
481	#
482	eval $graph element delete [$graph element names]
483	eval $graph marker delete [$graph marker names]
484
485	foreach {zmin zmax} [$itk_component(layout) limits] { break }
486	if {$zmin != "" && $zmin < $zmax} {
487	$graph axis configure x -min $zmin -max $zmax
488	}
489
490	if {$_device != ""} {
491	set units [$_device get units]
492	if {$units != "arbitrary"} {
493	$graph axis configure x -hide no -title "Position ($units)"
494	} else {
495	$graph axis configure x -hide yes
496	}
497	} else {
498	$graph axis configure x -hide no -title "Position"
499	}
500	$graph axis configure x -checklimits no
501
502	# turn on auto limits
503	$graph axis configure y -min "" -max "" -checklimits no
504
505	set flist ""
506	if {[info exists _tab2fields($name)]} {
507	set flist $_tab2fields($name)
508	}
509
510	set n 0
511	foreach fobj $flist {
512	catch {unset hints}
513	array set hints [$fobj hints]
514
515	if {[info exists hints(units)]} {
516	set _units $hints(units)
517	$graph axis configure y -title "$name ($hints(units))"
518	} else {
519	set _units ""
520	$graph axis configure y -title $name
521	}
522
523	if {[info exists hints(scale)]
524	&& [string match log* $hints(scale)]} {
525	$graph axis configure y -logscale yes
526	} else {
527	$graph axis configure y -logscale no
528	}
529
530	foreach comp [$fobj components] {
531	# can only handle 1D meshes here
532	if {[$fobj components -dimensions $comp] != "1D"} {
533	continue
534	}
535
536	set elem "elem[incr n]"
537	set xv [$fobj mesh $comp]
538	set yv [$fobj values $comp]
539
540	$graph element create $elem -x $xv -y $yv \
541	-color black -symbol "" -linewidth 2
542
543	if {[info exists hints(color)]} {
544	$graph element configure $elem -color $hints(color)
545	}
546
547	foreach {path x y val} [$fobj controls get $comp] {
548	if {$path != ""} {
549	set id "control[incr n]"
550	$graph marker create text -coords [list $x $y] \
551	-text $val -anchor s -name $id -background ""
552	$graph marker bind $id <Enter> \
553	[itcl::code $this _marker enter $id]
554	$graph marker bind $id <Leave> \
555	[itcl::code $this _marker leave $id]
556	$graph marker bind $id <ButtonPress> \
557	[itcl::code $this _marker edit $id $fobj/$path]
558	}
559	}
560	}
561	}
562
563	# let the widget settle, then fix the axes to "nice" values
564	after cancel [list catch [itcl::code $this _fixAxes]]
565	after 100 [list catch [itcl::code $this _fixAxes]]
566	}
567
568	# ----------------------------------------------------------------------
569	# USAGE: _fixSize
570	#
571	# Used internally to fix the overall size of this widget based on
572	# the various parts inside. Sets the requested width/height of the
573	# widget so that it is big enough to display the device and its
574	# fields.
575	# ----------------------------------------------------------------------
576	itcl::body Rappture::DeviceViewer1D::_fixSize {} {
577	update idletasks
578	set w [winfo reqwidth $itk_component(tabs)]
579	set h [winfo reqheight $itk_component(tabs)]
580	component hull configure -width $w -height $h
581	}
582
583	# ----------------------------------------------------------------------
584	# USAGE: _fixAxes
585	#
586	# Used internally to adjust the y-axis limits of the graph to "nice"
587	# values, so that any control marker associated with the value,
588	# for example, remains on screen.
589	# ----------------------------------------------------------------------
590	itcl::body Rappture::DeviceViewer1D::_fixAxes {} {
591	set graph $itk_component(graph)
592	if {![winfo ismapped $graph]} {
593	after cancel [list catch [itcl::code $this _fixAxes]]
594	after 100 [list catch [itcl::code $this _fixAxes]]
595	return
596	}
597
598	#
599	# HACK ALERT!
600	# Use this code to fix up the y-axis limits for the BLT graph.
601	# The auto-limits don't always work well. We want them to be
602	# set to a "nice" number slightly above or below the min/max
603	# limits.
604	#
605	set log [$graph axis cget y -logscale]
606	$graph axis configure y -min "" -max ""
607	foreach {min max} [$graph axis limits y] { break }
608
609	if {$log} {
610	set min [expr {0.9*$min}]
611	set max [expr {1.1*$max}]
612	} else {
613	if {$min > 0} {
614	set min [expr {0.95*$min}]
615	} else {
616	set min [expr {1.05*$min}]
617	}
618	if {$max > 0} {
619	set max [expr {1.05*$max}]
620	} else {
621	set max [expr {0.95*$max}]
622	}
623	}
624
625	# bump up the max so that it's big enough to show control markers
626	set fnt $itk_option(-font)
627	set h [expr {[font metrics $fnt -linespace] + 5}]
628	foreach mname [$graph marker names] {
629	set xy [$graph marker cget $mname -coord]
630	foreach {x y} [eval $graph transform $xy] { break }
631	set y [expr {$y-$h}] ;# find top of text in pixels
632	foreach {x y} [eval $graph invtransform [list 0 $y]] { break }
633	if {$y > $max} { set max $y }
634	}
635
636	if {$log} {
637	set min [expr {pow(10.0,floor(log10($min)))}]
638	set max [expr {pow(10.0,ceil(log10($max)))}]
639	} else {
640	set min [expr {0.1floor(10$min)}]
641	set max [expr {0.1ceil(10$max)}]
642	}
643
644	$graph axis configure y -min $min -max $max
645
646	after cancel [list catch [itcl::code $this _align]]
647	after 100 [list catch [itcl::code $this _align]]
648	}
649
650	# ----------------------------------------------------------------------
651	# USAGE: _align
652	#
653	# Used internally to align the margins of the device layout and the
654	# graph, so that two areas line up.
655	# ----------------------------------------------------------------------
656	itcl::body Rappture::DeviceViewer1D::_align {} {
657	set graph $itk_component(graph)
658
659	#
660	# Set the left/right margins of the layout so that it aligns
661	# with the graph. Set the right margin of the graph so it
662	# it is big enough to show the 3D edge of the device that
663	# hangs over on the right-hand side.
664	#
665	update
666	foreach {xmin xmax} [$graph axis limits x] { break }
667	set lm [$graph xaxis transform $xmin]
668	$itk_component(layout) configure -leftmargin $lm
669
670	set w [winfo width $graph]
671	set rm [expr {$w-[$graph xaxis transform $xmax]}]
672	$itk_component(layout) configure -rightmargin $rm
673	}
674
675	# ----------------------------------------------------------------------
676	# USAGE: _marker enter <name>
677	# USAGE: _marker leave <name>
678	# USAGE: _marker edit <name> <path>
679	# USAGE: _marker activate
680	# USAGE: _marker validate <value>
681	# USAGE: _marker apply <value>
682	#
683	# Used internally to manipulate the control markers draw on the
684	# graph for a field.
685	# ----------------------------------------------------------------------
686	itcl::body Rappture::DeviceViewer1D::_marker {option {name ""} {path ""}} {
687	switch -- $option {
688	enter {
689	$itk_component(graph) marker configure $name -background #e5e5e5
690	#
691	# BE CAREFUL: Need an update here to force the graph to
692	# refresh itself or else a subsequent click on the
693	# marker will ignore the text that was recently changed,
694	# and fail to generate a <ButtonPress> event!
695	#
696	update idletasks
697	}
698	leave {
699	$itk_component(graph) marker configure $name -background ""
700	#
701	# BE CAREFUL: Need an update here to force the graph to
702	# refresh itself or else a subsequent click on the
703	# marker will ignore the text that was recently changed,
704	# and fail to generate a <ButtonPress> event!
705	#
706	update idletasks
707	}
708	edit {
709	set _marker(name) $name
710	set _marker(fobj) [lindex [split $path /] 0]
711	set _marker(path) [lindex [split $path /] 1]
712	$itk_component(geditor) activate
713	}
714	activate {
715	set g $itk_component(graph)
716	set val [$g marker cget $_marker(name) -text]
717	foreach {x y} [$g marker cget $_marker(name) -coords] { break }
718	foreach {x y} [$g transform $x $y] { break }
719	set x [expr {$x + [winfo rootx $g] - 4}]
720	set y [expr {$y + [winfo rooty $g] - 5}]
721
722	set fnt $itk_option(-font)
723	set h [expr {[font metrics $fnt -linespace] + 2}]
724	set w [expr {[font measure $fnt $val] + 5}]
725
726	return [list text $val \
727	x [expr {$x-$w/2}] \
728	y [expr {$y-$h}] \
729	w $w \
730	h $h]
731	}
732	validate {
733	if {$_units != ""} {
734	if {[catch {Rappture::Units::convert $name \
735	-context $_units -to $_units} result] != 0} {
736	if {[regexp {^bad.*: +(.)(.+)} $result match first tail]
737	\|\| [regexp {(.)(.+)} $result match first tail]} {
738	set result "[string toupper $first]$tail"
739	}
740	bell
741	Rappture::Tooltip::cue $itk_component(geditor) $result
742	return 0
743	}
744	}
745	if {[catch {$_marker(fobj) controls validate $_marker(path) $name} result]} {
746	bell
747	Rappture::Tooltip::cue $itk_component(geditor) $result
748	return 0
749	}
750	return 1
751	}
752	apply {
753	if {$_units != ""} {
754	catch {Rappture::Units::convert $name \
755	-context $_units -to $_units} value
756	} else {
757	set value $name
758	}
759
760	$_marker(fobj) controls put $_marker(path) $value
761	$_owner changed $_marker(path)
762	event generate $itk_component(hull) <<Edit>>
763
764	_changeTabs
765	}
766	}
767	}
768
769	# ----------------------------------------------------------------------
770	# USAGE: _controlCreate <container> <libObj> <path>
771	#
772	# Used internally to create a gauge widget and pack it into the
773	# given <container>. When the gauge is set, it updates the value
774	# for the <path> in the <libObj>.
775	# ----------------------------------------------------------------------
776	itcl::body Rappture::DeviceViewer1D::_controlCreate {container libObj path} {
777	set presets ""
778	foreach pre [$libObj children -type preset $path] {
779	lappend presets \
780	[$libObj get $path.$pre.value] \
781	[$libObj get $path.$pre.label]
782	}
783
784	set type Rappture::Gauge
785	set units [$libObj get $path.units]
786	if {$units != ""} {
787	set desc [Rappture::Units::description $units]
788	if {[string match temperature* $desc]} {
789	set type Rappture::TemperatureGauge
790	}
791	}
792
793	set counter 0
794	set w "$container.gauge[incr counter]"
795	while {[winfo exists $w]} {
796	set w "$container.gauge[incr counter]"
797	}
798
799	# create the widget
800	$type $w -units $units -presets $presets
801	pack $w -side top -anchor w
802	bind $w <<Value>> [itcl::code $this _controlSet $w $libObj $path]
803
804	set min [$libObj get $path.min]
805	if {"" != $min} { $w configure -minvalue $min }
806
807	set max [$libObj get $path.max]
808	if {"" != $max} { $w configure -maxvalue $max }
809
810	set str [$libObj get $path.default]
811	if {$str != ""} { $w value $str }
812
813	if {$type == "Rappture::Gauge" && "" != $min && "" != $max} {
814	set color [$libObj get $path.color]
815	if {$color == ""} {
816	set color blue
817	}
818	if {$units != ""} {
819	set min [Rappture::Units::convert $min -to $units -units off]
820	set max [Rappture::Units::convert $max -to $units -units off]
821	}
822	$w configure -spectrum [Rappture::Spectrum ::#auto [list \
823	$min white $max $color] -units $units]
824	}
825
826	set str [$libObj get $path.label]
827	if {$str != ""} {
828	set help [$libObj get $path.help]
829	if {"" != $help} {
830	append str "\n$help"
831	}
832	if {$units != ""} {
833	set desc [Rappture::Units::description $units]
834	append str "\n(units of $desc)"
835	}
836	Rappture::Tooltip::for $w $str
837	}
838
839	set str [$libObj get $path.icon]
840	if {$str != ""} {
841	$w configure -image [image create photo -data $str]
842	}
843	}
844
845	# ----------------------------------------------------------------------
846	# USAGE: _controlSet <widget> <libObj> <path>
847	#
848	# Invoked automatically whenever an internal control changes value.
849	# Queries the new value for the control and assigns the value to the
850	# given <path> on the XML object <libObj>.
851	# ----------------------------------------------------------------------
852	itcl::body Rappture::DeviceViewer1D::_controlSet {widget libObj path} {
853	set newval [$widget value]
854	$libObj put $path.current $newval
855	event generate $itk_component(hull) <<Edit>>
856	}
857
858	# ----------------------------------------------------------------------
859	# CONFIGURATION OPTION: -device
860	#
861	# Set to the Rappture::Library object representing the device being
862	# displayed in the viewer. If set to "", the viewer is cleared to
863	# display nothing.
864	# ----------------------------------------------------------------------
865	itcl::configbody Rappture::DeviceViewer1D::device {
866	if {$itk_option(-device) != ""} {
867	if {![Rappture::library isvalid $itk_option(-device)]} {
868	error "bad value \"$itk_option(-device)\": should be Rappture::Library"
869	}
870	}
871
872	delete
873	if {"" != $itk_option(-device)} {
874	add $itk_option(-device)
875	}
876	_loadDevice
877	}

Note: See TracBrowser for help on using the repository browser.

Download in other formats: