1 Draw Test Harness {#occt_user_guides__test_harness}
2 ===============================
6 @section occt_draw_1 Introduction
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.
11 @subsection occt_draw_1_1 Overview
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.
15 Draw can be used interactively to create, display and modify objects such as curves, surfaces and topological shapes.
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.
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.
28 There is also a set of commands for each delivery unit in the modeling libraries:
37 @subsection occt_draw_1_2 Contents of this documentation
39 This documentation describes:
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.
47 This document does not describe other sets of commands and does not explain how to extend Draw using C++.
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.
55 Terminates the Draw, TCL session. If the commands are read from a file using the source command, this will terminate the file.
60 # this is a very short example
65 @subsection occt_draw_1_3 Getting started
67 Install Draw and launch Emacs. Get a command line in Emacs using *Esc x* and key in *woksh*.
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.
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.
73 @subsubsection occt_draw_1_3_1 Launching DRAW Test Harness
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).
78 @subsubsection occt_draw_1_3_2 Plug-in resource file
80 Open CASCADE Technology is shipped with the DrawPlugin resource file located in the <i>$CASROOT/src/DrawResources</i> directory.
82 The format of the file is compliant with standard Open CASCADE Technology resource files (see the *Resource_Manager.cdl* file for details).
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.
86 **Example:** (excerpt from DrawPlugin):
87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
88 OCAF : VISUALIZATION, OCAFKERNEL
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
96 @subsubsection occt_draw_1_3_3 Activation of commands implemented in the plug-in
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:
101 pload [-PluginFileName] [[Key1] [Key2]...]
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).
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.
112 Draw[] pload -DrawPlugin OCAF
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.
117 Draw[] pload (equivalent to pload -DrawPlugin DEFAULT).
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.
122 @section occt_draw_2 The Command Language
124 @subsection occt_draw_2_1 Overview
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.
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:
130 * Syntax of the TCL language.
131 * Accessing variables in TCL and Draw.
132 * Control structures.
135 @subsection occt_draw_2_2 Syntax of TCL
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.
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.
141 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
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.
153 The following substitutions are performed by TCL:
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.
158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
159 # set a variable value
160 set file documentation
161 puts $file #to display file contents on the screen
163 # a simple substitution, set psfile to documentation.ps
167 # another substitution, set pfile to documentationPS
171 # delete files NEWdocumentation and OLDdocumentation
172 foreach prefix {NEW OLD} {rm $prefix$file}
173 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175 Command substitution is triggered by the [ ] characters. The brackets must enclose a valid script. The script is evaluated and the result is substituted.
177 Compare command construction in csh.
180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
183 # expr is a command evaluating a numeric expression
184 set radian [expr $pi*$degree/180]
185 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
189 TCL uses two forms of *quoting* to prevent substitution and word breaking.
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 " ".
194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
195 # set msg to ;the price is 12.00;
197 set msg ;the price is $price;
198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
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
215 # the following cannot be written
216 # because while requires two arguments
221 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
226 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
228 set a 1 # this is not a comment
229 set b 1; # this is a comment
230 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
236 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
237 # I want to delete two files
241 # this will fail because rm will receive only one argument
242 # and complain that ;foo bar; does not exit
246 # a second evaluation will do it
247 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
249 @subsection occt_draw_2_3 Accessing variables in TCL and Draw
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.
253 TCL provides a mechanism to link user data to variables. Using this functionality, Draw defines its variables as TCL variables with associated data.
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.
257 There are many kinds of Draw variables, and new ones may be added with C++. Geometric and topological variables are described below.
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.
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.
270 @subsubsection occt_draw_2_3_1 set, unset
276 unset varname [varname varname ...]
279 *set* assigns a string value to a variable. If the variable does not already exist, it is created.
281 Without a value, *set* returns the content of the variable.
283 *unset* deletes variables. It is is also used to delete Draw variables.
286 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
293 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
295 **Note**, that the *set* command can set only one variable, unlike the *dset* command.
298 @subsubsection occt_draw_2_3_2 dset, dval
303 dset var1 value1 vr2 value2 ...
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.
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.
313 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
318 # no $ required for Draw commands
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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
329 @subsection occt_draw_2_4 lists
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.
333 This allows you to insert lists within lists.
336 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
337 # a list of 3 strings
340 # a list of two strings the first is a list of 2
342 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
344 Many TCL commands return lists and **foreach** is a useful way to create loops on list elements.
346 @subsubsection occt_draw_2_5 Control Structures
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:
350 * You use braces instead of parentheses to enclose conditions.
351 * You do not start the script on the next line of your command.
354 @subsubsection occt_draw_2_5_1 if
359 if condition script [elseif script .... else script]
362 **If** evaluates the condition and the script to see whether the condition is true.
367 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
375 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
377 @subsubsection occt_draw_2_5_2 while, for, foreach
383 while condition script
384 for init condition reinit script
385 foreach varname list script
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. \
391 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
394 while {[dval x] 100} {
399 # incr var d, increments a variable of d (default 1)
400 for {set i 0} {$i 10} {incr i} {
402 point p$i cos(angle0 sin(angle) 0
405 foreach object {crapo tomson lucas} {display $object}
406 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
408 @subsubsection occt_draw_2_5_3 break, continue
417 Within loops, the **break** and **continue** commands have the same effect as in C.
419 **break** interrupts the innermost loop and **continue** jumps to the next iteration.
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;
427 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
429 @subsection occt_draw_2_6 Procedures
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.
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.
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.
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.
440 @subsubsection occt_draw_2_6_1 proc
445 proc argumentlist script
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.
450 **return** gives a return value to the procedure.
453 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
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)]
464 if {$n == 0} {return 1} else {
465 return [expr n*[fact [expr n -1]]]
468 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
471 @subsubsection occt_draw_2_6_2 global, upvar
476 global varname [varname ...]
477 upvar varname localname [varname localname ...]
481 **global** accesses high level variables. Unlike C, global variables are not visible in procedures.
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.
485 **Note** that in the following examples the \$ character is always necessarily used to access the arguments.
488 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
489 # convert degree to radian
490 # pi is a global variable
491 proc deg2rad (degree} {
492 return [dval pi*$degree/2.]
494 # create line with a point and an angle
495 proc linang {linename x y angle} {
497 line l $x $y cos($angle) sin($angle)
499 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
501 @section occt_draw_3 Basic Commands
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:
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.
510 Note that Draw also features a GUI task bar providing an alternative way to give certain general, graphic and display commands
513 @subsection occt_draw_3_1 General commands
515 This section describes several useful commands:
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.
524 @subsubsection occt_draw_3_1_1 help
529 help [command [helpstring group]]
532 Provides help or modifies the help information.
534 **help** without arguments lists all groups and the commands in each group.
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.
539 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
540 # Gives help on all commands starting with *a*
541 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
544 @subsubsection occt_draw_3_1_2 source
553 The **exit** command will terminate the file.
555 @subsubsection occt_draw_3_1_3 spy
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.
565 If a command returns an error it is saved with a comment mark.
567 The file created by **spy** can be executed with the **source** command.
570 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
571 # all commands will be saved in the file ;session;
573 # the file ;session; is closed and commands are not saved
575 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
579 @subsubsection occt_draw_3_1_4 cpulimit
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.
590 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
591 #limit cpu to one hour
593 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
595 @subsubsection occt_draw_3_1_5 wait
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.
604 # You have ten seconds ...
608 @subsubsection occt_draw_3_1_6 chrono
613 chrono [ name start/stop/reset/show]
616 Without arguments, **chrono** activates Draw chronometers. The elapsed time ,cpu system and cpu user times for each command will be printed.
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).
625 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
627 ==Chronometers activated.
629 ==Elapsed time: 0 Hours 0 Minutes 0.0318 Seconds
630 ==CPU user time: 0.01 seconds
631 ==CPU system time: 0 seconds
632 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
634 @subsection occt_draw_3_2 Variable management commands
636 @subsubsection occt_draw_3_2_1 isdraw, directory
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.
646 Use **directory** to return a list of all Draw global variables matching a pattern.
649 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
662 # to destroy all Draw objects with name containing curve
663 foreach var [directory *curve*] {unset $var}
664 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
667 @subsubsection occt_draw_3_2_2 whatis, dump
672 whatis varname [varname ...]
673 dump varname [varname ...]
676 **whatis** returns short information about a Draw variable. This is usually the type name.
678 **dump** returns a brief type description, the coordinates, and if need be, the parameters of a Draw variable.
681 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
688 ***** Dump of c *****
694 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
696 **Note** The behavior of *whatis* on other variables (not Draw) is not excellent.
699 @subsubsection occt_draw_3_2_3 rename, copy
703 rename varname tovarname [varname tovarname ...]
704 copy varname tovarname [varname tovarname ...]
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.
711 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
715 # curves are copied, c2 will not be modified
717 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
719 @subsubsection occt_draw_3_2_4 datadir, save, restore
724 save variable [filename]
725 restore filename [variablename]
728 * **datadir** without arguments prints the path of the current data directory.
729 * **datadir** with an argument sets the data directory path. \
731 If the path starts with a dot (.) only the last directory name will be changed in the path.
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.
736 The exact content of the file is type-dependent. They are usually ASCII files and so, architecture independent.
739 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
740 # note how TCL accesses shell environment variables
745 datadir $env(WBCONTAINER)/data/default
746 ==/adv_20/BAG/data/default
750 ==/adv_20/BAG/data/default/theBox
752 # when TCL does not find a command it tries a shell command
758 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
760 @subsection occt_draw_3_3 User defined commands
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.
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.
766 @subsubsection occt_draw_3_3_1 set
768 #### In *DrawTrSurf* package:
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) ;
785 #### In *DBRep* package:
788 void Set(const Standard_CString Name,
789 const TopoDS_Shape& S) ;
792 Example of *DrawTrSurf*
795 Handle(Geom2d_Circle) C1 = new Geom2d_Circle
796 (gce_MakeCirc2d (gp_Pnt2d(50,0,) 25));
797 DrawTrSurf::Set(char*, C1);
804 B = BRepPrimAPI_MakeBox (10,10,10);
808 @subsubsection occt_draw_3_3_2 get
810 #### In *DrawTrSurf* package:
813 Handle_Geom_Geometry Get(Standard_CString& Name) ;
816 #### In *DBRep* package:
819 TopoDS_Shape Get(Standard_CString& Name,
820 const TopAbs_ShapeEnum Typ = TopAbs_SHAPE,
821 const Standard_Boolean Complain
825 Example of *DrawTrSurf*
828 Standard_Integer MyCommand
829 (Draw_Interpretor& theCommands,
830 Standard_Integer argc, char** argv)
832 // Creation of a Geom_Geometry from a Draw geometric
834 Handle (Geom_Geometry) aGeom= DrawTrSurf::Get(argv[1]);
841 Standard_Integer MyCommand
842 (Draw_Interpretor& theCommands,
843 Standard_Integer argc, char** argv)
845 // Creation of a TopoDS_Shape from a Draw topological
847 TopoDS_Solid B = DBRep::Get(argv[1]);
851 @section occt_draw_4 Graphic Commands
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.
855 @subsection occt_draw_4_1 Axonometric viewer
857 @subsubsection occt_draw_4_1_1 view, delete
861 view index type [X Y W H]
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.
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..
869 **delete** deletes a view. If no index is given, all the views are deleted.
871 Type selects from the following range:
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
878 The index, the type, the current zoom are displayed in the window title .
881 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
882 # this is the content of the mu4 procedure
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
890 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
892 See also: **axo, pers, top, bottom, left, right, front, back, mu4, v2d, av2d, smallview**
894 @subsubsection occt_draw_4_1_2 axo, pers, top, ...
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.
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.
915 See also: **view**, **delete**
917 @subsubsection occt_draw_4_1_3 mu, md, 2dmu, 2dmd, zoom, 2dzoom
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.
935 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
943 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
944 See also: **fit**, **2dfit**
947 @subsubsection occt_draw_4_14 pu, pd, pl, pr, 2dpu, 2dpd, 2dpl, 2dpr
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.
958 # you have selected one anonometric view
963 # you have selected an mu4 view; the object in the third view will pan up
966 See also: **fit**, **2dfit**
969 @subsubsection occt_draw_4_1_5 fit, 2dfit
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.
980 When fitting all views a unique zoom is computed for all the views. All views are on the same scale.
983 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
988 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
989 See also: **zoom**, **mu**, **pu**
992 @subsubsection occt_draw_4_1_6 u, d, l, r
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.
1006 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1007 # rotate the view up
1009 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1011 @subsubsection occt_draw_4_1_7 focal, fu, fd
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.
1024 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1027 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1029 **Note**: Do not use a negative or null focal value.
1033 @subsubsection occt_draw_4_1_8 color
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.
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.
1046 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1047 # change the value of blue
1049 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1052 **Note** that the color change will be visible on the next redraw of the views, for example, after *fit* or *mu*, etc.
1054 @subsubsection occt_draw_4_1_9 dtext
1058 dtext [x y [z]] string
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.
1063 The coordinates are real space coordinates.
1066 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1070 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1072 @subsubsection occt_draw_4_1_10 hardcopy, hcolor, xwd
1077 hcolor index width gray
1078 xwd [index] filename
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**.
1086 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1087 # all blue lines (color 3)
1088 # will be half-width and gray
1091 # make a postscript file and print it
1095 # make an xwd file and display it
1098 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1100 **Note:** When more than one view is present, specify the index of the view.
1102 Only use a postscript printer to print postscript files.
1107 @subsubsection occt_draw_4_1_11 wclick, pick
1112 pick index X Y Z b [nowait]
1115 **wclick** defers an event until the mouse button is clicked. The message <code>just click</code> is displayed.
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.
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.
1124 This option is useful for tracking the pointer.
1126 **Note** that the results are stored in Draw numeric variables.
1129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1130 # make a circle at mouse location
1132 circle c x y z 0 0 1 1 0 0 0 30
1134 # make a dynamic circle at mouse location
1135 # stop when a button is clicked
1136 # (see the repaint command)
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
1144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1145 See also: **repaint**
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.
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.
1159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1160 # OK use dot to dump an object on the screen
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
1173 # would have displayed only one point
1174 # because the precedent variable content is erased
1177 # is an other solution, creating variables
1180 # give a name to a graphic object
1182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1185 @subsubsection occt_draw_4_1_12 autodisplay
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.
1195 When **autodisplay** is off, using the dot return argument is ineffective.
1198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1207 # c is erased, but not displayed
1209 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1211 @subsubsection occt_draw_4_1_13 display, donly
1215 display varname [varname ...]
1216 donly varname [varname ...]
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.
1223 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1224 \# to see all objects
1225 foreach var [directory] {display $var}
1227 \# to select two objects and erase the other ones
1229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1232 @subsubsection occt_draw_4_1_14 erase, clear, 2dclear
1237 erase [varname varname ...]
1242 **erase** removes objects from all views. **erase** without arguments erases everything in 2d and 3d.
1244 **clear** erases only 3d objects and **2dclear** only 2d objects. **erase** without arguments is similar to **clear; 2dclear**.
1248 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1249 # erase eveerything with a name starting with c_
1250 foreach var [directory c_*] {erase $var}
1254 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1256 @subsubsection occt_draw_4_1_15 repaint, dflush
1266 * **repaint** forces repainting of views.
1267 * **dflush** flushes the graphic buffers.
1269 These commands are useful within loops or in scripts.
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.
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.
1275 See also: <a href="#occt_draw_4_1_11">pick</a> command.
1277 @subsection occt_draw_4_2 AIS viewer – view commands
1279 @subsubsection occt_draw_4_2_1 vinit
1285 Creates the 3D viewer window
1287 @subsubsection occt_draw_4_2_2 vhelp
1293 Displays help in the 3D viewer window. The help consists in a list of hotkeys and their functionalities.
1295 @subsubsection occt_draw_4_2_3 vtop
1302 Displays top view in the 3D viewer window.
1305 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1311 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1313 @subsubsection occt_draw_4_2_4 vaxo
1320 Displays axonometric view in the 3D viewer window.
1323 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1329 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1331 @subsubsection occt_draw_4_2_5 vsetbg
1335 vsetbg imagefile [filltype]
1338 Loads image file as background. *filltype* must be NONE, CENTERED, TILED or STRETCH.
1343 vsetbg myimage.brep CENTERED
1346 @subsubsection occt_draw_4_2_6 vclear
1352 Removes all objects from the viewer.
1354 @subsubsection occt_draw_4_2_7 vrepaint
1360 Forcedly redisplays the shape in the 3D viewer window.
1362 @subsubsection occt_draw_4_2_8 vfit
1368 Automatic zoom/panning. Objects in the view are visualized to occupy the maximum surface.
1370 @subsubsection occt_draw_4_2_9 vzfit
1377 Automatic depth panning. Objects in the view are visualized to occupy the maximum 3d space.
1379 @subsubsection occt_draw_4_2_10 vreadpixel
1383 vreadpixel xPixel yPixel [{rgb|rgba|depth|hls|rgbf|rgbaf}=rgba] [name]
1385 Read pixel value for active view.
1388 @subsubsection occt_draw_4_2_11 vselect
1392 vselect x1 y1 [x2 y2 [x3 y3 ... xn yn]] [shift_selection = 0|1]
1395 Emulates different types of selection:
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.
1402 @subsubsection occt_draw_4_2_12 vmoveto
1409 Emulates cursor movement to pixel position (x,y).
1411 @subsubsection occt_draw_4_2_13 vviewparams
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]
1417 Gets or sets the current view characteristics.
1419 @subsubsection occt_draw_4_2_14 vchangeselected
1423 vchangeselected shape
1425 Adds a shape to selection or removes one from it.
1427 @subsubsection occt_draw_4_2_15 vzclipping
1431 vzclipping [mode] [depth width]
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]
1438 @subsubsection occt_draw_4_2_16 vnbselected
1444 Returns the number of selected objects in the interactive context.
1446 @subsubsection occt_draw_4_2_17 vantialiasing
1452 Sets antialiasing if the command is called with 1 or unsets otherwise.
1454 @subsubsection occt_draw_4_2_18 vpurgedisplay
1458 vpurgedisplay [CollectorToo = 0|1]
1460 Removes structures which do not belong to objects displayed in neutral point.
1462 @subsubsection occt_draw_4_2_19 vhlr
1466 vhlr is_enabled={on|off}
1468 Switches hidden line removal (computed) mode on/off.
1470 @subsubsection occt_draw_4_2_20 vhlrtype
1474 vhlrtype algo_type={algo|polyalgo} [shape_1 ... shape_n]
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.
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.
1482 **Note** that this command works with instances of *AIS_Shape* or derived classes only, other interactive object types are ignored.
1484 @subsubsection occt_draw_4_2_21 vcamera
1491 Manages camera parameters.
1502 @subsubsection occt_draw_4_2_22 vstereo
1509 Turns stereo usage On/Off.
1518 vcamera -stereo -iod 1
1523 @subsubsection occt_draw_4_2_23 vfrustumculling
1527 vfrustumculling [toEnable]
1530 Enables/disables objects clipping.
1533 @subsection occt_draw_4_3 AIS viewer – display commands
1535 @subsubsection occt_draw_4_3_1 vdisplay
1539 vdisplay [-noupdate|-update] [-local] [-mutable] name1 [name2] … [name n]
1542 Displays named objects. Automatically redraws view by default.
1543 Redraw can be suppressed by -noupdate option.
1548 box b 40 40 40 10 10 10
1554 @subsubsection occt_draw_4_3_2 vdonly
1558 vdonly [name1] … [name n]
1561 Displays only selected or named objects. If there are no selected or named objects, nothing is done.
1566 box b 40 40 40 10 10 10
1572 @subsubsection occt_draw_4_3_3 vdisplayall
1579 Displays all created objects.
1584 box b 40 40 40 10 10 10
1590 @subsubsection occt_draw_4_3_4 verase
1594 verase [name1] [name2] … [name n]
1597 Erases some selected or named objects. If there are no selected or named objects, the whole viewer is erased.
1602 box b1 40 40 40 10 10 10
1603 box b2 -40 -40 -40 10 10 10
1607 # erase only first box
1609 # erase second box and sphere
1613 @subsubsection occt_draw_4_3_5 veraseall
1620 Erases all objects displayed in the viewer.
1625 box b1 40 40 40 10 10 10
1626 box b2 -40 -40 -40 10 10 10
1630 # erase only first box
1632 # erase second box and sphere
1636 @subsubsection occt_draw_4_3_6 vsetdispmode
1640 vsetdispmode [name] mode(0,1,2,3)
1643 Sets display mode for all, selected or named objects.
1644 * *0* (*WireFrame*),
1646 * *2* (*Quick HideLineremoval*),
1647 * *3* (*Exact HideLineremoval*).
1658 @subsubsection occt_draw_4_3_7 vdisplaytype
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*.
1668 @subsubsection occt_draw_4_3_8 verasetype
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*.
1678 @subsubsection occt_draw_4_3_9 vtypes
1685 Makes a list of known types and signatures in AIS.
1687 @subsubsection occt_draw_4_3_10 vaspects
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 [...]]]
1702 vsetcolor [shapename] colorname
1707 Manages presentation properties (color, material, transparency) of all objects, selected or named.
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*.
1711 vaspects [name] [-setcolor ColorName] [-setcolor R G B] [-unsetcolor]
1712 vsetcolor [name] ColorName
1716 **Transparency. The *Transp* may be between 0.0 (opaque) and 1.0 (fully transparent).
1717 **Warning**: at 1.0 the shape becomes invisible.
1719 vaspects [name] [-settransparency Transp] [-unsettransparency]
1720 vsettransparency [name] Transp
1721 vunsettransparency [name]
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*.
1726 vaspects [name] [-setmaterial MatName] [-unsetmaterial]
1727 vsetmaterial [name] MatName
1728 vunsetmaterial [name]
1731 **Line width**. Specifies width of the edges. The *LineWidth* may be between 0.0 and 10.0.
1733 vaspects [name] [-setwidth LineWidth] [-unsetwidth]
1734 vsetwidth [name] LineWidth
1746 vaspects -setcolor red -settransparency 0.2
1755 @subsubsection occt_draw_4_3_11 vsetshading
1759 vsetshading shapename [coefficient]
1762 Sets deflection coefficient that defines the quality of the shape’s representation in the shading mode. Default coefficient is 0.0008.
1774 @subsubsection occt_draw_4_3_12 vunsetshading
1778 vunsetshading [shapename]
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.
1783 @subsubsection occt_draw_4_3_13 vsetam
1787 vsetam [shapename] mode
1790 Activates selection mode for all selected or named shapes:
1791 * *0* for *shape* itself,
1798 * *7* (*compounds*).
1809 @subsubsection occt_draw_4_3_14 vunsetam
1816 Deactivates all selection modes for all shapes.
1818 @subsubsection occt_draw_4_3_15 vdump
1822 vdump <filename>.{png|bmp|jpg|gif}
1825 Extracts the contents of the viewer window to a image file.
1827 @subsubsection occt_draw_4_3_16 vdir
1834 Displays the list of displayed objects.
1836 @subsubsection occt_draw_4_3_17 vsub
1840 vsub 0/1(on/off)[shapename]
1843 Hilights/unhilights named or selected objects which are displayed at neutral state with subintensity color.
1856 @subsubsection occt_draw_4_3_18 vardis
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).
1865 @subsubsection occt_draw_4_3_19 varera
1872 Erases active areas.
1874 @subsubsection occt_draw_4_3_20 vsensdis
1881 Displays active entities (sensitive entities of one of the standard types corresponding to active selection modes).
1883 Standard entity types are those defined in Select3D package:
1890 * sensitive triangulation
1891 * sensitive triangle
1892 Custom (application-defined) sensitive entity types are not processed by this command.
1894 @subsubsection occt_draw_4_3_21 vsensera
1901 Erases active entities.
1903 @subsubsection occt_draw_4_3_22 vperf
1907 vperf shapename 1/0 (Transformation/Loacation) 1/0 (Primitives sensibles ON/OFF)
1910 Tests the animation of an object along a predefined trajectory.
1923 @subsubsection occt_draw_4_3_23 vr
1930 Reads shape from BREP-format file and displays it in the viewer.
1938 @subsubsection occt_draw_4_3_24 vstate
1942 vstate [name1] … [name n]
1945 Makes a list of the status (**Displayed** or **Not Displayed**) of some selected or named objects.
1947 @subsubsection occt_draw_4_3_25 vraytrace
1954 Turns on/off ray tracing renderer.
1956 @subsubsection occt_draw_4_3_26 vrenderparams
1963 Manages rendering parameters:
1980 vrenderparams -shadows 1 -reflections 1 -fsaa 1
1982 @subsubsection occt_draw_4_3_27 vshaderprog
1986 vshaderprog [name] pathToVertexShader pathToFragmentShader
1989 Enables rendering using a shader program.
1991 @subsubsection occt_draw_4_3_28 vsetcolorbg
1998 Sets background color.
2003 vsetcolorbg 200 0 200
2006 @subsection occt_draw_4_4 AIS viewer – object commands
2008 @subsubsection occt_draw_4_4_1 vtrihedron
2012 vtrihedron name [X0] [Y0] [Z0] [Zu] [Zv] [Zw] [Xu] [Xv] [Xw]
2015 Creates a new *AIS_Trihedron* object. If no argument is set, the default trihedron (0XYZ) is created.
2023 @subsubsection occt_draw_4_4_2 vplanetri
2030 Creates a plane from a trihedron selection.
2033 @subsubsection occt_draw_4_4_3 vsize
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.
2046 vtrihedron tr2 0 0 0 1 0 0 1 0 0
2050 @subsubsection occt_draw_4_4_4 vaxis
2054 vaxis name [Xa Ya Za Xb Yb Zb]
2057 Creates an axis. If the values are not defined, an axis is created by interactive selection of two vertices or one edge
2063 vaxis axe1 0 0 0 1 0 0
2066 @subsubsection occt_draw_4_4_5 vaxispara
2073 Creates an axis by interactive selection of an edge and a vertex.
2075 @subsubsection occt_draw_4_4_6 vaxisortho
2082 Creates an axis by interactive selection of an edge and a vertex. The axis will be orthogonal to the selected edge.
2084 @subsubsection occt_draw_4_4_7 vpoint
2088 vpoint name [Xa Ya Za]
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).
2099 @subsubsection occt_draw_4_4_8 vplane
2103 vplane name [AxisName] [PointName]
2104 vplane name [PointName] [PointName] [PointName]
2105 vplane name [PlaneName] [PointName]
2108 Creates a plane from named or interactively selected entities.
2114 vaxis axe1 0 0 0 0 0 1
2116 vplane plane1 axe1 p1
2119 @subsubsection occt_draw_4_4_9 vplanepara
2126 Creates a plane from interactively selected vertex and face.
2128 @subsubsection occt_draw_4_4_10 vplaneortho
2135 Creates a plane from interactive selected face and coplanar edge.
2137 @subsubsection occt_draw_4_4_11 vline
2141 vline name [PointName] [PointName]
2142 vline name [Xa Ya Za Xb Yb Zb]
2145 Creates a line from coordinates, named or interactively selected vertices.
2154 vline line2 0 0 0 50 0 1
2157 @subsubsection occt_draw_4_4_12 vcircle
2161 vcircle name [PointName PointName PointName IsFilled]
2162 vcircle name [PlaneName PointName Radius IsFilled]
2165 Creates a circle from named or interactively selected entities. Parameter IsFilled is defined as 0 or 1.
2174 vcircle circle1 p1 p2 p3 1
2177 @subsubsection occt_draw_4_4_13 vtri2d
2184 Creates a plane with a 2D trihedron from an interactively selected face.
2186 @subsubsection occt_draw_4_4_14 vselmode
2190 vselmode [object] mode On/Off
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.
2202 vtriangle triangle1 p1 p2 p3
2205 @subsubsection occt_draw_4_4_15 vconnect, vconnectsh
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
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.
2221 vsegment segment p1 p2
2222 restore CrankArm.brep obj
2224 vconnectsh new obj 100100100 1 0 0 0 0 1
2227 @subsubsection occt_draw_4_4_16 vtriangle
2231 vtriangle name PointName PointName PointName
2234 Creates and displays a filled triangle from named points.
2242 vtriangle triangle1 p1 p2 p3
2245 @subsubsection occt_draw_4_4_17 vsegment
2249 vsegment name PointName PointName
2252 Creates and displays a segment from named points.
2259 vsegment segment p1 p2
2262 @subsubsection occt_draw_4_4_18 vpointcloud
2266 vpointcloud name shape
2269 Creates an interactive object for an arbitary set of points from the triangulated shape.
2272 vpointcloud name x y z r npts {surface|volume}
2274 Creates an arbitrary set of points (npts) randomly distributed on a spheric surface or within a spheric volume (x y z r).
2279 vpointcloud pc 0 0 0 100 100000 surface -randColor
2283 @subsubsection occt_draw_4_4_19 vclipplane
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.
2304 Manages clipping planes
2309 vclipplane create pln1
2310 vclipplane change pln1 equation 1 0 0 -0.1
2311 vclipplane set pln1 view Driver1/Viewer1/View1
2320 @subsubsection occt_draw_4_4_20 vdimension
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]
2334 Builds angle, length, radius or diameter dimension interactive object **name**.
2336 **Attension:** length dimension can't be built without working plane.
2342 vdimension dim1 -length -plane xoy -shapes p1 p2
2345 vdimension dim2 -angle -shapes p1 p2 p3
2347 vcircle circle p1 p2 p3 0
2348 vdimension dim3 -radius -shapes circle
2352 @subsubsection occt_draw_4_4_21 vdimparam
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]
2369 Sets parameters for angle, length, radius and diameter dimension **name**.
2375 vdimension dim1 -length -plane xoy -shapes p1 p2
2376 vdimparam dim1 -flyout -15 -arrowlength 4 -showunits -value 10
2379 @subsubsection occt_draw_4_4_22 vmovedim
2383 vmovedim [name] [x y z]
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
2395 vdimension dim1 -length -plane xoy -shapes p1 p2
2396 vmovedim dim1 -10 30 0
2400 @subsection occt_draw_4_5 AIS viewer – Mesh Visualization Service
2402 **MeshVS** (Mesh Visualization Service) component provides flexible means of displaying meshes with associated pre- and post- processor data.
2404 @subsubsection occt_draw_4_5_1 meshfromstl
2408 meshfromstl meshname file
2411 Creates a *MeshVS_Mesh* object based on STL file data. The object will be displayed immediately.
2415 meshfromstl mesh myfile.stl
2418 @subsubsection occt_draw_4_5_2 meshdispmode
2422 meshdispmode meshname displaymode
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.
2433 meshfromstl mesh myfile.stl
2437 @subsubsection occt_draw_4_5_3 meshselmode
2441 meshselmode meshname selectionmode
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);
2453 meshfromstl mesh myfile.stl
2457 @subsubsection occt_draw_4_5_4 meshshadcolor
2461 meshshadcolor meshname red green blue
2464 Changes the face interior color of object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*.
2469 meshfromstl mesh myfile.stl
2470 meshshadcolormode mesh 0.5 0.5 0.5
2473 @subsubsection occt_draw_4_5_5 meshlinkcolor
2477 meshlinkcolor meshname red green blue
2480 Changes the color of face borders for object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*.
2485 meshfromstl mesh myfile.stl
2486 meshlinkcolormode mesh 0.5 0.5 0.5
2489 @subsubsection occt_draw_4_5_6 meshmat
2493 meshmat meshname material
2496 Changes the material of object **meshname**.
2498 *material* is represented with an integer value as follows (equivalent to enumeration *Graphic3d_NameOfMaterial*):
2509 * *10 - SHINY_PLASTIC,*
2519 * *20 - UserDefined*
2524 meshfromstl mesh myfile.stl
2528 @subsubsection occt_draw_4_5_7 meshshrcoef
2532 meshshrcoef meshname shrinkcoefficient
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.
2540 meshfromstl mesh myfile.stl
2541 meshshrcoef mesh 0.05
2544 @subsubsection occt_draw_4_5_8 meshshow
2551 Displays **meshname** in the viewer (if it is erased).
2556 meshfromstl mesh myfile.stl
2560 @subsubsection occt_draw_4_5_9 meshhide
2567 Hides **meshname** in the viewer.
2572 meshfromstl mesh myfile.stl
2576 @subsubsection occt_draw_4_5_10 meshhidesel
2580 meshhidesel meshname
2583 Hides only selected entities. The other part of **meshname** remains visible.
2585 @subsubsection occt_draw_4_5_11 meshshowsel
2589 meshshowsel meshname
2592 Shows only selected entities. The other part of **meshname** becomes invisible.
2594 @subsubsection occt_draw_4_5_12 meshshowall
2598 meshshowall meshname
2601 Changes the state of all entities to visible for **meshname**.
2603 @subsubsection occt_draw_4_5_13 meshdelete
2610 Deletes MeshVS_Mesh object **meshname**.
2615 meshfromstl mesh myfile.stl
2619 @subsection occt_draw_4_6 VIS Viewer commands
2621 A specific plugin with alias *VIS* should be loaded to have access to VIS functionality in DRAW Test Harness:
2627 @subsubsection occt_draw_4_6_1 ivtkinit
2634 Creates a window for VTK viewer.
2636 @figure{/user_guides/draw_test_harness/images/draw_image001.png}
2638 @subsection occt_draw_4_6_2 ivtkdisplay
2642 ivtkdisplay name1 [name2] …[name n]
2645 Displays named objects.
2655 @figure{/user_guides/draw_test_harness/images/draw_image002.png}
2657 @subsection occt_draw_4_6_3 ivtkerase
2661 ivtkerase [name1] [name2] … [name n]
2664 Erases named objects. If no arguments are passed, erases all displayed objects.
2677 # erase only the cylinder
2679 # erase the sphere and the cone
2683 @subsection occt_draw_4_6_4 ivtkfit
2690 Automatic zoom/panning.
2692 @subsection occt_draw_4_6_5 ivtkdispmode
2696 ivtksetdispmode [name] {0|1}
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).
2709 # set shading mode for the cone
2713 @figure{/user_guides/draw_test_harness/images/draw_image003.png}
2715 @subsection occt_draw_4_6_6 ivtksetselmode
2719 ivtksetselmode [name] mode {0|1}
2722 Sets selection mode for a named object. If no arguments are passed, sets the given selection mode for all the displayed objects.
2727 # load a shape from file
2728 restore CrankArm.brep a
2729 # display the loaded shape
2731 # set the face selection mode
2732 ivtksetselmode a 4 1
2735 @figure{/user_guides/draw_test_harness/images/draw_image004.png}
2737 @subsection occt_draw_4_6_7 ivtkmoveto
2744 Imitates mouse cursor moving to point with the given display coordinates **x**,**y**.
2754 @subsection occt_draw_4_6_8 ivtkselect
2761 Imitates mouse cursor moving to point with the given display coordinates and performs selection at this point.
2771 @subsection occt_draw_4_6_9 ivtkdump
2775 ivtkdump *filename* [buffer={rgb|rgba|depth}] [width height] [stereoproj={L|R}]
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).
2789 ivtkdump D:/ConeSnapshot.png rgb 768 768
2792 @subsection occt_draw_4_6_10 ivtkbgcolor
2797 ivtkbgcolor r g b [r2 g2 b2]
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].
2805 ivtkbgcolor 200 220 250
2808 @figure{/user_guides/draw_test_harness/images/draw_image005.png}
2811 ivtkbgcolor 10 30 80 255 255 255
2814 @figure{/user_guides/draw_test_harness/images/draw_image006.png}
2817 @section occt_draw_5 OCAF commands
2820 This chapter contains a set of commands for Open CASCADE Technology Application Framework (OCAF).
2823 @subsection occt_draw_5_1 Application commands
2826 @subsubsection occt_draw_5_1_1 NewDocument
2830 NewDocument docname [format]
2833 Creates a new **docname** document with MDTV-Standard or described format.
2837 # Create new document with default (MDTV-Standard) format
2840 # Create new document with BinOcaf format
2841 NewDocument D2 BinOcaf
2844 @subsubsection occt_draw_5_1_2 IsInSession
2851 Returns *0*, if **path** document is managed by the application session, *1* – otherwise.
2855 IsInSession /myPath/myFile.std
2858 @subsubsection occt_draw_5_1_3 ListDocuments
2865 Makes a list of documents handled during the session of the application.
2868 @subsubsection occt_draw_5_1_4 Open
2875 Retrieves the document of file **docname** in the path **path**. Overwrites the document, if it is already in session.
2879 Open /myPath/myFile.std D
2882 @subsubsection occt_draw_5_1_5 Close
2889 Closes **docname** document. The document is no longer handled by the applicative session.
2896 @subsubsection occt_draw_5_1_6 Save
2903 Saves **docname** active document.
2910 @subsubsection occt_draw_5_1_7 SaveAs
2917 Saves the active document in the file **docname** in the path **path**. Overwrites the file if it already exists.
2921 SaveAs D /myPath/myFile.std
2924 @subsection occt_draw_5_2 Basic commands
2926 @subsubsection occt_draw_5_2_1 Label
2934 Creates the label expressed by <i>\<entry\></i> if it does not exist.
2941 @subsubsection occt_draw_5_2_2 NewChild
2946 NewChild docname [taggerlabel = Root label]
2948 Finds (or creates) a *TagSource* attribute located at father label of <i>\<taggerlabel\></i> and makes a new child label.
2952 # Create new child of root label
2955 # Create new child of existing label
2960 @subsubsection occt_draw_5_2_3 Children
2964 Children docname label
2966 Returns the list of attributes of label.
2973 @subsubsection occt_draw_5_2_4 ForgetAll
2977 ForgetAll docname label
2979 Forgets all attributes of the label.
2987 @subsubsection occt_draw_5_3 Application commands
2989 @subsubsection occt_draw_5_3_1 Main
2996 Returns the main label of the framework.
3003 @subsubsection occt_draw_5_3_2 UndoLimit
3007 UndoLimit docname [value=0]
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
3018 @subsubsection occt_draw_5_3_3 Undo
3022 Undo docname [value=1]
3025 Undoes **value** steps.
3032 @subsubsection occt_draw_5_3_4 Redo
3036 Redo docname [value=1]
3039 Redoes **value** steps.
3046 @subsubsection occt_draw_5_3_5 OpenCommand
3053 Opens a new command transaction.
3060 @subsubsection occt_draw_5_3_6 CommitCommand
3064 CommitCommand docname
3067 Commits the Command transaction.
3074 @subsubsection occt_draw_5_3_7 NewCommand
3081 This is a short-cut for Commit and Open transaction.
3088 @subsubsection occt_draw_5_3_8 AbortCommand
3092 AbortCommand docname
3095 Aborts the Command transaction.
3102 @subsubsection occt_draw_5_3_9 Copy
3106 Copy docname entry Xdocname Xentry
3109 Copies the contents of *entry* to *Xentry*. No links are registered.
3116 @subsubsection occt_draw_5_3_10 UpdateLink
3120 UpdateLink docname [entry]
3123 Updates external reference set at *entry*.
3130 @subsubsection occt_draw_5_3_11 CopyWithLink
3134 CopyWithLink docname entry Xdocname Xentry
3137 Aborts the Command transaction.
3138 Copies the content of *entry* to *Xentry*. The link is registered with an *Xlink* attribute at *Xentry* label.
3142 CopyWithLink D1 0:2 D2 0:4
3145 @subsubsection occt_draw_5_3_12 UpdateXLinks
3149 UpdateXLinks docname entry
3152 Sets modifications on labels impacted by external references to the *entry*. The *document* becomes invalid and must be recomputed
3159 @subsubsection occt_draw_5_3_13 DumpDocument
3163 DumpDocument docname
3166 Displays parameters of *docname* document.
3174 @subsection occt_draw_5_4 Data Framework commands
3177 @subsubsection occt_draw_5_4_1 MakeDF
3184 Creates a new data framework.
3191 @subsubsection occt_draw_5_4_2 ClearDF
3198 Clears a data framework.
3205 @subsubsection occt_draw_5_4_3 CopyDF
3209 CopyDF dfname1 entry1 [dfname2] entry2
3212 Copies a data framework.
3219 @subsubsection occt_draw_5_4_4 CopyLabel
3223 CopyLabel dfname fromlabel tolablel
3230 CopyLabel D1 0:2 0:4
3233 @subsubsection occt_draw_5_4_5 MiniDumpDF
3240 Makes a mini-dump of a data framework.
3247 @subsubsection occt_draw_5_4_6 XDumpDF
3254 Makes an extended dump of a data framework.
3261 @subsection occt_draw_5_5 General attributes commands
3264 @subsubsection occt_draw_5_5_1 SetInteger
3268 SetInteger dfname entry value
3271 Finds or creates an Integer attribute at *entry* label and sets *value*.
3275 SetInteger D 0:2 100
3278 @subsubsection occt_draw_5_5_2 GetInteger
3282 GetInteger dfname entry [drawname]
3285 Gets a value of an Integer attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3289 GetInteger D 0:2 Int1
3292 @subsubsection occt_draw_5_5_3 SetReal
3296 SetReal dfname entry value
3299 Finds or creates a Real attribute at *entry* label and sets *value*.
3306 @subsubsection occt_draw_5_5_4 GetReal
3310 GetReal dfname entry [drawname]
3313 Gets a value of a Real attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3320 @subsubsection occt_draw_5_5_5 SetIntArray
3324 SetIntArray dfname entry lower upper value1 value2 …
3327 Finds or creates an IntegerArray attribute at *entry* label with lower and upper bounds and sets **value1*, *value2*...
3331 SetIntArray D 0:2 1 4 100 200 300 400
3334 @subsubsection occt_draw_5_5_6 GetIntArray
3338 GetIntArray dfname entry
3341 Gets a value of an *IntegerArray* attribute at *entry* label.
3348 @subsubsection occt_draw_5_5_7 SetRealArray
3352 SetRealArray dfname entry lower upper value1 value2 …
3355 Finds or creates a RealArray attribute at *entry* label with lower and upper bounds and sets *value1*, *value2*…
3359 GetRealArray D 0:2 1 4 100. 200. 300. 400.
3362 @subsubsection occt_draw_5_5_8 GetRealArray
3366 GetRealArray dfname entry
3369 Gets a value of a RealArray attribute at *entry* label.
3376 @subsubsection occt_draw_5_5_9 SetComment
3380 SetComment dfname entry value
3383 Finds or creates a Comment attribute at *entry* label and sets *value*.
3387 SetComment D 0:2 "My comment"
3390 @subsubsection occt_draw_5_5_10 GetComment
3394 GetComment dfname entry
3397 Gets a value of a Comment attribute at *entry* label.
3404 @subsubsection occt_draw_5_5_11 SetExtStringArray
3408 SetExtStringArray dfname entry lower upper value1 value2 …
3411 Finds or creates an *ExtStringArray* attribute at *entry* label with lower and upper bounds and sets *value1*, *value2*…
3415 SetExtStringArray D 0:2 1 3 *string1* *string2* *string3*
3418 @subsubsection occt_draw_5_5_12 GetExtStringArray
3422 GetExtStringArray dfname entry
3425 Gets a value of an ExtStringArray attribute at *entry* label.
3429 GetExtStringArray D 0:2
3432 @subsubsection occt_draw_5_5_13 SetName
3436 SetName dfname entry value
3439 Finds or creates a Name attribute at *entry* label and sets *value*.
3443 SetName D 0:2 *My name*
3446 @subsubsection occt_draw_5_5_14 GetName
3450 GetName dfname entry
3453 Gets a value of a Name attribute at *entry* label.
3460 @subsubsection occt_draw_5_5_15 SetReference
3464 SetReference dfname entry reference
3467 Creates a Reference attribute at *entry* label and sets *reference*.
3471 SetReference D 0:2 0:4
3474 @subsubsection occt_draw_5_5_16 GetReference
3478 GetReference dfname entry
3481 Gets a value of a Reference attribute at *entry* label.
3488 @subsubsection occt_draw_5_5_17 SetUAttribute
3492 SetUAttribute dfname entry localGUID
3495 Creates a UAttribute attribute at *entry* label with *localGUID*.
3499 set localGUID "c73bd076-22ee-11d2-acde-080009dc4422"
3500 SetUAttribute D 0:2 ${localGUID}
3503 @subsubsection occt_draw_5_5_18 GetUAttribute
3507 GetUAttribute dfname entry loacalGUID
3510 Finds a *UAttribute* at *entry* label with *localGUID*.
3514 set localGUID "c73bd076-22ee-11d2-acde-080009dc4422"
3515 GetUAttribute D 0:2 ${localGUID}
3518 @subsubsection occt_draw_5_5_19 SetFunction
3522 SetFunction dfname entry ID failure
3525 Finds or creates a *Function* attribute at *entry* label with driver ID and *failure* index.
3529 set ID "c73bd076-22ee-11d2-acde-080009dc4422"
3530 SetFunction D 0:2 ${ID} 1
3533 @subsubsection occt_draw_5_5_20 GetFunction
3537 GetFunction dfname entry ID failure
3540 Finds a Function attribute at *entry* label and sets driver ID to *ID* variable and failure index to *failure* variable.
3544 GetFunction D 0:2 ID failure
3547 @subsubsection occt_draw_5_5_21 NewShape
3551 NewShape dfname entry [shape]
3554 Finds or creates a Shape attribute at *entry* label. Creates or updates the associated *NamedShape* attribute by *shape* if *shape* is defined.
3562 @subsubsection occt_draw_5_5_22 SetShape
3566 SetShape dfname entry shape
3569 Creates or updates a *NamedShape* attribute at *entry* label by *shape*.
3577 @subsubsection occt_draw_5_5_23 GetShape
3581 GetShape2 dfname entry shape
3584 Sets a shape from NamedShape attribute associated with *entry* label to *shape* draw variable.
3591 @subsection occt_draw_5_6 Geometric attributes commands
3594 @subsubsection occt_draw_5_6_1 SetPoint
3598 SetPoint dfname entry point
3601 Finds or creates a Point attribute at *entry* label and sets *point* as generated in the associated *NamedShape* attribute.
3609 @subsubsection occt_draw_5_6_2 GetPoint
3613 GetPoint dfname entry [drawname]
3616 Gets a vertex from *NamedShape* attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3623 @subsubsection occt_draw_5_6_3 SetAxis
3627 SetAxis dfname entry axis
3630 Finds or creates an Axis attribute at *entry* label and sets *axis* as generated in the associated *NamedShape* attribute.
3634 line l 10 20 30 100 200 300
3638 @subsubsection occt_draw_5_6_4 GetAxis
3642 GetAxis dfname entry [drawname]
3645 Gets a line from *NamedShape* attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3652 @subsubsection occt_draw_5_6_5 SetPlane
3656 SetPlane dfname entry plane
3659 Finds or creates a Plane attribute at *entry* label and sets *plane* as generated in the associated *NamedShape* attribute.
3663 plane pl 10 20 30 –1 0 0
3667 @subsubsection occt_draw_5_6_6 GetPlane
3671 GetPlane dfname entry [drawname]
3674 Gets a plane from *NamedShape* attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3681 @subsubsection occt_draw_5_6_7 SetGeometry
3685 SetGeometry dfname entry [type] [shape]
3688 Creates a Geometry attribute at *entry* label and sets *type* and *shape* as generated in the associated *NamedShape* attribute if they are defined. *type* must be one of the following: *any, pnt, lin, cir, ell, spl, pln, cyl*.
3693 SetGeometry D 0:2 pnt p
3696 @subsubsection occt_draw_5_6_8 GetGeometryType
3700 GetGeometryType dfname entry
3703 Gets a geometry type from Geometry attribute at *entry* label.
3707 GetGeometryType D 0:2
3710 @subsubsection occt_draw_5_6_9 SetConstraint
3714 SetConstraint dfname entry keyword geometrie [geometrie …]
3715 SetConstraint dfname entry "plane" geometrie
3716 SetConstraint dfname entry "value" value
3719 1. Creates a Constraint attribute at *entry* label and sets *keyword* constraint between geometry(ies).
3720 *keyword* must be one of the following:
3721 *rad, dia, minr, majr, tan, par, perp, concentric, equal, dist, angle, eqrad, symm, midp, eqdist, fix, rigid,* or *from, axis, mate, alignf, aligna, axesa, facesa, round, offset*
3722 2. Sets plane for the existing constraint.
3723 3. Sets value for the existing constraint.
3727 SetConstraint D 0:2 "value" 5
3730 @subsubsection occt_draw_5_6_10 GetConstraint
3734 GetConstraint dfname entry
3737 Dumps a Constraint attribute at *entry* label
3744 @subsubsection occt_draw_5_6_11 SetVariable
3748 SetVariable dfname entry isconstant(0/1) units
3751 Creates a Variable attribute at *entry* label and sets *isconstant* flag and *units* as a string.
3755 SetVariable D 0:2 1 "mm"
3758 @subsubsection occt_draw_5_6_12 GetVariable
3762 GetVariable dfname entry isconstant units
3765 Gets an *isconstant* flag and units of a Variable attribute at *entry* label.
3769 GetVariable D 0:2 isconstant units
3770 puts "IsConstant=${isconstant}"
3771 puts "Units=${units}"
3774 @subsection occt_draw_5_7 Tree attributes commands
3777 @subsubsection occt_draw_5_7_1 RootNode
3781 RootNode dfname treenodeentry [ID]
3784 Returns the ultimate father of *TreeNode* attribute identified by its *treenodeentry* and its *ID* (or default ID, if *ID* is not defined).
3787 @subsubsection occt_draw_5_7_2 SetNode
3791 SetNode dfname treenodeentry [ID]
3794 Creates a *TreeNode* attribute on the *treenodeentry* label with its tree *ID* (or assigns a default ID, if the *ID* is not defined).
3797 @subsubsection occt_draw_5_7_3 AppendNode
3801 AppendNode dfname fatherentry childentry [fatherID]
3805 Inserts a *TreeNode* attribute with its tree *fatherID* (or default ID, if *fatherID* is not defined) on *childentry* as last child of *fatherentry*.
3810 @subsubsection occt_draw_5_7_4 PrependNode
3814 PrependNode dfname fatherentry childentry [fatherID]
3818 Inserts a *TreeNode* attribute with its tree *fatherID* (or default ID, if *fatherID* is not defined) on *childentry* as first child of *fatherentry*.
3821 @subsubsection occt_draw_5_7_5 InsertNodeBefore
3825 InsertNodeBefore dfname treenodeentry beforetreenode [ID]
3828 Inserts a *TreeNode* attribute with tree *ID* (or default ID, if *ID* is not defined) *beforetreenode* before *treenodeentry*.
3831 @subsubsection occt_draw_5_7_6 InsertNodeAfter
3835 InsertNodeAfter dfname treenodeentry aftertreenode [ID]
3838 Inserts a *TreeNode* attribute with tree *ID* (or default ID, if *ID* is not defined) *aftertreenode* after *treenodeentry*.
3841 @subsubsection occt_draw_5_7_7 DetachNode
3845 DetachNode dfname treenodeentry [ID]
3848 Removes a *TreeNode* attribute with tree *ID* (or default ID, if *ID* is not defined) from *treenodeentry*.
3851 @subsubsection occt_draw_5_7_8 ChildNodeIterate
3855 ChildNodeIterate dfname treenodeentry alllevels(0/1) [ID]
3859 Iterates on the tree of *TreeNode* attributes with tree *ID* (or default ID, if *ID* is not defined). If *alllevels* is set to *1* it explores not only the first, but all the sub Step levels.
3875 AppendNode D 0:2 0:4
3876 AppendNode D 0:2 0:5
3877 PrependNode D 0:4 0:3
3878 PrependNode D 0:4 0:8
3879 PrependNode D 0:4 0:9
3881 InsertNodeBefore D 0:5 0:6
3882 InsertNodeAfter D 0:4 0:7
3888 ChildNodeIterate D 0:2 1
3898 # List only first levels
3899 ChildNodeIterate D 0:2 1
3907 @subsubsection occt_draw_5_7_9 InitChildNodeIterator
3911 InitChildNodeIterator dfname treenodeentry alllevels(0/1) [ID]
3915 Initializes the iteration on the tree of *TreeNode* attributes with tree *ID* (or default ID, if *ID* is not defined). If *alllevels* is set to *1* it explores not only the first, but also all sub Step levels.
3919 InitChildNodeIterate D 0:5 1
3921 for {set i 1} {$i 100} {incr i} {
3922 if {[ChildNodeMore] == *TRUE*} {
3923 puts *Tree node = [ChildNodeValue]*
3928 puts "aChildNumber=$aChildNumber"
3931 @subsubsection occt_draw_5_7_10 ChildNodeMore
3938 Returns TRUE if there is a current item in the iteration.
3941 @subsubsection occt_draw_5_7_11 ChildNodeNext
3948 Moves to the next Item.
3951 @subsubsection occt_draw_5_7_12 ChildNodeValue
3958 Returns the current treenode of *ChildNodeIterator*.
3961 @subsubsection occt_draw_5_7_13 ChildNodeNextBrother
3965 ChildNodeNextBrother
3968 Moves to the next *Brother*. If there is none, goes up. This method is interesting only with *allLevels* behavior.
3971 @subsection occt_draw_5_8 Standard presentation commands
3974 @subsubsection occt_draw_5_8_1 AISInitViewer
3978 AISInitViewer docname
3981 Creates and sets *AISViewer* attribute at root label, creates AIS viewer window.
3988 @subsubsection occt_draw_5_8_2 AISRepaint
3995 Updates the AIS viewer window.
4002 @subsubsection occt_draw_5_8_3 AISDisplay
4006 AISDisplay docname entry [not_update]
4009 Displays a presantation of *AISobject* from *entry* label in AIS viewer. If *not_update* is not defined then *AISobject* is recomputed and all visualization settings are applied.
4016 @subsubsection occt_draw_5_8_4 AISUpdate
4020 AISUpdate docname entry
4023 Recomputes a presentation of *AISobject* from *entry* label and applies the visualization setting in AIS viewer.
4030 @subsubsection occt_draw_5_8_5 AISErase
4034 AISErase docname entry
4037 Erases *AISobject* of *entry* label in AIS viewer.
4044 @subsubsection occt_draw_5_8_6 AISRemove
4048 AISRemove docname entry
4051 Erases *AISobject* of *entry* label in AIS viewer, then *AISobject* is removed from *AIS_InteractiveContext*.
4058 @subsubsection occt_draw_5_8_7 AISSet
4062 AISSet docname entry ID
4065 Creates *AISPresentation* attribute at *entry* label and sets as driver ID. ID must be one of the following: *A* (*axis*), *C* (*constraint*), *NS* (*namedshape*), *G* (*geometry*), *PL* (*plane*), *PT* (*point*).
4072 @subsubsection occt_draw_5_8_8 AISDriver
4076 AISDriver docname entry [ID]
4079 Returns DriverGUID stored in *AISPresentation* attribute of an *entry* label or sets a new one. ID must be one of the following: *A* (*axis*), *C* (*constraint*), *NS* (*namedshape*), *G* (*geometry*), *PL* (*plane*), *PT* (*point*).
4087 @subsubsection occt_draw_5_8_9 AISUnset
4091 AISUnset docname entry
4094 Deletes *AISPresentation* attribute (if it exists) of an *entry* label.
4101 @subsubsection occt_draw_5_8_10 AISTransparency
4105 AISTransparency docname entry [transparency]
4108 Sets (if *transparency* is defined) or gets the value of transparency for *AISPresentation* attribute of an *entry* label.
4112 AISTransparency D 0:5 0.5
4115 @subsubsection occt_draw_5_8_11 AISHasOwnTransparency
4119 AISHasOwnTransparency docname entry
4122 Tests *AISPresentation* attribute of an *entry* label by own transparency.
4126 AISHasOwnTransparency D 0:5
4129 @subsubsection occt_draw_5_8_12 AISMaterial
4133 AISMaterial docname entry [material]
4136 Sets (if *material* is defined) or gets the value of transparency for *AISPresentation* attribute of an *entry* label. *material* is integer from 0 to 20 (see <a href="#occt_draw_4_5_6">meshmat</a> command).
4143 @subsubsection occt_draw_5_8_13 AISHasOwnMaterial
4147 AISHasOwnMaterial docname entry
4150 Tests *AISPresentation* attribute of an *entry* label by own material.
4154 AISHasOwnMaterial D 0:5
4157 @subsubsection occt_draw_5_8_14 AISColor
4161 AISColor docname entry [color]
4164 Sets (if *color* is defined) or gets value of color for *AISPresentation* attribute of an *entry* label. *color* is integer from 0 to 516 (see color names in *vsetcolor*).
4171 @subsubsection occt_draw_5_8_15 AISHasOwnColor
4175 AISHasOwnColor docname entry
4178 Tests *AISPresentation* attribute of an *entry* label by own color.
4182 AISHasOwnColor D 0:5
4185 @section occt_draw_6 Geometry commands
4187 @subsection occt_draw_6_1 Overview
4189 Draw provides a set of commands to test geometry libraries. These commands are found in the TGEOMETRY executable, or in any Draw executable which includes *GeometryTest* commands.
4191 In the context of Geometry, Draw includes the following types of variable:
4194 * The 2d curve, which corresponds to *Curve* in *Geom2d*.
4195 * The 3d curve and surface, which correspond to *Curve* and *Surface* in <a href="user_guides__modeling_data.html#occt_modat_1">Geom package</a>.
4197 Draw geometric variables never share data; the *copy* command will always make a complete copy of the content of the variable.
4199 The following topics are covered in the nine sections of this chapter:
4201 * **Curve creation** deals with the various types of curves and how to create them.
4202 * **Surface creation** deals with the different types of surfaces and how to create them.
4203 * **Curve and surface modification** deals with the commands used to modify the definition of curves and surfaces, most of which concern modifications to bezier and bspline curves.
4204 * **Geometric transformations** covers translation, rotation, mirror image and point scaling transformations.
4205 * **Curve and Surface Analysis** deals with the commands used to compute points, derivatives and curvatures.
4206 * **Intersections** presents intersections of surfaces and curves.
4207 * **Approximations** deals with creating curves and surfaces from a set of points.
4208 * **Constraints** concerns construction of 2d circles and lines by constraints such as tangency.
4209 * **Display** describes commands to control the display of curves and surfaces.
4211 Where possible, the commands have been made broad in application, i.e. they apply to 2d curves, 3d curves and surfaces. For instance, the *circle* command may create a 2d or a 3d circle depending on the number of arguments given.
4213 Likewise, the *translate* command will process points, curves or surfaces, depending on argument type. You may not always find the specific command you are looking for in the section where you expect it to be. In that case, look in another section. The *trim* command, for example, is described in the surface section. It can, nonetheless, be used with curves as well.
4215 @subsection occt_draw_6_2 Curve creation
4217 This section deals with both points and curves. Types of curves are:
4219 * Analytical curves such as lines, circles, ellipses, parabolas, and hyperbolas.
4220 * Polar curves such as bezier curves and bspline curves.
4221 * Trimmed curves and offset curves made from other curves with the *trim* and *offset* commands. Because they are used on both curves and surfaces, the *trim* and *offset* commands are described in the *surface creation* section.
4222 * NURBS can be created from other curves using *convert* in the *Surface Creation* section.
4223 * Curves can be created from the isoparametric lines of surfaces by the *uiso* and *viso* commands.
4224 * 3d curves can be created from 2d curves and vice versa using the *to3d* and *to2d* commands. The *project* command computes a 2d curve on a 3d surface.
4226 Curves are displayed with an arrow showing the last parameter.
4229 @subsubsection occt_draw_6_2_1 point
4236 Creates a 2d or 3d point, depending on the number of arguments.
4247 @subsubsection occt_draw_6_2_2 line
4251 line name x y [z] dx dy [dz]
4255 Creates a 2d or 3d line. *x y z* are the coordinates of the line’s point of origin; *dx, dy, dz* give the direction vector.
4257 A 2d line will be represented as *x y dx dy*, and a 3d line as *x y z dx dy dz* . A line is parameterized along its length starting from the point of origin along the direction vector. The direction vector is normalized and must not be null. Lines are infinite, even though their representation is not.
4261 # a 2d line at 45 degrees of the X axis
4264 # a 3d line through the point 10 0 0 and parallel to Z
4268 @subsubsection occt_draw_6_2_3 circle
4272 circle name x y [z [dx dy dz]] [ux uy [uz]] radius
4275 Creates a 2d or a 3d circle.
4277 In 2d, *x, y* are the coordinates of the center and *ux, uy* define the vector towards the point of origin of the parameters. By default, this direction is (1,0). The X Axis of the local coordinate system defines the origin of the parameters of the circle. Use another vector than the x axis to change the origin of parameters.
4279 In 3d, *x, y, z* are the coordinates of the center; *dx, dy, dz* give the vector normal to the plane of the circle. By default, this vector is (0,0,1) i.e. the Z axis (it must not be null). *ux, uy, uz* is the direction of the origin; if not given, a default direction will be computed. This vector must neither be null nor parallel to *dx, dy, dz*.
4281 The circle is parameterized by the angle in [0,2*pi] starting from the origin and. Note that the specification of origin direction and plane is the same for all analytical curves and surfaces.
4285 # A 2d circle of radius 5 centered at 10,-2
4288 # another 2d circle with a user defined origin
4289 # the point of parameter 0 on this circle will be
4290 # 1+sqrt(2),1+sqrt(2)
4293 # a 3d circle, center 10 20 -5, axis Z, radius 17
4294 circle c3 10 20 -5 17
4296 # same 3d circle with axis Y
4297 circle c4 10 20 -5 0 1 0 17
4299 # full 3d circle, axis X, origin on Z
4300 circle c5 10 20 -5 1 0 0 0 0 1 17
4303 @subsubsection occt_draw_6_2_4 ellipse
4307 ellipse name x y [z [dx dy dz]] [ux uy [uz]] firstradius secondradius
4310 Creates a 2d or 3d ellipse. In a 2d ellipse, the first two arguments define the center; in a 3d ellipse, the first three. The axis system is given by *firstradius*, the major radius, and *secondradius*, the minor radius. The parameter range of the ellipse is [0,2.*pi] starting from the X axis and going towards the Y axis. The Draw ellipse is parameterized by an angle:
4313 P(u) = O + firstradius*cos(u)*Xdir + secondradius*sin(u)*Ydir
4317 * P is the point of parameter *u*,
4318 * *O, Xdir* and *Ydir* are respectively the origin, *X Direction* and *Y Direction* of its local coordinate system.
4322 # default 2d ellipse
4323 ellipse e1 10 5 20 10
4325 # 2d ellipse at angle 60 degree
4326 ellipse e2 0 0 1 2 30 5
4328 # 3d ellipse, in the XY plane
4329 ellipse e3 0 0 0 25 5
4331 # 3d ellipse in the X,Z plane with axis 1, 0 ,1
4332 ellipse e4 0 0 0 0 1 0 1 0 1 25 5
4335 @subsubsection occt_draw_6_2_5 hyperbola
4339 hyperbola name x y [z [dx dy dz]] [ux uy [uz]] firstradius secondradius
4342 Creates a 2d or 3d conic. The first arguments define the center. The axis system is given by *firstradius*, the major radius, and *secondradius*, the minor radius. Note that the hyperbola has only one branch, that in the X direction.
4344 The Draw hyperbola is parameterized as follows:
4346 P(U) = O + firstradius*Cosh(U)*XDir + secondradius*Sinh(U)*YDir
4350 * *P* is the point of parameter *U*,
4351 * *O, XDir* and *YDir* are respectively the origin, *X Direction* and *YDirection* of its local coordinate system.
4355 # default 2d hyperbola, with asymptotes 1,1 -1,1
4356 hyperbola h1 0 0 30 30
4358 # 2d hyperbola at angle 60 degrees
4359 hyperbola h2 0 0 1 2 20 20
4361 # 3d hyperbola, in the XY plane
4362 hyperbola h3 0 0 0 50 50
4365 @subsubsection occt_draw_6_2_6 parabola
4369 parabola name x y [z [dx dy dz]] [ux uy [uz]] FocalLength
4372 Creates a 2d or 3d parabola. in the axis system defined by the first arguments. The origin is the apex of the parabola.
4374 The *Geom_Parabola* is parameterized as follows:
4377 P(u) = O + u*u/(4.*F)*XDir + u*YDir
4381 * *P* is the point of parameter *u*,
4382 * *O, XDir* and *YDir* are respectively the origin, *X Direction* and *Y Direction* of its local coordinate system,
4383 * *F* is the focal length of the parabola.
4390 # 2d parabola with convexity +Y
4391 parabola p2 0 0 0 1 50
4393 # 3d parabola in the Y-Z plane, convexity +Z
4394 parabola p3 0 0 0 1 0 0 0 0 1 50
4397 @subsubsection occt_draw_6_2_7 beziercurve, 2dbeziercurve
4401 beziercurve name nbpole pole, [weight]
4402 2dbeziercurve name nbpole pole, [weight]
4405 Creates a 3d rational or non-rational Bezier curve. Give the number of poles (control points,) and the coordinates of the poles *(x1 y1 z1 [w1] x2 y2 z2 [w2])*. The degree will be *nbpoles-1*. To create a rational curve, give weights with the poles. You must give weights for all poles or for none. If the weights of all the poles are equal, the curve is polynomial, and therefore non-rational.
4409 # a rational 2d bezier curve (arc of circle)
4410 2dbeziercurve ci 3 0 0 1 10 0 sqrt(2.)/2. 10 10 1
4412 # a 3d bezier curve, not rational
4413 beziercurve cc 4 0 0 0 10 0 0 10 0 10 10 10 10
4416 @subsubsection occt_draw_6_2_8 bsplinecurve, 2dbsplinecurve, pbsplinecurve, 2dpbsplinecurve
4420 bsplinecurve name degree nbknots knot, umult pole, weight
4421 2dbsplinecurve name degree nbknots knot, umult pole, weight
4423 pbsplinecurve name degree nbknots knot, umult pole, weight (periodic)
4424 2dpbsplinecurve name degree nbknots knot, umult pole, weight (periodic)
4427 Creates 2d or 3d bspline curves; the **pbsplinecurve** and **2dpbsplinecurve** commands create periodic bspline curves.
4429 A bspline curve is defined by its degree, its periodic or non-periodic nature, a table of knots and a table of poles (i.e. control points). Consequently, specify the degree, the number of knots, and for each knot, the multiplicity, for each pole, the weight. In the syntax above, the commas link the adjacent arguments which they fall between: knot and multiplicities, pole and weight.
4431 The table of knots is an increasing sequence of reals without repetition.
4432 Multiplicities must be lower or equal to the degree of the curve. For non-periodic curves, the first and last multiplicities can be equal to degree+1. For a periodic curve, the first and last multiplicities must be equal.
4434 The poles must be given with their weights, use weights of 1 for a non rational curve, the number of poles must be:
4436 * For a non periodic curve: Sum of multiplicities - degree + 1
4437 * For a periodic curve: Sum of multiplicities - last multiplicity
4441 # a bspline curve with 4 poles and 3 knots
4442 bsplinecurve bc 2 3 0 3 1 1 2 3 \
4443 10 0 7 1 7 0 7 1 3 0 8 1 0 0 7 1
4444 # a 2d periodic circle (parameter from 0 to 2*pi !!)
4446 2dpbsplinecurve c 2 \
4447 4 0 2 pi/1.5 2 pi/0.75 2 2*pi 2 \
4457 **Note** that you can create the **NURBS** subset of bspline curves and surfaces by trimming analytical curves and surfaces and executing the command *convert*.
4460 @subsubsection occt_draw_6_2_9 uiso, viso
4468 Creates a U or V isoparametric curve from a surface.
4472 # create a cylinder and extract iso curves
4479 **Note** that this cannot be done from offset surfaces.
4482 @subsubsection occt_draw_6_2_10 to3d, to2d
4486 to3d name curve2d [plane]
4487 to2d name curve3d [plane]
4490 Create respectively a 3d curve from a 2d curve and a 2d curve from a 3d curve. The transformation uses a planar surface to define the XY plane in 3d (by default this plane is the default OXYplane). **to3d** always gives a correct result, but as **to2d** is not a projection, it may surprise you. It is always correct if the curve is planar and parallel to the plane of projection. The points defining the curve are projected on the plane. A circle, however, will remain a circle and will not be changed to an ellipse.
4494 # the following commands
4496 plane p -2 1 0 1 2 3
4499 # will create the same circle as
4500 circle c -2 1 0 1 2 3 5
4503 See also: **project**
4506 @subsubsection occt_draw_6_2_11 project
4510 project name curve3d surface
4513 Computes a 2d curve in the parametric space of a surface corresponding to a 3d curve. This can only be used on analytical surfaces.
4515 If we, for example, intersect a cylinder and a plane and project the resulting ellipse on the cylinder, this will create a 2d sinusoid-like bspline.
4524 @subsection occt_draw_6_3 Surface creation
4526 The following types of surfaces exist:
4527 * Analytical surfaces: plane, cylinder, cone, sphere, torus;
4528 * Polar surfaces: bezier surfaces, bspline surfaces;
4529 * Trimmed and Offset surfaces;
4530 * Surfaces produced by Revolution and Extrusion, created from curves with the *revsurf* and *extsurf*;
4533 Surfaces are displayed with isoparametric lines. To show the parameterization, a small parametric line with a length 1/10 of V is displayed at 1/10 of U.
4535 @subsubsection occt_draw_6_3_1 plane
4539 plane name [x y z [dx dy dz [ux uy uz]]]
4542 Creates an infinite plane.
4544 A plane is the same as a 3d coordinate system, *x,y,z* is the origin, *dx, dy, dz* is the Z direction and *ux, uy, uz* is the X direction.
4546 The plane is perpendicular to Z and X is the U parameter. *dx,dy,dz* and *ux,uy,uz* must not be null or collinear. *ux,uy,uz* will be modified to be orthogonal to *dx,dy,dz*.
4548 There are default values for the coordinate system. If no arguments are given, the global system (0,0,0), (0,0,1), (1,0,0). If only the origin is given, the axes are those given by default(0,0,1), (1,0,0). If the origin and the Z axis are given, the X axis is generated perpendicular to the Z axis.
4550 Note that this definition will be used for all analytical surfaces.
4554 # a plane through the point 10,0,0 perpendicular to X
4555 # with U direction on Y
4556 plane p1 10 0 0 1 0 0 0 1 0
4558 # an horixontal plane with origin 10, -20, -5
4562 @subsubsection occt_draw_6_3_2 cylinder
4566 cylinder name [x y z [dx dy dz [ux uy uz]]] radius
4569 A cylinder is defined by a coordinate system, and a radius. The surface generated is an infinite cylinder with the Z axis as the axis. The U parameter is the angle starting from X going in the Y direction.
4573 # a cylinder on the default Z axis, radius 10
4576 # a cylinder, also along the Z axis but with origin 5,
4578 cylinder c2 5 10 -3 10
4580 # a cylinder through the origin and on a diagonal
4581 # with longitude pi/3 and latitude pi/4 (euler angles)
4582 dset lo pi/3. la pi/4.
4583 cylinder c3 0 0 0 cos(la)*cos(lo) cos(la)*sin(lo)
4587 @subsubsection occt_draw_6_3_3 cone
4591 cone name [x y z [dx dy dz [ux uy uz]]] semi-angle radius
4593 Creates a cone in the infinite coordinate system along the Z-axis. The radius is that of the circle at the intersection of the cone and the XY plane. The semi-angle is the angle formed by the cone relative to the axis; it should be between –90 and 90. If the radius is 0, the vertex is the origin.
4597 # a cone at 45 degrees at the origin on Z
4600 # a cone on axis Z with radius r1 at z1 and r2 at z2
4601 cone c2 0 0 z1 180.*atan2(r2-r1,z2-z1)/pi r1
4604 @subsubsection occt_draw_6_3_4 sphere
4608 sphere name [x y z [dx dy dz [ux uy uz]]] radius
4611 Creates a sphere in the local coordinate system defined in the **plane** command. The sphere is centered at the origin.
4613 To parameterize the sphere, *u* is the angle from X to Y, between 0 and 2*pi. *v* is the angle in the half-circle at angle *u* in the plane containing the Z axis. *v* is between -pi/2 and pi/2. The poles are the points Z = +/- radius; their parameters are u,+/-pi/2 for any u in 0,2*pi.
4617 # a sphere at the origin
4619 # a sphere at 10 10 10, with poles on the axis 1,1,1
4620 sphere s2 10 10 10 1 1 1 10
4623 @subsubsection occt_draw_6_3_5 torus
4627 torus name [x y z [dx dy dz [ux uy uz]]] major minor
4630 Creates a torus in the local coordinate system with the given major and minor radii. *Z* is the axis for the major radius. The major radius may be lower in value than the minor radius.
4632 To parameterize a torus, *u* is the angle from X to Y; *v* is the angle in the plane at angle *u* from the XY plane to Z. *u* and *v* are in 0,2*pi.
4636 # a torus at the origin
4639 # a torus in another coordinate system
4640 torus t2 10 5 -2 2 1 0 20 5
4644 @subsubsection occt_draw_6_3_6 beziersurf
4648 beziersurf name nbupoles nbvolpes pole, [weight]
4651 Use this command to create a bezier surface, rational or non-rational. First give the numbers of poles in the u and v directions.
4653 Then give the poles in the following order: *pole(1, 1), pole(nbupoles, 1), pole(1, nbvpoles)* and *pole(nbupoles, nbvpoles)*.
4655 Weights may be omitted, but if you give one weight you must give all of them.
4659 # a non-rational degree 2,3 surface
4661 0 0 0 10 0 5 20 0 0 \
4662 0 10 2 10 10 3 20 10 2 \
4663 0 20 10 10 20 20 20 20 10 \
4664 0 30 0 10 30 0 20 30 0
4667 @subsubsection occt_draw_6_3_7 bsplinesurf, upbsplinesurf, vpbsplinesurf, uvpbsplinesurf
4671 bsplinesurf name udegree nbuknots uknot umult ... nbvknot vknot
4672 vmult ... x y z w ...
4678 * **bsplinesurf** generates bspline surfaces;
4679 * **upbsplinesurf** creates a bspline surface periodic in u;
4680 * **vpbsplinesurf** creates one periodic in v;
4681 * **uvpbsplinesurf** creates one periodic in uv.
4683 The syntax is similar to the *bsplinecurve* command. First give the degree in u and the knots in u with their multiplicities, then do the same in v. The poles follow. The number of poles is the product of the number in u and the number in v.
4685 See *bsplinecurve* to compute the number of poles, the poles are first given in U as in the *beziersurf* command. You must give weights if the surface is rational.
4689 # create a bspline surface of degree 1 2
4690 # with two knots in U and three in V
4695 0 10 2 1 10 10 3 1 \
4696 0 20 10 1 10 20 20 1 \
4701 @subsubsection occt_draw_6_3_8 trim, trimu, trimv
4705 trim newname name [u1 u2 [v1 v2]]
4710 The **trim** commands create trimmed curves or trimmed surfaces. Note that trimmed curves and surfaces are classes of the *Geom* package.
4711 * *trim* creates either a new trimmed curve from a curve or a new trimmed surface in u and v from a surface.
4712 * *trimu* creates a u-trimmed surface,
4713 * *trimv* creates a v-trimmed surface.
4715 After an initial trim, a second execution with no parameters given recreates the basis curve. The curves can be either 2d or 3d. If the trimming parameters decrease and if the curve or surface is not periodic, the direction is reversed.
4717 **Note** that a trimmed curve or surface contains a copy of the basis geometry: modifying that will not modify the trimmed geometry. Trimming trimmed geometry will not create multiple levels of trimming. The basis geometry will be used.
4721 # create a 3d circle
4724 # trim it, use the same variable, the original is
4728 # the original can be recovered!
4734 # the original is not the trimmed curve but the basis
4737 # as the circle is periodic, the two following commands
4742 # trim an infinite cylinder
4747 @subsubsection occt_draw_6_3_9 offset
4751 offset name basename distance [dx dy dz]
4754 Creates offset curves or surfaces at a given distance from a basis curve or surface. Offset curves and surfaces are classes from the *Geom *package.
4756 The curve can be a 2d or a 3d curve. To compute the offsets for a 3d curve, you must also give a vector *dx,dy,dz*. For a planar curve, this vector is usually the normal to the plane containing the curve.
4758 The offset curve or surface copies the basic geometry, which can be modified later.
4762 # graphic demonstration that the outline of a torus
4763 # is the offset of an ellipse
4766 torus t 0 0 0 0 cos(angle) sin(angle) 50 20
4768 ellipse e 0 0 0 50 50*sin(angle)
4769 # note that the distance can be negative
4770 offset l1 e 20 0 0 1
4773 @subsubsection occt_draw_6_3_10 revsurf
4777 revsurf name curvename x y z dx dy dz
4780 Creates a surface of revolution from a 3d curve.
4782 A surface of revolution or revolved surface is obtained by rotating a curve (called the *meridian*) through a complete revolution about an axis (referred to as the *axis of revolution*). The curve and the axis must be in the same plane (the *reference plane* of the surface). Give the point of origin x,y,z and the vector dx,dy,dz to define the axis of revolution.
4784 To parameterize a surface of revolution: u is the angle of rotation around the axis. Its origin is given by the position of the meridian on the surface. v is the parameter of the meridian.
4788 # another way of creating a torus like surface
4790 revsurf s c 0 0 0 0 1 0
4793 @subsubsection occt_draw_6_3*11 extsurf
4797 extsurf newname curvename dx dy dz
4800 Creates a surface of linear extrusion from a 3d curve. The basis curve is swept in a given direction,the *direction of extrusion* defined by a vector.
4802 In the syntax, *dx,dy,dz* gives the direction of extrusion.
4804 To parameterize a surface of extrusion: *u* is the parameter along the extruded curve; the *v* parameter is along the direction of extrusion.
4808 # an elliptic cylinder
4809 ellipse e 0 0 0 10 5
4815 @subsubsection occt_draw_6_3_12 convert
4819 convert newname name
4822 Creates a 2d or 3d NURBS curve or a NURBS surface from any 2d curve, 3d curve or surface. In other words, conics, beziers and bsplines are turned into NURBS. Offsets are not processed.
4826 # turn a 2d arc of a circle into a 2d NURBS
4831 # an easy way to make a planar bspline surface
4837 **Note** that offset curves and surfaces are not processed by this command.
4839 @subsection occt_draw_6_4 Curve and surface modifications
4841 Draw provides commands to modify curves and surfaces, some of them are general, others restricted to bezier curves or bsplines.
4843 General modifications:
4845 * Reversing the parametrization: **reverse**, **ureverse**, **vreverse**
4847 Modifications for both bezier curves and bsplines:
4849 * Exchanging U and V on a surface: **exchuv**
4850 * Segmentation: **segment**, **segsur**
4851 * Increasing the degree: **incdeg**, **incudeg**, **incvdeg**
4852 * Moving poles: **cmovep**, **movep**, **movecolp**, **moverowp**
4854 Modifications for bezier curves:
4856 * Adding and removing poles: **insertpole**, **rempole**, **remcolpole**, **remrowpole**
4858 Modifications for bspline:
4860 * Inserting and removing knots: **insertknot**, **remknot**, **insertuknot**, **remuknot**, **insetvknot**, **remvknot**
4861 * Modifying periodic curves and surfaces: **setperiodic**, **setnotperiodic**, **setorigin**, **setuperiodic**, **setunotperiodic**, **setuorigin**, **setvperiodic**, **setvnotperiodic**, **setvorigin**
4865 @subsubsection occt_draw_6_4_1 reverse, ureverse, vreverse
4871 ureverse surfacename
4872 vreverse surfacename
4875 The **reverse** command reverses the parameterization and inverses the orientation of a 2d or 3d curve. Note that the geometry is modified. To keep the curve or the surface, you must copy it before modification.
4877 **ureverse** or **vreverse** reverse the u or v parameter of a surface. Note that the new parameters of the curve may change according to the type of curve. For instance, they will change sign on a line or stay 0,1 on a bezier.
4879 Reversing a parameter on an analytical surface may create an indirect coordinate system.
4883 # reverse a trimmed 2d circle
4888 # dumping c will show that it is now trimmed between
4889 # 3*pi/2 and 7*pi/4 i.e. 2*pi-pi/2 and 2*pi-pi/4
4892 @subsubsection occt_draw_6_4_2 exchuv
4899 For a bezier or bspline surface this command exchanges the u and v parameters.
4903 # exchanging u and v on a spline (made from a cylinder)
4910 @subsubsection occt_draw_6_4_3 segment, segsur
4914 segment curve Ufirst Ulast
4915 segsur surface Ufirst Ulast Vfirst Vlast
4918 **segment** and **segsur** segment a bezier curve and a bspline curve or surface respectively.
4920 These commands modify the curve to restrict it between the new parameters: *Ufirst*, the starting point of the modified curve, and *Ulast*, the end point. *Ufirst* is less than *Ulast*.
4922 This command must not be confused with **trim** which creates a new geometry.
4926 # segment a bezier curve in half
4927 beziercurve c 3 0 0 0 10 0 0 10 10 0
4928 segment c ufirst ulast
4931 @subsubsection occt_draw_6_4_4 iincudeg, incvdeg
4935 incudeg surfacename newdegree
4936 incvdeg surfacename newdegree
4939 **incudeg** and **incvdeg** increase the degree in the U or V parameter of a bezier or bspline surface.
4943 # make a planar bspline and increase the degree to 2 3
4951 **Note** that the geometry is modified.
4954 @subsubsection occt_draw_6_4_5 cmovep, movep, movecolp, moverowp
4958 cmovep curve index dx dy [dz]
4959 movep surface uindex vindex dx dy dz
4960 movecolp surface uindex dx dy dz
4961 moverowp surface vindex dx dy dz
4964 **move** methods translate poles of a bezier curve, a bspline curve or a bspline surface.
4965 * **cmovep** and **movep** translate one pole with a given index.
4966 * **movecolp** and **moverowp** translate a whole column (expressed by the *uindex*) or row (expressed by the *vindex*) of poles.
4970 # start with a plane
4971 # transform to bspline, raise degree and add relief
4973 trim p p -10 10 -10 10
4982 @subsubsection occt_draw_6_4_6 insertpole, rempole, remcolpole, remrowpole
4986 insertpole curvename index x y [z] [weight]
4987 rempole curvename index
4988 remcolpole surfacename index
4989 remrowpole surfacename index
4992 **insertpole** inserts a new pole into a 2d or 3d bezier curve. You may add a weight for the pole. The default value for the weight is 1. The pole is added at the position after that of the index pole. Use an index 0 to insert the new pole before the first one already existing in your drawing.
4994 **rempole** removes a pole from a 2d or 3d bezier curve. Leave at least two poles in the curves.
4996 **remcolpole** and **remrowpole** remove a column or a row of poles from a bezier surface. A column is in the v direction and a row in the u direction The resulting degree must be at least 1; i.e there will be two rows and two columns left.
5000 # start with a segment, insert a pole at end
5001 # then remove the central pole
5002 beziercurve c 2 0 0 0 10 0 0
5003 insertpole c 2 10 10 0
5007 @subsubsection occt_draw_6_4_7 insertknot, insertuknot, insertvknot
5011 insertknot name knot [mult = 1] [knot mult ...]
5012 insertuknot surfacename knot mult
5013 insertvknot surfacename knot mult
5016 **insertknot** inserts knots in the knot sequence of a bspline curve. You must give a knot value and a target multiplicity. The default multiplicity is 1. If there is already a knot with the given value and a multiplicity lower than the target one, its multiplicity will be raised.
5018 **insertuknot** and **insertvknot** insert knots in a surface.
5022 # create a cylindrical surface and insert a knot
5024 trim c c 0 pi/2 0 10
5026 insertuknot c1 pi/4 1
5029 @subsubsection occt_draw_6_4_8 remknot, remuknot, remvknot
5033 remknot index [mult] [tol]
5034 remuknot index [mult] [tol]
5035 remvknot index [mult] [tol]
5038 **remknot** removes a knot from the knot sequence of a curve or a surface. Give the index of the knot and optionally, the target multiplicity. If the target multiplicity is not 0, the multiplicity of the knot will be lowered. As the curve may be modified, you are allowed to set a tolerance to control the process. If the tolerance is low, the knot will only be removed if the curve will not be modified.
5040 By default, if no tolerance is given, the knot will always be removed.
5044 # bspline circle, remove a knot
5051 **Note** that Curves or Surfaces may be modified.
5054 @subsubsection occt_draw_6_4_9 setperiodic, setnotperiodic, setuperiodic, setunotperiodic, setvperiodic, setvnotperiodic
5059 setnotperiodic curve
5060 setuperiodic surface
5061 setunotperiodic surface
5062 setvperiodic surface
5063 setvnotperiodic surface
5066 **setperiodic** turns a bspline curve into a periodic bspline curve; the knot vector stays the same and excess poles are truncated. The curve may be modified if it has not been closed. **setnotperiodic** removes the periodicity of a periodic curve. The pole table mau be modified. Note that knots are added at the beginning and the end of the knot vector and the multiplicities are knots set to degree+1 at the start and the end.
5068 **setuperiodic** and **setvperiodic** make the u or the v parameter of bspline surfaces periodic; **setunotperiodic**, and **setvnotperiodic** remove periodicity from the u or the v parameter of bspline surfaces.
5072 # a circle deperiodicized
5078 @subsubsection occt_draw_6_4_10 setorigin, setuorigin, setvorigin
5082 setorigin curvename index
5083 setuorigin surfacename index
5084 setuorigin surfacename index
5087 These commands change the origin of the parameters on periodic curves or surfaces. The new origin must be an existing knot. To set an origin other than an existing knot, you must first insert one with the *insertknot* command.
5091 # a torus with new U and V origins
5099 @subsection occt_draw_6_5 Transformations
5101 Draw provides commands to apply linear transformations to geometric objects: they include translation, rotation, mirroring and scaling.
5103 @subsubsection occt_draw_6_5_1 translate, dtranslate
5107 translate name [names ...] dx dy dz
5108 2dtranslate name [names ...] dx dy
5111 The **Translate** command translates 3d points, curves and surfaces along a vector *dx,dy,dz*. You can translate more than one object with the same command.
5113 For 2d points or curves, use the **2dtranslate** command.
5120 torus t 10 20 30 5 2
5121 translate p c t 0 0 15
5125 *Objects are modified by this command.*
5127 @subsubsection occt_draw_6_5_2 rotate, 2drotate
5131 rotate name [name ...] x y z dx dy dz angle
5132 2drotate name [name ...] x y angle
5135 The **rotate** command rotates a 3d point curve or surface. You must give an axis of rotation with a point *x,y,z*, a vector *dx,dy,dz* and an angle in degrees.
5137 For a 2d rotation, you need only give the center point and the angle. In 2d or 3d, the angle can be negative.
5141 # make a helix of circles. create a scripte file with
5142 this code and execute it using **source**.
5144 for {set i 1} {$i = 10} {incr i} {
5145 copy c[expr $i-1] c$i
5147 rotate c$i 0 0 0 0 0 1 36
5151 @subsubsection occt_draw_6_5_3 pmirror, lmirror, smirror, dpmirror, dlmirror
5155 pmirror name [names ...] x y z
5156 lmirror name [names ...] x y z dx dy dz
5157 smirror name [names ...] x y z dx dy dz
5158 2dpmirror name [names ...] x y
5159 2dlmirror name [names ...] x y dx dy
5162 The mirror commands perform a mirror transformation of 2d or 3d geometry.
5164 * **pmirror** is the point mirror, mirroring 3d curves and surfaces about a point of symmetry.
5165 * **lmirror** is the line mirror commamd, mirroring 3d curves and surfaces about an axis of symmetry.
5166 * **smirror** is the surface mirror, mirroring 3d curves and surfaces about a plane of symmetry. In the last case, the plane of symmetry is perpendicular to dx,dy,dz.
5167 * **2dpmirror** is the point mirror in 2D.
5168 * **2dlmirror** is the axis symmetry mirror in 2D.
5172 # build 3 images of a torus
5173 torus t 10 10 10 1 2 3 5 1
5177 lmirror t2 0 0 0 1 0 0
5179 smirror t3 0 0 0 1 0 0
5182 @subsubsection occt_draw_6_5_4 pscale, dpscale
5186 pscale name [name ...] x y z s
5187 2dpscale name [name ...] x y s
5190 The **pscale** and **2dpscale** commands transform an object by point scaling. You must give the center and the scaling factor. Because other scalings modify the type of the object, they are not provided. For example, a sphere may be transformed into an ellipsoid. Using a scaling factor of -1 is similar to using **pmirror**.
5195 # double the size of a sphere
5200 @subsection occt_draw_6_6 Curve and surface analysis
5202 **Draw** provides methods to compute information about curves and surfaces:
5204 * **coord** to find the coordinates of a point.
5205 * **cvalue** and **2dcvalue** to compute points and derivatives on curves.
5206 * **svalue** to compute points and derivatives on a surface.
5207 * **localprop** and **minmaxcurandif** to compute the curvature on a curve.
5208 * **parameters** to compute (u,v) values for a point on a surface.
5209 * **proj** and **2dproj** to project a point on a curve or a surface.
5210 * **surface_radius** to compute the curvature on a surface.
5212 @subsubsection occt_draw_6_6_1 coord
5219 Sets the x, y (and optionally z) coordinates of the point P.
5231 @subsubsection occt_draw_6_6_2 cvalue, 2dcvalue
5235 cvalue curve U x y z [d1x d1y d1z [d2x d2y d2z]]
5236 2dcvalue curve U x y [d1x d1y [d2x d2y]]
5239 For a curve at a given parameter, and depending on the number of arguments, **cvalue** computes the coordinates in *x,y,z*, the first derivative in *d1x,d1y,d1z* and the second derivative in *d2x,d2y,d2z*.
5243 Let on a bezier curve at parameter 0 the point is the first pole; the first derivative is the vector to the second pole multiplied by the degree; the second derivative is the difference first to the second pole, second to the third pole multipied by *degree-1* :
5246 2dbeziercurve c 4 0 0 1 1 2 1 3 0
5247 2dcvalue c 0 x y d1x d1y d2x d2y
5249 # values of x y d1x d1y d2x d2y
5253 @subsubsection occt_draw_6_6_3 svalue
5257 svalue surfname U v x y z [dux duy duz dvx dvy dvz [d2ux d2uy d2uz d2vx d2vy d2vz d2uvx d2uvy d2uvz]]
5260 Computes points and derivatives on a surface for a pair of parameter values. The result depends on the number of arguments. You can compute the first and the second derivatives.
5264 # display points on a sphere
5266 for {dset t 0} {[dval t] = 1} {dset t t+0.01} {
5267 svalue s t*2*pi t*pi-pi/2 x y z
5272 @subsubsection occt_draw_6_6_4 localprop, minmaxcurandinf
5276 localprop curvename U
5277 minmaxcurandinf curve
5280 **localprop** computes the curvature of a curve.
5281 **minmaxcurandinf** computes and prints the parameters of the points where the curvature is minimum and maximum on a 2d curve.
5285 # show curvature at the center of a bezier curve
5286 beziercurve c 3 0 0 0 10 2 0 20 0 0
5291 @subsubsection occt_draw_6_6_5 parameters
5295 parameters surf/curve x y z U [V]
5298 Returns the parameters on the surface of the 3d point *x,y,z* in variables *u* and *v*. This command may only be used on analytical surfaces: plane, cylinder, cone, sphere and torus.
5302 # Compute parameters on a plane
5303 plane p 0 0 10 1 1 0
5304 parameters p 5 5 5 u v
5305 # the values of u and v are : 0 5
5308 @subsubsection occt_draw_6_6_6 proj, dproj
5316 Use **proj** to project a point on a 3d curve or a surface and **2dproj** for a 2d curve.
5318 The command will compute and display all points in the projection. The lines joining the point to the projections are created with the names *ext_1, ext_2, ... *
5322 Let us project a point on a torus
5327 == ext_1 ext_2 ext_3 ext_4
5330 @subsubsection occt_draw_6_6_7 surface_radius
5334 surface_radius surface u v [c1 c2]
5337 Computes the main curvatures of a surface at parameters *(u,v)*. If there are extra arguments, their curvatures are stored in variables *c1* and *c2*.
5341 Let us compute curvatures of a cylinder:
5345 surface_radius c pi 3 c1 c2
5346 == Min Radius of Curvature : -5
5347 == Min Radius of Curvature : infinite
5351 @subsection occt_draw_6_7 Intersections
5353 * **intersect** computes intersections of surfaces;
5354 * **2dintersect** computes intersections of 2d curves.
5356 @subsubsection occt_draw_6_7_1 intersect
5360 intersect name surface1 surface2
5363 Intersects two surfaces; if there is one intersection curve it will be named *name*, if there are more than one they will be named *name_1*, *name_2*, ...
5369 plane p 0 0 40 0 1 5
5373 @subsubsection occt_draw_6_7_2 dintersect
5377 2dintersect curve1 curve2
5380 Displays the intersection points between two 2d curves.
5384 # intersect two 2d ellipses
5386 ellipse e2 0 0 0 1 5 2
5390 @subsection occt_draw_6_8 Approximations
5392 Draw provides command to create curves and surfaces by approximation.
5394 * **2dapprox** fits a curve through 2d points;
5395 * **appro** fits a curve through 3d points;
5396 * **surfapp** and **grilapp** fit a surface through 3d points;
5397 * **2dinterpolate** interpolates a curve.
5399 @subsubsection occt_draw_6_8_1 appro, dapprox
5403 appro result nbpoint [curve]
5404 2dapprox result nbpoint [curve / x1 y1 x2 y2]
5407 These commands fit a curve through a set of points. First give the number of points, then choose one of the three ways available to get the points. If you have no arguments, click on the points. If you have a curve argument or a list of points, the command launches computation of the points on the curve.
5411 Let us pick points and they will be fitted
5417 @subsubsection occt_draw_6_8_2 surfapp, grilapp
5422 surfapp name nbupoints nbvpoints x y z ....
5423 grilapp name nbupoints nbvpoints xo dx yo dy z11 z12 ...
5426 * **surfapp** fits a surface through an array of u and v points, nbupoints*nbvpoints.
5427 * **grilapp** has the same function, but the x,y coordinates of the points are on a grid starting at x0,y0 with steps dx,dy.
5431 # a surface using the same data as in the beziersurf
5434 0 0 0 10 0 5 20 0 0 \
5435 0 10 2 10 10 3 20 10 2 \
5436 0 20 10 10 20 20 20 20 10 \
5437 0 30 0 10 30 0 20 30 0
5440 @subsection occt_draw_6_9 Constraints
5442 * **cirtang** constructs 2d circles tangent to curves;
5443 * **lintan** constructs 2d lines tangent to curves.
5446 @subsubsection occt_draw_6_9_1 cirtang
5450 cirtang cname curve/point/radius curve/point/radius curve/point/radius
5453 Builds all circles satisfying the three constraints which are either a curve (the circle must be tangent to that curve), a point (the circle must pass through that point), or a radius for the circle. Only one constraint can be a radius. The solutions will be stored in variables *name_1*, *name_2*, etc.
5457 # a point, a line and a radius. 2 solutions
5464 @subsubsection occt_draw_6_9_2 lintan
5468 lintan name curve curve [angle]
5471 Builds all 2d lines tangent to two curves. If the third angle argument is given the second curve must be a line and **lintan** will build all lines tangent to the first curve and forming the given angle with the line. The angle is given in degrees. The solutions are named *name_1*, *name_2*, etc.
5475 # lines tangent to 2 circles, 4 solutions
5480 # lines at 15 degrees tangent to a circle and a line, 2
5481 solutions: l1_1 l1_2
5487 @subsection occt_draw_6_10 Display
5489 Draw provides commands to control the display of geometric objects. Some display parameters are used for all objects, others are valid for surfaces only, some for bezier and bspline only, and others for bspline only.
5491 On curves and surfaces, you can control the mode of representation with the **dmode** command. You can control the parameters for the mode with the **defle** command and the **discr** command, which control deflection and discretization respectively.
5493 On surfaces, you can control the number of isoparametric curves displayed on the surface with the **nbiso** command.
5495 On bezier and bspline curve and surface you can toggle the display of the control points with the **clpoles** and **shpoles** commands.
5497 On bspline curves and surfaces you can toggle the display of the knots with the **shknots** and **clknots** commands.
5500 @subsubsection occt_draw_6_10_1 dmod, discr, defle
5504 dmode name [name ...] u/d
5505 discr name [name ...] nbintervals
5506 defle name [name ...] deflection
5509 **dmod** command allows choosing the display mode for a curve or a surface.
5511 In mode *u*, or *uniform deflection*, the points are computed to keep the polygon at a distance lower than the deflection of the geometry. The deflection is set with the *defle* command. This mode involves intensive use of computational power.
5513 In *d*, or discretization mode, a fixed number of points is computed. This number is set with the *discr* command. This is the default mode. On a bspline, the fixed number of points is computed for each span of the curve. (A span is the interval between two knots).
5515 If the curve or the isolines seem to present too many angles, you can either increase the discretization or lower the deflection, depending on the mode. This will increase the number of points.
5519 # increment the number of points on a big circle
5527 @subsubsection occt_draw_6_10_2 nbiso
5531 nbiso name [names...] nuiso nviso
5534 Changes the number of isoparametric curves displayed on a surface in the U and V directions. On a bspline surface, isoparametric curves are displayed by default at knot values. Use *nbiso* to turn this feature off.
5538 Let us display 35 meridians and 15 parallels on a sphere:
5544 @subsubsection occt_draw_6_10_3 clpoles, shpoles
5552 On bezier and bspline curves and surfaces, the control polygon is displayed by default: *clpoles* erases it and *shpoles* restores it.
5556 Let us make a bezier curve and erase the poles
5559 beziercurve c 3 0 0 0 10 0 0 10 10 0
5563 @subsubsection occt_draw_6_10_4 clknots, shknots
5571 By default, knots on a bspline curve or surface are displayed with markers at the points with parametric value equal to the knots. *clknots* removes them and *shknots* restores them.
5575 # hide the knots on a bspline curve
5576 bsplinecurve bc 2 3 0 3 1 1 2 3 \
5577 10 0 7 1 7 0 7 1 3 0 8 1 0 0 7 1
5582 @section occt_draw_7 Topology commands
5584 Draw provides a set of commands to test OCCT Topology libraries. The Draw commands are found in the DRAWEXE executable or in any executable including the BRepTest commands.
5586 Topology defines the relationship between simple geometric entities, which can thus be linked together to represent complex shapes. The type of variable used by Topology in Draw is the shape variable.
5588 The <a href="user_guides__modeling_data.html#occt_modat_5">different topological shapes</a> include:
5590 * **COMPOUND**: A group of any type of topological object.
5591 * **COMPSOLID**: A set of solids connected by their faces. This expands the notions of WIRE and SHELL to solids.
5592 * **SOLID**: A part of space limited by shells. It is three dimensional.
5593 * **SHELL**: A set of faces connected by their edges. A shell can be open or closed.
5594 * **FACE**: In 2d, a plane; in 3d, part of a surface. Its geometry is constrained (trimmed) by contours. It is two dimensional.
5595 * **WIRE**: A set of edges connected by their vertices. It can be open or closed depending on whether the edges are linked or not.
5596 * **EDGE**: A topological element corresponding to a restrained curve. An edge is generally limited by vertices. It has one dimension.
5597 * **VERTEX**: A topological element corresponding to a point. It has a zero dimension.
5599 Shapes are usually shared. **copy** will create a new shape which shares its representation with the original. Nonetheless, two shapes sharing the same topology can be moved independently (see the section on **transformation**).
5601 The following topics are covered in the eight sections of this chapter:
5603 * Basic shape commands to handle the structure of shapes and control the display.
5604 * Curve and surface topology, or methods to create topology from geometry and vice versa.
5605 * Primitive construction commands: box, cylinder, wedge etc.
5606 * Sweeping of shapes.
5607 * Transformations of shapes: translation, copy, etc.
5608 * Topological operations, or booleans.
5609 * Drafting and blending.
5610 * Analysis of shapes.
5613 @subsection occt_draw_7_1 Basic topology
5615 The set of basic commands allows simple operations on shapes, or step-by-step construction of objects. These commands are useful for analysis of shape structure and include:
5617 * **isos** and **discretisation** to control display of shape faces by isoparametric curves .
5618 * **orientation**, **complement** and **invert** to modify topological attributes such as orientation.
5619 * **explode**, **exwire** and **nbshapes** to analyze the structure of a shape.
5620 * **emptycopy**, **add**, **compound** to create shapes by stepwise construction.
5622 In Draw, shapes are displayed using isoparametric curves. There is color coding for the edges:
5624 * a red edge is an isolated edge, which belongs to no faces.
5625 * a green edge is a free boundary edge, which belongs to one face,
5626 * a yellow edge is a shared edge, which belongs to at least two faces.
5629 @subsubsection occt_draw_7_1_1 isos, discretisation
5633 isos [name ...][nbisos]
5634 discretisation nbpoints
5637 Determines or changes the number of isoparametric curves on shapes.
5639 The same number is used for the u and v directions. With no arguments, *isos* prints the current default value. To determine, the number of isos for a shape, give it name as the first argument.
5641 *discretisation* changes the default number of points used to display the curves. The default value is 30.
5645 # Display only the edges (the wireframe)
5649 **Warning**: don’t confuse *isos* and *discretisation* with the geometric commands *nbisos* and *discr*.
5652 @subsubsection occt_draw_7_1_2 orientation, complement, invert, normals, range
5656 orientation name [name ...] F/R/E/I
5657 complement name [name ...]
5659 normals s (length = 10), disp normals
5660 range name value value
5663 * **orientation** assigns the orientation of shapes - simple and complex - to one of the following four values: *FORWARD, REVERSED, INTERNAL, EXTERNAL*.
5664 * **complement** changes the current orientation of shapes to its complement, *FORWARD - REVERSED, INTERNAL - EXTERNAL*.
5665 * **invert** creates a new shape which is a copy of the original with the orientation all subshapes reversed. For example, it may be useful to reverse the normals of a solid.
5666 * *normals** returns the assignment of colors to orientation values.
5667 * **range** defines the length of a selected edge by defining the values of a starting point and an end point.
5671 # to invert normals of a box
5677 # to assign a value to an edge
5679 # to define the box as edges
5681 b_1 b_2 b_3 b_4 b_5 b_6 b_7 b_8 b_9 b_10 b_11 b_12
5682 # to define as an edge
5684 # to define the length of the edge as starting from 0
5689 @subsubsection occt_draw_7_1_3 explode, exwire, nbshapes
5693 explode name [C/So/Sh/F/W/E/V]
5698 **explode** extracts subshapes from an entity. The subshapes will be named *name_1*, *name_2*, ... Note that they are not copied but shared with the original.
5700 With name only, **explode** will extract the first sublevel of shapes: the shells of a solid or the edges of a wire, for example. With one argument, **explode** will extract all subshapes of that type: *C* for compounds, *So* for solids, *Sh* for shells, *F* for faces, *W* for wires, *E* for edges, *V* for vertices.
5702 **exwire** is a special case of **explode** for wires, which extracts the edges in an ordered way, if possible. Each edge, for example, is connected to the following one by a vertex.
5704 **nbshapes** counts the number of shapes of each type in an entity.
5711 # whatis returns the type and various information
5713 = b is a shape SOLID FORWARD Free Modified
5718 = b_1 is a shape SHELL FORWARD Modified Orientable
5721 # extract the edges b_1, ... , b_12
5728 Number of shapes in b
5740 @subsubsection occt_draw_7_1_4 emptycopy, add, compound
5744 emptycopy [newname] name
5746 compound [name ...] compoundname
5749 **emptycopy** returns an empty shape with the same orientation, location, and geometry as the target shape, but with no sub-shapes. If the newname argument is not given, the new shape is stored with the same name. This command is used to modify a frozen shape. A frozen shape is a shape used by another one. To modify it, you must emptycopy it. Its subshape may be reinserted with the **add** command.
5751 **add** inserts shape *C* into shape *S*. Verify that *C* and *S* reference compatible types of objects:
5752 * Any *Shape* can be added to a *Compound*.
5753 * Only a *Solid* can be added to a *CompSolid*.
5754 * Only a *Shell* can *Edge* or a *Vertex* can be added into a *Solid*.
5755 * Only a *Face* can be added to a *Shell*.
5756 * Only a *Wire* and *Vertex* can be added in a *Solid*.
5757 * Only an *Edge* can be added to a *Wire*.
5758 * Only a *Vertex* can be added to an *Edge*.
5759 * Nothing can be added to a *Vertex*.
5761 **emptycopy** and **add** should be used with care.
5763 On the other hand, **compound** is a safe way to achieve a similar result. It creates a compound from shapes. If no shapes are given, the compound is empty.
5767 # a compound with three boxes
5774 @subsubsection occt_draw_7_1_5 checkshape
5778 checkshape [-top] shape [result] [-short]
5782 * *top* – optional parameter, which allows checking only topological validity of a shape.
5783 * *shape*– the only required parameter which represents the name of the shape to check.
5784 * *result* – optional parameter which is the prefix of the output shape names.
5785 * *short* – a short description of the check.
5787 **checkshape** examines the selected object for topological and geometric coherence. The object should be a three dimensional shape.
5791 # checkshape returns a comment valid or invalid
5794 # returns the comment
5795 this shape seems to be valid
5798 **Note** that this test is performed using the tolerance set in the algorithm.
5801 @subsection occt_draw_7_2 Curve and surface topology
5803 This group of commands is used to create topology from shapes and to extract shapes from geometry.
5805 * To create vertices, use the **vertex** command.
5806 * To create edges use, the **edge**, **mkedge** commands.
5807 * To create wires, use the **wire**, **polyline**, **polyvertex** commands.
5808 * To create faces, use the **mkplane**, **mkface** commands.
5809 * To extract the geometry from edges or faces, use the **mkcurve** and **mkface** commands.
5810 * To extract the 2d curves from edges or faces, use the **pcurve** command.
5813 @subsubsection occt_draw_7_2_1 vertex
5817 vertex name [x y z / p edge]
5820 Creates a vertex at either a 3d location x,y,z or the point at parameter p on an edge.
5827 @subsubsection occt_draw_7_2_2 edge, mkedge, uisoedge, visoedge
5831 edge name vertex1 vertex2
5832 mkedge edge curve [surface] [pfirst plast] [vfirst [pfirst] vlast [plast]]
5833 uisoedge edge face u v1 v2
5834 visoedge edge face v u1 u2
5837 * **edge** creates a straight line edge between two vertices.
5838 * **mkedge** generates edges from curves<.Two parameters can be given for the vertices: the first and last parameters of the curve are given by default. Vertices can also be given with their parameters, this option allows blocking the creation of new vertices. If the parameters of the vertices are not given, they are computed by projection on the curve. Instead of a 3d curve, a 2d curve and a surface can be given.
5842 # straight line edge
5847 # make a circular edge
5851 # A similar result may be achieved by trimming the curve
5852 # The trimming is removed by mkedge
5857 * **visoedge** and **uisoedge** are commands that generate a *uiso* parameter edge or a *viso* parameter edge.
5861 # to create an edge between v1 and v2 at point u
5862 # to create the example plane
5871 # to create the edge in the plane at the u axis point
5872 0.5, and between the v axis points v=0.2 and v =0.8
5873 uisoedge e p 0.5 0.20 0.8
5876 @subsubsection occt_draw_7_2_3 wire, polyline, polyvertex
5880 wire wirename e1/w1 [e2/w2 ...]
5881 polyline name x1 y1 z1 x2 y2 z2 ...
5882 polyvertex name v1 v2 ...
5885 **wire** creates a wire from edges or wires. The order of the elements should ensure that the wire is connected, and vertex locations will be compared to detect connection. If the vertices are different, new edges will be created to ensure topological connectivity. The original edge may be copied in the new one.
5887 **polyline** creates a polygonal wire from point coordinates. To make a closed wire, you should give the first point again at the end of the argument list.
5889 **polyvertex** creates a polygonal wire from vertices.
5893 # create two polygonal wires
5894 # glue them and define as a single wire
5895 polyline w1 0 0 0 10 0 0 10 10 0
5896 polyline w2 10 10 0 0 10 0 0 0 0
5900 @subsubsection occt_draw_7_2_4 profile
5904 profile name [code values] [code values] ...
5908 **profile** builds a profile in a plane using a moving point and direction. By default, the profile is closed and a face is created. The original point is 0 0, and direction is 1 0 situated in the XY plane.
5911 | **Code** | **Values ** | **Action** |
5912 | :------------ | :------------- | :---------------- |
5913 | O | X Y Z | Sets the origin of the plane |
5914 | P | DX DY DZ UX UY UZ | Sets the normal and X of the plane |
5915 | F | X Y | Sets the first point |
5916 | X | DX | Translates a point along X |
5917 | Y | DY | Translates a point along Y |
5918 | L | DL | Translates a point along direction |
5919 | XX | X | Sets point X coordinate |
5920 | YY | Y | Sets point Y coordinate |
5921 | T | DX DY | Translates a point |
5922 | TT | X Y | Sets a point |
5923 | R | Angle | Rotates direction |
5924 | RR | Angle | Sets direction |
5925 | D | DX DY | Sets direction |
5926 | IX | X | Intersects with vertical |
5927 | IY | Y | Intersects with horizontal |
5928 | C | Radius Angle | Arc of circle tangent to direction |
5931 Codes and values are used to define the next point or change the direction. When the profile changes from a straight line to a curve, a tangent is created. All angles are in degrees and can be negative.
5933 The point [code values] can be repeated any number of times and in any order to create the profile contour.
5937 | No suffix | Makes a closed face |
5938 | W | Make a closed wire |
5939 | WW | Make an open wire |
5941 The profile shape definition is the suffix; no suffix produces a face, *w* is a closed wire, *ww* is an open wire.
5943 Code letters are not case-sensitive.
5947 # to create a trianglular plane using a vertex at the
5948 origin, in the xy plane
5949 profile p O 0 0 0 X 1 Y 0 x 1 y 1
5954 # to create a contour using the different code
5957 # two vertices in the xy plane
5958 profile p F 1 0 x 2 y 1 ww
5960 # to view from a point normal to the plane
5963 # add a circular element of 45 degrees
5964 profile p F 1 0 x 2 y 1 c 1 45 ww
5966 # add a tangential segment with a length value 1
5967 profile p F 1 0 x 2 y 1 c 1 45 l 1 ww
5969 # add a vertex with xy values of 1.5 and 1.5
5970 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 ww
5972 # add a vertex with the x value 0.2, y value is constant
5973 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 xx 0.2 ww
5975 # add a vertex with the y value 2 x value is constant
5976 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 yy 2 ww
5978 # add a circular element with a radius value of 1 and a circular value of 290 degrees
5979 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 xx 0.2 yy 2 c 1 290
5981 # wire continues at a tangent to the intersection x = 0
5982 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 xx 0.2 yy 2 c 1 290 ix 0 ww
5984 # continue the wire at an angle of 90 degrees until it intersects the y axis at y= -o.3
5985 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 xx 0.2 yy 2 c 1 290 ix 0 r 90 ix -0.3 ww
5988 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 xx 0.2 yy 2 c 1 290 ix 0 r 90 ix -0.3 w
5990 # to create the plane with the same contour
5991 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 xx 0.2 yy 2 c 1 290 ix 0 r 90 ix -0.3
5994 @subsubsection occt_draw_7_2_5 bsplineprof
5998 bsplineprof name [S face] [W WW]
6001 * for an edge : \<digitizes\> ... <mouse button 2>
6002 * to end profile : <mouse button 3>
6004 Builds a profile in the XY plane from digitizes. By default the profile is closed and a face is built.
6006 **bsplineprof** creates a 2d profile from bspline curves using the mouse as the input. *MB1* creates the points, *MB2* finishes the current curve and starts the next curve, *MB3* closes the profile.
6008 The profile shape definition is the suffix; no suffix produces a face, **w** is a closed wire, **ww** is an open wire.
6012 #to view the xy plane
6014 #to create a 2d curve with the mouse
6016 # click mb1 to start the curve
6017 # click mb1 to create the second vertex
6018 # click mb1 to create a curve
6020 #click mb2 to finish the curve and start a new curve
6022 # click mb1 to create the second curve
6023 # click mb3 to create the face
6026 @subsubsection occt_draw_7_2_6 mkoffset
6030 mkoffset result face/compound of wires nboffset stepoffset
6033 **mkoffset** creates a parallel wire in the same plane using a face or an existing continuous set of wires as a reference. The number of occurences is not limited.
6035 The offset distance defines the spacing and the positioning of the occurences.
6039 #Create a box and select a face
6042 #Create three exterior parallel contours with an offset
6045 Create one interior parallel contour with an offset
6048 mkoffset r b_1 1 -0.4
6051 **Note** that *mkoffset* command must be used with prudence, as angular contours produce offset contours with fillets. Interior parallel contours can produce more than one wire, normally these are refused. In the following example, any increase in the offset value is refused.
6055 # to create the example contour
6056 profile p F 0 0 x 2 y 4 tt 1 1 tt 0 4 w
6057 # to create an incoherent interior offset
6058 mkoffset r p 1 -0.50
6059 ==p is not a FACE but a WIRE
6060 BRepFill_TrimEdgeTool: incoherent intersection
6061 # to create two incoherent wires
6062 mkoffset r p 1 -0.50
6065 @subsubsection occt_draw_7_2_7 mkplane, mkface
6070 mkface name surface [ufirst ulast vfirst vlast]
6073 **mkplane** generates a face from a planar wire. The planar surface will be constructed with an orientation which keeps the face inside the wire.
6075 **mkface** generates a face from a surface. Parameter values can be given to trim a rectangular area. The default boundaries are those of the surface.
6079 # make a polygonal face
6080 polyline f 0 0 0 20 0 0 20 10 0 10 10 0 10 20 0 0 20 0 0 0 0
6083 # make a cylindrical face
6085 trim g g -pi/3 pi/2 0 15
6089 @subsubsection occt_draw_7_2_8 mkcurve, mksurface
6097 **mkcurve** creates a 3d curve from an edge. The curve will be trimmed to the edge boundaries.
6099 **mksurface** creates a surface from a face. The surface will not be trimmed.
6109 @subsubsection occt_draw_7_2_9 pcurve
6114 pcurve [name edgename] facename
6117 Extracts the 2d curve of an edge on a face. If only the face is specified, the command extracts all the curves and colors them according to their orientation. This is useful in checking to see if the edges in a face are correctly oriented, i.e. they turn counter-clockwise. To make curves visible, use a fitted 2d view.
6121 # view the pcurves of a face
6130 @subsubsection occt_draw_7_2_10 chfi2d
6134 chfi2d result face [edge1 edge2 (F radius/CDD d1 d2/CDA d ang) ....
6138 Creates chamfers and fillets on 2D objects. Select two adjacent edges and:
6140 * two respective distance values
6141 * a distance value and an angle
6143 The radius value produces a fillet between the two faces.
6145 The distance is the length value from the edge between the two selected faces in a normal direction.
6149 Let us create a 2d fillet:
6153 profile p x 2 y 2 x -2
6154 chfi2d cfr p . . F 0.3
6161 Let us create a 2d chamfer using two distances:
6164 profile p x 2 y 2 x -2
6165 chfi2d cfr p . . CDD 0.3 0.6
6172 Let us create a 2d chamfer using a defined distance and angle
6176 profile p x 2 y 2 x -2
6177 chfi2d cfr p . . CDA 0.3 75
6184 @subsubsection occt_draw_7_2_11 nproject
6188 nproject pj e1 e2 e3 ... surf -g -d [dmax] [Tol
6189 [continuity [maxdeg [maxseg]]]
6192 Creates a shape projection which is normal to the target surface.
6196 # create a curved surface
6205 translate ll 2 -0.5 0
6211 #display in four views
6214 # create the example shape
6215 circle c 1.8 -0.5 1 0 1 0 1 0 0 0.4
6218 # create the normal projection of the shape(circle)
6223 @subsection occt_draw_7_3 Primitives
6225 Primitive commands make it possible to create simple shapes. They include:
6227 * **box** and **wedge** commands.
6228 * **pcylinder**, **pcone**, **psphere**, **ptorus** commands.
6229 * **halfspace** command
6232 @subsubsection occt_draw_7_3_1 box, wedge
6236 box name [x y z] dx dy dz
6237 wedge name dx dy dz ltx / xmin zmin xmax xmax
6240 **box** creates a box parallel to the axes with dimensions *dx,dy,dz*. *x,y,z* is the corner of the box. It is the default origin.
6242 **wedge** creates a box with five faces called a wedge. One face is in the OXZ plane, and has dimensions *dx,dz* while the other face is in the plane *y = dy*. This face either has dimensions *ltx, dz* or is bounded by *xmin,zmin,xmax,zmax*.
6244 The other faces are defined between these faces. The face in the *y=yd* plane may be degenerated into a line if *ltx = 0*, or a point if *xmin = xmax* and *ymin = ymax*. In these cases, the line and the point both have 5 faces each. To position the wedge use the *ttranslate* and *trotate* commands.
6248 # a box at the origin
6252 box b2 30 30 40 10 20 30
6257 # a wedge with a sharp edge (5 faces)
6261 wedge w3 20 20 20 10 10 10 10
6264 @subsubsection occt_draw_7_3_2 pcylinder, pcone, psphere, ptorus
6268 pcylinder name [plane] radius height [angle]
6269 pcone name [plane] radius1 radius2 height [angle]
6270 pcone name [plane] radius1 radius2 height [angle]
6271 psphere name [plane] radius1 [angle1 angle2] [angle]
6272 ptorus name [plane] radius1 radius2 [angle1 angle2] [angle]
6275 All these commands create solid blocks in the default coordinate system, using the Z axis as the axis of revolution and the X axis as the origin of the angles. To use another system, translate and rotate the resulting solid or use a plane as first argument to specify a coordinate system. All primitives have an optional last argument which is an angle expressed in degrees and located on the Z axis, starting from the X axis. The default angle is 360.
6277 **pcylinder** creates a cylindrical block with the given radius and height.
6279 **pcone** creates a truncated cone of the given height with radius1 in the plane z = 0 and radius2 in the plane z = height. Neither radius can be negative, but one of them can be null.
6281 **psphere** creates a solid sphere centered on the origin. If two angles, *angle1* and *angle2*, are given, the solid will be limited by two planes at latitude *angle1* and *angle2*. The angles must be increasing and in the range -90,90.
6283 **ptorus** creates a solid torus with the given radii, centered on the origin, which is a point along the z axis. If two angles increasing in degree in the range 0 – 360 are given, the solid will be bounded by two planar surfaces at those positions on the circle.
6290 # a quarter of a truncated cone
6291 pcone co 15 10 10 90
6293 # three-quarters of sphere
6300 @subsubsection occt_draw_7_3_3 halfspace
6304 halfspace result face/shell x y z
6307 **halfspace** creates an infinite solid volume based on a face in a defined direction. This volume can be used to perform the boolean operation of cutting a solid by a face or plane.
6313 ==b_1 b_2 b_3 b_4 b_5 b_6
6314 halfspace hr b_3 0.5 0.5 0.5
6318 @subsection occt_draw_7_4 Sweeping
6320 Sweeping creates shapes by sweeping out a shape along a defined path:
6322 * **prism** sweeps along a direction.
6323 * **revol** sweeps around an axis.
6324 * **pipe** sweeps along a wire.
6325 * **mksweep** and **buildsweep** are commands to create sweeps by defining the arguments and algorithms.
6326 * **thrusections** creates a sweep from wire in different planes.
6329 @subsubsection occt_draw_7_4_1 prism
6333 prism result base dx dy dz [Copy | Inf | SemiInf]
6336 Creates a new shape by sweeping a shape in a direction. Any shape can be swept: a vertex gives an edge; an edge gives a face; and a face gives a solid.
6338 The shape is swept along the vector *dx dy dz*. The original shape will be shared in the result unless *Copy* is specified. If *Inf* is specified the prism is infinite in both directions. If *SemiInf* is specified the prism is infinite in the *dx,dy,dz* direction, and the length of the vector has no importance.
6342 # sweep a planar face to make a solid
6343 polyline f 0 0 0 10 0 0 10 5 0 5 5 0 5 15 0 0 15 0 0 0 0
6347 @subsubsection occt_draw_7_4_2 revol
6351 revol result base x y z dx dy dz angle [Copy]
6354 Creates a new shape by sweeping a base shape through an angle along the axis *x,y,z dx,dy,dz*. As with the prism command, the shape can be of any type and is not shared if *Copy* is specified.
6358 # shell by wire rotation
6359 polyline w 0 0 0 10 0 0 10 5 0 5 5 0 5 15 0 0 15 0
6360 revol s w 20 0 0 0 1 0 90
6364 @subsubsection occt_draw_7_4_3 pipe
6368 pipe name wire_spine Profile
6371 Creates a new shape by sweeping a shape known as the profile along a wire known as the spine.
6375 # sweep a circle along a bezier curve to make a solid
6378 beziercurve spine 4 0 0 0 10 0 0 10 10 0 20 10 0
6381 circle profile 0 0 0 1 0 0 2
6382 mkedge profile profile
6383 wire profile profile
6384 mkplane profile profile
6385 pipe p spine profile
6388 @subsubsection occt_draw_7_4_4 mksweep, addsweep, setsweep, deletesweep, buildsweep, simulsweep
6393 addsweep wire[vertex][-M][-C] [auxiilaryshape]
6395 setsweep options [arg1 [arg2 [...]]]
6396 simulsweep r [n] [option]
6397 buildsweep [r] [option] [Tol]
6401 * *-FR* : Tangent and Normal are defined by a Frenet trihedron
6402 * *-CF* : Tangent is given by Frenet, the Normal is computed to minimize the torsion
6403 * *-DX Surf* : Tangent and Normal are given by Darboux trihedron, surf must be a shell or a face
6404 * *-CN dx dy dz* : BiNormal is given by *dx dy dz*
6405 * *-FX Tx Ty TZ [Nx Ny Nz]* : Tangent and Normal are fixed
6408 These commands are used to create a shape from wires. One wire is designated as the contour that defines the direction; it is called the spine. At least one other wire is used to define the the sweep profile.
6409 * **mksweep** initializes the sweep creation and defines the wire to be used as the spine.
6410 * **addsweep** defines the wire to be used as the profile.
6411 * **deletesweep** cancels the choice of profile wire, without leaving the mksweep mode. You can re-select a profile wire.
6412 * **setsweep** commands the algorithms used for the construction of the sweep.
6413 * **simulsweep** can be used to create a preview of the shape. [n] is the number of sections that are used to simulate the sweep.
6414 * **buildsweep** creates the sweep using the arguments defined by all the commands.
6418 #create a sweep based on a semi-circular wire using the
6420 #create a circular figure
6421 circle c2 0 0 0 1 0 0 10
6422 trim c2 c2 -pi/2 pi/2
6428 # to display all the options for a sweep
6430 #to create a sweep using the Frenet algorithm where the
6431 #normal is computed to minimise the torsion
6434 # to simulate the sweep with a visual approximation
6438 @subsubsection occt_draw_7_4_5 thrusections
6442 thrusections [-N] result issolid isruled wire1 wire2 [..wire..]
6445 **thrusections** creates a shape using wires that are positioned in different planes. Each wire selected must have the same number of edges and vertices.
6446 A bezier curve is generated between the vertices of each wire. The option *[-N]* means that no check is made on wires for direction.
6450 #create three wires in three planes
6451 polyline w1 0 0 0 5 0 0 5 5 0 2 3 0
6452 polyline w2 0 1 3 4 1 3 4 4 3 1 3 3
6453 polyline w3 0 0 5 5 0 5 5 5 5 2 3 5
6455 thrusections th issolid isruled w1 w2 w3
6456 ==thrusections th issolid isruled w1 w2 w3
6457 Tolerances obtenues -- 3d : 0
6462 @subsection occt_draw_7_5 Topological transformation
6464 Transformations are applications of matrices. When the transformation is nondeforming, such as translation or rotation, the object is not copied. The topology localcoordinate system feature is used. The copy can be enforced with the **tcopy** command.
6466 * **tcopy** makes a copy of the structure of a shape.
6467 * **ttranslate**, **trotate**, **tmove**, **reset** move a shape.
6468 * **tmirror**, **tscale** always modify the shape.
6471 @subsubsection occt_draw_7_5_1 tcopy
6475 tcopy name toname [name toname ...]
6478 Copies the structure of one shape, including the geometry, into another, newer shape.
6482 # create an edge from a curve and copy it
6483 beziercurve c 3 0 0 0 10 0 0 20 10 0
6488 # now modify the curve, only e1 and e2 will be modified
6491 @subsubsection occt_draw_7_5_2 tmove, treset
6495 tmove name [name ...] shape
6496 reset name [name ...]
6499 **tmove** and **reset** modify the location, or the local coordinate system of a shape.
6501 **tmove** applies the location of a given shape to other shapes. **reset** restores one or several shapes it to its or their original coordinate system(s).
6507 box b2 20 0 0 10 10 10
6508 # translate the first box
6509 ttranslate b1 0 10 0
6510 # and apply the same location to b2
6512 # return to original positions
6516 @subsubsection occt_draw_7_5_3 ttranslate, trotate
6520 ttranslate [name ...] dx dy dz
6521 trotate [name ...] x y z dx dy dz angle
6524 **ttranslate** translates a set of shapes by a given vector, and **trotate** rotates them by a given angle around an axis. Both commands only modify the location of the shape.
6525 When creating multiple shapes, the same location is used for all the shapes. (See *toto.tcl* example below. Note that the code of this file can also be directly executed in interactive mode.)
6527 Locations are very economic in the data structure because multiple occurences of an object share the topological description.
6531 # make rotated copies of a sphere in between two cylinders
6532 # create a file source toto.tcl
6534 for {set i 0} {$i 360} {incr i 20} {
6536 trotate s$i 0 0 0 0 0 1 $i
6539 # create two cylinders
6542 ttranslate c2 0 0 20
6546 ttranslate s 25 0 12.5
6548 # call the source file for multiple copies
6552 @subsubsection occt_draw_7_5_4 tmirror, tscale
6556 tmirror name x y z dx dy dz
6557 tscale name x y z scale
6560 * **tmirror** makes a mirror copy of a shape about a plane x,y,z dx,dy,dz.
6562 * **Tscale** applies a central homotopic mapping to a shape.
6566 # mirror a portion of cylinder about the YZ plane
6567 pcylinder c1 10 10 270
6569 tmirror c2 15 0 0 1 0 0
6575 @subsection occt_draw_7_6 Old Topological operations
6577 * **fuse**, **cut**, **common** are boolean operations.
6578 * **section**, **psection** compute sections.
6579 * **sewing** joins two or more shapes.
6582 @subsubsection occt_draw_7_6_1 fuse, cut, common
6586 fuse name shape1 shape2
6587 cut name shape1 shape2
6588 common name shape1 shape2
6591 **fuse** creates a new shape by a boolean operation on two existing shapes. The new shape contains both originals intact.
6593 **cut** creates a new shape which contains all parts of the second shape but only the first shape without the intersection of the two shapes.
6595 **common** creates a new shape which contains only what is in common between the two original shapes in their intersection.
6599 # all four boolean operations on a box and a cylinder
6601 box b 0 -10 5 20 20 10
6605 ttranslate s1 40 0 0
6608 ttranslate s2 -40 0 0
6611 ttranslate s3 0 40 0
6614 ttranslate s4 0 -40 0
6618 @subsubsection occt_draw_7_6_2 section, psection
6622 section result shape1 shape2
6623 psection name shape plane
6626 **section** creates a compound object consisting of the edges for the intersection curves on the faces of two shapes.
6628 **psection** creates a planar section consisting of the edges for the intersection curves on the faces of a shape and a plane.
6632 # section line between a cylinder and a box
6634 box b 0 0 5 15 15 15
6635 trotate b 0 0 0 1 1 1 20
6638 # planar section of a cone
6640 plane p 0 0 15 1 1 2
6644 @subsubsection occt_draw_7_6_3 sewing
6648 sewing result [tolerance] shape1 shape2 ...
6651 **Sewing** joins shapes by connecting their adjacent or near adjacent edges. Adjacency can be redefined by modifying the tolerance value.
6655 # create two adjacent boxes
6660 sr is a shape COMPOUND FORWARD Free Modified
6663 @subsection occt_draw_7_7 New Topological operations
6666 The new algorithm of Boolean operations avoids a large number of weak points and limitations presented in the old boolean operation algorithm.
6669 @subsubsection occt_draw_7_7_1 bparallelmode
6671 * **bparallelmode** enable or disable parallel mode for boolean operations. Sequential computing is used by default.
6679 Without arguments, bparallelmode shows current state of parallel mode for boolean operations.
6681 * *0* Disable parallel mode,
6682 * *1* Enable parallel mode
6686 # Enable parallel mode for boolean operations.
6689 # Show state of parallel mode for boolean operations.
6693 @subsubsection occt_draw_7_7_2 bop, bopfuse, bopcut, boptuc, bopcommon
6695 * **bop** defines *shape1* and *shape2* subject to ulterior Boolean operations
6696 * **bopfuse** creates a new shape by a boolean operation on two existing shapes. The new shape contains both originals intact.
6697 * **bopcut** creates a new shape which contains all parts of the second shape but only the first shape without the intersection of the two shapes.
6698 * **boptuc** is a reverced **bopcut**.
6699 * **bopcommon** creates a new shape which contains only whatever is in common between the two original shapes in their intersection.
6710 These commands have short variants:
6713 bcommon result shape1 shape2
6714 bfuse result shape1 shape2
6715 bcut result shape1 shape2
6719 **bop** fills data structure (DS) of boolean operation for *shape1* and *shape2*.
6720 **bopcommon, bopfuse, bopcut, boptuc** commands are used after **bop** command. After one **bop** command it is possible to call several commands from the list above. For example:
6730 Let us produce all four boolean operations on a box and a cylinder:
6733 box b 0 -10 5 20 20 10
6736 # fills data structure
6740 ttranslate s1 40 0 0
6743 ttranslate s2 -40 0 0
6746 ttranslate s3 0 40 0
6749 ttranslate s4 0 -40 0
6752 Now use short variants of the commands:
6756 ttranslate s11 40 0 100
6759 ttranslate s12 -40 0 100
6762 ttranslate s14 0 -40 100
6765 @subsubsection occt_draw_7_7_3 bopsection
6773 * **bopsection** creates a compound object consisting of the edges for the intersection curves on the faces of two shapes.
6774 * **bop** fills data structure (DS) of boolean operation for *shape1* and *shape2*.
6775 * **bopsection** command used after **bop** command.
6777 Short variant syntax:
6779 bsection result shape1 shape2 [-2d/-2d1/-2s2] [-a]
6782 * <i>-2d</i> - PCurves are computed on both parts.
6783 * <i>-2d1</i> - PCurves are computed on first part.
6784 * <i>-2d2</i> - PCurves are computed on second part.
6785 * <i>-a</i> - built geometries are approximated.
6789 Let us build a section line between a cylinder and a box
6792 box b 0 0 5 15 15 15
6793 trotate b 0 0 0 1 1 1 20
6800 @subsubsection occt_draw_7_7_4 bopcheck, bopargshape
6805 bopargcheck shape1 [[shape2] [-F/O/C/T/S/U] [/R|F|T|V|E|I|P]] [#BF]
6808 **bopcheck** checks a shape for self-interference.
6810 **bopargcheck** checks the validity of argument(s) for boolean operations.
6812 * Boolean Operation - (by default a section is made) :
6819 * Test Options - (by default all options are enabled) :
6820 * **R** (disable small edges (shrank range) test)
6821 * **F** (disable faces verification test)
6822 * **T** (disable tangent faces searching test)
6823 * **V** (disable test possibility to merge vertices)
6824 * **E** (disable test possibility to merge edges)
6825 * **I** (disable self-interference test)
6826 * **P** (disable shape type test)
6827 * Additional Test Options :
6828 * **B** (stop test on first faulty found) - by default it is off;
6829 * **F** (full output for faulty shapes) - by default the output is made in a short format.
6831 **Note** that Boolean Operation and Test Options are used only for a couple of argument shapes, except for <b>I</b> and <b>P</b> options that are always used to test a couple of shapes as well as a single shape.
6835 # checks a shape on self-interference
6839 # checks the validity of argument for boolean cut operations
6840 box b2 0 0 0 10 10 10
6841 bopargcheck b1 b2 -C
6844 @subsection occt_draw_7_8 Drafting and blending
6846 Drafting is creation of a new shape by tilting faces through an angle.
6848 Blending is the creation of a new shape by rounding edges to create a fillet.
6850 * Use the **depouille** command for drafting.
6851 * Use the **chamf** command to add a chamfer to an edge
6852 * Use the **blend** command for simple blending.
6853 * Use **fubl** for a fusion + blending operation.
6854 * Use **buildevol**, **mkevol**, **updatevol** to realize varying radius blending.
6857 @subsubsection occt_draw_7_8_1 depouille
6861 dep result shape dirx diry dirz face angle x y x dx dy dz [face angle...]
6864 Creates a new shape by drafting one or more faces of a shape.
6866 Identify the shape(s) to be drafted, the drafting direction, and the face(s) with an angle and an axis of rotation for each face. You can use dot syntax to identify the faces.
6870 # draft a face of a box
6873 == b_1 b_2 b_3 b_4 b_5 b_6
6875 dep a b 0 0 1 b_2 10 0 10 0 1 0 5
6878 @subsubsection occt_draw_7_8_2 chamf
6882 chamf newname shape edge face S dist
6883 chamf newname shape edge face dist1 dist2
6884 chamf newname shape edge face A dist angle
6887 Creates a chamfer along the edge between faces using:
6889 * a equal distances from the edge
6890 * the edge, a face and distance, a second distance
6891 * the edge, a reference face and an angle
6893 Use the dot syntax to select the faces and edges.
6897 Let us create a chamfer based on equal distances from the edge (45 degree angle):
6901 chamf ch b . . S 0.5
6905 # select an adjacent face
6908 Let us create a chamfer based on different distances from the selected edge:
6911 chamf ch b . . 0.3 0.4
6915 # select an adjacent face
6918 Let us create a chamfer based on a distance from the edge and an angle:
6922 chamf ch b . . A 0.4 30
6926 # select an adjacent face
6929 @subsubsection occt_draw_7_8_3 blend
6933 blend result object rad1 ed1 rad2 ed2 ... [R/Q/P]
6936 Creates a new shape by filleting the edges of an existing shape. The edge must be inside the shape. You may use the dot syntax. Note that the blend is propagated to the edges of tangential planar, cylindrical or conical faces.
6940 # blend a box, click on an edge
6943 ==tolerance ang : 0.01
6944 ==tolerance 3d : 0.0001
6945 ==tolerance 2d : 1e-05
6947 ==tolblend 0.01 0.0001 1e-05 0.001
6949 # click on the edge you want ot fillet
6951 ==COMPUTE: temps total 0.1s dont :
6952 ==- Init + ExtentAnalyse 0s
6953 ==- PerformSetOfSurf 0.02s
6954 ==- PerformFilletOnVertex 0.02s
6956 ==- Reconstruction 0.06s
6960 @subsubsection occt_draw_7_8_4 fubl
6964 fubl name shape1 shape2 radius
6967 Creates a boolean fusion of two shapes and then blends (fillets) the intersection edges using the given radius.
6971 # fuse-blend two boxes
6974 ttranslate b2 -10 10 3
6979 @subsubsection occt_draw_7_8_5 mkevol, updatevol, buildevol
6983 mkevol result object (then use updatevol) [R/Q/P]
6984 updatevol edge u1 radius1 [u2 radius2 ...]
6988 These three commands work together to create fillets with evolving radii.
6990 * **mkevol** allows specifying the shape and the name of the result. It returns the tolerances of the fillet.
6991 * **updatevol** allows describing the filleted edges you want to create. For each edge, you give a set of coordinates: parameter and radius and the command prompts you to pick the edge of the shape which you want to modify. The parameters will be calculated along the edges and the radius function applied to the whole edge.
6992 * **buildevol** produces the result described previously in **mkevol** and **updatevol**.
6996 # makes an evolved radius on a box
6999 ==tolerance ang : 0.01
7000 ==tolerance 3d : 0.0001
7001 ==tolerance 2d : 1e-05
7003 ==tolblend 0.01 0.0001 1e-05 0.001
7006 updatevol . 0 1 1 3 2 2
7010 ==Dump of SweepApproximation
7011 ==Error 3d = 1.28548881203818e-14
7012 ==Error 2d = 1.3468326936926e-14 ,
7013 ==1.20292299999388e-14
7014 ==2 Segment(s) of degree 3
7016 ==COMPUTE: temps total 0.91s dont :
7017 ==- Init + ExtentAnalyse 0s
7018 ==- PerformSetOfSurf 0.33s
7019 ==- PerformFilletOnVertex 0.53s
7021 ==- Reconstruction 0.04s
7026 @subsection occt_draw_7_9 Topological analysis
7028 Analysis of shapes includes commands to compute length, area, volumes and inertial properties.
7030 * Use **lprops**, **sprops**, **vprops** to compute integral properties.
7031 * Use **bounding** to display the bounding box of a shape.
7032 * Use **distmini** to calculate the minimum distance between two shapes.
7035 @subsubsection occt_draw_7_9_1 lprops, sprops, vprops
7044 * **lprops** computes the mass properties of all edges in the shape with a linear density of 1;
7045 * **sprops** of all faces with a surface density of 1;
7046 * **vprops** of all solids with a density of 1.
7048 All three commands print the mass, the coordinates of the center of gravity, the matrix of inertia and the moments. Mass is either the length, the area or the volume. The center and the main axis of inertia are displayed.
7052 # volume of a cylinder
7056 Mass : 6283.18529981086
7059 X = 4.1004749224903e-06
7060 Y = -2.03392858349861e-16
7064 366519.141445068 5.71451850691484e-12
7066 5.71451850691484e-12 366519.141444962
7067 2.26823064169991e-10 0.257640437382627
7068 2.26823064169991e-10 314159.265358863
7071 IX = 366519.141446336
7072 IY = 366519.141444962
7073 I.Z = 314159.265357595
7077 @subsubsection occt_draw_7_9_2 bounding
7084 Displays the bounding box of a shape. The bounding box is a cuboid created with faces parallel to the x, y, and z planes. The command returns the dimension values of the the box, *xmin ymin zmin xmax ymax zmax.*
7088 # bounding box of a torus
7091 ==-27.059805107309852 -27.059805107309852 -
7093 ==27.059805107309852 27.059805107309852
7097 @subsubsection occt_draw_7_9_3 distmini
7101 distmini name Shape1 Shape2
7104 Calculates the minimum distance between two shapes. The calculation returns the number of solutions, If more than one solution exists. The options are displayed in the viewer(red) and the results are listed in the shell window. The *distmini* lines are considered as shapes which have a value v.
7108 box b 0 0 0 10 20 30
7109 box b2 30 30 0 10 20 30
7111 ==the distance value is : 22.3606797749979
7112 ==the number of solutions is :2
7115 ==the type of the solution on the first shape is 0
7116 ==the type of the solution on the second shape is 0
7117 ==the coordinates of the point on the first shape are:
7119 ==the coordinates of the point on the second shape
7123 ==solution number 2:
7124 ==the type of the solution on the first shape is 0
7125 ==the type of the solution on the second shape is 0
7126 ==the coordinates of the point on the first shape are:
7128 ==the coordinates of the point on the second shape
7135 @subsection occt_draw_7_10 Surface creation
7137 Surface creation commands include surfaces created from boundaries and from spaces between shapes.
7138 * **gplate** creates a surface from a boundary definition.
7139 * **filling** creates a surface from a group of surfaces.
7141 @subsubsection occt_draw_7_10_1 gplate,
7145 gplate result nbrcurfront nbrpntconst [SurfInit] [edge 0] [edge tang (1:G1;2:G2) surf]...[point] [u v tang (1:G1;2:G2) surf] ...
7148 Creates a surface from a defined boundary. The boundary can be defined using edges, points, or other surfaces.
7156 beziercurve c1 3 0 0 0 1 0 1 2 0 0
7162 trotate e3 0 0 0 0 0 1 90
7165 # create the surface
7166 gplate r1 4 0 p e1 0 e2 0 e3 0 e4 0
7168 ======== Results ===========
7169 DistMax=8.50014503228635e-16
7171 Calculation time: 0.33
7173 Approximation results
7174 Approximation error : 2.06274907619957e-13
7175 Criterium error : 4.97600631215754e-14
7177 #to create a surface defined by edges and passing through a point
7178 # to define the border edges and the point
7183 beziercurve c1 3 0 0 0 1 0 1 2 0 0
7189 trotate e3 0 0 0 0 0 1 90
7194 # to create the surface
7195 gplate r2 4 1 p e1 0 e2 0 e3 0 e4 0 pp
7197 ======== Results ===========
7198 DistMax=3.65622157610934e-06
7200 Calculculation time: 0.27
7202 Approximation results
7203 Approximation error : 0.000422195884750181
7204 Criterium error : 3.43709808053967e-05
7207 @subsubsection occt_draw_7_10_2 filling, fillingparam
7211 filling result nbB nbC nbP [SurfInit] [edge][face]order...
7212 edge[face]order... point/u v face order...
7215 Creates a surface between borders. This command uses the **gplate** algorithm but creates a surface that is tangential to the adjacent surfaces. The result is a smooth continuous surface based on the G1 criterion.
7217 To define the surface border:
7219 * enter the number of edges, constraints, and points
7220 * enumerate the edges, constraints and points
7222 The surface can pass through other points. These are defined after the border definition.
7224 You can use the *fillingparam* command to access the filling parameters.
7228 * <i>-l</i> : to list current values
7229 * <i>-i</i> : to set default values
7230 * <i>-rdeg nbPonC nbIt anis </i> : to set filling options
7231 * <i>-c t2d t3d tang tcur </i> : to set tolerances
7232 * <i>-a maxdeg maxseg </i> : Approximation option
7236 # to create four curved survaces and a point
7241 beziercurve c1 3 0 0 0 1 0 1 2 0 0
7247 trotate e3 0 0 0 0 0 1 90
7258 # to create a tangential surface
7259 filling r1 4 0 0 p e1 f1 1 e2 f2 1 e3 f3 1 e4 f4 1
7260 # to create a tangential surface passing through point pp
7261 filling r2 4 0 1 p e1 f1 1 e2 f2 1 e3 f3 1 e4 f4 1 pp#
7262 # to visualise the surface in detail
7264 # to display the current filling parameters
7281 @subsection occt_draw_7_11 Complex Topology
7283 Complex topology is the group of commands that modify the topology of shapes. This includes feature modeling.
7286 @subsubsection occt_draw_7_11_1 offsetshape, offsetcompshape
7290 offsetshape r shape offset [tol] [face ...]
7291 offsetcompshape r shape offset [face ...]
7294 **offsetshape** and **offsetcompshape** assign a thickness to the edges of a shape. The *offset* value can be negative or positive. This value defines the thickness and direction of the resulting shape. Each face can be removed to create a hollow object.
7296 The resulting shape is based on a calculation of intersections. In case of simple shapes such as a box, only the adjacent intersections are required and you can use the **offsetshape** command.
7298 In case of complex shapes, where intersections can occur from non-adjacent edges and faces, use the **offsetcompshape** command. **comp** indicates complete and requires more time to calculate the result.
7300 The opening between the object interior and exterior is defined by the argument face or faces.
7306 == b1_1 b1_2 b1_3 b1_4 b1_5 b1_6
7307 offsetcompshape r b1 -1 b1_3
7310 @subsubsection occt_draw_7_11_2 featprism, featdprism, featrevol, featlf, featrf
7314 featprism shape element skface Dirx Diry Dirz Fuse(0/1/2) Modify(0/1)
7315 featdprism shape face skface angle Fuse(0/1/2) Modify(0/1)
7316 featrevol shape element skface Ox Oy Oz Dx Dy Dz Fuse(0/1/2) Modify(0/1)
7317 featlf shape wire plane DirX DirY DirZ DirX DirY DirZ Fuse(0/1/2) Modify(0/1)
7318 featrf shape wire plane X Y Z DirX DirY DirZ Size Size Fuse(0/1/2) Modify(0/1)
7319 featperform prism/revol/pipe/dprism/lf result [[Ffrom] Funtil]
7320 featperformval prism/revol/dprism/lf result value
7323 **featprism** loads the arguments for a prism with contiguous sides normal to the face.
7325 **featdprism** loads the arguments for a prism which is created in a direction normal to the face and includes a draft angle.
7327 **featrevol** loads the arguments for a prism with a circular evolution.
7329 **featlf** loads the arguments for a linear rib or slot. This feature uses planar faces and a wire as a guideline.
7331 **featrf** loads the arguments for a rib or slot with a curved surface. This feature uses a circular face and a wire as a guideline.
7333 **featperform** loads the arguments to create the feature.
7335 **featperformval** uses the defined arguments to create a feature with a limiting value.
7337 All the features are created from a set of arguments which are defined when you initialize the feature context. Negative values can be used to create depressions.
7341 Let us create a feature prism with a draft angle and a normal direction :
7344 # create a box with a wire contour on the upper face
7346 profil f O 0 0 1 F 0.25 0.25 x 0.5 y 0.5 x -0.5
7348 # loads the feature arguments defining the draft angle
7349 featdprism b f b_6 5 1 0
7350 # create the feature
7351 featperformval dprism r 1
7352 ==BRepFeat_MakeDPrism::Perform(Height)
7353 BRepFeat_Form::GlobalPerform ()
7359 Let us create a feature prism with circular direction :
7362 # create a box with a wire contour on the upper face
7364 profil f O 0 0 1 F 0.25 0.25 x 0.5 y 0.5 x -0.5
7366 # loads the feature arguments defining a rotation axis
7367 featrevol b f b_6 1 0 1 0 1 0 1 0
7368 featperformval revol r 45
7369 ==BRepFeat_MakeRevol::Perform(Angle)
7370 BRepFeat_Form::GlobalPerform ()
7377 Let us create a slot using the linear feature :
7380 #create the base model using the multi viewer
7382 profile p x 5 y 1 x -3 y -0.5 x -1.5 y 0.5 x 0.5 y 4 x -1 y -5
7384 # create the contour for the linear feature
7385 vertex v1 -0.2 4 0.3
7387 vertex v3 0.2 0.2 0.3
7389 vertex v5 4 -0.2 0.3
7396 plane pl 0.2 0.2 0.3 0 0 1
7397 # loads the linear feature arguments
7398 featlf pr w pl 0 0 0.3 0 0 0 0 1
7399 featperform lf result
7402 Let us create a rib using the revolution feature :
7405 #create the base model using the multi viewer
7408 # create the contour for the revolution feature
7409 profile w c 1 190 WW
7410 trotate w 0 0 0 1 0 0 90
7412 trotate w -3 0 1.5 0 0 1 180
7413 plane pl -3 0 1.5 0 1 0
7414 # loads the revolution feature arguments
7415 featrf c1 w pl 0 0 0 0 0 1 0.3 0.3 1 1
7416 featperform rf result
7419 @subsubsection occt_draw_7_11_3 draft
7423 draft result shape dirx diry dirz angle shape/surf/length [-IN/-OUT] [Ri/Ro] [-Internal]
7426 Computes a draft angle surface from a wire. The surface is determined by the draft direction, the inclination of the draft surface, a draft angle, and a limiting distance.
7428 * The draft angle is measured in radians.
7429 * The draft direction is determined by the argument -INTERNAL
7430 * The argument Ri/Ro deftermines wether the corner edges of the draft surfaces are angular or rounded.
7431 * Arguments that can be used to define the surface distance are:
7432 * length, a defined distance
7433 * shape, until the surface contacts a shape
7434 * surface, until the surface contacts a surface.
7436 **Note** that the original aim of adding a draft angle to a shape is to produce a shape which can be removed easily from a mould. The Examples below use larger angles than are used normally and the calculation results returned are not indicated.
7440 # to create a simple profile
7441 profile p F 0 0 x 2 y 4 tt 0 4 w
7442 # creates a draft with rounded angles
7443 draft res p 0 0 1 3 1 -Ro
7444 # to create a profile with an internal angle
7445 profile p F 0 0 x 2 y 4 tt 1 1.5 tt 0 4 w
7446 # creates a draft with rounded external angles
7447 draft res p 0 0 1 3 1 -Ro
7450 @subsubsection occt_draw_7_11_4 deform
7454 deform newname name CoeffX CoeffY CoeffZ
7457 Modifies the shape using the x, y, and z coefficients. You can reduce or magnify the shape in the x,y, and z directions.
7463 # the conversion to bspline is followed by the
7468 @subsubsection occt_draw_7_11_5 nurbsconvert
7473 nurbsconvert result name [result name]
7476 Changes the NURBS curve definition of a shape to a Bspline curve definition. This conversion is required for assymetric deformation and prepares the arguments for other commands such as **deform**. The conversion can be necessary when transferring shape data to other applications.
7479 @subsection occt_draw_7_12 Texture Mapping to a Shape
7481 Texture mapping allows you to map textures on a shape. Textures are texture image files and several are predefined. You can control the number of occurrences of the texture on a face, the position of a texture and the scale factor of the texture.
7483 @subsubsection occt_draw_7_12_1 vtexture
7487 vtexture NameOfShape TextureFile
7488 vtexture NameOfShape
7489 vtexture NameOfShape ?
7490 vtexture NameOfShape IdOfTexture
7493 **TextureFile** identifies the file containing the texture you want. The same syntax without **TextureFile** disables texture mapping. The question-mark <b>?</b> lists available textures. **IdOfTexture** allows applying predefined textures.
7495 @subsubsection occt_draw_7_12_2 vtexscale
7499 vtexscale NameOfShape ScaleU ScaleV
7500 vtexscale NameOfShape ScaleUV
7501 vtexscale NameOfShape
7504 *ScaleU* and *Scale V* allow scaling the texture according to the U and V parameters individually, while *ScaleUV* applies the same scale to both parameters.
7506 The syntax without *ScaleU*, *ScaleV* or *ScaleUV* disables texture scaling.
7508 @subsubsection occt_draw_7_12_3 vtexorigin
7512 vtexorigin NameOfShape UOrigin VOrigin
7513 vtexorigin NameOfShape UVOrigin
7514 vtexorigin NameOfShape
7517 *UOrigin* and *VOrigin* allow placing the texture according to the U and V parameters individually, while *UVOrigin* applies the same position value to both parameters.
7519 The syntax without *UOrigin*, *VOrigin* or *UVOrigin* disables origin positioning.
7521 @subsubsection occt_draw_7_12_4 vtexrepeat
7525 vtexrepeat NameOfShape URepeat VRepeat
7526 vtexrepeat NameOfShape UVRepeat
7527 vtexrepeat NameOfShape
7530 *URepeat* and *VRepeat* allow repeating the texture along the U and V parameters individually, while *UVRepeat* applies the same number of repetitions for both parameters.
7532 The same syntax without *URepeat*, *VRepeat* or *UVRepeat* disables texture repetition.
7534 @subsubsection occt_draw_7_12_5 vtexdefault
7538 vtexdefault NameOfShape
7541 *Vtexdefault* sets or resets the texture mapping default parameters.
7545 * *URepeat = VRepeat = 1* no repetition
7546 * *UOrigin = VOrigin = 1* origin set at (0,0)
7547 * *UScale = VScale = 1* texture covers 100% of the face
7550 @section occt_draw_20 General Fuse Algorithm commands
7552 This chapter describes existing commands of Open CASCADE Draw Test Harness that are used for debugging of General Fuse Algorithm (GFA). It is also applicable for Boolean Operations Algorithm (BOA) and Partition Algorithm (PA) because these algorithms are subclasses of GFA.
7554 See @ref occt_user_guides__boolean_operations "Boolean operations" user's guide for the description of these algorithms.
7556 @subsection occt_draw_20_1 Definitions
7558 The following terms and definitions are used in this document:
7559 * **Objects** – list of shapes that are arguments of the algorithm.
7560 * **Tools** – list of shapes that are arguments of the algorithm. Difference between Objects and Tools is defined by specific requirements of the operations (Boolean Operations, Partition Operation).
7561 * **DS** – internal data structure used by the algorithm (*BOPDS_DS* object).
7562 * **PaveFiller** – intersection part of the algorithm (*BOPAlgo_PaveFiller* object).
7563 * **Builder** – builder part of the algorithm (*BOPAlgo_Builder* object).
7564 * **IDS Index** – the index of the vector *myLines*.
7566 @subsection occt_draw_20_2 General commands
7568 * **bclearobjects** - clears the list of Objects;
7569 * **bcleartools** - clears the list of Tools;
7570 * **baddobjects** *S1 S2...Sn* - adds shapes *S1, S2, ... Sn* as Objects;
7571 * **baddtools** *S1 S2...Sn* - adds shapes *S1, S2, ... Sn* as Tools;
7572 * **bfillds** - performs the Intersection Part of the Algorithm;
7573 * **bbuild** *r* - performs the Building Part of the Algorithm; *r* is the resulting shape.
7575 @subsection occt_draw_20_3 Commands for Intersection Part
7577 All commands listed below are available when the Intersection Part of the algorithm is done (i.e. after the command *bfillds*).
7579 @subsubsection occt_draw_20_3_1 bopds
7587 * all BRep shapes of arguments that are in the DS [default];
7588 * <i>–v</i> : only vertices of arguments that are in the DS;
7589 * <i>–e</i> : only edges of arguments that are in the DS;
7590 * <i>–f</i> : only faces of arguments that are in the DS.
7592 @subsubsection occt_draw_20_3_2 bopdsdump
7594 Prints contents of the DS.
7601 Ranges:2 number of ranges
7602 range: 0 33 indices for range 1
7603 range: 34 67 indices for range 2
7604 Shapes:68 total number of source shapes
7606 1 : SHELL { 2 12 22 26 30 32 }
7607 2 : FACE { 4 5 6 7 8 9 10 11 }
7608 3 : WIRE { 4 7 9 11 }
7616 @code 0 : SOLID { 1 } @endcode has the following meaning:
7617 * *0* – index in the DS;
7618 * *SOLID* – type of the shape;
7619 * <i>{ 1 }</i> – a DS index of the successors.
7621 @subsubsection occt_draw_20_3_3 bopindex
7627 Prints DS index of shape *S*.
7629 @subsubsection occt_draw_20_3_4 bopiterator
7636 Prints pairs of DS indices of source shapes that are intersected in terms of bounding boxes.
7638 <i>[t1 t2]</i> are types of the shapes:
7645 Draw[104]> bopiterator 6 4
7654 * *bopiterator 6 4* prints pairs of indices for types: edge/face;
7655 * *z58 z12* - DS indices of intersecting edge and face.
7658 @subsubsection occt_draw_20_3_5 bopinterf
7665 Prints contents of *myInterfTB* for the type of interference *t*:
7666 * *t=0* : vertex/vertex;
7667 * *t=1* : vertex/edge;
7668 * *t=2* : edge/edge;
7669 * *t=3* : vertex/face;
7670 * *t=4* : edge/face.
7674 Draw[108]> bopinterf 4
7675 EF: (58, 12, 68), (17, 56, 69), (19, 64, 70), (45, 26, 71), (29, 36, 72), (38, 32, 73), 6 EF found.
7678 Here, record <i>(58, 12, 68)</i> means:
7679 * *58* – a DS index of the edge;
7680 * *12* – a DS index of the face;
7681 * *68* – a DS index of the new vertex.
7683 @subsubsection occt_draw_20_3_6 bopsp
7685 Displays split edges.
7690 edge 58 : z58_74 z58_75
7691 edge 17 : z17_76 z17_77
7692 edge 19 : z19_78 z19_79
7693 edge 45 : z45_80 z45_81
7694 edge 29 : z29_82 z29_83
7695 edge 38 : z38_84 z38_85
7698 * *edge 58* – 58 is a DS index of the original edge.
7699 * *z58_74 z58_75* – split edges, where 74, 75 are DS indices of the split edges.
7701 @subsubsection occt_draw_20_3_7 bopcb
7708 Prints Common Blocks for:
7709 * all source edges (by default);
7710 * the source edge with the specified index *nE*.
7716 PB:{ E:71 orE:17 Pave1: { 68 3.000 } Pave2: { 18 10.000 } }
7720 This command dumps common blocks for the source edge with index 17.
7721 * *PB* – information about the Pave Block;
7722 * *71* – a DS index of the split edge
7723 * *17* – a DS index of the original edge
7724 * <i>Pave1 : { 68 3.000 }</i> – information about the Pave:
7725 * *68* – a DS index of the vertex of the pave
7726 * *3.000* – a parameter of vertex 68 on edge 17
7727 * *Faces: 36* – 36 is a DS index of the face the common block belongs to.
7730 @subsubsection occt_draw_20_3_8 bopfin
7737 Prints Face Info about IN-parts for the face with DS index *nF*.
7743 PB:{ E:71 orE:17 Pave1: { 68 3.000 } Pave2: { 18 10.000 } }
7744 PB:{ E:75 orE:19 Pave1: { 69 3.000 } Pave2: { 18 10.000 } }
7750 * <i>PB:{ E:71 orE:17 Pave1: { 68 3.000 } Pave2: { 18 10.000 } }</i> – information about the Pave Block;
7751 * <i>vrts In ... 18 – 18</i> a DS index of the vertex IN the face.
7753 @subsubsection occt_draw_20_3_9 bopfon
7759 Print Face Info about ON-parts for the face with DS index *nF*.
7765 PB:{ E:72 orE:38 Pave1: { 69 0.000 } Pave2: { 68 10.000 } }
7766 PB:{ E:76 orE:45 Pave1: { 69 0.000 } Pave2: { 71 10.000 } }
7767 PB:{ E:78 orE:43 Pave1: { 71 0.000 } Pave2: { 70 10.000 } }
7768 PB:{ E:74 orE:41 Pave1: { 68 0.000 } Pave2: { 70 10.000 } }
7773 * <i>PB:{ E:72 orE:38 Pave1: { 69 0.000 } Pave2: { 68 10.000 } }</i> – information about the Pave Block;
7774 * <i>vrts On: ... 68 69 70 71 – 68, 69, 70, 71 </i> DS indices of the vertices ON the face.
7776 @subsubsection occt_draw_20_3_10 bopwho
7783 Prints the information about the shape with DS index *nF*.
7791 * *rank: 0* – means that shape 5 results from the Argument with index 0.
7795 Draw[118]> bopwho 68
7798 FF curves: (12, 56),
7799 FF curves: (12, 64),
7802 This means that shape 68 is a result of the following interferences:
7803 * *EF: (58, 12)* – edge 58 / face 12
7804 * *FF curves: (12, 56)* – edge from the intersection curve between faces 12 and 56
7805 * *FF curves: (12, 64)* – edge from the intersection curve between faces 12 and 64
7807 @subsubsection occt_draw_20_3_11 bopnews
7814 * <i>-v</i> - displays all new vertices produced during the operation;
7815 * <i>-e</i> - displays all new edges produced during the operation.
7817 @subsection occt_draw_20_4 Commands for the Building Part
7819 The commands listed below are available when the Building Part of the algorithm is done (i.e. after the command *bbuild*).
7821 @subsubsection occt_draw_20_4_1 bopim
7828 Shows the compound of shapes that are images of shape *S* from the argument.
7831 @section occt_draw_8 Data Exchange commands
7833 This chapter presents some general information about Data Exchange (DE) operations.
7835 DE commands are intended for translation files of various formats (IGES,STEP) into OCCT shapes with their attributes (colors, layers etc.)
7837 This files include a number of entities. Each entity has its own number in the file which we call label and denote as # for a STEP file and D for an IGES file. Each file has entities called roots (one or more). A full description of such entities is contained in the Users' Guides
7838 * for <a href="user_guides__step.html#occt_step_1">STEP format</a> and
7839 * for <a href="user_guides__iges.html#occt_iges_1">IGES format</a>.
7841 Each Draw session has an interface model, which is a structure for keeping various information.
7843 The first step of translation is loading information from a file into a model.
7844 The second step is creation of an OpenCASCADE shape from this model.
7846 Each entity from a file has its own number in the model (num). During the translation a map of correspondences between labels(from file) and numbers (from model) is created.
7848 The model and the map are used for working with most of DE commands.
7850 @subsection occt_draw_8_1 IGES commands
7852 @subsubsection occt_draw_8_1_1 igesread
7856 igesread <file_name> <result_shape_name> [<selection>]
7859 Reads an IGES file to an OCCT shape. This command will interactively ask the user to select a set of entities to be converted.
7862 | N | Mode | Description |
7863 | :-- | :-- | :---------- |
7864 | 0 | End | finish conversion and exit igesbrep |
7865 | 1 | Visible roots | convert only visible roots |
7866 | 2 | All roots | convert all roots |
7867 | 3 | One entity | convert entity with number provided by the user |
7868 | 4 | Selection | convert only entities contained in selection |
7871 After the selected set of entities is loaded the user will be asked how loaded entities should be converted into OCCT shapes (e.g., one shape per root or one shape for all the entities). It is also possible to save loaded shapes in files, and to cancel loading.
7873 The second parameter of this command defines the name of the loaded shape. If several shapes are created, they will get indexed names. For instance, if the last parameter was *s*, they will be *s_1, ... s_N*.
7875 <i>\<selection\></i> specifies the scope of selected entities in the model, by default it is *xst-transferrable-roots*. If we use symbol <i>*</i> as <i>\<selection\></i> all roots will be translated.
7877 See also the detailed description of <a href="user_guides__iges.html#occt_iges_2_3_4">Selecting IGES entities</a>.
7881 # translation all roots from file
7882 igesread /disk01/files/model.igs a *
7885 @subsubsection occt_draw_8_1_2 tplosttrim
7889 tplosttrim [<IGES_type>]
7892 Sometimes the trimming contours of IGES faces (i.e., entity 141 for 143, 142 for 144) can be lost during translation due to fails. This command gives us a number of lost trims and the number of corresponding IGES entities.
7893 It outputs the rank and numbers of faces that lost their trims and their numbers for each type (143, 144, 510) and their total number. If a face lost several of its trims it is output only once.
7894 Optional parameter <i>\<IGES_type\></i> can be *0TrimmedSurface, BoundedSurface* or *Face* to specify the only type of IGES faces.
7898 tplosttrim TrimmedSurface
7901 @subsubsection occt_draw_8_1_3 brepiges
7905 brepiges <shape_name> <filename.igs>
7908 Writes an OCCT shape to an IGES file.
7912 # write shape with name aa to IGES file
7913 brepiges aa /disk1/tmp/aaa.igs
7914 == unit (write) : MM
7915 == mode write : Faces
7916 == To modifiy : command param
7917 == 1 Shapes written, giving 345 Entities
7918 == Now, to write a file, command : writeall filename
7919 == Output on file : /disk1/tmp/aaa.igs
7923 @subsection occt_draw_8_2 STEP commands
7925 These commands are used during the translation of STEP models.
7928 @subsubsection occt_draw_8_2_1 stepread
7932 stepread file_name result_shape_name [selection]
7935 Read a STEP file to an OCCT shape.
7936 This command will interactively ask the user to select a set of entities to be converted:
7938 | N | Mode | Description |
7939 | :---- | :---- | :---- |
7940 | 0 | End | Finish transfer and exit stepread |
7941 | 1 | root with rank 1 | Transfer first root |
7942 | 2 | root by its rank | Transfer root specified by its rank |
7943 | 3 | One entity | Transfer entity with a number provided by the user |
7944 | 4 | Selection | Transfer only entities contained in selection |
7946 After the selected set of entities is loaded the user will be asked how loaded entities should be converted into OCCT shapes.
7947 The second parameter of this command defines the name of the loaded shape. If several shapes are created, they will get indexed names. For instance, if the last parameter was *s*, they will be *s_1, ... s_N*.
7948 <i>\<selection\></i> specifies the scope of selected entities in the model. If we use symbol <i>*</i> as <i>\<selection\></i> all roots will be translated.
7950 See also the detailed description of <a href="user_guides__step.html#occt_step_2_3_6">Selecting STEP entities</a>.
7954 # translation all roots from file
7955 stepread /disk01/files/model.stp a *
7958 @subsubsection occt_draw_8_2_2 stepwrite
7962 stepwrite mode shape_name file_name
7965 Writes an OCCT shape to a STEP file.
7967 The following modes are available :
7968 * *a* - as is – mode is selected automatically depending on the type & geometry of the shape;
7969 * *m* - *manifold_solid_brep* or *brep_with_voids*
7970 * *f* - *faceted_brep*
7971 * *w* - *geometric_curve_set*
7972 * *s* - *shell_based_surface_model*
7974 For further information see <a href="#user_guides__step.html#occt_step_6_5">Writing a STEP file</a>.
7978 Let us write shape *a* to a STEP file in mode *0*.
7981 stepwrite 0 a /disk1/tmp/aaa.igs
7985 @subsection occt_draw_8_3 General commands
7987 These are auxilary commands used for the analysis of result of translation of IGES and STEP files.
7989 @subsubsection occt_draw_8_3_1 count
7993 count <counter> [<selection>]
7996 Calculates statistics on the entities in the model and outputs a count of entities.
7998 The optional selection argument, if specified, defines a subset of entities, which are to be taken into account. The first argument should be one of the currently defined counters.
8000 | Counter | Operation |
8001 | :-------- | :-------- |
8002 | xst-types | Calculates how many entities of each OCCT type exist |
8003 | step214-types | Calculates how many entities of each STEP type exist |
8010 @subsubsection occt_draw_8_3_2 data
8017 Obtains general statistics on the loaded data.
8018 The information printed by this command depends on the symbol specified.
8022 # print full information about warnings and fails
8027 | :------ | :------ |
8028 | g | Prints the information contained in the header of the file |
8029 | c or f | Prints messages generated during the loading of the STEP file (when the procedure of the integrity of the loaded data check is performed) and the resulting statistics (f works only with fail messages while c with both fail and warning messages) |
8030 | t | The same as c or f, with a list of failed or warned entities |
8031 | m or l | The same as t but also prints a status for each entity |
8032 | e | Lists all entities of the model with their numbers, types, validity status etc. |
8033 | R | The same as e but lists only root entities |
8037 @subsubsection occt_draw_8_3_3 elabel
8044 Entities in the IGES and STEP files are numbered in the succeeding order. An entity can be identified either by its number or by its label. Label is the letter ‘#'(for STEP, for IGES use ‘D’) followed by the rank. This command gives us a label for an entity with a known number.
8051 @subsubsection occt_draw_8_3_4 entity
8055 entity <#(D)>_or_<num> <level_of_information>
8058 The content of an IGES or STEP entity can be obtained by using this command.
8059 Entity can be determined by its number or label.
8060 <i>\<level_of_information\></i> has range [0-6]. You can get more information about this level using this command without parameters.
8064 # full information for STEP entity with label 84
8068 @subsubsection occt_draw_8_3_5 enum
8075 Prints a number for the entity with a given label.
8079 # give a number for IGES entity with label 21
8083 @subsubsection occt_draw_8_3_6 estatus
8087 estatus <#(D)>_or_<num>
8090 The list of entities referenced by a given entity and the list of entities referencing to it can be obtained by this command.
8097 @subsubsection occt_draw_8_3_7 fromshape
8101 fromshape <shape_name>
8104 Gives the number of an IGES or STEP entity corresponding to an OCCT shape. If no corresponding entity can be found and if OCCT shape is a compound the command explodes it to subshapes and try to find corresponding entities for them.
8111 @subsubsection occt_draw_8_3_8 givecount
8115 givecount <selection_name> [<selection_name>]
8119 Prints a number of loaded entities defined by the selection argument.
8120 Possible values of \<selection_name\> you can find in the “IGES FORMAT Users’s Guide”.
8124 givecount xst-model-roots
8127 @subsubsection occt_draw_8_3_9 givelist
8131 givelist <selection_name>
8134 Prints a list of a subset of loaded entities defined by the selection argument:
8135 | Selection | Description |
8136 | :-------- | :----------- |
8137 | xst-model-all | all entities of the model |
8138 | xst-model-roots | all roots |
8139 | xst-pointed | (Interactively) pointed entities (not used in DRAW) |
8140 | xst-transferrable-all | all transferable (recognized) entities |
8141 | xst-transferrable-roots | Transferable roots |
8146 # give a list of all entities of the model
8147 givelist xst-model-all
8150 @subsubsection occt_draw_8_3_10 listcount
8152 Syntax: listcount \<counter\> [\<selection\> ...]
8154 Prints a list of entities per each type matching the criteria defined by arguments.
8155 Optional <i>\<selection\></i> argument, if specified, defines a subset of entities, which are to be taken into account. Argument <i>\<counter\></i> should be one of the currently defined counters:
8157 | Counter | Operation |
8158 | :----- | :------ |
8159 | xst-types | Calculates how many entities of each OCCT type exist |
8160 | iges-types | Calculates how many entities of each IGES type and form exist |
8161 | iges-levels | Calculates how many entities lie in different IGES levels |
8168 @subsubsection occt_draw_8_3_11 listitems
8175 This command prints a list of objects (counters, selections etc.) defined in the current session.
8178 @subsubsection occt_draw_8_3_12 listtypes
8182 listtypes [<selection_name> ...]
8185 Gives a list of entity types which were encountered in the last loaded file (with a number of entities of each type). The list can be shown not for all entities but for a subset of them. This subset is defined by an optional selection argument.
8188 @subsubsection occt_draw_8_3_13 newmodel
8195 Clears the current model.
8198 @subsubsection occt_draw_8_3_14 param
8202 param [<parameter>] [<value>]
8205 This command is used to manage translation parameters.
8206 Command without arguments gives a full list of parameters with current values.
8207 Command with <i>\<parameter\></i> (without <i><value></i>) gives us the current value of this parameter and all possible values for it. Command with <i><value></i> sets this new value to <i>\<parameter\></i>.
8211 Let us get the information about possible schemes for writing STEP file :
8214 param write.step.schema
8217 @subsubsection occt_draw_8_3_15 sumcount
8221 sumcount <counter> [<selection> ...]
8224 Prints only a number of entities per each type matching the criteria defined by arguments.
8231 @subsubsection occt_draw_8_3_16 tpclear
8238 Clears the map of correspondences between IGES or STEP entities and OCCT shapes.
8242 @subsubsection occt_draw_8_3_17 tpdraw
8246 tpdraw <#(D)>_or_<num>
8254 @subsubsection occt_draw_8_3_18 tpent
8258 tpent <#(D)>_or_<num>
8261 Get information about the result of translation of the given IGES or STEP entity.
8268 @subsubsection occt_draw_8_3_19 tpstat
8272 tpstat [*|?]<symbol> [<selection>]
8276 Provides all statistics on the last transfer, including a list of transferred entities with mapping from IGES or STEP to OCCT types, as well as fail and warning messages. The parameter <i>\<symbol\></i> defines what information will be printed:
8278 * *g* - General statistics (a list of results and messages)
8279 * *c* - Count of all warning and fail messages
8280 * *C* - List of all warning and fail messages
8281 * *f* - Count of all fail messages
8282 * *F* - List of all fail messages
8283 * *n* - List of all transferred roots
8284 * *s* - The same, with types of source entity and the type of result
8285 * *b* - The same, with messages
8286 * *t* - Count of roots for geometrical types
8287 * *r* - Count of roots for topological types
8288 * *l* - The same, with the type of the source entity
8290 The sign \* before parameters *n, s, b, t, r* makes it work on all entities (not only on roots).
8292 The sign ? before *n, s, b, t* limits the scope of information to invalid entities.
8294 Optional argument \<selection\> can limit the action of the command to the selection, not to all entities.
8296 To get help, run this command without arguments.
8300 # translation ratio on IGES faces
8301 tpstat *l iges-faces
8304 @subsubsection occt_draw_8_3_20 xload
8311 This command loads an IGES or STEP file into memory (i.e. to fill the model with data from the file) without creation of an OCCT shape.
8315 xload /disk1/tmp/aaa.stp
8319 @subsection occt_draw_8_4 Overview of XDE commands
8321 These commands are used for translation of IGES and STEP files into an XCAF document (special document is inherited from CAF document and is intended for Extended Data Exchange (XDE) ) and working with it. XDE translation allows reading and writing of shapes with additional attributes – colors, layers etc. All commands can be divided into the following groups:
8322 * XDE translation commands
8323 * XDE general commands
8324 * XDE shape’s commands
8325 * XDE color’s commands
8326 * XDE layer’s commands
8327 * XDE property’s commands
8329 Reminding: All operations of translation are performed with parameters managed by command <a href="#occt_draw_8_3_14">the command *param*</a>.
8331 @subsubsection occt_draw_8_4_1 ReadIges
8335 ReadIges document file_name
8338 Reads information from an IGES file to an XCAF document.
8342 ReadIges D /disk1/tmp/aaa.igs
8343 ==> Document saved with name D
8346 @subsubsection occt_draw_8_4_2 ReadStep
8350 ReadStep <document> <file_name>
8353 Reads information from a STEP file to an XCAF document.
8357 ReadStep D /disk1/tmp/aaa.stp
8358 == Document saved with name D
8361 @subsubsection occt_draw_8_4_3 WriteIges
8365 WriteIges <document> <file_name>
8370 WriteIges D /disk1/tmp/aaa.igs
8373 @subsubsection occt_draw_8_4_4 WriteStep
8377 WriteStep <document> <file_name>
8380 Writes information from an XCAF document to a STEP file.
8384 WriteStep D /disk1/tmp/aaa.stp
8387 @subsubsection occt_draw_8_4_5 XFileCur
8394 Returns the name of file which is set as the current one in the Draw session.
8402 @subsubsection occt_draw_8_4_6 XFileList
8409 Returns a list all files that were transferred by the last transfer. This command is meant (assigned) for the assemble step file.
8414 ==> *as1-ct-Bolt.stp*
8415 ==> *as1-ct-L-Bracktet.stp*
8416 ==> *as1-ct-LBA.stp*
8417 ==> *as1-ct-NBA.stp*
8421 @subsubsection occt_draw_8_4_7 XFileSet
8428 Sets the current file taking it from the components list of the assemble file.
8432 XFileSet as1-ct-NBA.stp
8435 @subsubsection occt_draw_8_4_8 XFromShape
8442 This command is similar to <a href="#occt_draw_8_3_7">the command *fromshape*</a>, but gives additional information about the file name. It is useful if a shape was translated from several files.
8447 ==> Shape a: imported from entity 217:#26 in file as1-ct-Nut.stp
8450 @subsection occt_draw_8_5 XDE general commands
8452 @subsubsection occt_draw_8_5_1 XNewDoc
8459 Creates a new XCAF document.
8466 @subsubsection occt_draw_8_5_2 XShow
8470 XShow <document> [ <label1> … ]
8473 Shows a shape from a given label in the 3D viewer. If the label is not given – shows all shapes from the document.
8477 # show shape from label 0:1:1:4 from document D
8481 @subsubsection occt_draw_8_5_3 XStat
8488 Prints common information from an XCAF document.
8493 ==>Statistis of shapes in the document:
8497 ==>Total number of labels for shapes in the document = 32
8498 ==>Number of labels with name = 27
8499 ==>Number of labels with color link = 3
8500 ==Number of labels with layer link = 0
8501 ==>Statistis of Props in the document:
8502 ==>Number of Centroid Props = 5
8503 ==>Number of Volume Props = 5
8504 ==>Number of Area Props = 5
8505 ==>Number of colors = 4
8506 ==>BLUE1 RED YELLOW BLUE2
8507 ==>Number of layers = 0
8510 @subsubsection occt_draw_8_5_4 XWdump
8514 XWdump <document> <filename>
8517 Saves the contents of the viewer window as an image (XWD, png or BMP file).
8518 <i>\<filename\></i> must have a corresponding extention.
8522 XWdump D /disk1/tmp/image.png
8525 @subsubsection occt_draw_8_5_5 Xdump
8529 Xdump <document> [int deep {0|1}]
8532 Prints information about the tree structure of the document. If parameter 1 is given, then the tree is printed with a link to shapes.
8537 ==> ASSEMBLY 0:1:1:1 L-BRACKET(0xe8180448)
8538 ==> ASSEMBLY 0:1:1:2 NUT(0xe82151e8)
8539 ==> ASSEMBLY 0:1:1:3 BOLT(0xe829b000)
8540 ==> ASSEMBLY 0:1:1:4 PLATE(0xe8387780)
8541 ==> ASSEMBLY 0:1:1:5 ROD(0xe8475418)
8542 ==> ASSEMBLY 0:1:1:6 AS1(0xe8476968)
8543 ==> ASSEMBLY 0:1:1:7 L-BRACKET-ASSEMBLY(0xe8476230)
8544 ==> ASSEMBLY 0:1:1:1 L-BRACKET(0xe8180448)
8545 ==> ASSEMBLY 0:1:1:8 NUT-BOLT-ASSEMBLY(0xe8475ec0)
8546 ==> ASSEMBLY 0:1:1:2 NUT(0xe82151e8)
8547 ==> ASSEMBLY 0:1:1:3 BOLT(0xe829b000)
8551 @subsection occt_draw_8_6 XDE shape commands
8553 @subsubsection occt_draw_8_6_1 XAddComponent
8557 XAddComponent <document> <label> <shape>
8560 Adds a component shape to assembly.
8564 Let us add shape b as component shape to assembly shape from label *0:1:1:1*
8567 XAddComponent D 0:1:1:1 b
8570 @subsubsection occt_draw_8_6_2 XAddShape
8574 XAddShape <document> <shape> [makeassembly=1]
8577 Adds a shape (or an assembly) to a document. If this shape already exists in the document, then prints the label which points to it. By default, a new shape is added as an assembly (i.e. last parameter 1), otherwise it is necessary to pass 0 as the last parameter.
8581 # add shape b to document D
8584 # if pointed shape is compound and last parameter in
8585 # XAddShape command is used by default (1), then for
8586 # each subshapes new label is created
8589 @subsubsection occt_draw_8_6_3 XFindComponent
8593 XFindComponent <document> <shape>
8596 Prints a sequence of labels of the assembly path.
8603 @subsubsection occt_draw_8_6_4 XFindShape
8607 XFindShape <document> <shape>
8610 Finds and prints a label with an indicated top-level shape.
8617 @subsubsection occt_draw_8_6_5 XGetFreeShapes
8621 XGetFreeShapes <document> [shape_prefix]
8624 Print labels or create DRAW shapes for all free shapes in the document.
8625 If *shape_prefix* is absent – prints labels, else – creates DRAW shapes with names
8626 <i>shape_prefix</i>_num (i.e. for example: there are 3 free shapes and *shape_prefix* = a therefore shapes will be created with names a_1, a_2 and a_3).
8628 **Note**: a free shape is a shape to which no other shape refers to.
8633 == 0:1:1:6 0:1:1:10 0:1:1:12 0:1:1:13
8636 == sh_1 sh_2 sh_3 sh_4
8639 @subsubsection occt_draw_8_6_6 XGetOneShape
8643 XGetOneShape <shape> <document>
8646 Creates one DRAW shape for all free shapes from a document.
8653 @subsubsection occt_draw_8_6_7 XGetReferredShape
8657 XGetReferredShape <document> <label>
8660 Prints a label that contains a top-level shape that corresponds to a shape at a given label.
8664 XGetReferredShape D 0:1:1:1:1
8667 @subsubsection occt_draw_8_6_8 XGetShape
8671 XGetShape <result> <document> <label>
8674 Puts a shape from the indicated label in document to result.
8678 XGetShape b D 0:1:1:3
8681 @subsubsection occt_draw_8_6_9 XGetTopLevelShapes
8685 XGetTopLevelShapes <document>
8688 Prints labels that contain top-level shapes.
8692 XGetTopLevelShapes D
8693 == 0:1:1:1 0:1:1:2 0:1:1:3 0:1:1:4 0:1:1:5 0:1:1:6 0:1:1:7
8697 @subsubsection occt_draw_8_6_10 XLabelInfo
8701 XLabelInfo <document> <label>
8704 Prints information about a shape, stored at an indicated label.
8708 XLabelInfo D 0:1:1:6
8709 ==> There are TopLevel shapes. There is an Assembly. This Shape is not used.
8712 @subsubsection occt_draw_8_6_11 XNewShape
8716 XNewShape <document>
8719 Creates a new empty top-level shape.
8726 @subsubsection occt_draw_8_6_12 XRemoveComponent
8730 XRemoveComponent <document> <label>
8733 Removes a component from the components label.
8737 XRemoveComponent D 0:1:1:1:1
8740 @subsubsection occt_draw_8_6_13 XRemoveShape
8744 XRemoveShape <document> <label>
8747 Removes a shape from a document (by it’s label).
8751 XRemoveShape D 0:1:1:2
8754 @subsubsection occt_draw_8_6_14 XSetShape
8758 XSetShape <document> <label> <shape>
8761 Sets a shape at the indicated label.
8765 XSetShape D 0:1:1:3 b
8769 @subsection occt_draw_8_7_ XDE color commands
8771 @subsubsection occt_draw_8_7_1 XAddColor
8775 XAddColor <document> <R> <G> <B>
8778 Adds color in document to the color table. Parameters R,G,B are real.
8782 XAddColor D 0.5 0.25 0.25
8785 @subsubsection occt_draw_8_7_2 XFindColor
8789 XFindColor <document> <R> <G> <B>
8792 Finds a label where the indicated color is situated.
8796 XFindColor D 0.25 0.25 0.5
8800 @subsubsection occt_draw_8_7_3 XGetAllColors
8804 XGetAllColors <document>
8807 Prints all colors that are defined in the document.
8812 ==> RED DARKORANGE BLUE1 GREEN YELLOW3
8815 @subsubsection occt_draw_8_7_4 XGetColor
8819 XGetColor <document> <label>
8822 Returns a color defined at the indicated label from the color table.
8830 @subsubsection occt_draw_8_7_5 XGetObjVisibility
8834 XGetObjVisibility <document> {<label>|<shape>}
8837 Returns the visibility of a shape.
8841 XGetObjVisibility D 0:1:1:4
8844 @subsubsection occt_draw_8_7_6 XGetShapeColor
8848 XGetShapeColor <document> <label> <colortype(s|c)>
8851 Returns the color defined by label. If <i>colortype</i>=’s’ – returns surface color, else – returns curve color.
8855 XGetShapeColor D 0:1:1:4 c
8858 @subsubsection occt_draw_8_7_7 XRemoveColor
8862 XRemoveColor <document> <label>
8865 Removes a color from the color table in a document.
8869 XRemoveColor D 0:1:2:1
8872 @subsubsection occt_draw_8_7_8 XSetColor
8876 XSetColor <document> {<label>|<shape>} <R> <G> <B>
8879 Sets an RGB color to a shape given by label.
8883 XsetColor D 0:1:1:4 0.5 0.5 0.
8886 @subsubsection occt_draw_8_7_9 XSetObjVisibility
8890 XSetObjVisibility <document> {<label>|<shape>} {0|1}
8893 Sets the visibility of a shape.
8897 # set shape from label 0:1:1:4 as invisible
8898 XSetObjVisibility D 0:1:1:4 0
8901 @subsubsection occt_draw_8_7_10 XUnsetColor
8905 XUnsetColor <document> {<label>|<shape>} <colortype>
8908 Unset a color given type (‘s’ or ‘c’) for the indicated shape.
8912 XUnsetColor D 0:1:1:4 s
8916 @subsection occt_draw_8_8_ XDE layer commands
8918 @subsubsection occt_draw_8_8_1 XAddLayer
8922 XAddLayer <document> <layer>
8925 Adds a new layer in an XCAF document.
8932 @subsubsection occt_draw_8_8_2 XFindLayer
8936 XFindLayer <document> <layer>
8939 Prints a label where a layer is situated.
8947 @subsubsection occt_draw_8_8_3 XGetAllLayers
8951 XGetAllLayers <document>
8954 Prints all layers in an XCAF document.
8959 == *0:1:1:3* *Bolt* *0:1:1:9*
8962 @subsubsection occt_draw_8_8_4 XGetLayers
8966 XGetLayers <document> {<shape>|<label>}
8969 Returns names of layers, which are pointed to by links of an indicated shape.
8973 XGetLayers D 0:1:1:3
8977 @subsubsection occt_draw_8_8_5 XGetOneLayer
8981 XGetOneLayer <document> <label>
8984 Prints the name of a layer at a given label.
8988 XGetOneLayer D 0:1:3:2
8991 @subsubsection occt_draw_8_8_6 XIsVisible
8995 XIsVisible <document> {<label>|<layer>}
8998 Returns 1 if the indicated layer is visible, else returns 0.
9002 XIsVisible D 0:1:3:1
9005 @subsubsection occt_draw_8_8_7 XRemoveAllLayers
9009 XRemoveAllLayers <document>
9012 Removes all layers from an XCAF document.
9019 @subsubsection occt_draw_8_8_8 XRemoveLayer
9023 XRemoveLayer <document> {<label>|<layer>}
9026 Removes the indicated layer from an XCAF document.
9030 XRemoveLayer D layer2
9033 @subsubsection occt_draw_8_8_9 XSetLayer
9037 XSetLayer XSetLayer <document> {<shape>|<label>} <layer> [shape_in_one_layer {0|1}]
9041 Sets a reference between a shape and a layer (adds a layer if it is necessary).
9042 Parameter <i>\<shape_in_one_layer\></i> shows whether a shape could be in a number of layers or only in one (0 by default).
9046 XSetLayer D 0:1:1:2 layer2
9049 @subsubsection occt_draw_8_8_10 XSetVisibility
9053 XSetVisibility <document> {<label>|<layer>} <isvisible {0|1}>
9056 Sets the visibility of a layer.
9060 # set layer at label 0:1:3:2 as invisible
9061 XSetVisibility D 0:1:3:2 0
9064 @subsubsection occt_draw_8_8_11 XUnSetAllLayers
9068 XUnSetAllLayers <document> {<label>|<shape>}
9071 Unsets a shape from all layers.
9075 XUnSetAllLayers D 0:1:1:2
9078 @subsubsection occt_draw_8_8_12 XUnSetLayer
9082 XUnSetLayer <document> {<label>|<shape>} <layer>
9085 Unsets a shape from the indicated layer.
9089 XUnSetLayer D 0:1:1:2 layer1
9092 @subsection occt_draw_8_9 XDE property commands
9094 @subsubsection occt_draw_8_9_1 XCheckProps
9098 XCheckProps <document> [ {0|deflection} [<shape>|<label>] ]
9101 Gets properties for a given shape (*volume*, *area* and <i>centroid</i>) and compares them with the results after internal calculations. If the second parameter is 0, the standard OCCT tool is used for the computation of properties. If the second parameter is not 0, it is processed as a deflection. If the deflection is positive the computation is done by triangulations, if it is negative – meshing is forced.
9105 # check properties for shapes at label 0:1:1:1 from
9106 # document using standard Open CASCADE Technology tools
9107 XCheckProps D 0 0:1:1:1
9108 == Label 0:1:1:1 ;L-BRACKET*
9109 == Area defect: -0.0 ( 0%)
9110 == Volume defect: 0.0 ( 0%)
9111 == CG defect: dX=-0.000, dY=0.000, dZ=0.000
9114 @subsubsection occt_draw_8_9_2 XGetArea
9118 XGetArea <document> {<shape>|<label>}
9121 Returns the area of a given shape.
9126 == 24628.31815094999
9129 @subsubsection occt_draw_8_9_3 XGetCentroid
9133 XGetCentroid <document> {<shape>|<label>}
9136 Returns the center of gravity coordinates of a given shape.
9140 XGetCentroid D 0:1:1:1
9143 @subsubsection occt_draw_8_9_4 XGetVolume
9147 XGetVolume <document> {<shape>|<label>}
9150 Returns the volume of a given shape.
9154 XGetVolume D 0:1:1:1
9157 @subsubsection occt_draw_8_9_5 XSetArea
9161 XSetArea <document> {<shape>|<label>} <area>
9164 Sets new area to attribute list ??? given shape.
9168 XSetArea D 0:1:1:1 2233.99
9171 @subsubsection occt_draw_8_9_6 XSetCentroid
9175 XSetCentroid <document> {<shape>|<label>} <x> <y> <z>
9178 Sets new center of gravity to the attribute list given shape.
9182 XSetCentroid D 0:1:1:1 0. 0. 100.
9185 @subsubsection occt_draw_8_9_7 XSetMaterial
9189 XSetMaterial <document> {<shape>|<label>} <name> <density(g/cu sm)>
9192 Adds a new label with material into the material table in a document, and adds a link to this material to the attribute list of a given shape or a given label. The last parameter sets the density of a pointed material.
9196 XSetMaterial D 0:1:1:1 Titanium 8899.77
9199 @subsubsection occt_draw_8_9_8 XSetVolume
9203 XSetVolume <document> {<shape>|<label>} <volume>
9206 Sets new volume to the attribute list ??? given shape.
9210 XSetVolume D 0:1:1:1 444555.33
9213 @subsubsection occt_draw_8_9_9 XShapeMassProps
9217 XShapeMassProps <document> [ <deflection> [{<shape>|<label>}] ]
9220 Computes and returns real mass and real center of gravity for a given shape or for all shapes in a document. The second parameter is used for calculation of the volume and CG(center of gravity). If it is 0, then the standard CASCADE tool (geometry) is used for computation, otherwise - by triangulations with a given deflection.
9225 == Shape from label : 0:1:1:1
9226 == Mass = 193.71681469282299
9227 == CenterOfGravity X = 14.594564763807696,Y =
9228 20.20271885211281,Z = 49.999999385313245
9229 == Shape from label : 0:1:1:2 not have a mass
9233 @subsubsection occt_draw_8_9_10 XShapeVolume
9237 XShapeVolume <shape> <deflection>
9240 Calculates the real volume of a pointed shape with a given deflection.
9247 @section occt_draw_9 Shape Healing commands
9251 @subsection occt_draw_9_1 General commands
9253 @subsubsection occt_draw_9_1_1 bsplres
9257 bsplres <result> <shape> <tol3d> <tol2d< <reqdegree> <reqnbsegments> <continuity3d> <continuity2d> <PriorDeg> <RationalConvert>
9260 Performs approximations of a given shape (BSpline curves and surfaces or other surfaces) to BSpline with given required parameters. The specified continuity can be reduced if the approximation with a specified continuity was not done successfully. Results are put into the shape, which is given as a parameter result. For a more detailed description see the ShapeHealing User’s Guide (operator: **BSplineRestriction**).
9262 @subsubsection occt_draw_9_1_2 checkfclass2d
9266 checkfclass2d <face> <ucoord> <vcoord>
9269 Shows where a point which is given by coordinates is located in relation to a given face – outbound, inside or at the bounds.
9273 checkfclass2d f 10.5 1.1
9277 @subsubsection occt_draw_9_1_3 checkoverlapedges
9281 checkoverlapedges <edge1> <edge2> [<toler> <domaindist>]
9284 Checks the overlapping of two given edges. If the distance between two edges is less than the given value of tolerance then edges are overlapped. Parameter \<domaindist\> sets length of part of edges on which edges are overlapped.
9288 checkoverlapedges e1 e2
9291 @subsubsection occt_draw_9_1_4 comtol
9295 comptol <shape> [nbpoints] [prefix]
9298 Compares the real value of tolerance on curves with the value calculated by standard (using 23 points). The maximal value of deviation of 3d curve from pcurve at given simple points is taken as a real value (371 is by default). Command returns the maximal, minimal and average value of tolerance for all edges and difference between real values and set values. Edges with the maximal value of tolerance and relation will be saved if the ‘prefix’ parameter is given.
9304 ==> Edges tolerance computed by 871 points:
9305 ==> MAX=8.0001130696523449e-008 AVG=6.349346868091096e-009 MIN=0
9306 ==> Relation real tolerance / tolerance set in edge
9307 ==> MAX=0.80001130696523448 AVG=0.06349345591805905 MIN=0
9308 ==> Edge with max tolerance saved to t_edge_tol
9309 ==> Concerned faces saved to shapes t_1, t_2
9312 @subsubsection occt_draw_9_1_5 convtorevol
9316 convtorevol <result> <shape>
9319 Converts all elementary surfaces of a given shape into surfaces of revolution.
9320 Results are put into the shape, which is given as the <i>\<result\></i> parameter.
9327 @subsubsection occt_draw_9_1_6 directfaces
9331 directfaces <result> <shape>
9334 Converts indirect surfaces and returns the results into the shape, which is given as the result parameter.
9341 @subsubsection occt_draw_9_1_7 expshape
9345 expshape <shape> <maxdegree> <maxseg>
9348 Gives statistics for a given shape. This test command is working with Bezier and BSpline entities.
9353 ==> Number of Rational Bspline curves 128
9354 ==> Number of Rational Bspline pcurves 48
9357 @subsubsection occt_draw_9_1_8 fixsmall
9361 fixsmall <result> <shape> [<toler>=1.]
9364 Fixes small edges in given shape by merging adjacent edges with agiven tolerance. Results are put into the shape, which is given as the result parameter.
9371 @subsubsection occt_draw_9_1_9 fixsmalledges
9375 fixsmalledges <result> <shape> [<toler> <mode> <maxangle>]
9378 Searches at least one small edge at a given shape. If such edges have been found, then small edges are merged with a given tolerance. If parameter <i>\<mode\></i> is equal to *Standard_True* (can be given any values, except 2), then small edges, which can not be merged, are removed, otherwise they are to be kept (*Standard_False* is used by default). Parameter <i>\<maxangle\></i> sets a maximum possible angle for merging two adjacent edges, by default no limit angle is applied (-1). Results are put into the shape, which is given as parameter result.
9382 fixsmalledges r a 0.1 1
9385 @subsubsection occt_draw_9_1_10 fixshape
9389 fixshape <result> <shape> [<preci> [<maxpreci>]] [{switches}]
9392 Performs fixes of all sub-shapes (such as *Solids*, *Shells*, *Faces*, *Wires* and *Edges*) of a given shape. Parameter <i>\<preci\></i> sets a basic precision value, <i>\<maxpreci\></i> sets the maximal allowed tolerance. Results are put into the shape, which is given as parameter result. <b>{switches}</b> allows to tune parameters of ShapeFix
9394 The following syntax is used:
9395 * <i>\<symbol\></i> may be
9396 * "-" to set parameter off,
9398 * "*" to set default
9399 * <i>\<parameter\></i> is identified by letters:
9400 * l - FixLackingMode
9401 * o - FixOrientationMode
9402 * h - FixShiftedMode
9403 * m - FixMissingSeamMode
9404 * d - FixDegeneratedMode
9406 * i - FixSelfIntersectionMode
9407 * n - FixNotchedEdgesMode
9408 For enhanced message output, use switch '+?'
9415 @subsubsection occt_draw_9_1_11 fixwgaps
9419 fixwgaps <result> <shape> [<toler>=0]
9422 Fixes gaps between ends of curves of adjacent edges (both 3d and pcurves) in wires in a given shape with a given tolerance. Results are put into the shape, which is given as parameter result.
9429 @subsubsection occt_draw_9_1_12 offsetcurve, offset2dcurve
9433 offsetcurve <result> <curve> <offset> <direction(as point)>
9434 offset2dcurve <result> <curve> <offset>
9437 **offsetcurve** works with the curve in 3d space, **offset2dcurve** in 2d space.
9439 Both commands are intended to create a new offset curve by copying the given curve to distance, given by parameter <i>\<offset\></i>. Parameter <i>\<direction\></i> defines direction of the offset curve. It is created as a point. For correct work of these commands the direction of normal of the offset curve must be perpendicular to the plane, the basis curve is located there. Results are put into the curve, which is given as parameter <i>\<result\></i>.
9444 offsetcurve r c 20 pp
9447 @subsubsection occt_draw_9_1_13 projcurve
9451 projcurve <edge>|<curve3d>|<curve3d first last> <X> <Y> <Z>
9454 **projcurve** returns the projection of a given point on a given curve. The curve may be defined by three ways: by giving the edge name, giving the 3D curve and by giving the unlimited curve and limiting it by pointing its start and finish values.
9459 ==Edge k_1 Params from 0 to 1.3
9460 ==Precision (BRepBuilderAPI) : 9.9999999999999995e-008 ==Projection : 0 1 5
9461 ==Result : 0 1.1000000000000001 0
9462 ==Param = -0.20000000000000001 Gap = 5.0009999000199947
9465 @subsubsection occt_draw_9_1_14 projface
9469 projface <face> <X> <Y> [<Z>]
9472 Returns the projection of a given point to a given face in 2d or 3d space. If two coordinates (2d space) are given then returns coordinates projection of this point in 3d space and vice versa.
9476 projface a_1 10.0 0.0
9477 == Point UV U = 10 V = 0
9478 == = proj X = -116 Y = -45 Z = 0
9481 @subsubsection occt_draw_9_1_15 scaleshape
9485 scaleshape <result> <shape> <scale>
9488 Returns a new shape, which is the result of scaling of a given shape with a coefficient equal to the parameter <i>\<scale\></i>. Tolerance is calculated for the new shape as well.
9492 scaleshape r a_1 0.8
9495 @subsubsection occt_draw_9_1_16 settolerance
9499 settolerance <shape> [<mode>=v-e-w-f-a] <val>(fix value) or
9503 Sets new values of tolerance for a given shape. If the second parameter <i>mode</i> is given, then the tolerance value is set only for these sub shapes.
9507 settolerance a 0.001
9510 @subsubsection occt_draw_9_1_17 splitface
9514 splitface <result> <face> [u usplit1 usplit2...] [v vsplit1 vsplit2 ...]
9517 Splits a given face in parametric space and puts the result into the given parameter <i>\<result\></i>.
9518 Returns the status of split face.
9522 # split face f by parameter u = 5
9524 ==> Splitting by U: ,5
9528 @subsubsection occt_draw_9_1_18 statshape
9532 statshape <shape> [particul]
9535 Returns the number of sub-shapes, which compose the given shape. For example, the number of solids, number of faces etc. It also returns the number of geometrical objects or sub-shapes with a specified type, example, number of free faces, number of C0
9536 surfaces. The last parameter becomes out of date.
9543 ==> 402 Edge (oriented)
9544 ==> 402 Edge (Shared)
9547 ==> 804 Vertex (Oriented)
9548 ==> 402 Vertex (Shared)
9550 ==> 4 Face with more than one wire
9551 ==> 34 bspsur: BSplineSurface
9554 @subsubsection occt_draw_9_1_19 tolerance
9558 tolerance <shape> [<mode>:D v e f c] [<tolmin> <tolmax>:real]
9561 Returns tolerance (maximal, avg and minimal values) of all given shapes and tolerance of their *Faces*, *Edges* and *Vertices*. If parameter <i>\<tolmin\></i> or <i>\<tolmax\></i> or both of them are given, then sub-shapes are returned as a result of analys of this shape, which satisfy the given tolerances. If a particular value of entity ((**D**)all shapes (**v**) *vertices* (**e**) *edges* (**f**) *faces* (**c**) *combined* (*faces*)) is given as the second parameter then only this group will be analyzed for tolerance.
9566 ==> Tolerance MAX=0.31512672416608001 AVG=0.14901359484722074 MIN=9.9999999999999995e-08
9567 ==> FACE : MAX=9.9999999999999995e-08 AVG=9.9999999999999995e-08 MIN=9.9999999999999995e-08
9568 ==> EDGE : MAX=0.31512672416608001 AVG=0.098691334511810405 MIN=9.9999999999999995e-08
9569 ==> VERTEX : MAX=0.31512672416608001 AVG=0.189076074499648 MIN=9.9999999999999995e-08
9571 tolerance a v 0.1 0.001
9572 ==> Analysing Vertices gives 6 Shapes between tol1=0.10000000000000001 and tol2=0.001 , named tol_1 to tol_6
9576 @subsection occt_draw_9_2 Conversion commands
9578 @subsubsection occt_draw_9_2_1 DT_ClosedSplit
9582 DT_ClosedSplit <result> <shape>
9585 Divides all closed faces in the shape (for example cone) and returns result of given shape into shape, which is given as parameter result. Number of faces in resulting shapes will be increased.
9586 Note: Closed face – it’s face with one or more seam.
9593 @subsubsection occt_draw_9_2_2 DT_ShapeConvert, DT_ShapeConvertRev
9597 DT_ShapeConvert <result> <shape> <convert2d> <convert3d>
9598 DT_ShapeConvertRev <result> <shape> <convert2d> <convert3d>
9601 Both commands are intended for the conversion of 3D, 2D curves to Bezier curves and surfaces to Bezier based surfaces. Parameters convert2d and convert3d take on a value 0 or 1. If the given value is 1, then the conversion will be performed, otherwise it will not be performed. The results are put into the shape, which is given as parameter Result. Command *DT_ShapeConvertRev* differs from *DT_ShapeConvert* by converting all elementary surfaces into surfaces of revolution first.
9605 DT_ShapeConvert r a 1 1
9609 @subsubsection occt_draw_9_2_3 DT_ShapeDivide
9613 DT_ShapeDivide <result> <shape> <tol>
9616 Divides the shape with C1 criterion and returns the result of geometry conversion of a given shape into the shape, which is given as parameter result. This command illustrates how class *ShapeUpgrade_ShapeDivideContinuity* works. This class allows to convert geometry with a continuity less than the specified continuity to geometry with target continuity. If conversion is not possible then the geometrical object is split into several ones, which satisfy the given tolerance. It also returns the status shape splitting:
9617 * OK : no splitting was done
9618 * Done1 : Some edges were split
9619 * Done2 : Surface was split
9620 * Fail1 : Some errors occurred
9624 DT_ShapeDivide r a 0.001
9628 @subsubsection occt_draw_9_2_4 DT_SplitAngle
9632 DT_SplitAngle <result> <shape> [MaxAngle=95]
9635 Works with all revolved surfaces, like cylinders, surfaces of revolution, etc. This command divides given revolved surfaces into segments so that each resulting segment covers not more than the given *MaxAngle* degrees and puts the result of splitting into the shape, which is given as parameter result. Values of returned status are given above.
9636 This command illustrates how class *ShapeUpgrade_ShapeDivideAngle* works.
9644 @subsubsection occt_draw_9_2_5 DT_SplitCurve
9648 DT_SplitCurve <curve> <tol> <split(0|1)>
9651 Divides the 3d curve with C1 criterion and returns the result of splitting of the given curve into a new curve. If the curve had been divided by segments, then each segment is put to an individual result. This command can correct a given curve at a knot with the given tolerance, if it is impossible, then the given surface is split at that knot. If the last parameter is 1, then 5 knots are added at the given curve, and its surface is split by segments, but this will be performed not for all parametric spaces.
9658 @subsubsection occt_draw_9_2_6 DT_SplitCurve2d
9662 DT_SplitCurve2d Curve Tol Split(0/1)
9665 Works just as **DT_SplitCurve** (see above), only with 2d curve.
9672 @subsubsection occt_draw_9_2_7 DT_SplitSurface
9676 DT_SplitSurface <result> <Surface|GridSurf> <tol> <split(0|1)>
9679 Divides surface with C1 criterion and returns the result of splitting of a given surface into surface, which is given as parameter result. If the surface has been divided into segments, then each segment is put to an individual result. This command can correct a given C0 surface at a knot with a given tolerance, if it is impossible, then the given surface is split at that knot. If the last parameter is 1, then 5 knots are added to the given surface, and its surface is split by segments, but this will be performed not for all parametric spaces.
9685 # split surface with name "su"
9686 DT_SplitSurface res su 0.1 1
9688 ==> appel a SplitSurface::Init
9689 ==> appel a SplitSurface::Build
9690 ==> appel a SplitSurface::GlobalU/VKnots
9691 ==> nb GlobalU;nb GlobalV=7 2 0 1 2 3 4 5 6.2831853072 0 1
9692 ==> appel a Surfaces
9693 ==> transfert resultat
9694 ==> res1_1_1 res1_2_1 res1_3_1 res1_4_1 res1_5_1 res1_6_1
9698 @subsubsection occt_draw_9_2_8 DT_ToBspl
9702 DT_ToBspl <result> <shape>
9705 Converts a surface of linear extrusion, revolution and offset surfaces into BSpline surfaces. Returns the result into the shape, which is given as parameter result.
9710 == error = 5.20375663162094e-08 spans = 10
9711 == Surface is aproximated with continuity 2
9714 @section occt_draw_10 Performance evaluation commands
9717 @subsection occt_draw_10_1 VDrawSphere
9721 vdrawsphere shapeName Fineness [X=0.0 Y=0.0 Z=0.0] [Radius=100.0] [ToEnableVBO=1] [NumberOfViewerUpdate=1] [ToShowEdges=0]
9724 Calculates and displays in a given number of steps a sphere with given coordinates, radius and fineness. Returns the information about the properties of the sphere, the time and the amount of memory required to build it.
9726 This command can be used for visualization performance evaluation instead of the outdated Visualization Performance Meter.
9730 vdrawsphere s 200 1 1 1 500 1
9731 == Compute Triangulation...
9732 == NumberOfPoints: 39602
9733 == NumberOfTriangles: 79200
9734 == Amount of memory required for PolyTriangulation without Normals: 2 Mb
9735 == Amount of memory for colors: 0 Mb
9736 == Amount of memory for PolyConnect: 1 Mb
9737 == Amount of graphic card memory required: 2 Mb
9738 == Number of scene redrawings: 1
9739 == CPU user time: 15.6000999999998950 msec
9740 == CPU system time: 0.0000000000000000 msec
9741 == CPU average time of scene redrawing: 15.6000999999998950 msec
9745 @section occt_draw_11 Extending Test Harness with custom commands
9748 The following chapters explain how to extend Test Harness with custom commands and how to activate them using a plug-in mechanism.
9751 @subsection occt_draw_11_1 Custom command implementation
9753 Custom command implementation has not undergone any changes since the introduction of the plug-in mechanism. The syntax of every command should still be like in the following example.
9757 static Standard_Integer myadvcurve(Draw_Interpretor& di, Standard_Integer n, char** a)
9763 For examples of existing commands refer to Open CASCADE Technology (e.g. GeomliteTest.cxx).
9766 @subsection occt_draw_11_2 Registration of commands in Test Harness
9768 To become available in the Test Harness the custom command must be registered in it. This should be done as follows.
9772 void MyPack::CurveCommands(Draw_Interpretor& theCommands)
9775 char* g = "Advanced curves creation";
9777 theCommands.Add ( "myadvcurve", "myadvcurve name p1 p2 p3 – Creates my advanced curve from points",
9778 __FILE__, myadvcurve, g );
9783 @subsection occt_draw_11_3 Creating a toolkit (library) as a plug-in
9785 All custom commands are compiled and linked into a dynamic library (.dll on Windows, or .so on Unix/Linux). To make Test Harness recognize it as a plug-in it must respect certain conventions. Namely, it must export function *PLUGINFACTORY()* accepting the Test Harness interpreter object (*Draw_Interpretor*). This function will be called when the library is dynamically loaded during the Test Harness session.
9787 This exported function *PLUGINFACTORY()* must be implemented only once per library.
9789 For convenience the *DPLUGIN* macro (defined in the *Draw_PluginMacro.hxx* file) has been provided. It implements the *PLUGINFACTORY()* function as a call to the *Package::Factory()* method and accepts *Package* as an argument. Respectively, this *Package::Factory()* method must be implemented in the library and activate all implemented commands.
9793 #include <Draw_PluginMacro.hxx>
9795 void MyPack::Factory(Draw_Interpretor& theDI)
9799 MyPack::CurveCommands(theDI);
9803 // Declare entry point PLUGINFACTORY
9807 @subsection occt_draw_11_4 Creation of the plug-in resource file
9809 As mentioned above, the plug-in resource file must be compliant with Open CASCADE Technology requirements (see *Resource_Manager.cdl* file for details). In particular, it should contain keys separated from their values by a colon (;:;).
9810 For every created plug-in there must be a key. For better readability and comprehension it is recommended to have some meaningful name.
9811 Thus, the resource file must contain a line mapping this name (key) to the library name. The latter should be without file extension (.dll on Windows, .so on Unix/Linux) and without the ;lib; prefix on Unix/Linux.
9812 For several plug-ins one resource file can be created. In such case, keys denoting plug-ins can be combined into groups, these groups - into their groups and so on (thereby creating some hierarchy). Any new parent key must have its value as a sequence of child keys separated by spaces, tabs or commas. Keys should form a tree without cyclic dependencies.
9814 **Examples** (file MyDrawPlugin):
9816 ! Hierarchy of plug-ins
9817 ALL : ADVMODELING, MESHING
9819 ADVMODELING : ADVSURF, ADVCURV
9821 ! Mapping from naming to toolkits (libraries)
9822 ADVSURF : TKMyAdvSurf
9823 ADVCURV : TKMyAdvCurv
9827 For other examples of the plug-in resource file refer to the <a href="#occt_draw_1_3_2">Plug-in resource file</a> chapter above or to the <i>$CASROOT/src/DrawPlugin</i> file shipped with Open CASCADE Technology.
9830 @subsection occt_draw_11_5 Dynamic loading and activation
9832 Loading a plug-in and activating its commands is described in the <a href="#occt_draw_1_3_3">Activation of the commands implemented in the plug-in</a> chapter.
9834 The procedure consists in defining the system variables and using the pload commands in the Test Harness session.
9838 Draw[]> set env(CSF_MyDrawPluginDefaults) /users/test
9839 Draw[]> pload -MyDrawPlugin ALL