2e99346874647777682ca25953901a9cbfee29d2
[occt.git] / dox / user_guides / draw_test_harness / draw_test_harness.md
1 Draw Test Harness  {#occt_user_guides__test_harness}
2 ===============================
3
4 @tableofcontents
5  
6 @section occt_draw_1 Introduction
7
8 This manual explains how to use Draw, the test harness for Open CASCADE Technology (**OCCT**).
9 Draw is a command interpreter based on TCL and a graphical system used to test and demonstrate Open CASCADE Technology modeling libraries. 
10
11 @subsection occt_draw_1_1 Overview
12
13 Draw is a test harness for Open CASCADE Technology. It provides a flexible and easy to use means of testing and demonstrating the OCCT modeling libraries. 
14
15 Draw can be used interactively to create, display and modify objects such as curves, surfaces and topological shapes. 
16
17 Scripts may be written to customize Draw and perform tests. New types of objects and new commands may be added using the C++ programing language. 
18
19 Draw consists of: 
20
21   * A command interpreter based on the TCL command language.
22   * A 3d graphic viewer based on the X system.
23   * A basic set of commands covering scripts, variables and graphics.
24   * A set of geometric commands allowing the user to create and modify curves and surfaces and to use OCCT geometry algorithms. This set of commands is optional.
25   * A set of topological commands allowing the user to create and modify BRep shapes and to use the OCCT topology algorithms.
26
27
28 There is also a set of commands for each delivery unit in the modeling libraries: 
29
30   * GEOMETRY, 
31   * TOPOLOGY, 
32   * ADVALGOS, 
33   * GRAPHIC, 
34   * PRESENTATION. 
35
36
37 @subsection occt_draw_1_2 Contents of this documentation
38
39 This documentation describes: 
40
41   * The command language.
42   * The basic set of commands.
43   * The graphical commands.
44   * The Geometry set of commands.
45   * The Topology set of commands.
46
47 This document does not describe other sets of commands and does not explain how to extend Draw using C++. 
48
49 This document is a reference manual. It contains a full description of each command. All descriptions have the format illustrated below for the exit command. 
50
51 ~~~~~
52 exit
53 ~~~~~
54
55 Terminates the Draw, TCL session. If the commands are read from a file using the source command, this will terminate the file. 
56
57 **Example:** 
58
59 ~~~~~
60 # this is a very short example 
61 exit 
62 ~~~~~
63
64
65 @subsection occt_draw_1_3 Getting started
66
67 Install Draw and launch Emacs. Get a command line in Emacs using *Esc x* and key in *woksh*. 
68
69 All DRAW Test Harness can be activated in the common executable called **DRAWEXE**. They are grouped in toolkits and can be loaded at run-time thereby implementing dynamically loaded plug-ins. Thus, it is possible to work only with the required commands adding them dynamically without leaving the Test Harness session. 
70
71 Declaration of available plug-ins is done through the special resource file(s). The *pload* command loads the plug-in in accordance with the specified resource file and activates the commands implemented in the plug-in. 
72
73 @subsubsection occt_draw_1_3_1 Launching DRAW Test Harness
74
75 Test Harness executable *DRAWEXE* is located in the <i>$CASROOT/\<platform\>/bin</i> directory (where \<platform\> is Win for Windows and Linux for Linux operating systems). Prior to launching it is important to make sure that the environment is correctly set-up (usually this is done automatically after the installation process on Windows or after launching specific scripts on Linux).  
76
77
78 @subsubsection occt_draw_1_3_2 Plug-in resource file
79
80 Open CASCADE Technology is shipped with the DrawPlugin resource file located in the <i>$CASROOT/src/DrawResources</i> directory. 
81
82 The format of the file is compliant with standard Open CASCADE Technology resource files (see the *Resource_Manager.cdl* file for details). 
83
84 Each key defines a sequence of either further (nested) keys or a name of the dynamic library. Keys can be nested down to an arbitrary level. However, cyclic dependencies between the keys are not checked. 
85
86 **Example:** (excerpt from DrawPlugin): 
87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
88 OCAF               : VISUALIZATION, OCAFKERNEL 
89 VISUALIZATION      : AISV 
90 OCAFKERNEL         : DCAF 
91
92 DCAF               : TKDCAF 
93 AISV               : TKViewerTest 
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95
96 @subsubsection occt_draw_1_3_3 Activation of commands implemented in the plug-in
97
98 To load a plug-in declared in the resource file and to activate the commands the following command must be used in Test Harness: 
99
100 ~~~~~
101 pload [-PluginFileName] [[Key1] [Key2]...]
102 ~~~~~
103
104 where: 
105
106 * <i>-PluginFileName</i> - defines the name of a plug-in resource file (prefix "-" is mandatory) described above. If this parameter is omitted then the default name *DrawPlugin* is used. 
107 * *Key…* - defines the key(s) enumerating plug-ins to be loaded. If no keys are specified then the key named *DEFAULT* is used (if there is no such key in the file then no plug-ins are loaded). 
108
109 According to the OCCT resource file management rules, to access the resource file the environment variable *CSF_PluginFileNameDefaults* (and optionally *CSF_PluginFileNameUserDefaults*) must be set and point to the directory storing the resource file. If it is omitted then the plug-in resource file will be searched in the <i>$CASROOT/src/DrawResources</i> directory. 
110
111 ~~~~~
112 Draw[]        pload -DrawPlugin OCAF 
113 ~~~~~
114 This command will search the resource file *DrawPlugin* using variable *CSF_DrawPluginDefaults* (and *CSF_DrawPluginUserDefaults*) and will start with the OCAF key. Since the *DrawPlugin* is the file shipped with Open CASCADE Technology it will be found in the <i>$CASROOT/src/DrawResources</i> directory (unless this location is redefined by user's variables). The OCAF key will be recursively extracted into two toolkits/plug-ins: *TKDCAF* and *TKViewerTest* (e.g. on Windows they correspond to *TKDCAF.dll* and *TKViewerTest.dll*). Thus, commands implemented for Visualization and OCAF will be loaded and activated in Test Harness. 
115
116 ~~~~~
117 Draw[]        pload (equivalent to pload -DrawPlugin DEFAULT). 
118 ~~~~~
119 This command will find the default DrawPlugin file and the DEFAULT key. The latter finally maps to the TKTopTest toolkit which implements basic modeling commands. 
120
121
122 @section occt_draw_2 The Command Language
123
124 @subsection occt_draw_2_1 Overview
125
126 The command language used in Draw is Tcl. Tcl documentation such as "TCL and the TK Toolkit" by John K. Ousterhout (Addison-Wesley) will prove useful if you intend to use Draw extensively. 
127
128 This chapter is designed to give you a short outline of both the TCL language and some extensions included in Draw. The following topics are covered: 
129
130   * Syntax of the TCL language.
131   * Accessing variables in TCL and Draw.
132   * Control structures.
133   * Procedures.
134
135 @subsection occt_draw_2_2 Syntax of TCL
136
137 TCL is an interpreted command language, not a structured language like C, Pascal, LISP or Basic. It uses a shell similar to that of csh. TCL is, however, easier to use than csh because control structures and procedures are easier to define. As well, because TCL does not assign a process to each command, it is faster than csh. 
138
139 The basic program for TCL is a script. A script consists of one or more commands. Commands are separated by new lines or semicolons. 
140
141 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
142 set a 24 
143 set b 15 
144 set a 25; set b 15 
145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
146
147 Each command consists of one or more *words*; the first word is the name of a command and additional words are arguments to that command. 
148
149 Words are separated by spaces or tabs. In the preceding example each of the four commands has three words. A command may contain any number of words and each word is a string of arbitrary length. 
150
151 The evaluation of a command by TCL is done in two steps. In the first step, the command is parsed and broken into words. Some substitutions are also performed. In the second step, the command procedure corresponding to the first word is called and the other words are interpreted as arguments. In the first step, there is only string manipulation, The words only acquire *meaning* in the second step by the command procedure. 
152
153 The following substitutions are performed by TCL: 
154
155 Variable substitution is triggered by the $ character (as with csh), the content of the variable is substitued; { } may be used as in csh to enclose the name of the variable. 
156
157 **Example:** 
158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
159 # set a variable value 
160 set file documentation 
161 puts $file #to display file contents on the screen 
162
163 # a simple substitution, set psfile to documentation.ps 
164 set psfile $file.ps 
165 puts $psfile 
166
167 # another substitution, set pfile to documentationPS 
168 set pfile ${file}PS 
169
170 # a last one, 
171 # delete files NEWdocumentation and OLDdocumentation 
172 foreach prefix {NEW OLD} {rm $prefix$file} 
173 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
174
175 Command substitution is triggered by the [ ] characters. The brackets must enclose a valid script. The script is evaluated and the result is substituted. 
176
177 Compare command construction in csh. 
178
179 **Example:** 
180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
181 set degree 30 
182 set pi 3.14159265 
183 # expr is a command evaluating a numeric expression 
184 set radian [expr $pi*$degree/180] 
185 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
186
187 Backslash substitution is triggered by the backslash character. It is used to insert special characters like $, [ , ] , etc. It is also useful to insert a new line, a backslash terminated line is continued on the following line. 
188
189 TCL uses two forms of *quoting* to prevent substitution and word breaking. 
190
191 Double quote *quoting* enables the definition of a string with space and tabs as a single word. Substitutions are still performed inside the inverted commas " ". 
192
193 **Example:** 
194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
195 # set msg to ;the price is 12.00; 
196 set price 12.00 
197 set msg ;the price is $price; 
198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
199
200 Braces *quoting* prevents all substitutions. Braces are also nested. The main use of braces is to defer evaluation when defining procedures and control structures. Braces are used for a clearer presentation of TCL scripts on several lines. 
201
202 **Example:** 
203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
204 set x 0 
205 # this will loop for ever 
206 # because while argument is ;0  3; 
207 while ;$x  3; {set x [expr $x+1]} 
208 # this will terminate as expected because 
209 # while argument is {$x  3} 
210 while {$x  3} {set x [expr $x+1]} 
211 # this can be written also 
212 while {$x  3} { 
213 set x [expr $x+1] 
214
215 # the following cannot be written 
216 # because while requires two arguments 
217 while {$x  3} 
218
219 set x [expr $x+1] 
220
221 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
222
223 Comments start with a \# character as the first non-blank character in a command. To add a comment at the end of the line, the comment must be preceded by a semi-colon to end the preceding command. 
224
225 **Example:** 
226 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
227 # This is a comment 
228 set a 1 # this is not a comment 
229 set b 1; # this is a comment 
230 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
231
232 The number of words is never changed by substitution when parsing in TCL. For example, the result of a substitution is always a single word. This is different from csh but convenient as the behavior of the parser is more predictable. It may sometimes be necessary to force a second round of parsing. **eval** accomplishes this: it accepts several arguments, concatenates them and executes the resulting script. 
233
234
235 **Example:** 
236 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
237 # I want to delete two files 
238
239 set files ;foo bar; 
240
241 # this will fail because rm will receive only one argument 
242 # and complain that ;foo bar; does not exit 
243
244 exec rm $files 
245
246 # a second evaluation will do it 
247 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
248
249 @subsection occt_draw_2_3 Accessing variables in TCL and Draw
250
251 TCL variables have only string values. Note that even numeric values are stored as string literals, and computations using the **expr** command start by parsing the strings. Draw, however, requires variables with other kinds of values such as curves, surfaces or topological shapes. 
252
253 TCL provides a mechanism to link user data to variables. Using this functionality, Draw defines its variables as TCL variables with associated data. 
254
255 The string value of a Draw variable is meaningless. It is usually set to the name of the variable itself. Consequently, preceding a Draw variable with a <i>$</i> does not change the result of a command. The content of a Draw variable is accessed using appropriate commands. 
256
257 There are many kinds of Draw variables, and new ones may be added with C++. Geometric and topological variables are described below. 
258
259 Draw numeric variables can be used within an expression anywhere a Draw command requires a numeric value. The *expr* command is useless in this case as the variables are stored not as strings but as floating point values. 
260
261 **Example:** 
262 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
263 # dset is used for numeric variables 
264 # pi is a predefined Draw variable 
265 dset angle pi/3 radius 10 
266 point p radius*cos(angle) radius*sin(angle) 0 
267 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
268 It is recommended that you use TCL variables only for strings and Draw for numerals. That way, you will avoid the *expr* command. As a rule, Geometry and Topology require numbers but no strings. 
269
270 @subsubsection occt_draw_2_3_1 set, unset
271
272 Syntax:                  
273
274 ~~~~~
275 set varname [value] 
276 unset varname [varname varname ...] 
277 ~~~~~
278
279 *set* assigns a string value to a variable. If the variable does not already exist, it is created. 
280
281 Without a value, *set* returns the content of the variable. 
282
283 *unset* deletes variables. It is is also used to delete Draw variables. 
284
285 **Example:** 
286 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
287 set a "Hello world"
288 set b "Goodbye" 
289 set a 
290 == "Hello world" 
291 unset a b 
292 set a 
293 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
294
295 **Note**, that the *set* command can set only one variable, unlike the *dset* command. 
296
297
298 @subsubsection occt_draw_2_3_2 dset, dval
299
300 Syntax
301
302 ~~~~~
303 dset var1 value1 vr2 value2 ... 
304 dval name 
305 ~~~~~
306
307 *dset* assigns values to Draw numeric variables. The argument can be any numeric expression including Draw numeric variables. Since all Draw commands expect a numeric expression, there is no need to use $ or *expr*. The *dset* command can assign several variables. If there is an odd number of arguments, the last variable will be assigned a value of 0. If the variable does not exist, it will be created. 
308
309 *dval* evaluates an expression containing Draw numeric variables and returns the result as a string, even in the case of a single variable. This is not used in Draw commands as these usually interpret the expression. It is used for basic TCL commands expecting strings. 
310
311
312 **Example:** 
313 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
314 # z is set to 0 
315 dset x 10 y 15 z 
316 == 0 
317
318 # no $ required for Draw commands 
319 point p x y z 
320
321 # "puts" prints a string 
322 puts ;x = [dval x], cos(x/pi) = [dval cos(x/pi)]; 
323 == x = 10, cos(x/pi) = -0.99913874099467914 
324 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
325
326 **Note,** that in TCL, parentheses are not considered to be special characters. Do not forget to quote an expression if it contains spaces in order to avoid parsing different words. <i>(a + b)</i> is parsed as three words: <i>"(a + b)"</i> or <i>(a+b)</i> are correct.
327
328
329 @subsection occt_draw_2_4 lists
330
331 TCL uses lists. A list is a string containing elements separated by spaces or tabs. If the string contains braces, the braced part accounts as one element. 
332
333 This allows you to insert lists within lists. 
334
335 **Example:** 
336 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
337 # a list of 3 strings 
338 ;a b c; 
339
340 # a list of two strings the first is a list of 2 
341 ;{a b} c; 
342 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
343
344 Many TCL commands return lists and **foreach** is a useful way to create loops on list elements. 
345
346 @subsubsection occt_draw_2_5 Control Structures
347
348 TCL allows looping using control structures. The control structures are implemented by commands and their syntax is very similar to that of their C counterparts (**if**, **while**, **switch**, etc.). In this case, there are two main differences between TCL and C: 
349
350 * You use braces instead of parentheses to enclose conditions. 
351 * You do not start the script on the next line of your command. 
352
353
354 @subsubsection occt_draw_2_5_1 if
355
356 Syntax       
357
358 ~~~~~
359 if condition script [elseif script .... else script] 
360 ~~~~~
361
362 **If** evaluates the condition and the script to see whether the condition is true. 
363
364
365
366 **Example:** 
367 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
368 if {$x  0} { 
369 puts ;positive; 
370 } elseif {$x == 0} { 
371 puts ;null; 
372 } else { 
373 puts ;negative; 
374
375 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
376
377 @subsubsection occt_draw_2_5_2 while, for, foreach
378
379 Syntax:                  
380
381
382 ~~~~~~
383 while condition script 
384 for init condition reinit script 
385 foreach varname list script 
386 ~~~~~
387
388 The three loop structures are similar to their C or csh equivalent. It is important to use braces to delay evaluation. **foreach** will assign the elements of the list to the variable before evaluating the script. \
389
390 **Example:** 
391 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
392 # while example 
393 dset x 1.1 
394 while {[dval x]  100} { 
395   circle c 0 0 x 
396   dset x x*x 
397
398 # for example 
399 # incr var d, increments a variable of d (default 1) 
400 for {set i 0} {$i  10} {incr i} { 
401   dset angle $i*pi/10 
402   point p$i cos(angle0 sin(angle) 0 
403
404 # foreach example 
405 foreach object {crapo tomson lucas} {display $object} 
406 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
407
408 @subsubsection occt_draw_2_5_3 break, continue
409
410 Syntax:                  
411
412 ~~~~~
413 break 
414 continue 
415 ~~~~~
416
417 Within loops, the **break** and **continue** commands have the same effect as in C. 
418
419 **break** interrupts the innermost loop and **continue** jumps to the next iteration. 
420
421 **Example:** 
422 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
423 # search the index for which t$i has value ;secret; 
424 for {set i 1} {$i = 100} {incr i} { 
425   if {[set t$i] == ;secret;} break; 
426
427 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
428
429 @subsection occt_draw_2_6 Procedures
430
431 TCL can be extended by defining procedures using the **proc** command, which sets up a context of local variables, binds arguments and executes a TCL script. 
432
433 The only problematic aspect of procedures is that variables are strictly local, and as they are implicitly created when used, it may be difficult to detect errors. 
434
435 There are two means of accessing a variable outside the scope of the current procedures: **global** declares a global variable (a variable outside all procedures); **upvar** accesses a variable in the scope of the caller. Since arguments in TCL are always string values, the only way to pass Draw variables is by reference, i.e. passing the name of the variable and using the **upvar** command as in the following examples. 
436
437 As TCL is not a strongly typed language it is very difficult to detect programming errors and debugging can be tedious. TCL procedures are, of course, not designed for large scale software development but for testing and simple command or interactive writing. 
438
439
440 @subsubsection occt_draw_2_6_1 proc
441
442 Syntax:
443
444 ~~~~~
445 proc argumentlist script 
446 ~~~~~
447
448 **proc** defines a procedure. An argument may have a default value. It is then a list of the form {argument value}. The script is the body of the procedure. 
449
450 **return** gives a return value to the procedure. 
451
452 **Example:** 
453 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
454 # simple procedure 
455 proc hello {} { 
456   puts ;hello world; 
457
458 # procedure with arguments and default values 
459 proc distance {x1 y1 {x2 0} {y2 0}} { 
460   set d [expr (x2-x1)*(x2-x1) + (y2-y1)*(y2-y1)] 
461   return [expr sqrt(d)] 
462
463 proc fact n { 
464   if {$n == 0} {return 1} else { 
465     return [expr n*[fact [expr n -1]]] 
466   } 
467
468 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
469
470
471 @subsubsection occt_draw_2_6_2 global, upvar
472
473 Syntax:                 
474
475 ~~~~~
476 global varname [varname ...] 
477 upvar varname localname [varname localname ...] 
478 ~~~~~
479
480
481 **global** accesses high level variables. Unlike C, global variables are not visible in procedures. 
482
483 **upvar** gives a local name to a variable in the caller scope. This is useful when an argument is the name of a variable instead of a value. This is a call by reference and is the only way to use Draw variables as arguments. 
484
485 **Note** that in the following examples the \$ character is always necessarily used to access the arguments.
486  
487 **Example:** 
488 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
489 # convert degree to radian 
490 # pi is a global variable 
491 proc deg2rad (degree} { 
492   return [dval pi*$degree/2.] 
493
494 # create line with a point and an angle 
495 proc linang {linename x y angle} { 
496   upvar linename l 
497   line l $x $y cos($angle) sin($angle) 
498 }
499 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
500
501 @section occt_draw_3 Basic Commands
502
503 This chapter describes all the commands defined in the basic Draw package. Some are TCL commands, but most of them have been formulated in Draw. These commands are found in all Draw applications. The commands are grouped into four sections: 
504
505   * General commands, which are used for Draw and TCL management.
506   * Variable commands, which are used to manage Draw variables such as storing and dumping.
507   * Graphic commands, which are used to manage the graphic system, and so pertain to views.
508   * Variable display commands, which are used to manage the display of objects within given views.
509
510 Note that Draw also features a GUI task bar providing an alternative way to give certain general, graphic and display commands 
511
512
513 @subsection occt_draw_3_1 General commands
514
515 This section describes several useful commands:
516
517   * **help** to get information, 
518   * **source** to eval a script from a file, 
519   * **spy** to capture the commands in a file,
520   * **cpulimit** to limit the process cpu time, 
521   * **wait** to waste some time, 
522   * **chrono** to time commands. 
523
524 @subsubsection occt_draw_3_1_1 help
525
526 Syntax:                  
527
528 ~~~~~
529 help [command [helpstring group]] 
530 ~~~~~
531
532 Provides help or modifies the help information. 
533
534 **help** without arguments lists all groups and the commands in each group. 
535
536 Specifying the command returns its syntax and in some cases, information on the command, The joker \* is automatically added at the end so that all completing commands are returned as well. 
537
538 **Example:** 
539 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
540 # Gives help on all commands starting with *a* 
541 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
542
543
544 @subsubsection occt_draw_3_1_2 source
545
546 Syntax:
547
548 ~~~~~
549 source filename 
550 ~~~~~
551 Executes a file. 
552
553 The **exit** command will terminate the file. 
554
555 @subsubsection occt_draw_3_1_3 spy
556
557 Syntax:                  
558
559 ~~~~~
560 spy [filename] 
561 ~~~~~
562
563 Saves interactive commands in the file. If spying has already been performed, the current file is closed. **spy** without an argument closes the current file and stops spying. If a file already exists, the file is overwritten. Commands are not appended. 
564
565 If a command returns an error it is saved with a comment mark. 
566
567 The file created by **spy** can be executed with the **source** command. 
568
569 **Example:** 
570 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
571 # all commands will be saved in the file ;session; 
572 spy session 
573 # the file ;session; is closed and commands are not saved 
574 spy 
575 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
576
577
578
579 @subsubsection occt_draw_3_1_4 cpulimit
580
581 Syntax:                  
582
583 ~~~~~
584 cpulimit [nbseconds] 
585 ~~~~~
586
587 **cpulimit**limits a process after the number of seconds specified in nbseconds. It is used in tests to avoid infinite loops. **cpulimit** without arguments removes all existing limits. 
588
589 **Example:** 
590 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
591 #limit cpu to one hour 
592 cpulimit 3600 
593 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
594
595 @subsubsection occt_draw_3_1_5 wait
596
597 Syntax:
598 ~~~~~
599 wait [nbseconds] 
600 ~~~~~
601 Suspends execution for the number of seconds specified in *nbseconds*. The default value is ten (10) seconds. This is a useful command for a slide show. 
602
603 ~~~~~
604 # You have ten seconds ... 
605 wait 
606 ~~~~~
607
608 @subsubsection occt_draw_3_1_6 chrono
609
610 Syntax:                  
611
612 ~~~~~
613 chrono [ name start/stop/reset/show] 
614 ~~~~~
615
616 Without arguments, **chrono** activates Draw chronometers. The elapsed time ,cpu system and cpu user times for each command will be printed. 
617
618 With arguments, **chrono** is used to manage activated chronometers. You can perform the following actions with a chronometer. 
619   * run the chronometer (start).
620   * stop the chronometer (stop).
621   * reset the chronometer to 0 (reset).
622   * display the current time (show).
623
624 **Example:** 
625 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
626 chrono 
627 ==Chronometers activated. 
628 ptorus t 20 5 
629 ==Elapsed time: 0 Hours 0 Minutes 0.0318 Seconds 
630 ==CPU user time: 0.01 seconds 
631 ==CPU system time: 0 seconds 
632 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
633
634 @subsection occt_draw_3_2  Variable management commands
635
636 @subsubsection occt_draw_3_2_1 isdraw, directory
637
638 Syntax:                  
639 ~~~~~
640 isdraw varname 
641 directory [pattern] 
642 ~~~~~
643
644 **isdraw** tests to see if a variable is a Draw variable. **isdraw** will return 1 if there is a Draw value attached to the variable. 
645
646 Use **directory** to return a list of all Draw global variables matching a pattern. 
647
648 **Example:** 
649 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
650 set a 1 
651 isdraw a 
652 === 0 
653
654 dset a 1 
655 isdraw a 
656 === 1 
657
658 circle c 0 0 1 0 5 
659 isdraw c 
660 === 1 
661
662 # to destroy all Draw objects with name containing curve 
663 foreach var [directory *curve*] {unset $var} 
664 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
665
666
667 @subsubsection occt_draw_3_2_2 whatis, dump
668
669 Syntax:
670
671 ~~~~~
672 whatis varname [varname ...] 
673 dump varname [varname ...] 
674 ~~~~~
675
676 **whatis** returns short information about a Draw variable. This is usually the type name. 
677
678 **dump** returns a brief type description, the coordinates, and if need be, the parameters of a Draw variable. 
679
680 **Example:** 
681 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
682 circle c 0 0 1 0 5 
683 whatis c 
684 c is a 2d curve 
685
686 dump c 
687
688 ***** Dump of c ***** 
689 Circle 
690 Center :0, 0 
691 XAxis :1, 0 
692 YAxis :-0, 1 
693 Radius :5 
694 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
695
696 **Note** The behavior of *whatis* on other variables (not Draw) is not excellent. 
697
698
699 @subsubsection occt_draw_3_2_3 rename, copy
700
701 Syntax:      
702 ~~~~~
703 rename varname tovarname [varname tovarname ...] 
704 copy varname tovarname [varname tovarname ...] 
705 ~~~~~
706
707   * **rename** changes the name of a Draw variable. The original variable will no longer exist. Note that the content is not modified. Only the name is changed. 
708   * **copy** creates a new variable with a copy of the content of an existing variable. The exact behavior of **copy** is type dependent; in the case of certain topological variables, the content may still be shared. 
709
710 **Example:** 
711 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
712 circle c1 0 0 1 0 5 
713 rename c1 c2 
714
715 # curves are copied, c2 will not be modified 
716 copy c2 c3 
717 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
718
719 @subsubsection occt_draw_3_2_4 datadir, save, restore
720
721 Syntax:
722 ~~~~~
723 datadir [directory] 
724 save variable [filename] 
725 restore filename [variablename] 
726 ~~~~~
727
728   * **datadir** without arguments prints the path of the current data directory. 
729   * **datadir** with an argument sets the data directory path. \
730
731 If the path starts with a dot (.) only the last directory name will be changed in the path. 
732
733   * **save** writes a file in the data directory with the content of a variable. By default the name of the file is the name of the variable. To give a different name use a second argument. 
734   * **restore** reads the content of a file in the data directory in a local variable. By default, the name of the variable is the name of the file. To give a different name, use a second argument. 
735
736 The exact content of the file is type-dependent. They are usually ASCII files and so, architecture independent. 
737
738 **Example:** 
739 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
740 # note how TCL accesses shell environment variables 
741 # using $env() 
742 datadir 
743 ==. 
744
745 datadir $env(WBCONTAINER)/data/default 
746 ==/adv_20/BAG/data/default 
747
748 box b 10 20 30 
749 save b theBox 
750 ==/adv_20/BAG/data/default/theBox 
751
752 # when TCL does not find a command it tries a shell command 
753 ls [datadir] 
754 == theBox 
755
756 restore theBox 
757 == theBox 
758 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
759
760 @subsection occt_draw_3_3 User defined commands
761
762 *DrawTrSurf* provides commands to create and display a Draw **geometric** variable from a *Geom_Geometry* object and also get a *Geom_Geometry* object from a Draw geometric variable name. 
763
764 *DBRep* provides commands to create and display a Draw **topological** variable from a *TopoDS_Shape* object and also get a *TopoDS_Shape* object from a Draw topological variable name. 
765
766 @subsubsection occt_draw_3_3_1 set
767
768 #### In *DrawTrSurf* package:
769
770 ~~~~~
771 void Set(Standard_CString& Name,const gp_Pnt& G) ; 
772 void Set(Standard_CString& Name,const gp_Pnt2d& G) ; 
773 void Set(Standard_CString& Name, 
774 const Handle(Geom_Geometry)& G) ; 
775 void Set(Standard_CString& Name, 
776 const Handle(Geom2d_Curve)& C) ; 
777 void Set(Standard_CString& Name, 
778 const Handle(Poly_Triangulation)& T) ; 
779 void Set(Standard_CString& Name, 
780 const Handle(Poly_Polygon3D)& P) ; 
781 void Set(Standard_CString& Name, 
782 const Handle(Poly_Polygon2D)& P) ; 
783 ~~~~~
784
785 #### In *DBRep* package:
786
787 ~~~~~
788 void Set(const Standard_CString Name, 
789 const TopoDS_Shape& S) ; 
790 ~~~~~
791
792 Example of *DrawTrSurf*
793
794 ~~~~~
795 Handle(Geom2d_Circle) C1 = new Geom2d_Circle 
796 (gce_MakeCirc2d (gp_Pnt2d(50,0,) 25)); 
797 DrawTrSurf::Set(char*, C1); 
798 ~~~~~
799
800 Example of *DBRep* 
801
802 ~~~~~
803 TopoDS_Solid B; 
804 B = BRepPrimAPI_MakeBox (10,10,10); 
805 DBRep::Set(char*,B); 
806 ~~~~~
807
808 @subsubsection occt_draw_3_3_2 get
809
810 #### In *DrawTrSurf* package:
811  
812 ~~~~~
813 Handle_Geom_Geometry Get(Standard_CString& Name) ; 
814 ~~~~~
815
816 #### In *DBRep* package:
817
818 ~~~~~
819 TopoDS_Shape Get(Standard_CString& Name, 
820 const TopAbs_ShapeEnum Typ = TopAbs_SHAPE, 
821 const Standard_Boolean Complain 
822 = Standard_True) ; 
823 ~~~~~
824
825 Example of *DrawTrSurf*
826
827 ~~~~~
828 Standard_Integer MyCommand 
829 (Draw_Interpretor& theCommands, 
830 Standard_Integer argc, char** argv) 
831 {...... 
832 // Creation of a Geom_Geometry from a Draw geometric 
833 // name 
834 Handle (Geom_Geometry) aGeom= DrawTrSurf::Get(argv[1]); 
835
836 ~~~~~
837
838 Example of *DBRep*
839
840 ~~~~~
841 Standard_Integer MyCommand 
842 (Draw_Interpretor& theCommands, 
843 Standard_Integer argc, char** argv) 
844 {...... 
845 // Creation of a TopoDS_Shape from a Draw topological 
846 // name 
847 TopoDS_Solid B = DBRep::Get(argv[1]); 
848
849 ~~~~~
850
851 @section occt_draw_4 Graphic Commands
852
853 Graphic commands are used to manage the Draw graphic system. Draw provides a 2d and a 3d viewer with up to 30 views. Views are numbered and the index of the view is displayed in the window’s title. Objects are displayed in all 2d views or in all 3d views, depending on their type. 2d objects can only be viewed in 2d views while 3d objects – only in 3d views correspondingly. 
854
855 @subsection occt_draw_4_1 Axonometric viewer
856
857 @subsubsection occt_draw_4_1_1 view, delete
858
859 Syntax:                  
860 ~~~~~
861 view index type [X Y W H] 
862 delete [index] 
863 ~~~~~
864
865 **view** is the basic view creation command: it creates a new view with the given index. If a view with this index already exits, it is deleted. The view is created with default parameters and X Y W H are the position and dimensions of the window on the screen. Default values are 0, 0, 500, 500. 
866
867 As a rule it is far simpler either to use the procedures **axo**, **top**, **left** or to click on the desired view type in the menu under *Views* in the task bar.. 
868
869 **delete** deletes a view. If no index is given, all the views are deleted. 
870
871 Type selects from the following range: 
872
873   * *AXON* : Axonometric view
874   * *PERS* : Perspective view
875   * <i>+X+Y</i> : View on both axes (i.e. a top view), other codes are <i>-X+Y</i>, <i>+Y-Z</i>, etc.
876   * <i>-2D-</i> : 2d view
877
878 The index, the type, the current zoom are displayed in the window title . 
879
880 **Example:** 
881 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
882 # this is the content of the mu4 procedure 
883 proc mu4 {} { 
884 delete 
885 view 1 +X+Z 320 20 400 400 
886 view 2 +X+Y 320 450 400 400 
887 view 3 +Y+Z 728 20 400 400 
888 view 4 AXON 728 450 400 400 
889
890 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
891
892 See also: **axo, pers, top, bottom, left, right, front, back, mu4, v2d, av2d, smallview** 
893
894 @subsubsection occt_draw_4_1_2  axo, pers, top, ...
895
896 Syntax:      
897
898 ~~~~~
899 axo 
900 pers 
901 ... 
902 smallview type 
903 ~~~~~
904
905 All these commands are procedures used to define standard screen layout. They delete all existing views and create new ones. The layout usually complies with the European convention, i.e. a top view is under a front view. 
906
907   * **axo** creates a large window axonometric view;
908   * **pers** creates a large window perspective view;
909   * **top**, **bottom**, **left**, **right**, **front**, **back** create a large window axis view;
910   * **mu4** creates four small window views: front, left, top and axo.
911   * **v2d** creates a large window 2d view.
912   * **av2d** creates two small window views, one 2d and one axo
913   * **smallview** creates a view at the bottom right of the screen of the given type. 
914
915 See also: **view**, **delete** 
916
917 @subsubsection occt_draw_4_1_3 mu, md, 2dmu, 2dmd, zoom, 2dzoom
918
919 Syntax:
920
921 ~~~~~
922     mu [index] value 
923     2dmu [index] value 
924     zoom [index] value 
925     wzoom 
926 ~~~~~
927
928 * **mu** (magnify up) increases the zoom in one or several views by a factor of 10%. 
929 * **md** (magnify down) decreases the zoom by the inverse factor. **2dmu** and **2dmd** 
930 perform the same on one or all 2d views. 
931 * **zoom** and **2dzoom** set the zoom factor to a value specified by you. The current zoom factor is always displayed in the window’s title bar. Zoom 20 represents a full screen view in a large window; zoom 10, a full screen view in a small one. 
932 * **wzoom** (window zoom) allows you to select the area you want to zoom in on with the mouse. You will be prompted to give two of the corners of the area that you want to magnify and the rectangle so defined will occupy the window of the view. 
933
934 **Example:** 
935 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
936     # set a zoom of 2.5 
937     zoom 2.5 
938
939     # magnify by 10% 
940     mu 1 
941
942     # magnify by 20% 
943 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
944 See also: **fit**, **2dfit** 
945
946
947 @subsubsection occt_draw_4_14 pu, pd, pl, pr, 2dpu, 2dpd, 2dpl, 2dpr
948
949 Syntax:                  
950
951 ~~~~~
952 pu [index] 
953 pd [index] 
954 ~~~~~
955
956 The <i>p_</i> commands are used to pan. **pu** and **pd** pan up and down respectively; **pl** and **pr** pan to the left and to the right respectively. Each time the view is displaced by 40 pixels. When no index is given, all views will pan in the direction specified. 
957 ~~~~~
958 # you have selected one anonometric view
959 pu
960 # or
961 pu 1
962
963 # you have selected an mu4 view; the object in the third view will pan up
964 pu 3
965 ~~~~~
966 See also: **fit**, **2dfit** 
967
968
969 @subsubsection occt_draw_4_1_5 fit, 2dfit
970
971 Syntax:      
972
973 ~~~~~
974 fit [index] 
975 2dfit [index] 
976 ~~~~~
977
978 **fit** computes the best zoom and pans on the content of the view. The content of the view will be centered and fit the whole window. 
979
980 When fitting all views a unique zoom is computed for all the views. All views are on the same scale. 
981
982 **Example:** 
983 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
984 # fit only view 1 
985 fit 1 
986 # fit all 2d views 
987 2dfit 
988 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
989 See also: **zoom**, **mu**, **pu** 
990
991
992 @subsubsection occt_draw_4_1_6 u, d, l, r
993
994 Syntax:      
995
996 ~~~~~
997 u [index] 
998 d [index] 
999 l [index] 
1000 r [index] 
1001 ~~~~~
1002
1003 **u**, **d**, **l**, **r** Rotate the object in view around its axis by five degrees up, down, left or right respectively. This command is restricted to axonometric and perspective views. 
1004
1005 **Example:** 
1006 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1007 # rotate the view up 
1008
1009 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1010
1011 @subsubsection occt_draw_4_1_7 focal, fu, fd
1012
1013 Syntax:                  
1014 ~~~~~
1015 focal [f] 
1016 fu [index] 
1017 fd [index] 
1018 ~~~~~
1019
1020 * **focal** changes the vantage point in perspective views. A low f value increases the perspective effect; a high one give a perspective similar to that of an axonometric view. The default value is 500. 
1021 * **fu** and **fd** increase or decrease the focal value by 10%. **fd** makes the eye closer to the object. 
1022
1023 **Example:** 
1024 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1025 pers 
1026 repeat 10 fd 
1027 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1028
1029 **Note**: Do not use a negative or null focal value. 
1030
1031 See also: **pers** 
1032
1033 @subsubsection occt_draw_4_1_8 color
1034
1035 Syntax: 
1036
1037 ~~~~~
1038 color index name 
1039 ~~~~~
1040
1041 **color** sets the color to a value. The index of the *color* is a value between 0 and 15. The name is an X window color name. The list of these can be found in the file *rgb.txt* in the X library directory. 
1042
1043 The default values are: 0 White, 1 Red, 2 Green, 3 Blue, 4 Cyan, 5 Gold, 6 Magenta, 7 Marron, 8 Orange, 9 Pink, 10 Salmon, 11 Violet, 12 Yellow, 13 Khaki, 14 Coral. 
1044
1045 **Example:** 
1046 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1047 # change the value of blue 
1048 color 3 "navy blue" 
1049 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1050
1051
1052 **Note** that the color change will be visible on the next redraw of the views, for example, after *fit* or *mu*, etc. 
1053
1054 @subsubsection occt_draw_4_1_9 dtext
1055
1056 Syntax:      
1057 ~~~~~
1058 dtext [x y [z]] string 
1059 ~~~~~
1060
1061 **dtext** displays a string in all 3d or 2d views. If no coordinates are given, a graphic selection is required. If two coordinates are given, the text is created in a 2d view at the position specified. With 3 coordinates, the text is created in a 3d view. 
1062
1063 The coordinates are real space coordinates. 
1064
1065 **Example:** 
1066 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1067 # mark the origins 
1068 dtext 0 0 bebop 
1069 dtext 0 0 0 bebop 
1070 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1071
1072 @subsubsection occt_draw_4_1_10 hardcopy, hcolor, xwd
1073
1074 Syntax:      
1075 ~~~~~
1076 hardcopy [index] 
1077 hcolor index width gray 
1078 xwd [index] filename 
1079 ~~~~~
1080
1081 * **hardcopy** creates a postcript file called a4.ps in the current directory. This file contains the postscript description of the view index, and will allow you to print the view. 
1082 * **hcolor** lets you change the aspect of lines in the postscript file. It allows to specify a width and a gray level for one of the 16 colors. **width** is measured in points with default value as 1, **gray** is the gray level from 0 = black to 1 = white with default value as 0. All colors are bound to the default values at the beginning. 
1083 * **xwd** creates an X window xwd file from an active view. By default, the index is set to1. To visualize an xwd file, use the unix command **xwud**. 
1084
1085 **Example:** 
1086 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1087 # all blue lines (color 3) 
1088 # will be half-width and gray 
1089 hcolor 3 0.5 
1090
1091 # make a postscript file and print it 
1092 hardcopy 
1093 lpr a4.ps 
1094
1095 # make an xwd file and display it 
1096 xwd theview 
1097 xwud -in theview 
1098 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1099
1100 **Note:** When more than one view is present, specify the index of the view. 
1101
1102 Only use a postscript printer to print postscript files. 
1103
1104 See also: **color** 
1105
1106
1107 @subsubsection occt_draw_4_1_11 wclick, pick
1108
1109 Syntax:      
1110 ~~~~~
1111 wclick 
1112 pick index X Y Z b [nowait] 
1113 ~~~~~
1114
1115 **wclick** defers an event until the mouse button is clicked. The message <code>just click</code> is displayed. 
1116
1117 Use the **pick** command to get graphic input. The arguments must be names for variables where the results are stored. 
1118   * index: index of the view where the input was made.
1119   * X,Y,Z: 3d coordinates in real world.
1120   * b: b is the mouse button 1,2 or 3.
1121
1122 When there is an extra argument, its value is not used and the command does not wait for a click; the value of b may then be 0 if there has not been a click. 
1123
1124 This option is useful for tracking the pointer. 
1125
1126 **Note** that the results are stored in Draw numeric variables.
1127
1128 **Example:** 
1129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1130 # make a circle at mouse location 
1131 pick index x y z b 
1132 circle c x y z 0 0 1 1 0 0 0 30 
1133
1134 # make a dynamic circle at mouse location 
1135 # stop when a button is clicked 
1136 # (see the repaint command) 
1137
1138 dset b 0 
1139 while {[dval b] == 0} { 
1140 pick index x y z b nowait 
1141 circle c x y z 0 0 1 1 0 0 0 30 
1142 repaint 
1143
1144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1145 See also: **repaint** 
1146
1147
1148 Draw provides commands to manage the display of objects. 
1149 * **display**, **donly** are used to display, 
1150 * **erase**, **clear**, **2dclear** to erase. 
1151 * **autodisplay** command is used to check whether variables are displayed when created. 
1152
1153 The variable name "." (dot) has a special status in Draw. Any Draw command expecting a Draw object as argument can be passed a dot. The meaning of the dot is the following. 
1154   * If the dot is an input argument, a graphic selection will be made. Instead of getting the object from a variable, Draw will ask you to select an object in a view.
1155   * If the dot is an output argument, an unnamed object will be created. Of course this makes sense only for graphic objects: if you create an unnamed number you will not be able to access it. This feature is used when you want to create objects for display only.
1156   * If you do not see what you expected while executing loops or sourcing files, use the **repaint** and **dflush** commands.
1157
1158 **Example:** 
1159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1160 # OK use dot to dump an object on the screen 
1161 dump . 
1162
1163 point . x y z 
1164
1165 #Not OK. display points on a curve c 
1166 # with dot no variables are created 
1167 for {set i 0} {$i = 10} {incr i} { 
1168 cvalue c $i/10 x y z 
1169 point . x y z 
1170
1171
1172 # point p x y z 
1173 # would have displayed only one point 
1174 # because the precedent variable content is erased 
1175
1176 # point p$i x y z 
1177 # is an other solution, creating variables 
1178 # p0, p1, p2, .... 
1179
1180 # give a name to a graphic object 
1181 rename . x 
1182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1183
1184
1185 @subsubsection occt_draw_4_1_12 autodisplay
1186
1187 Syntax:      
1188
1189 ~~~~~
1190 autodisplay [0/1] 
1191 ~~~~~
1192
1193 By default, Draw automatically displays any graphic object as soon as it is created. This behavior known as autodisplay can be removed with the command **autodisplay**. Without arguments, **autodisplay** toggles the autodisplay mode. The command always returns the current mode. 
1194
1195 When **autodisplay** is off, using the dot return argument is ineffective. 
1196
1197 **Example:** 
1198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1199 # c is displayed 
1200 circle c 0 0 1 0 5 
1201
1202 # toggle the mode 
1203 autodisplay 
1204 == 0 
1205 circle c 0 0 1 0 5 
1206
1207 # c is erased, but not displayed 
1208 display c 
1209 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1210
1211 @subsubsection occt_draw_4_1_13 display, donly
1212
1213 Syntax:      
1214 ~~~~~
1215 display varname [varname ...] 
1216 donly varname [varname ...] 
1217 ~~~~~
1218
1219 * **display** makes objects visible. 
1220 * **donly** *display only* makes objects visible and erases all other objects. It is very useful to extract one object from a messy screen. 
1221
1222 **Example:** 
1223 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1224 \# to see all objects 
1225 foreach var [directory] {display $var} 
1226
1227 \# to select two objects and erase the other ones 
1228 donly . . 
1229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1230
1231
1232 @subsubsection occt_draw_4_1_14 erase, clear, 2dclear
1233
1234 Syntax:      
1235
1236 ~~~~~
1237 erase [varname varname ...] 
1238 clear 
1239 2dclear 
1240 ~~~~~
1241
1242 **erase** removes objects from all views. **erase** without arguments erases everything in 2d and 3d. 
1243
1244 **clear** erases only 3d objects and **2dclear** only 2d objects. **erase** without arguments is similar to  **clear; 2dclear**.
1245
1246
1247 **Example:** 
1248 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1249 # erase eveerything with a name starting with c_ 
1250 foreach var [directory c_*] {erase $var} 
1251
1252 # clear 2d views 
1253 2dclear 
1254 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1255
1256 @subsubsection occt_draw_4_1_15 repaint, dflush
1257
1258
1259 Syntax:
1260
1261 ~~~~~
1262 repaint 
1263 dflush 
1264 ~~~~~
1265
1266 * **repaint** forces repainting of views. 
1267 * **dflush** flushes the graphic buffers. 
1268
1269 These commands are useful within loops or in scripts. 
1270
1271 When an object is modified or erased, the whole view must be repainted. To avoid doing this too many times, Draw sets up a flag and delays the repaint to the end of the command in which the new prompt is issued. In a script, you may want to display the result of a change immediately. If the flag is raised, **repaint** will repaint the views and clear the flag. 
1272
1273 Graphic operations are buffered by Draw (and also by the X system). Usually the buffer is flushed at the end of a command and before graphic selection. If you want to flush the buffer from inside a script, use the **dflush** command. 
1274
1275 See also: <a href="#occt_draw_4_1_11">pick</a> command.  
1276
1277 @subsection occt_draw_4_2 AIS viewer – view commands
1278
1279 @subsubsection occt_draw_4_2_1 vinit
1280
1281 Syntax:                  
1282 ~~~~~
1283 vinit 
1284 ~~~~~
1285 Creates the 3D viewer window 
1286
1287 @subsubsection occt_draw_4_2_2 vhelp
1288
1289 Syntax:
1290 ~~~~~
1291 vhelp 
1292 ~~~~~
1293 Displays help in the 3D viewer window. The help consists in a list of hotkeys and their functionalities. 
1294
1295 @subsubsection occt_draw_4_2_3 vtop
1296
1297 Syntax:
1298 ~~~~~
1299 vtop 
1300 ~~~~~
1301
1302 Displays top view in the 3D viewer window. 
1303
1304 **Example:** 
1305 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1306 vinit 
1307 box b 10 10 10 
1308 vdisplay b 
1309 vfit 
1310 vtop 
1311 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1312
1313 @subsubsection occt_draw_4_2_4 vaxo
1314
1315 Syntax:                  
1316 ~~~~~
1317 vaxo 
1318 ~~~~~
1319
1320 Displays axonometric view in the 3D viewer window. 
1321
1322 **Example:** 
1323 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1324 vinit 
1325 box b 10 10 10 
1326 vdisplay b 
1327 vfit 
1328 vaxo 
1329 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1330
1331 @subsubsection occt_draw_4_2_5 vsetbg
1332
1333 Syntax:                  
1334 ~~~~~
1335 vsetbg imagefile [filltype] 
1336 ~~~~~
1337
1338 Loads image file as background. *filltype* must be NONE, CENTERED, TILED or STRETCH. 
1339
1340 **Example:** 
1341 ~~~~~
1342 vinit 
1343 vsetbg myimage.brep CENTERED 
1344 ~~~~~
1345
1346 @subsubsection occt_draw_4_2_6 vclear
1347
1348 Syntax:                  
1349 ~~~~~
1350 vclear 
1351 ~~~~~
1352 Removes all objects from the viewer. 
1353
1354 @subsubsection occt_draw_4_2_7 vrepaint
1355
1356 Syntax:                  
1357 ~~~~~
1358 vrepaint 
1359 ~~~~~
1360 Forcedly redisplays the shape in the 3D viewer window. 
1361
1362 @subsubsection occt_draw_4_2_8 vfit
1363
1364 Syntax:                  
1365 ~~~~~
1366 vfit 
1367 ~~~~~
1368 Automatic zoom/panning. Objects in the view are visualized to occupy the maximum surface. 
1369
1370 @subsubsection occt_draw_4_2_9 vzfit
1371
1372 Syntax:                  
1373 ~~~~~
1374 vzfit 
1375 ~~~~~
1376
1377 Automatic depth panning. Objects in the view are visualized to occupy the maximum 3d space. 
1378
1379 @subsubsection occt_draw_4_2_10  vreadpixel
1380
1381 Syntax:     
1382 ~~~~~
1383 vreadpixel xPixel yPixel [{rgb|rgba|depth|hls|rgbf|rgbaf}=rgba] [name] 
1384 ~~~~~
1385 Read pixel value for active view.
1386
1387
1388 @subsubsection occt_draw_4_2_11  vselect
1389
1390 Syntax:     
1391 ~~~~~
1392 vselect x1 y1 [x2 y2 [x3 y3 ... xn yn]] [shift_selection = 0|1]
1393 ~~~~~
1394
1395 Emulates different types of selection:
1396
1397   * single mouse click selection
1398   * selection with a rectangle having the upper left and bottom right corners in <i>(x1,y1)</i> and <i>(x2,y2)</i> respectively
1399   * selection with a polygon having the corners in pixel positions <i>(x1,y1), (x2,y2),…, (xn,yn)</i>
1400   * any of these selections if shift_selection is set to 1.
1401
1402 @subsubsection occt_draw_4_2_12  vmoveto
1403
1404 Syntax:     
1405
1406 ~~~~~
1407 vmoveto x y
1408 ~~~~~
1409 Emulates cursor movement to pixel position (x,y).
1410
1411 @subsubsection occt_draw_4_2_13  vviewparams
1412
1413 Syntax:     
1414 ~~~~~
1415 vviewparams [scale center_X center_Y proj_X proj_Y proj_Z up_X up_Y up_Z at_X at_Y at_Z]
1416 ~~~~~
1417 Gets or sets the current view characteristics.
1418
1419 @subsubsection occt_draw_4_2_14  vchangeselected
1420
1421 Syntax:     
1422 ~~~~~
1423 vchangeselected shape
1424 ~~~~~
1425 Adds a shape to selection or removes one from it.
1426
1427 @subsubsection occt_draw_4_2_15  vzclipping
1428
1429 Syntax:     
1430 ~~~~~
1431 vzclipping [mode] [depth width]
1432 ~~~~~
1433 Gets or sets ZClipping mode, width and depth, where
1434  - *mode = OFF|BACK|FRONT|SLICE*
1435  - *depth* is a real value from segment [0,1]
1436  - *width* is a real value from segment [0,1]
1437
1438 @subsubsection occt_draw_4_2_16  vnbselected
1439
1440 Syntax:     
1441 ~~~~~
1442 vnbselected
1443 ~~~~~
1444 Returns the number of selected objects in the interactive context.
1445
1446 @subsubsection occt_draw_4_2_17  vantialiasing
1447
1448 Syntax:     
1449 ~~~~~
1450 valntialiasing 1|0
1451 ~~~~~
1452 Sets antialiasing if the command is called with 1 or unsets otherwise.
1453
1454 @subsubsection occt_draw_4_2_18  vpurgedisplay
1455
1456 Syntax:     
1457 ~~~~~
1458 vpurgedisplay [CollectorToo = 0|1]
1459 ~~~~~
1460 Removes structures which do not belong to objects displayed in neutral point.
1461
1462 @subsubsection occt_draw_4_2_19  vhlr
1463
1464 Syntax:     
1465 ~~~~~
1466 vhlr is_enabled={on|off}
1467 ~~~~~
1468 Switches hidden line removal (computed) mode on/off.
1469
1470 @subsubsection occt_draw_4_2_20  vhlrtype
1471
1472 Syntax:     
1473 ~~~~~
1474 vhlrtype  algo_type={algo|polyalgo} [shape_1 ... shape_n]
1475 ~~~~~
1476
1477 Changes the type of HLR algorithm used for shapes.
1478 If the algo_type is algo, the exact HLR algorithm is used, otherwise the polygonal algorithm is used for defined shapes. 
1479
1480 If no shape is specified through the command arguments, the given HLR algorithm_type is applied to all *AIS_Shape* isntances in the current context, and the command also changes the default HLR algorithm type.
1481
1482 **Note** that this command works with instances of *AIS_Shape* or derived classes only, other interactive object types are ignored.
1483
1484 @subsubsection occt_draw_4_2_21 vcamera
1485
1486 Syntax:
1487 ~~~~~
1488 vcamera
1489 ~~~~~
1490
1491 Manages camera parameters.
1492
1493 **Example:**
1494 ~~~~~
1495 vinit
1496 box b 10 10 10
1497 vdisplay b
1498 vfit
1499 vcamera -persp
1500 ~~~~~
1501
1502 @subsubsection occt_draw_4_2_22 vstereo
1503
1504 Syntax:
1505 ~~~~~
1506 vstereo [0:1]
1507 ~~~~~
1508
1509 Turns stereo usage On/Off.
1510
1511 **Example:**
1512 ~~~~~
1513 vinit
1514 box b 10 10 10
1515 vdisplay b
1516 vstereo 1
1517 vfit
1518 vcamera -stereo -iod 1
1519 vcamera -lefteye
1520 vcamera -righteye
1521 ~~~~~
1522
1523 @subsubsection occt_draw_4_2_23 vfrustumculling
1524
1525 Syntax:
1526 ~~~~~
1527 vfrustumculling [toEnable]
1528 ~~~~~
1529
1530 Enables/disables objects clipping.
1531
1532
1533 @subsection occt_draw_4_3 AIS viewer – display commands
1534
1535 @subsubsection occt_draw_4_3_1 vdisplay
1536
1537 Syntax: 
1538 ~~~~~                 
1539 vdisplay [-noupdate|-update] [-local] [-mutable] name1 [name2] … [name n]
1540 ~~~~~
1541
1542 Displays named objects. Automatically redraws view by default.
1543 Redraw can be suppressed by -noupdate option.
1544
1545 **Example:** 
1546 ~~~~~ 
1547 vinit 
1548 box b 40 40 40 10 10 10 
1549 psphere s 20 
1550 vdisplay s b 
1551 vfit 
1552 ~~~~~ 
1553
1554 @subsubsection occt_draw_4_3_2 vdonly
1555
1556 Syntax:                  
1557 ~~~~~
1558 vdonly [name1] … [name n]
1559 ~~~~~ 
1560
1561 Displays only selected or named objects. If there are no selected or named objects, nothing is done. 
1562
1563 **Example:** 
1564 ~~~~~ 
1565 vinit 
1566 box b 40 40 40 10 10 10 
1567 psphere s 20 
1568 vdonly b 
1569 vfit
1570 ~~~~~ 
1571  
1572 @subsubsection occt_draw_4_3_3 vdisplayall
1573
1574 Syntax:                  
1575 ~~~~~ 
1576 vdisplayall 
1577 ~~~~~ 
1578
1579 Displays all created objects. 
1580
1581 **Example:** 
1582 ~~~~~ 
1583 vinit 
1584 box b 40 40 40 10 10 10 
1585 psphere s 20 
1586 vdisplayall 
1587 vfit 
1588 ~~~~~ 
1589
1590 @subsubsection occt_draw_4_3_4 verase
1591
1592 Syntax:                  
1593 ~~~~~
1594 verase [name1] [name2] … [name n]
1595 ~~~~~ 
1596
1597 Erases some selected or named objects. If there are no selected or named objects, the whole viewer is erased. 
1598
1599 **Example:** 
1600 ~~~~~
1601 vinit 
1602 box b1 40 40 40 10 10 10 
1603 box b2 -40 -40 -40 10 10 10 
1604 psphere s 20 
1605 vdisplayall 
1606 vfit 
1607 # erase only first box 
1608 verase b1 
1609 # erase second box and sphere 
1610 verase
1611 ~~~~~ 
1612
1613 @subsubsection occt_draw_4_3_5 veraseall
1614
1615 Syntax:                  
1616 ~~~~~
1617 veraseall
1618 ~~~~~ 
1619
1620 Erases all objects displayed in the viewer. 
1621
1622 **Example:**
1623 ~~~~~ 
1624 vinit 
1625 box b1 40 40 40 10 10 10 
1626 box b2 -40 -40 -40 10 10 10 
1627 psphere s 20 
1628 vdisplayall 
1629 vfit 
1630 # erase only first box 
1631 verase b1 
1632 # erase second box and sphere 
1633 verseall
1634 ~~~~~ 
1635
1636 @subsubsection occt_draw_4_3_6 vsetdispmode
1637
1638 Syntax:                  
1639 ~~~~~
1640 vsetdispmode [name] mode(0,1,2,3)
1641 ~~~~~ 
1642
1643 Sets display mode for all, selected or named objects. 
1644 * *0* (*WireFrame*), 
1645 * *1* (*Shading*), 
1646 * *2* (*Quick HideLineremoval*), 
1647 * *3* (*Exact HideLineremoval*). 
1648
1649 **Example:** 
1650 ~~~~~
1651 vinit 
1652 box b 10 10 10 
1653 vdisplay b 
1654 vsetdispmode 1 
1655 vfit
1656 ~~~~~
1657  
1658 @subsubsection occt_draw_4_3_7 vdisplaytype
1659
1660 Syntax:                  
1661 ~~~~~
1662 vdisplaytype type
1663 ~~~~~ 
1664
1665 Displays all objects of a given type. 
1666 The following types are possible: *Point*, *Axis*, *Trihedron*, *PlaneTrihedron*, *Line*, *Circle*, *Plane*, *Shape*, *ConnectedShape*, *MultiConn.Shape*, *ConnectedInter.*, *MultiConn.*, *Constraint* and *Dimension*. 
1667
1668 @subsubsection occt_draw_4_3_8 verasetype
1669
1670 Syntax:                  
1671 ~~~~~
1672 verasetype type
1673 ~~~~~ 
1674
1675 Erases all objects of a given type. 
1676 Possible type is *Point*, *Axis*, *Trihedron*, *PlaneTrihedron*, *Line*, *Circle*, *Plane*, *Shape*, *ConnectedShape*, *MultiConn.Shape*, *ConnectedInter.*, *MultiConn.*, *Constraint* and *Dimension*. 
1677
1678 @subsubsection occt_draw_4_3_9 vtypes
1679
1680 Syntax:                  
1681 ~~~~~
1682 vtypes
1683 ~~~~~ 
1684
1685 Makes a list of known types and signatures in AIS. 
1686
1687 @subsubsection occt_draw_4_3_10 vaspects
1688
1689 Syntax:
1690 ~~~~~
1691 vaspects [-noupdate|-update] [name1 [name2 [...]]]
1692          [-setcolor ColorName] [-setcolor R G B] [-unsetcolor]
1693          [-setmaterial MatName] [-unsetmaterial]
1694          [-settransparency Transp] [-unsettransparency]
1695          [-setwidth LineWidth] [-unsetwidth]
1696          [-subshapes subname1 [subname2 [...]]]
1697
1698 ~~~~~
1699
1700 Aliases:
1701 ~~~~~
1702 vsetcolor [shapename] colorname
1703
1704 ~~~~~
1705
1706
1707 Manages presentation properties (color, material, transparency) of all objects, selected or named.
1708
1709 **Color**. The *ColorName* can be: *BLACK*, *MATRAGRAY*, *MATRABLUE*, *ALICEBLUE*, *ANTIQUEWHITE*, *ANTIQUEWHITE1*, *ANTIQUEWHITE2*, *ANTIQUEWHITE3*, *ANTIQUEWHITE4*, *AQUAMARINE1*, *AQUAMARINE2*, *AQUAMARINE4*, *AZURE*, *AZURE2*, *AZURE3*, *AZURE4*, *BEIGE*, *BISQUE*, *BISQUE2*, *BISQUE3*, *BISQUE4*, *BLANCHEDALMOND*, *BLUE1*, *BLUE2*, *BLUE3*, *BLUE4*, *BLUEVIOLET*, *BROWN*, *BROWN1*, *BROWN2*, *BROWN3*, *BROWN4*, *BURLYWOOD*, *BURLYWOOD1*, *BURLYWOOD2*, *BURLYWOOD3*, *BURLYWOOD4*, *CADETBLUE*, *CADETBLUE1*, *CADETBLUE2*, *CADETBLUE3*, *CADETBLUE4*, *CHARTREUSE*, *CHARTREUSE1*, *CHARTREUSE2*, *CHARTREUSE3*, *CHARTREUSE4*, *CHOCOLATE*, *CHOCOLATE1*, *CHOCOLATE2*, *CHOCOLATE3*, *CHOCOLATE4*, *CORAL*, *CORAL1*, *CORAL2*, *CORAL3*, *CORAL4*, *CORNFLOWERBLUE*, *CORNSILK1*, *CORNSILK2*, *CORNSILK3*, *CORNSILK4*, *CYAN1*, *CYAN2*, *CYAN3*, *CYAN4*, *DARKGOLDENROD*, *DARKGOLDENROD1*, *DARKGOLDENROD2*, *DARKGOLDENROD3*, *DARKGOLDENROD4*, *DARKGREEN*, *DARKKHAKI*, *DARKOLIVEGREEN*, *DARKOLIVEGREEN1*, *DARKOLIVEGREEN2*, *DARKOLIVEGREEN3*, *DARKOLIVEGREEN4*, *DARKORANGE*, *DARKORANGE1*, *DARKORANGE2*, *DARKORANGE3*, *DARKORANGE4*, *DARKORCHID*, *DARKORCHID1*, *DARKORCHID2*, *DARKORCHID3*, *DARKORCHID4*, *DARKSALMON*, *DARKSEAGREEN*, *DARKSEAGREEN1*, *DARKSEAGREEN2*, *DARKSEAGREEN3*, *DARKSEAGREEN4*, *DARKSLATEBLUE*, *DARKSLATEGRAY1*, *DARKSLATEGRAY2*, *DARKSLATEGRAY3*, *DARKSLATEGRAY4*, *DARKSLATEGRAY*, *DARKTURQUOISE*, *DARKVIOLET*, *DEEPPINK*, *DEEPPINK2*, *DEEPPINK3*, *DEEPPINK4*, *DEEPSKYBLUE1*, *DEEPSKYBLUE2*, *DEEPSKYBLUE3*, *DEEPSKYBLUE4*, *DODGERBLUE1*, *DODGERBLUE2*, *DODGERBLUE3*, *DODGERBLUE4*, *FIREBRICK*, *FIREBRICK1*, *FIREBRICK2*, *FIREBRICK3*, *FIREBRICK4*, *FLORALWHITE*, *FORESTGREEN*, *GAINSBORO*, *GHOSTWHITE*, *GOLD*, *GOLD1*, *GOLD2*, *GOLD3*, *GOLD4*, *GOLDENROD*, *GOLDENROD1*, *GOLDENROD2*, *GOLDENROD3*, *GOLDENROD4*, *GRAY*, *GRAY0*, *GRAY1*, *GRAY10*, *GRAY11*, *GRAY12*, *GRAY13*, *GRAY14*, *GRAY15*, *GRAY16*, *GRAY17*, *GRAY18*, *GRAY19*, *GRAY2*, *GRAY20*, *GRAY21*, *GRAY22*, *GRAY23*, *GRAY24*, *GRAY25*, *GRAY26*, *GRAY27*, *GRAY28*, *GRAY29*, *GRAY3*, *GRAY30*, *GRAY31*, *GRAY32*, *GRAY33*, *GRAY34*, *GRAY35*, *GRAY36*, *GRAY37*, *GRAY38*, *GRAY39*, *GRAY4*, *GRAY40*, *GRAY41*, *GRAY42*, *GRAY43*, *GRAY44*, *GRAY45*, *GRAY46*, *GRAY47*, *GRAY48*, *GRAY49*, *GRAY5*, *GRAY50*, *GRAY51*, *GRAY52*, *GRAY53*, *GRAY54*, *GRAY55*, *GRAY56*, *GRAY57*, *GRAY58*, *GRAY59*, *GRAY6*, *GRAY60*, *GRAY61*, *GRAY62*, *GRAY63*, *GRAY64*, *GRAY65*, *GRAY66*, *GRAY67*, *GRAY68*, *GRAY69*, *GRAY7*, *GRAY70*, *GRAY71*, *GRAY72*, *GRAY73*, *GRAY74*, *GRAY75*, *GRAY76*, *GRAY77*, *GRAY78*, *GRAY79*, *GRAY8*, *GRAY80*, *GRAY81*, *GRAY82*, *GRAY83*, *GRAY85*, *GRAY86*, *GRAY87*, *GRAY88*, *GRAY89*, *GRAY9*, *GRAY90*, *GRAY91*, *GRAY92*, *GRAY93*, *GRAY94*, *GRAY95*, *GREEN*, *GREEN1*, *GREEN2*, *GREEN3*, *GREEN4*, *GREENYELLOW*, *GRAY97*, *GRAY98*, *GRAY99*, *HONEYDEW*, *HONEYDEW2*, *HONEYDEW3*, *HONEYDEW4*, *HOTPINK*, *HOTPINK1*, *HOTPINK2*, *HOTPINK3*, *HOTPINK4*, *INDIANRED*, *INDIANRED1*, *INDIANRED2*, *INDIANRED3*, *INDIANRED4*, *IVORY*, *IVORY2*, *IVORY3*, *IVORY4*, *KHAKI*, *KHAKI1*, *KHAKI2*, *KHAKI3*, *KHAKI4*, *LAVENDER*, *LAVENDERBLUSH1*, *LAVENDERBLUSH2*, *LAVENDERBLUSH3*, *LAVENDERBLUSH4*, *LAWNGREEN*, *LEMONCHIFFON1*, *LEMONCHIFFON2*, *LEMONCHIFFON3*, *LEMONCHIFFON4*, *LIGHTBLUE*, *LIGHTBLUE1*, *LIGHTBLUE2*, *LIGHTBLUE3*, *LIGHTBLUE4*, *LIGHTCORAL*, *LIGHTCYAN1*, *LIGHTCYAN2*, *LIGHTCYAN3*, *LIGHTCYAN4*, *LIGHTGOLDENROD*, *LIGHTGOLDENROD1*, *LIGHTGOLDENROD2*, *LIGHTGOLDENROD3*, *LIGHTGOLDENROD4*, *LIGHTGOLDENRODYELLOW*, *LIGHTGRAY*, *LIGHTPINK*, *LIGHTPINK1*, *LIGHTPINK2*, *LIGHTPINK3*, *LIGHTPINK4*, *LIGHTSALMON1*, *LIGHTSALMON2*, *LIGHTSALMON3*, *LIGHTSALMON4*, *LIGHTSEAGREEN*, *LIGHTSKYBLUE*, *LIGHTSKYBLUE1*, *LIGHTSKYBLUE2*, *LIGHTSKYBLUE3*, *LIGHTSKYBLUE4*, *LIGHTSLATEBLUE*, *LIGHTSLATEGRAY*, *LIGHTSTEELBLUE*, *LIGHTSTEELBLUE1*, *LIGHTSTEELBLUE2*, *LIGHTSTEELBLUE3*, *LIGHTSTEELBLUE4*, *LIGHTYELLOW*, *LIGHTYELLOW2*, *LIGHTYELLOW3*, *LIGHTYELLOW4*, *LIMEGREEN*, *LINEN*, *MAGENTA1*, *MAGENTA2*, *MAGENTA3*, *MAGENTA4*, *MAROON*, *MAROON1*, *MAROON2*, *MAROON3*, *MAROON4*, *MEDIUMAQUAMARINE*, *MEDIUMORCHID*, *MEDIUMORCHID1*, *MEDIUMORCHID2*, *MEDIUMORCHID3*, *MEDIUMORCHID4*, *MEDIUMPURPLE*, *MEDIUMPURPLE1*, *MEDIUMPURPLE2*, *MEDIUMPURPLE3*, *MEDIUMPURPLE4*, *MEDIUMSEAGREEN*, *MEDIUMSLATEBLUE*, *MEDIUMSPRINGGREEN*, *MEDIUMTURQUOISE*, *MEDIUMVIOLETRED*, *MIDNIGHTBLUE*, *MINTCREAM*, *MISTYROSE*, *MISTYROSE2*, *MISTYROSE3*, *MISTYROSE4*, *MOCCASIN*, *NAVAJOWHITE1*, *NAVAJOWHITE2*, *NAVAJOWHITE3*, *NAVAJOWHITE4*, *NAVYBLUE*, *OLDLACE*, *OLIVEDRAB*, *OLIVEDRAB1*, *OLIVEDRAB2*, *OLIVEDRAB3*, *OLIVEDRAB4*, *ORANGE*, *ORANGE1*, *ORANGE2*, *ORANGE3*, *ORANGE4*, *ORANGERED*, *ORANGERED1*, *ORANGERED2*, *ORANGERED3*, *ORANGERED4*, *ORCHID*, *ORCHID1*, *ORCHID2*, *ORCHID3*, *ORCHID4*, *PALEGOLDENROD*, *PALEGREEN*, *PALEGREEN1*, *PALEGREEN2*, *PALEGREEN3*, *PALEGREEN4*, *PALETURQUOISE*, *PALETURQUOISE1*, *PALETURQUOISE2*, *PALETURQUOISE3*, *PALETURQUOISE4*, *PALEVIOLETRED*, *PALEVIOLETRED1*, *PALEVIOLETRED2*, *PALEVIOLETRED3*, *PALEVIOLETRED4*, *PAPAYAWHIP*, *PEACHPUFF*, *PEACHPUFF2*, *PEACHPUFF3*, *PEACHPUFF4*, *PERU*, *PINK*, *PINK1*, *PINK2*, *PINK3*, *PINK4*, *PLUM*, *PLUM1*, *PLUM2*, *PLUM3*, *PLUM4*, *POWDERBLUE*, *PURPLE*, *PURPLE1*, *PURPLE2*, *PURPLE3*, *PURPLE4*, *RED*, *RED1*, *RED2*, *RED3*, *RED4*, *ROSYBROWN*, *ROSYBROWN1*, *ROSYBROWN2*, *ROSYBROWN3*, *ROSYBROWN4*, *ROYALBLUE*, *ROYALBLUE1*, *ROYALBLUE2*, *ROYALBLUE3*, *ROYALBLUE4*, *SADDLEBROWN*, *SALMON*, *SALMON1*, *SALMON2*, *SALMON3*, *SALMON4*, *SANDYBROWN*, *SEAGREEN*, *SEAGREEN1*, *SEAGREEN2*, *SEAGREEN3*, *SEAGREEN4*, *SEASHELL*, *SEASHELL2*, *SEASHELL3*, *SEASHELL4*, *BEET*, *TEAL*, *SIENNA*, *SIENNA1*, *SIENNA2*, *SIENNA3*, *SIENNA4*, *SKYBLUE*, *SKYBLUE1*, *SKYBLUE2*, *SKYBLUE3*, *SKYBLUE4*, *SLATEBLUE*, *SLATEBLUE1*, *SLATEBLUE2*, *SLATEBLUE3*, *SLATEBLUE4*, *SLATEGRAY1*, *SLATEGRAY2*, *SLATEGRAY3*, *SLATEGRAY4*, *SLATEGRAY*, *SNOW*, *SNOW2*, *SNOW3*, *SNOW4*, *SPRINGGREEN*, *SPRINGGREEN2*, *SPRINGGREEN3*, *SPRINGGREEN4*, *STEELBLUE*, *STEELBLUE1*, *STEELBLUE2*, *STEELBLUE3*, *STEELBLUE4*, *TAN*, *TAN1*, *TAN2*, *TAN3*, *TAN4*, *THISTLE*, *THISTLE1*, *THISTLE2*, *THISTLE3*, *THISTLE4*, *TOMATO*, *TOMATO1*, *TOMATO2*, *TOMATO3*, *TOMATO4*, *TURQUOISE*, *TURQUOISE1*, *TURQUOISE2*, *TURQUOISE3*, *TURQUOISE4*, *VIOLET*, *VIOLETRED*, *VIOLETRED1*, *VIOLETRED2*, *VIOLETRED3*, *VIOLETRED4*, *WHEAT*, *WHEAT1*, *WHEAT2*, *WHEAT3*, *WHEAT4*, *WHITE*, *WHITESMOKE*, *YELLOW*, *YELLOW1*, *YELLOW2*, *YELLOW3*, *YELLOW4* and *YELLOWGREEN*.
1710 ~~~~~
1711 vaspects    [name] [-setcolor ColorName] [-setcolor R G B] [-unsetcolor]
1712 vsetcolor   [name] ColorName
1713 vunsetcolor [name]
1714 ~~~~~
1715
1716 **Transparency. The *Transp* may be between 0.0 (opaque) and 1.0 (fully transparent).
1717 **Warning**: at 1.0 the shape becomes invisible.
1718 ~~~~~
1719 vaspects           [name] [-settransparency Transp] [-unsettransparency]
1720 vsettransparency   [name] Transp
1721 vunsettransparency [name]
1722 ~~~~~
1723
1724 **Material**. The *MatName* can be *BRASS*, *BRONZE*, *COPPER*, *GOLD*, *PEWTER*, *PLASTER*, *PLASTIC*, *SILVER*, *STEEL*, *STONE*, *SHINY_PLASTIC*, *SATIN*, *METALIZED*, *NEON_GNC*, *CHROME*, *ALUMINIUM*, *OBSIDIAN*, *NEON_PHC*, *JADE*, *WATER*, *GLASS*, *DIAMOND* or *CHARCOAL*.
1725 ~~~~~
1726 vaspects       [name] [-setmaterial MatName] [-unsetmaterial]
1727 vsetmaterial   [name] MatName
1728 vunsetmaterial [name]
1729 ~~~~~
1730
1731 **Line width**. Specifies width of the edges. The *LineWidth* may be between 0.0 and 10.0.
1732 ~~~~~
1733 vaspects    [name] [-setwidth LineWidth] [-unsetwidth]
1734 vsetwidth   [name] LineWidth
1735 vunsetwidth [name]
1736 ~~~~~
1737
1738 **Example:**
1739 ~~~~~
1740 vinit
1741 box b 10 10 10
1742 vdisplay b
1743 vfit
1744
1745 vsetdispmode b 1
1746 vaspects -setcolor red -settransparency 0.2
1747 vrotate 10 10 10
1748 ~~~~~
1749
1750
1751
1752
1753
1754
1755 @subsubsection occt_draw_4_3_11 vsetshading
1756
1757 Syntax:                  
1758 ~~~~~
1759 vsetshading shapename [coefficient]
1760 ~~~~~ 
1761
1762 Sets deflection coefficient that defines the quality of the shape’s representation in the shading mode. Default coefficient is 0.0008. 
1763
1764 **Example:** 
1765 ~~~~~
1766 vinit 
1767 psphere s 20 
1768 vdisplay s 
1769 vfit 
1770 vsetdispmode 1 
1771 vsetshading s 0.005
1772 ~~~~~
1773  
1774 @subsubsection occt_draw_4_3_12 vunsetshading
1775
1776 Syntax:                  
1777 ~~~~~
1778 vunsetshading [shapename]
1779 ~~~~~ 
1780
1781 Sets default deflection coefficient (0.0008) that defines the quality of the shape’s representation in the shading mode. Default coefficient is 0.0008. 
1782
1783 @subsubsection occt_draw_4_3_13 vsetam
1784
1785 Syntax:                  
1786 ~~~~~
1787 vsetam [shapename] mode
1788 ~~~~~ 
1789
1790 Activates selection mode for all selected or named shapes: 
1791 * *0* for *shape* itself, 
1792 * *1* (*vertices*), 
1793 * *2* (*edges*), 
1794 * *3* (*wires*), 
1795 * *4* (*faces*), 
1796 * *5* (*shells*),
1797 * *6* (*solids*),
1798 * *7* (*compounds*).
1799  
1800 **Example:** 
1801 ~~~~~
1802 vinit 
1803 box b 10 10 10 
1804 vdisplay b 
1805 vfit 
1806 vsetam b 2
1807 ~~~~~
1808  
1809 @subsubsection occt_draw_4_3_14 vunsetam
1810
1811 Syntax:                  
1812 ~~~~~
1813 vunsetam
1814 ~~~~~ 
1815
1816 Deactivates all selection modes for all shapes. 
1817
1818 @subsubsection occt_draw_4_3_15 vdump
1819
1820 Syntax:                  
1821 ~~~~~
1822 vdump <filename>.{png|bmp|jpg|gif}
1823 ~~~~~ 
1824
1825 Extracts the contents of the viewer window to a image file.
1826
1827 @subsubsection occt_draw_4_3_16 vdir
1828
1829 Syntax:                  
1830 ~~~~~
1831 vdir
1832 ~~~~~ 
1833
1834 Displays the list of displayed objects. 
1835
1836 @subsubsection occt_draw_4_3_17 vsub
1837
1838 Syntax:                  
1839 ~~~~~
1840 vsub 0/1(on/off)[shapename]
1841 ~~~~~ 
1842
1843 Hilights/unhilights named or selected objects which are displayed at neutral state with subintensity color.
1844  
1845 **Example:** 
1846 ~~~~~
1847 vinit 
1848 box b 10 10 10 
1849 psphere s 20 
1850 vdisplay b s 
1851 vfit 
1852 vsetdispmode 1 
1853 vsub b 1
1854 ~~~~~ 
1855
1856 @subsubsection occt_draw_4_3_18 vardis
1857
1858 Syntax:                  
1859 ~~~~~
1860 vardis
1861 ~~~~~ 
1862
1863 Displays active areas (for each activated sensitive entity, one or several 2D bounding boxes are displayed, depending on the implementation of a particular entity). 
1864
1865 @subsubsection occt_draw_4_3_19 varera
1866
1867 Syntax:                  
1868 ~~~~~
1869 varera
1870 ~~~~~ 
1871
1872 Erases active areas. 
1873
1874 @subsubsection occt_draw_4_3_20 vsensdis
1875
1876 Syntax:                  
1877 ~~~~~
1878 vsensdis
1879 ~~~~~ 
1880
1881 Displays active entities (sensitive entities of one of the standard types corresponding to active selection modes). 
1882
1883 Standard entity types are those defined in Select3D package: 
1884   * sensitive box
1885   * sensitive face
1886   * sensitive curve
1887   * sensitive segment
1888   * sensitive circle
1889   * sensitive point
1890   * sensitive triangulation
1891   * sensitive triangle
1892 Custom (application-defined) sensitive entity types are not processed by this command. 
1893
1894 @subsubsection occt_draw_4_3_21 vsensera
1895
1896 Syntax:                  
1897 ~~~~~
1898 vsensera
1899 ~~~~~ 
1900
1901 Erases active entities. 
1902
1903 @subsubsection occt_draw_4_3_22 vperf
1904
1905 Syntax:                  
1906 ~~~~~
1907 vperf shapename 1/0 (Transformation/Loacation) 1/0 (Primitives sensibles ON/OFF)
1908 ~~~~~ 
1909
1910 Tests the animation of an object along a predefined trajectory. 
1911
1912 **Example:** 
1913 ~~~~~
1914 vinit 
1915 box b 10 10 10 
1916 psphere s 20 
1917 vdisplay b s 
1918 vfit 
1919 vsetdispmode 0 
1920 vperf b 1 1
1921 ~~~~~
1922  
1923 @subsubsection occt_draw_4_3_23 vr
1924
1925 Syntax:                  
1926 ~~~~~
1927 vr filename
1928 ~~~~~ 
1929
1930 Reads shape from BREP-format file and displays it in the viewer. 
1931
1932 **Example:** 
1933 ~~~~~
1934 vinit 
1935 vr myshape.brep
1936 ~~~~~
1937  
1938 @subsubsection occt_draw_4_3_24 vstate
1939
1940 Syntax:                  
1941 ~~~~~
1942 vstate [name1] … [name n]
1943 ~~~~~ 
1944
1945 Makes a list of the status (**Displayed** or **Not Displayed**) of some selected or named objects. 
1946
1947 @subsubsection occt_draw_4_3_25 vraytrace
1948
1949 Syntax:
1950 ~~~~~
1951 vraytrace [0/1]
1952 ~~~~~
1953
1954 Turns on/off ray tracing renderer.
1955
1956 @subsubsection occt_draw_4_3_26 vrenderparams
1957
1958 Syntax:
1959 ~~~~~
1960 vrenderparams
1961 ~~~~~
1962
1963 Manages rendering parameters:
1964 * rayTrace
1965 * raster
1966 * rayDepth
1967 * shadows
1968 * reflections
1969 * fsaa
1970 * gleam
1971 * shadingModel
1972
1973 **Example:**
1974 ~~~~~
1975 vinit
1976 box b 10 10 10
1977 vdisplay b
1978 vfit
1979 vraytrace 1
1980 vrenderparams -shadows 1 -reflections 1 -fsaa 1
1981 ~~~~~
1982 @subsubsection occt_draw_4_3_27 vshaderprog
1983
1984 Syntax:
1985 ~~~~~
1986 vshaderprog [name] pathToVertexShader pathToFragmentShader
1987 ~~~~~
1988
1989 Enables rendering using a shader program.
1990
1991 @subsubsection occt_draw_4_3_28 vsetcolorbg
1992
1993 Syntax:
1994 ~~~~~
1995 vsetcolorbg r g b
1996 ~~~~~
1997
1998 Sets background color.
1999
2000 **Example:**
2001 ~~~~~
2002 vinit
2003 vsetcolorbg 200 0 200
2004 ~~~~~
2005
2006 @subsection occt_draw_4_4 AIS viewer – object commands
2007
2008 @subsubsection occt_draw_4_4_1 vtrihedron
2009
2010 Syntax:                  
2011 ~~~~~
2012 vtrihedron name [X0] [Y0] [Z0] [Zu] [Zv] [Zw] [Xu] [Xv] [Xw]
2013 ~~~~~ 
2014
2015 Creates a new *AIS_Trihedron* object. If no argument is set, the default trihedron (0XYZ) is created.
2016  
2017 **Example:** 
2018 ~~~~~
2019 vinit 
2020 vtrihedron tr
2021 ~~~~~ 
2022
2023 @subsubsection occt_draw_4_4_2 vplanetri
2024
2025 Syntax:                  
2026 ~~~~~
2027 vplanetri name
2028 ~~~~~ 
2029
2030 Creates a plane from a trihedron selection. 
2031
2032
2033 @subsubsection occt_draw_4_4_3 vsize
2034
2035 Syntax:                  
2036 ~~~~~
2037 vsize [name] [size]
2038 ~~~~~ 
2039
2040 Changes the size of a named or selected trihedron. If the name is not defined: it affects the selected trihedrons otherwise nothing is done. If the value is not defined, it is set to 100 by default.
2041  
2042 **Example:** 
2043 ~~~~~
2044 vinit 
2045 vtrihedron tr1 
2046 vtrihedron tr2 0 0 0 1 0 0 1 0 0 
2047 vsize tr2 400
2048 ~~~~~ 
2049
2050 @subsubsection occt_draw_4_4_4 vaxis
2051
2052 Syntax:                  
2053 ~~~~~
2054 vaxis name [Xa Ya Za Xb Yb Zb]
2055 ~~~~~ 
2056
2057 Creates an axis. If  the values are not defined, an axis is created by interactive selection of two vertices or one edge
2058  
2059 **Example:** 
2060 ~~~~~
2061 vinit 
2062 vtrihedron tr 
2063 vaxis axe1 0 0 0 1 0 0 
2064 ~~~~~
2065
2066 @subsubsection occt_draw_4_4_5 vaxispara
2067
2068 Syntax:                  
2069 ~~~~~
2070 vaxispara nom
2071 ~~~~~ 
2072
2073 Creates an axis by interactive selection of an edge and a vertex. 
2074
2075 @subsubsection occt_draw_4_4_6 vaxisortho
2076
2077 Syntax:                  
2078 ~~~~~
2079 vaxisotrho name
2080 ~~~~~ 
2081
2082 Creates an axis by interactive selection of an edge and a vertex. The axis will be orthogonal to the selected edge. 
2083
2084 @subsubsection occt_draw_4_4_7 vpoint
2085
2086 Syntax:                  
2087 ~~~~~
2088 vpoint name [Xa Ya Za]
2089 ~~~~~ 
2090
2091 Creates a point from coordinates. If the values are not defined, a point is created by interactive selection of a vertice or an edge (in the center of the edge). 
2092
2093 **Example:** 
2094 ~~~~~
2095 vinit 
2096 vpoint p 0 0 0 
2097 ~~~~~
2098
2099 @subsubsection occt_draw_4_4_8 vplane
2100
2101 Syntax:                  
2102 ~~~~~
2103 vplane name [AxisName] [PointName] 
2104 vplane name [PointName] [PointName] [PointName] 
2105 vplane name [PlaneName] [PointName]
2106 ~~~~~ 
2107
2108 Creates a plane from named or interactively selected entities.
2109  
2110 **Example:** 
2111 ~~~~~
2112 vinit 
2113 vpoint p1 0 50 0 
2114 vaxis axe1 0 0 0 0 0 1 
2115 vtrihedron tr 
2116 vplane plane1 axe1 p1 
2117 ~~~~~
2118
2119 @subsubsection occt_draw_4_4_9 vplanepara
2120
2121 Syntax:                  
2122 ~~~~~
2123 vplanepara name
2124 ~~~~~ 
2125
2126 Creates a plane from interactively selected vertex and face. 
2127
2128 @subsubsection occt_draw_4_4_10 vplaneortho
2129
2130 Syntax:                  
2131 ~~~~~
2132 vplaneortho name
2133 ~~~~~ 
2134
2135 Creates a plane from interactive selected face and coplanar edge. 
2136
2137 @subsubsection occt_draw_4_4_11 vline
2138
2139 Syntax:                  
2140 ~~~~~
2141 vline name [PointName] [PointName] 
2142 vline name [Xa Ya Za Xb Yb Zb]
2143 ~~~~~ 
2144
2145 Creates a line from coordinates, named or interactively selected vertices. 
2146
2147 **Example:** 
2148 ~~~~~
2149 vinit 
2150 vtrihedron tr 
2151 vpoint p1 0 50 0 
2152 vpoint p2 50 0 0 
2153 vline line1 p1 p2 
2154 vline line2 0 0 0 50 0 1 
2155 ~~~~~
2156
2157 @subsubsection occt_draw_4_4_12 vcircle
2158
2159 Syntax:      
2160 ~~~~~
2161 vcircle name [PointName PointName PointName IsFilled] 
2162 vcircle name [PlaneName PointName Radius IsFilled] 
2163 ~~~~~
2164
2165 Creates a circle from named or interactively selected entities.  Parameter IsFilled is defined as 0 or 1.
2166  
2167 **Example:** 
2168 ~~~~~
2169 vinit 
2170 vtrihedron tr 
2171 vpoint p1 0 50 0 
2172 vpoint p2 50 0 0 
2173 vpoint p3 0 0 0 
2174 vcircle circle1 p1 p2 p3 1
2175 ~~~~~ 
2176
2177 @subsubsection occt_draw_4_4_13 vtri2d
2178
2179 Syntax:                  
2180 ~~~~~
2181 vtri2d name
2182 ~~~~~ 
2183
2184 Creates a plane with a 2D trihedron from an interactively selected face. 
2185
2186 @subsubsection occt_draw_4_4_14 vselmode
2187
2188 Syntax:                  
2189 ~~~~~
2190 vselmode [object] mode On/Off
2191 ~~~~~ 
2192
2193 Sets the selection mode for an object. If the object value is not defined, the selection mode is set for all displayed objects. 
2194 Value *On* is defined as 1 and *Off* – as 0. 
2195
2196 **Example:** 
2197 ~~~~~
2198 vinit 
2199 vpoint p1 0 0 0 
2200 vpoint p2 50 0 0 
2201 vpoint p3 25 40 0 
2202 vtriangle triangle1 p1 p2 p3 
2203 ~~~~~
2204
2205 @subsubsection occt_draw_4_4_15 vconnect, vconnectsh
2206
2207 Syntax:                  
2208 ~~~~~
2209 vconnect name object Xo Yo Zo Xu Xv Xw Zu Zv Zw 
2210 vconnectsh name shape Xo Yo Zo Xu Xv Xw Zu Zv Zw
2211 ~~~~~ 
2212
2213 Creates and displays an object with input location connected to a named entity. 
2214 The difference between these two commands is that the object created by *vconnect* does not support the selection modes different from 0. 
2215
2216 **Example:** 
2217 ~~~~~
2218 Vinitvinit 
2219 vpoint p1 0 0 0 
2220 vpoint p2 50 0 0 
2221 vsegment segment p1 p2 
2222 restore CrankArm.brep obj 
2223 vdisplay obj 
2224 vconnectsh new obj 100100100 1 0 0 0 0 1
2225 ~~~~~ 
2226
2227 @subsubsection occt_draw_4_4_16 vtriangle
2228
2229 Syntax:                  
2230 ~~~~~
2231 vtriangle name PointName PointName PointName
2232 ~~~~~ 
2233
2234 Creates and displays a filled triangle from named points. 
2235
2236 **Example:** 
2237 ~~~~~
2238 vinit 
2239 vpoint p1 0 0 0 
2240 vpoint p2 50 0 0 
2241 vpoint p3 25 40 0 
2242 vtriangle triangle1 p1 p2 p3
2243 ~~~~~ 
2244
2245 @subsubsection occt_draw_4_4_17 vsegment
2246
2247 Syntax:                  
2248 ~~~~~
2249 vsegment name PointName PointName 
2250 ~~~~~
2251
2252 Creates and displays a segment from named points. 
2253
2254 **Example:** 
2255 ~~~~~
2256 Vinit 
2257 vpoint p1 0 0 0 
2258 vpoint p2 50 0 0 
2259 vsegment segment p1 p2 
2260 ~~~~~
2261
2262 @subsubsection occt_draw_4_4_18 vpointcloud
2263
2264 Syntax:
2265 ~~~~~
2266 vpointcloud name shape
2267 ~~~~~
2268
2269 Creates an interactive object for an arbitary set of points from the triangulated shape.
2270
2271 ~~~~~
2272 vpointcloud name x y z r npts {surface|volume}
2273 ~~~~~
2274 Creates an arbitrary set of points (npts) randomly distributed on a spheric surface or within a spheric volume (x y z r).
2275
2276 **Example:**
2277 ~~~~~
2278 vinit
2279 vpointcloud pc 0 0 0 100 100000 surface -randColor
2280 vfit
2281 ~~~~~
2282
2283 @subsubsection occt_draw_4_4_19 vclipplane
2284
2285 Syntax:
2286 ~~~~~
2287 vclipplane maxplanes <view_name> - gets plane limit for the view.
2288 vclipplane create <plane_name> - creates a new plane.
2289 vclipplane delete <plane_name> - delete a plane.
2290 vclipplane clone <source_plane> <plane_name> - clones the plane definition.
2291 vclipplane set/unset <plane_name> object <object list> - sets/unsets the plane for an IO.
2292 vclipplane set/unset <plane_name> view <view list> - sets/unsets plane for a view.
2293 vclipplane change <plane_name> on/off - turns clipping on/off.
2294 vclipplane change <plane_name> equation <a> <b> <c> <d> - changes plane equation.
2295 vclipplane change <plane_name> capping on/off - turns capping on/off.
2296 vclipplane change <plane_name> capping color <r> <g> <b> - sets color.
2297 vclipplane change <plane name> capping texname <texture> - sets texture.
2298 vclipplane change <plane_name> capping texscale <sx> <sy> - sets texture scale.
2299 vclipplane change <plane_name> capping texorigin <tx> <ty> - sets texture origin.
2300 vclipplane change <plane_name> capping texrotate <angle> - sets texture rotation.
2301 vclipplane change <plane_name> capping hatch on/off/<id> - sets hatching mask.
2302 ~~~~~
2303
2304 Manages clipping planes
2305
2306 **Example:**
2307 ~~~~~
2308 vinit
2309 vclipplane create pln1
2310 vclipplane change pln1 equation 1 0 0 -0.1
2311 vclipplane set pln1 view Driver1/Viewer1/View1
2312 box b 100 100 100
2313 vdisplay b
2314 vsetdispmode 1
2315 vfit
2316 vrotate 10 10 10
2317 vselect 100 100
2318 ~~~~~
2319
2320 @subsubsection occt_draw_4_4_20 vdimension
2321
2322 Syntax:
2323 ~~~~~
2324 vdimension name {-angle|-length|-radius|-diameter} -shapes shape1 [shape2 [shape3]]
2325                 [-text 3d|2d wf|sh|wireframe|shading IntegerSize]
2326                 [-label left|right|hcenter|hfit top|bottom|vcenter|vfit]
2327                 [-arrow external|internal|fit] [{-arrowlength|-arlen} RealArrowLength]
2328                 [{-arrowangle|-arangle} ArrowAngle(degrees)] [-plane xoy|yoz|zox]
2329                 [-flyout FloatValue -extension FloatValue] [-value CustomNumberValue]
2330                 [-dispunits DisplayUnitsString] [-modelunits ModelUnitsString]
2331                 [-showunits | -hideunits]
2332 ~~~~~
2333
2334 Builds angle, length, radius or diameter dimension interactive object **name**.
2335
2336 **Attension:** length dimension can't be built without working plane.
2337
2338 **Example:** 
2339 ~~~~~
2340 vpoint p1 0 0 0
2341 vpoint p2 50 50 0
2342 vdimension dim1 -length -plane xoy -shapes p1 p2
2343
2344 vpoint p3 100 0 0
2345 vdimension dim2 -angle -shapes p1 p2 p3
2346
2347 vcircle circle p1 p2 p3 0
2348 vdimension dim3 -radius -shapes circle
2349 vfit
2350 ~~~~~
2351
2352 @subsubsection occt_draw_4_4_21 vdimparam
2353
2354 Syntax:
2355 ~~~~~
2356 vdimparam name [-text 3d|2d wf|sh|wireframe|shading IntegerSize]
2357                [-label left|right|hcenter|hfit top|bottom|vcenter|vfit]
2358                [-arrow external|internal|fit]
2359                [{-arrowlength|-arlen} RealArrowLength]
2360                [{-arrowangle|-arangle} ArrowAngle(degrees)]
2361                [-plane xoy|yoz|zox]
2362                [-flyout FloatValue -extension FloatValue]
2363                [-value CustomNumberValue]
2364                [-dispunits DisplayUnitsString]
2365                [-modelunits ModelUnitsString]
2366                [-showunits | -hideunits]
2367 ~~~~~
2368
2369 Sets parameters for angle, length, radius and diameter dimension **name**.
2370
2371 **Example:** 
2372 ~~~~~
2373 vpoint p1 0 0 0
2374 vpoint p2 50 50 0
2375 vdimension dim1 -length -plane xoy -shapes p1 p2
2376 vdimparam dim1 -flyout -15 -arrowlength 4 -showunits -value 10
2377 ~~~~~
2378
2379 @subsubsection occt_draw_4_4_22 vmovedim
2380
2381 Syntax:
2382 ~~~~~
2383 vmovedim [name] [x y z]
2384 ~~~~~
2385
2386 Moves picked or named (if **name** parameter is defined) dimension
2387 to picked mouse position or input point with coordinates **x**,**y**,**z**.
2388 Text label of dimension **name** is moved to position, another parts of dimension
2389 are adjusted.
2390
2391 **Example:** 
2392 ~~~~~
2393 vpoint p1 0 0 0
2394 vpoint p2 50 50 0
2395 vdimension dim1 -length -plane xoy -shapes p1 p2
2396 vmovedim dim1 -10 30 0
2397 ~~~~~
2398
2399
2400 @subsection occt_draw_4_5 AIS viewer – Mesh Visualization Service
2401
2402 **MeshVS** (Mesh Visualization Service) component provides flexible means of displaying meshes with associated pre- and post- processor data.
2403
2404 @subsubsection occt_draw_4_5_1 meshfromstl
2405
2406 Syntax:                  
2407 ~~~~~
2408 meshfromstl meshname file
2409 ~~~~~ 
2410
2411 Creates a *MeshVS_Mesh* object based on STL file data. The object will be displayed immediately.
2412  
2413 **Example:**
2414 ~~~~~ 
2415 meshfromstl mesh myfile.stl
2416 ~~~~~ 
2417
2418 @subsubsection occt_draw_4_5_2 meshdispmode
2419
2420 Syntax:                  
2421 ~~~~~
2422 meshdispmode meshname displaymode
2423 ~~~~~ 
2424
2425 Changes the display mode of object **meshname**. The **displaymode** is integer, which can be:
2426 * *1* for *wireframe*, 
2427 * *2* for *shading* mode, or
2428 * *3* for *shrink* mode. 
2429
2430 **Example:** 
2431 ~~~~~
2432 vinit 
2433 meshfromstl mesh myfile.stl 
2434 meshdispmode mesh 2
2435 ~~~~~ 
2436
2437 @subsubsection occt_draw_4_5_3 meshselmode
2438
2439 Syntax:                  
2440 ~~~~~
2441 meshselmode meshname selectionmode
2442 ~~~~~ 
2443
2444 Changes the selection mode of object **meshname**. The *selectionmode* is integer OR-combination of mode flags. The basic flags are the following: 
2445 * *1* – node selection;
2446 * *2* – 0D elements (not supported in STL); 
2447 * *4* – links (not supported in STL); 
2448 * *8* – faces.
2449  
2450 **Example:** 
2451 ~~~~~
2452 vinit 
2453 meshfromstl mesh myfile.stl 
2454 meshselmode mesh 1
2455 ~~~~~ 
2456
2457 @subsubsection occt_draw_4_5_4 meshshadcolor
2458
2459 Syntax:                  
2460 ~~~~~
2461 meshshadcolor meshname red green blue
2462 ~~~~~ 
2463
2464 Changes the face interior color of object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*.
2465  
2466 **Example:** 
2467 ~~~~~
2468 vinit 
2469 meshfromstl mesh myfile.stl 
2470 meshshadcolormode mesh 0.5 0.5 0.5
2471 ~~~~~ 
2472
2473 @subsubsection occt_draw_4_5_5 meshlinkcolor
2474
2475 Syntax:                  
2476 ~~~~~
2477 meshlinkcolor meshname red green blue
2478 ~~~~~ 
2479
2480 Changes the color of face borders for object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*.
2481  
2482 **Example:** 
2483 ~~~~~
2484 vinit 
2485 meshfromstl mesh myfile.stl 
2486 meshlinkcolormode mesh 0.5 0.5 0.5
2487 ~~~~~ 
2488
2489 @subsubsection occt_draw_4_5_6 meshmat
2490
2491 Syntax:                  
2492 ~~~~~
2493 meshmat meshname material
2494 ~~~~~ 
2495
2496 Changes the material of object **meshname**.
2497
2498 *material* is represented with an integer value as follows (equivalent to enumeration *Graphic3d_NameOfMaterial*): 
2499 * *0 - BRASS,* 
2500 * *1 - BRONZE,* 
2501 * *2 - COPPER,* 
2502 * *3 - GOLD,* 
2503 * *4 - PEWTER,* 
2504 * *5 - PLASTER,* 
2505 * *6 - PLASTIC,* 
2506 * *7 - SILVER,* 
2507 * *8 - STEEL,* 
2508 * *9 - STONE,* 
2509 * *10 - SHINY_PLASTIC,* 
2510 * *11 - SATIN,*
2511 * *12 - METALIZED,* 
2512 * *13 - NEON_GNC,* 
2513 * *14 - CHROME,*
2514 * *15 - ALUMINIUM,*
2515 * *16 - OBSIDIAN,* 
2516 * *17 - NEON_PHC,* 
2517 * *18 - JADE,*
2518 * *19 - DEFAULT,* 
2519 * *20 - UserDefined*
2520  
2521 **Example:** 
2522 ~~~~~
2523 vinit 
2524 meshfromstl mesh myfile.stl 
2525 meshmat mesh JADE 
2526 ~~~~~
2527
2528 @subsubsection occt_draw_4_5_7 meshshrcoef
2529
2530 Syntax:                  
2531 ~~~~~
2532 meshshrcoef meshname shrinkcoefficient
2533 ~~~~~ 
2534
2535 Changes the value of shrink coefficient used in the shrink mode. In the shrink mode the face is shown as a congruent part of a usual face, so that *shrinkcoefficient* controls the value of this part. The *shrinkcoefficient* is a positive real number.
2536  
2537 **Example:** 
2538 ~~~~~
2539 vinit 
2540 meshfromstl mesh myfile.stl 
2541 meshshrcoef mesh 0.05
2542 ~~~~~ 
2543
2544 @subsubsection occt_draw_4_5_8 meshshow
2545
2546 Syntax:                  
2547 ~~~~~
2548 meshshow meshname
2549 ~~~~~ 
2550
2551 Displays **meshname** in the viewer (if it is erased).
2552  
2553 **Example:** 
2554 ~~~~~
2555 vinit 
2556 meshfromstl mesh myfile.stl 
2557 meshshow mesh
2558 ~~~~~ 
2559
2560 @subsubsection occt_draw_4_5_9 meshhide
2561
2562 Syntax:                  
2563 ~~~~~
2564 meshhide meshname
2565 ~~~~~ 
2566
2567 Hides **meshname** in the viewer. 
2568
2569 **Example:** 
2570 ~~~~~
2571 vinit 
2572 meshfromstl mesh myfile.stl 
2573 meshhide mesh
2574 ~~~~~ 
2575
2576 @subsubsection occt_draw_4_5_10 meshhidesel
2577
2578 Syntax:                  
2579 ~~~~~
2580 meshhidesel meshname
2581 ~~~~~ 
2582
2583 Hides only selected entities. The other part of **meshname** remains visible. 
2584
2585 @subsubsection occt_draw_4_5_11 meshshowsel
2586
2587 Syntax:                  
2588 ~~~~~
2589 meshshowsel meshname
2590 ~~~~~ 
2591
2592 Shows only selected entities. The other part of **meshname** becomes invisible. 
2593
2594 @subsubsection occt_draw_4_5_12 meshshowall
2595
2596 Syntax:                  
2597 ~~~~~
2598 meshshowall meshname
2599 ~~~~~ 
2600
2601 Changes the state of all entities to visible for **meshname**. 
2602
2603 @subsubsection occt_draw_4_5_13 meshdelete
2604
2605 Syntax:                  
2606 ~~~~~
2607 meshdelete meshname
2608 ~~~~~ 
2609
2610 Deletes MeshVS_Mesh object **meshname**. 
2611
2612 **Example:** 
2613 ~~~~~
2614 vinit 
2615 meshfromstl mesh myfile.stl 
2616 meshdelete mesh 
2617 ~~~~~
2618
2619 @subsection occt_draw_4_6       VIS Viewer commands
2620
2621 A specific plugin with alias *VIS* should be loaded to have access to VIS functionality in DRAW Test Harness:
2622
2623 ~~~~
2624 \> pload VIS
2625 ~~~~
2626
2627 @subsubsection occt_draw_4_6_1  ivtkinit
2628
2629 Syntax:
2630 ~~~~~
2631 ivtkinit
2632 ~~~~~
2633
2634 Creates a window for VTK viewer.
2635
2636 @figure{/user_guides/draw_test_harness/images/draw_image001.png}
2637
2638 @subsection occt_draw_4_6_2     ivtkdisplay
2639
2640 Syntax:
2641 ~~~~~
2642 ivtkdisplay name1 [name2] …[name n]
2643 ~~~~~
2644
2645 Displays named objects.
2646
2647 **Example:** 
2648 ~~~~~
2649 ivtkinit
2650 # create cone
2651 pcone c 5 0 10
2652 ivtkdisplay c
2653 ~~~~~
2654
2655 @figure{/user_guides/draw_test_harness/images/draw_image002.png}
2656
2657 @subsection occt_draw_4_6_3     ivtkerase
2658
2659 Syntax:
2660 ~~~~~
2661 ivtkerase [name1] [name2] … [name n]
2662 ~~~~~
2663
2664 Erases named objects. If no arguments are passed, erases all displayed objects.
2665
2666 **Example:**
2667 ~~~~~
2668 ivtkinit
2669 # create a sphere
2670 psphere s 10
2671 # create a cone
2672 pcone c 5 0 10
2673 # create a cylinder
2674 pcylinder cy 5 10
2675 # display objects
2676 ivtkdisplay s c cy
2677 # erase only the cylinder
2678 ivtkerase cy
2679 # erase the sphere and the cone
2680 ivtkerase s c
2681 ~~~~~
2682
2683 @subsection occt_draw_4_6_4      ivtkfit
2684
2685 Syntax:
2686 ~~~~~
2687 ivtkfit
2688 ~~~~~
2689
2690 Automatic zoom/panning.
2691
2692 @subsection occt_draw_4_6_5     ivtkdispmode
2693
2694 Syntax:
2695 ~~~~~
2696 ivtksetdispmode [name] {0|1}
2697 ~~~~~
2698
2699 Sets display mode for a named object. If no arguments are passed, sets the given display mode for all displayed objects
2700 The possible modes are: 0 (WireFrame) and 1 (Shading).
2701
2702 **Example:**
2703 ~~~~~
2704 ivtkinit
2705 # create a cone
2706 pcone c 5 0 10
2707 # display the cone
2708 ivtkdisplay c
2709 # set shading mode for the cone
2710 ivtksetdispmode c 1
2711 ~~~~~
2712
2713 @figure{/user_guides/draw_test_harness/images/draw_image003.png}
2714  
2715 @subsection occt_draw_4_6_6     ivtksetselmode
2716
2717 Syntax:
2718 ~~~~~
2719 ivtksetselmode [name] mode {0|1}
2720 ~~~~~
2721
2722 Sets selection mode for a named object. If no arguments are passed, sets the given selection mode for all the displayed objects.
2723
2724 **Example:**
2725 ~~~~~
2726 ivtkinit
2727 # load a shape from file
2728 restore CrankArm.brep a
2729 # display the loaded shape
2730 ivtkdisplay a
2731 # set the face selection mode
2732 ivtksetselmode a 4 1
2733 ~~~~~
2734
2735 @figure{/user_guides/draw_test_harness/images/draw_image004.png}
2736  
2737 @subsection occt_draw_4_6_7     ivtkmoveto
2738
2739 Syntax:
2740 ~~~~~
2741 ivtkmoveto x y
2742 ~~~~~
2743
2744 Imitates mouse cursor moving to point with the given display coordinates **x**,**y**.
2745
2746 **Example:**
2747 ~~~~~
2748 ivtkinit
2749 pcone c 5 0 10
2750 ivtkdisplay c
2751 ivtkmoveto 40 50
2752 ~~~~~
2753
2754 @subsection occt_draw_4_6_8     ivtkselect
2755
2756 Syntax:
2757 ~~~~~
2758 ivtkselect x y
2759 ~~~~~
2760
2761 Imitates mouse cursor moving to point with the given display coordinates and performs selection at this point.
2762
2763 **Example:**
2764 ~~~~~
2765 ivtkinit
2766 pcone c 5 0 10
2767 ivtkdisplay c
2768 ivtkselect 40 50
2769 ~~~~~
2770
2771 @subsection occt_draw_4_6_9     ivtkdump
2772
2773 Syntax:
2774 ~~~~~
2775 ivtkdump *filename* [buffer={rgb|rgba|depth}] [width height] [stereoproj={L|R}]
2776 ~~~~~
2777
2778 Dumps the contents of VTK viewer to image. It supports:
2779 * dumping in different raster graphics formats: PNG, BMP, JPEG, TIFF or PNM.
2780 * dumping of different buffers: RGB, RGBA or depth buffer.
2781 * defining of image sizes (width and height in pixels).
2782 * dumping of stereo projections (left or right).
2783
2784 **Example:**
2785 ~~~~~
2786 ivtkinit
2787 pcone c 5 0 10
2788 ivtkdisplay c
2789 ivtkdump D:/ConeSnapshot.png rgb 768 768
2790 ~~~~~
2791
2792 @subsection occt_draw_4_6_10    ivtkbgcolor
2793
2794
2795 Syntax:
2796 ~~~~~
2797 ivtkbgcolor r g b [r2 g2 b2]
2798 ~~~~~
2799
2800 Sets uniform background color or gradient background if second triple of parameters is set. Color parameters r,g,b have to be chosen in the interval  [0..255].
2801
2802 **Example:**
2803 ~~~~~
2804 ivtkinit
2805 ivtkbgcolor 200 220 250
2806 ~~~~~
2807  
2808 @figure{/user_guides/draw_test_harness/images/draw_image005.png}
2809
2810 ~~~~~
2811 ivtkbgcolor 10 30 80 255 255 255
2812 ~~~~~
2813
2814 @figure{/user_guides/draw_test_harness/images/draw_image006.png}
2815
2816
2817 @section occt_draw_5 OCAF commands
2818
2819
2820 This chapter contains a set of commands for Open CASCADE Technology Application Framework (OCAF). 
2821
2822
2823 @subsection occt_draw_5_1 Application commands
2824
2825
2826 @subsubsection occt_draw_5_1_1 NewDocument
2827
2828 Syntax:       
2829 ~~~~~
2830 NewDocument docname [format]
2831 ~~~~~ 
2832
2833 Creates a new **docname** document with MDTV-Standard or described format. 
2834
2835 **Example:** 
2836 ~~~~~
2837 # Create new document with default (MDTV-Standard) format 
2838 NewDocument D 
2839
2840 # Create new document with BinOcaf format 
2841 NewDocument D2 BinOcaf 
2842 ~~~~~
2843
2844 @subsubsection occt_draw_5_1_2 IsInSession
2845
2846 Syntax:       
2847 ~~~~~
2848 IsInSession path
2849 ~~~~~ 
2850
2851 Returns *0*, if **path** document is managed by the application session, *1* – otherwise. 
2852
2853 **Example:** 
2854 ~~~~~
2855 IsInSession /myPath/myFile.std 
2856 ~~~~~
2857
2858 @subsubsection occt_draw_5_1_3 ListDocuments
2859
2860 Syntax:       
2861 ~~~~~
2862 ListDocuments
2863 ~~~~~ 
2864
2865 Makes a list of documents handled during the session of the application. 
2866
2867
2868 @subsubsection occt_draw_5_1_4 Open
2869
2870 Syntax:       
2871 ~~~~~
2872 Open path docname
2873 ~~~~~ 
2874
2875 Retrieves the document of file **docname** in the path **path**. Overwrites the document, if it is already in session. 
2876
2877 **Example:** 
2878 ~~~~~
2879 Open /myPath/myFile.std D
2880 ~~~~~ 
2881
2882 @subsubsection occt_draw_5_1_5 Close
2883
2884 Syntax:       
2885 ~~~~~
2886 Close docname
2887 ~~~~~ 
2888
2889 Closes **docname** document. The document is no longer handled by the applicative session. 
2890
2891 **Example:** 
2892 ~~~~~
2893 Close D 
2894 ~~~~~
2895
2896 @subsubsection occt_draw_5_1_6 Save
2897
2898 Syntax:       
2899 ~~~~~
2900 Save docname
2901 ~~~~~ 
2902
2903 Saves **docname** active document. 
2904
2905 **Example:** 
2906 ~~~~~
2907 Save D 
2908 ~~~~~
2909
2910 @subsubsection occt_draw_5_1_7 SaveAs
2911
2912 Syntax:       
2913 ~~~~~
2914 SaveAs docname path
2915 ~~~~~ 
2916
2917 Saves the active document in the file **docname** in the path **path**. Overwrites the file if it already exists. 
2918
2919 **Example:** 
2920 ~~~~~
2921 SaveAs D /myPath/myFile.std
2922 ~~~~~ 
2923
2924 @subsection occt_draw_5_2 Basic commands
2925
2926 @subsubsection occt_draw_5_2_1 Label
2927
2928 Syntax:   
2929
2930 ~~~~~
2931 Label docname entry
2932 ~~~~~
2933
2934 Creates the label expressed by <i>\<entry\></i> if it does not exist.
2935
2936 Example
2937 ~~~~~
2938 Label D 0:2
2939 ~~~~~
2940
2941 @subsubsection occt_draw_5_2_2 NewChild
2942
2943 Syntax:   
2944
2945 ~~~~~
2946 NewChild docname [taggerlabel = Root label]
2947 ~~~~~
2948 Finds (or creates) a *TagSource* attribute located at father label of <i>\<taggerlabel\></i> and makes a new child label.
2949
2950 Example
2951 ~~~~~
2952 # Create new child of root label
2953 NewChild D
2954
2955 # Create new child of existing label
2956 Label D 0:2
2957 NewChild D 0:2
2958 ~~~~~
2959
2960 @subsubsection occt_draw_5_2_3 Children
2961
2962 Syntax:  
2963 ~~~~~
2964 Children docname label
2965 ~~~~~
2966 Returns the list of attributes of label.
2967
2968 Example
2969 ~~~~~
2970 Children D 0:2
2971 ~~~~~
2972
2973 @subsubsection occt_draw_5_2_4 ForgetAll
2974
2975 Syntax:   
2976 ~~~~~
2977 ForgetAll docname label
2978 ~~~~~
2979 Forgets all attributes of the label.
2980
2981 Example
2982 ~~~~~
2983 ForgetAll D 0:2
2984 ~~~~~
2985
2986
2987 @subsubsection occt_draw_5_3 Application commands
2988
2989 @subsubsection occt_draw_5_3_1  Main
2990
2991 Syntax:       
2992 ~~~~~
2993 Main docname
2994 ~~~~~ 
2995
2996 Returns the main label of the framework. 
2997
2998 **Example:** 
2999 ~~~~~
3000 Main D 
3001 ~~~~~
3002
3003 @subsubsection occt_draw_5_3_2  UndoLimit
3004
3005 Syntax:       
3006 ~~~~~
3007 UndoLimit docname [value=0]
3008 ~~~~~ 
3009
3010
3011 Sets the limit on the number of Undo Delta stored. **0** will disable Undo on the document. A negative *value* means that there is no limit. Note that by default Undo is disabled. Enabling it will take effect with the next call to *NewCommand*. Of course, this limit is the same for Redo 
3012
3013 **Example:** 
3014 ~~~~~
3015 UndoLimit D 100 
3016 ~~~~~
3017
3018 @subsubsection occt_draw_5_3_3  Undo
3019
3020 Syntax:       
3021 ~~~~~
3022 Undo docname [value=1]
3023 ~~~~~ 
3024
3025 Undoes **value** steps. 
3026
3027 **Example:** 
3028 ~~~~~
3029 Undo D 
3030 ~~~~~
3031
3032 @subsubsection occt_draw_5_3_4  Redo
3033
3034 Syntax:       
3035 ~~~~~
3036 Redo docname [value=1]
3037 ~~~~~ 
3038
3039 Redoes **value** steps.
3040  
3041 **Example:** 
3042 ~~~~~
3043 Redo D 
3044 ~~~~~
3045
3046 @subsubsection occt_draw_5_3_5  OpenCommand
3047
3048 Syntax:       
3049 ~~~~~
3050 OpenCommand docname
3051 ~~~~~ 
3052
3053 Opens a new command transaction. 
3054
3055 **Example:**
3056 ~~~~~ 
3057 OpenCommand D
3058 ~~~~~ 
3059
3060 @subsubsection occt_draw_5_3_6  CommitCommand
3061
3062 Syntax:       
3063 ~~~~~
3064 CommitCommand docname
3065 ~~~~~ 
3066
3067 Commits the Command transaction. 
3068
3069 **Example:** 
3070 ~~~~~
3071 CommitCommand D
3072 ~~~~~ 
3073
3074 @subsubsection occt_draw_5_3_7  NewCommand
3075
3076 Syntax:       
3077 ~~~~~
3078 NewCommand docname
3079 ~~~~~ 
3080
3081 This is a short-cut for Commit and Open transaction. 
3082
3083 **Example:** 
3084 ~~~~~
3085 NewCommand D 
3086 ~~~~~
3087
3088 @subsubsection occt_draw_5_3_8  AbortCommand
3089
3090 Syntax:       
3091 ~~~~~
3092 AbortCommand docname
3093 ~~~~~ 
3094
3095 Aborts the Command transaction. 
3096
3097 **Example:** 
3098 ~~~~~
3099 AbortCommand D 
3100 ~~~~~
3101
3102 @subsubsection occt_draw_5_3_9  Copy
3103
3104 Syntax:       
3105 ~~~~~
3106 Copy docname entry Xdocname Xentry
3107 ~~~~~ 
3108
3109 Copies the contents of *entry* to *Xentry*. No links are registered. 
3110
3111 **Example:** 
3112 ~~~~~
3113 Copy D1 0:2 D2 0:4 
3114 ~~~~~
3115
3116 @subsubsection occt_draw_5_3_10  UpdateLink
3117
3118 Syntax:       
3119 ~~~~~
3120 UpdateLink docname [entry] 
3121 ~~~~~
3122
3123 Updates external reference set at *entry*. 
3124
3125 **Example:** 
3126 ~~~~~
3127 UpdateLink D 
3128 ~~~~~
3129
3130 @subsubsection occt_draw_5_3_11  CopyWithLink
3131
3132 Syntax:       
3133 ~~~~~
3134 CopyWithLink docname entry Xdocname Xentry
3135 ~~~~~ 
3136
3137 Aborts the Command transaction. 
3138 Copies the content of *entry* to *Xentry*. The link is registered with an *Xlink* attribute at *Xentry*  label. 
3139
3140 **Example:** 
3141 ~~~~~
3142 CopyWithLink D1 0:2 D2 0:4
3143 ~~~~~ 
3144
3145 @subsubsection occt_draw_5_3_12  UpdateXLinks
3146
3147 Syntax:       
3148 ~~~~~
3149 UpdateXLinks docname entry
3150 ~~~~~ 
3151
3152 Sets modifications on labels impacted by external references to the *entry*. The *document* becomes invalid and must be recomputed 
3153
3154 **Example:** 
3155 ~~~~~
3156 UpdateXLinks D 0:2 
3157 ~~~~~
3158
3159 @subsubsection occt_draw_5_3_13  DumpDocument
3160
3161 Syntax:       
3162 ~~~~~
3163 DumpDocument docname
3164 ~~~~~ 
3165
3166 Displays parameters of *docname* document. 
3167
3168 **Example:** 
3169 ~~~~~
3170 DumpDocument D 
3171 ~~~~~
3172
3173
3174 @subsection occt_draw_5_4  Data Framework commands
3175
3176
3177 @subsubsection occt_draw_5_4_1  MakeDF
3178
3179 Syntax:       
3180 ~~~~~
3181 MakeDF dfname
3182 ~~~~~ 
3183
3184 Creates a new data framework. 
3185
3186 **Example:** 
3187 ~~~~~
3188 MakeDF D 
3189 ~~~~~
3190
3191 @subsubsection occt_draw_5_4_2  ClearDF
3192
3193 Syntax:       
3194 ~~~~~
3195 ClearDF dfname
3196 ~~~~~ 
3197
3198 Clears a data framework. 
3199
3200 **Example:** 
3201 ~~~~~
3202 ClearDF D 
3203 ~~~~~
3204
3205 @subsubsection occt_draw_5_4_3  CopyDF
3206
3207 Syntax:       
3208 ~~~~~
3209 CopyDF dfname1 entry1 [dfname2] entry2
3210 ~~~~~ 
3211
3212 Copies a data framework. 
3213
3214 **Example:** 
3215 ~~~~~
3216 CopyDF D 0:2 0:4 
3217 ~~~~~
3218
3219 @subsubsection occt_draw_5_4_4  CopyLabel
3220
3221 Syntax:       
3222 ~~~~~
3223 CopyLabel dfname fromlabel tolablel
3224 ~~~~~ 
3225
3226 Copies a label. 
3227
3228 **Example:** 
3229 ~~~~~
3230 CopyLabel D1 0:2 0:4 
3231 ~~~~~
3232
3233 @subsubsection occt_draw_5_4_5  MiniDumpDF
3234
3235 Syntax:       
3236 ~~~~~
3237 MiniDumpDF dfname
3238 ~~~~~ 
3239
3240 Makes a mini-dump of a data framework. 
3241
3242 **Example:** 
3243 ~~~~~
3244 MiniDumpDF D 
3245 ~~~~~
3246
3247 @subsubsection occt_draw_5_4_6  XDumpDF
3248
3249 Syntax:       
3250 ~~~~~
3251 XDumpDF dfname
3252 ~~~~~ 
3253
3254 Makes an extended dump of a data framework. 
3255
3256 **Example:** 
3257 ~~~~~
3258 XDumpDF D
3259 ~~~~~ 
3260
3261 @subsection occt_draw_5_5  General attributes commands
3262
3263
3264 @subsubsection occt_draw_5_5_1  SetInteger
3265
3266 Syntax:       
3267 ~~~~~
3268 SetInteger dfname entry value
3269 ~~~~~ 
3270
3271 Finds or creates an Integer attribute at *entry* label and sets *value*. 
3272
3273 **Example:** 
3274 ~~~~~
3275 SetInteger D 0:2 100 
3276 ~~~~~
3277
3278 @subsubsection occt_draw_5_5_2  GetInteger
3279
3280 Syntax:       
3281 ~~~~~
3282 GetInteger dfname entry [drawname]
3283 ~~~~~ 
3284
3285 Gets a value of an Integer attribute at *entry* label and sets it to *drawname* variable, if it is defined. 
3286
3287 **Example:** 
3288 ~~~~~
3289 GetInteger D 0:2 Int1 
3290 ~~~~~
3291
3292 @subsubsection occt_draw_5_5_3  SetReal
3293
3294 Syntax:       
3295 ~~~~~
3296 SetReal dfname entry value
3297 ~~~~~ 
3298
3299 Finds or creates a Real attribute at *entry* label and sets *value*. 
3300
3301 **Example:** 
3302 ~~~~~
3303 SetReal D 0:2 100. 
3304 ~~~~~
3305
3306 @subsubsection occt_draw_5_5_4  GetReal
3307
3308 Syntax:       
3309 ~~~~~
3310 GetReal dfname entry [drawname]
3311 ~~~~~ 
3312
3313 Gets a value of a Real attribute at *entry* label and sets it to *drawname* variable, if it is defined. 
3314
3315 **Example:** 
3316 ~~~~~
3317 GetReal D 0:2 Real1 
3318 ~~~~~
3319
3320 @subsubsection occt_draw_5_5_5  SetIntArray
3321
3322 Syntax:       
3323 ~~~~~
3324 SetIntArray dfname entry lower upper value1 value2 … 
3325 ~~~~~
3326
3327 Finds or creates an IntegerArray attribute at *entry* label with lower and upper bounds and sets **value1*, *value2*... 
3328
3329 **Example:** 
3330 ~~~~~
3331 SetIntArray D 0:2 1 4 100 200 300 400
3332 ~~~~~ 
3333
3334 @subsubsection occt_draw_5_5_6  GetIntArray
3335
3336 Syntax:       
3337 ~~~~~
3338 GetIntArray dfname entry
3339 ~~~~~ 
3340
3341 Gets a value of an *IntegerArray* attribute at *entry* label. 
3342
3343 **Example:** 
3344 ~~~~~
3345 GetIntArray D 0:2
3346 ~~~~~ 
3347
3348 @subsubsection occt_draw_5_5_7  SetRealArray
3349
3350 Syntax:       
3351 ~~~~~
3352 SetRealArray dfname entry lower upper value1 value2 …
3353 ~~~~~ 
3354
3355 Finds or creates a RealArray attribute at *entry* label with lower and upper bounds and sets *value1*, *value2*… 
3356
3357 **Example:** 
3358 ~~~~~
3359 GetRealArray D 0:2 1 4 100. 200. 300. 400. 
3360 ~~~~~
3361
3362 @subsubsection occt_draw_5_5_8  GetRealArray
3363
3364 Syntax:       
3365 ~~~~~
3366 GetRealArray dfname entry
3367 ~~~~~ 
3368
3369 Gets a value of a RealArray attribute at *entry* label. 
3370
3371 **Example:** 
3372 ~~~~~
3373 GetRealArray D 0:2 
3374 ~~~~~
3375
3376 @subsubsection occt_draw_5_5_9  SetComment
3377
3378 Syntax:       
3379 ~~~~~
3380 SetComment dfname entry value
3381 ~~~~~ 
3382
3383 Finds or creates a Comment attribute at *entry* label and sets *value*. 
3384
3385 **Example:** 
3386 ~~~~~
3387 SetComment D 0:2 "My comment"
3388 ~~~~~ 
3389
3390 @subsubsection occt_draw_5_5_10  GetComment
3391
3392 Syntax:       
3393 ~~~~~
3394 GetComment dfname entry
3395 ~~~~~ 
3396
3397 Gets a value of a Comment attribute at *entry* label. 
3398
3399 **Example:** 
3400 ~~~~~
3401 GetComment D 0:2
3402 ~~~~~ 
3403
3404 @subsubsection occt_draw_5_5_11  SetExtStringArray
3405
3406 Syntax:       
3407 ~~~~~
3408 SetExtStringArray dfname entry lower upper value1 value2 …
3409 ~~~~~ 
3410
3411 Finds or creates an *ExtStringArray* attribute at *entry* label with lower and upper bounds and sets *value1*, *value2*… 
3412
3413 **Example:** 
3414 ~~~~~
3415 SetExtStringArray D 0:2 1 3 *string1* *string2* *string3*
3416 ~~~~~ 
3417
3418 @subsubsection occt_draw_5_5_12  GetExtStringArray
3419
3420 Syntax:       
3421 ~~~~~
3422 GetExtStringArray dfname entry
3423 ~~~~~ 
3424
3425 Gets a value of an ExtStringArray attribute at *entry* label. 
3426
3427 **Example:** 
3428 ~~~~~
3429 GetExtStringArray D 0:2 
3430 ~~~~~
3431
3432 @subsubsection occt_draw_5_5_13  SetName
3433
3434 Syntax:       
3435 ~~~~~
3436 SetName dfname entry value 
3437 ~~~~~
3438
3439 Finds or creates a Name attribute at *entry* label and sets *value*. 
3440
3441 **Example:** 
3442 ~~~~~
3443 SetName D 0:2 *My name* 
3444 ~~~~~
3445
3446 @subsubsection occt_draw_5_5_14  GetName
3447
3448 Syntax:       
3449 ~~~~~
3450 GetName dfname entry 
3451 ~~~~~
3452
3453 Gets a value of a Name attribute at *entry* label. 
3454
3455 **Example:** 
3456 ~~~~~
3457 GetName D 0:2 
3458 ~~~~~
3459
3460 @subsubsection occt_draw_5_5_15  SetReference
3461
3462 Syntax:       
3463 ~~~~~
3464 SetReference dfname entry reference 
3465 ~~~~~
3466
3467 Creates a Reference attribute at *entry* label and sets *reference*. 
3468
3469 **Example:** 
3470 ~~~~~
3471 SetReference D 0:2 0:4 
3472 ~~~~~
3473
3474 @subsubsection occt_draw_5_5_16  GetReference
3475
3476 Syntax:       
3477 ~~~~~
3478 GetReference dfname entry 
3479 ~~~~~
3480
3481 Gets a value of a Reference attribute at *entry* label. 
3482
3483 **Example:** 
3484 ~~~~~
3485 GetReference D 0:2 
3486 ~~~~~
3487
3488 @subsubsection occt_draw_5_5_17  SetUAttribute
3489
3490 Syntax:       
3491 ~~~~~
3492 SetUAttribute dfname entry localGUID 
3493 ~~~~~
3494
3495 Creates a UAttribute attribute at *entry* label with *localGUID*. 
3496
3497 **Example:** 
3498 ~~~~~
3499 set localGUID "c73bd076-22ee-11d2-acde-080009dc4422" 
3500 SetUAttribute D 0:2 ${localGUID} 
3501 ~~~~~
3502
3503 @subsubsection occt_draw_5_5_18  GetUAttribute
3504
3505 Syntax:       
3506 ~~~~~
3507 GetUAttribute dfname entry loacalGUID 
3508 ~~~~~
3509
3510 Finds a *UAttribute* at *entry* label with *localGUID*. 
3511
3512 **Example:** 
3513 ~~~~~
3514 set localGUID "c73bd076-22ee-11d2-acde-080009dc4422" 
3515 GetUAttribute D 0:2 ${localGUID} 
3516 ~~~~~
3517
3518 @subsubsection occt_draw_5_5_19  SetFunction
3519
3520 Syntax:       
3521 ~~~~~
3522 SetFunction dfname entry ID failure 
3523 ~~~~~
3524
3525 Finds or creates a *Function* attribute at *entry* label with driver ID and *failure* index. 
3526
3527 **Example:** 
3528 ~~~~~
3529 set ID "c73bd076-22ee-11d2-acde-080009dc4422" 
3530 SetFunction D 0:2 ${ID} 1 
3531 ~~~~~
3532
3533 @subsubsection occt_draw_5_5_20  GetFunction
3534
3535 Syntax:       
3536 ~~~~~
3537 GetFunction dfname entry ID failure 
3538 ~~~~~
3539
3540 Finds a Function attribute at *entry* label and sets driver ID to *ID* variable and failure index to *failure* variable. 
3541
3542 **Example:** 
3543 ~~~~~
3544 GetFunction D 0:2 ID failure 
3545 ~~~~~
3546
3547 @subsubsection occt_draw_5_5_21  NewShape
3548
3549 Syntax:       
3550 ~~~~~
3551 NewShape dfname entry [shape] 
3552 ~~~~~
3553
3554 Finds or creates a Shape attribute at *entry* label. Creates or updates the associated *NamedShape* attribute by *shape* if *shape* is defined. 
3555
3556 **Example:** 
3557 ~~~~~
3558 box b 10 10 10 
3559 NewShape D 0:2 b 
3560 ~~~~~
3561
3562 @subsubsection occt_draw_5_5_22  SetShape
3563
3564 Syntax:       
3565 ~~~~~
3566 SetShape dfname entry shape 
3567 ~~~~~
3568
3569 Creates or updates a *NamedShape* attribute at *entry* label by *shape*. 
3570
3571 **Example:** 
3572 ~~~~~
3573 box b 10 10 10 
3574 SetShape D 0:2 b 
3575 ~~~~~
3576
3577 @subsubsection occt_draw_5_5_23  GetShape
3578
3579 Syntax:       
3580 ~~~~~
3581 GetShape2 dfname entry shape 
3582 ~~~~~
3583
3584 Sets a shape from NamedShape attribute associated with *entry* label to *shape* draw variable. 
3585
3586 **Example:** 
3587 ~~~~~
3588 GetShape2 D 0:2 b 
3589 ~~~~~
3590
3591 @subsection occt_draw_5_6  Geometric attributes commands
3592
3593
3594 @subsubsection occt_draw_5_6_1  SetPoint
3595
3596 Syntax: