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**). It provides basic documentation on using Draw. For advanced information on Draw and its applications, see our offerings on our web site at <a href="http://www.opencascade.org/support/training">http://www.opencascade.org/support/training</a>
10 Draw is a command interpreter based on TCL and a graphical system used to test and demonstrate Open CASCADE Technology modeling libraries.
13 @subsection occt_draw_1_1 Overview
15 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.
17 Draw can be used interactively to create, display and modify objects such as curves, surfaces and topological shapes.
19 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.
23 * A command interpreter based on the TCL command language.
24 * A 3d graphic viewer based on the X system.
25 * A basic set of commands covering scripts, variables and graphics.
26 * 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.
27 * A set of topological commands allowing the user to create and modify BRep shapes and to use the OCCT topology algorithms.
30 There is also a set of commands for each delivery unit in the modeling libraries:
39 @subsection occt_draw_1_2 Contents of this documentation
41 This documentation describes:
43 * The command language.
44 * The basic set of commands.
45 * The graphical commands.
46 * The Geometry set of commands.
47 * The Topology set of commands.
49 This document does not describe other sets of commands and does not explain how to extend Draw using C++.
51 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.
57 Terminates the Draw, TCL session. If the commands are read from a file using the source command, this will terminate the file.
62 # this is a very short example
67 @subsection occt_draw_1_3 Getting started
69 Install Draw and launch Emacs. Get a command line in Emacs using *Esc x *and key in *woksh*.
71 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.
73 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.
75 @subsubsection occt_draw_1_3_1 Launching DRAW Test Harness
77 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).
80 @subsubsection occt_draw_1_3_2 Plug-in resource file
82 Open CASCADE Technology is shipped with the DrawPlugin resource file located in the <i>$CASROOT/src/DrawResources</i> directory.
84 The format of the file is compliant with standard Open CASCADE Technology resource files (see the *Resource_Manager.cdl* file for details).
86 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.
88 **Example:** (excerpt from DrawPlugin):
89 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
90 OCAF : VISUALIZATION, OCAFKERNEL
96 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98 @subsubsection occt_draw_1_3_3 Activation of commands implemented in the plug-in
100 To load a plug-in declared in the resource file and to activate the commands the following command must be used in Test Harness:
103 pload [-PluginFileName] [[Key1] [Key2]...]
108 * <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.
109 * *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).
111 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.
114 Draw[] pload -DrawPlugin OCAF
116 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.
119 Draw[] pload (equivalent to pload -DrawPlugin DEFAULT).
121 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.
124 @section occt_draw_2 The Command Language
126 @subsection occt_draw_2_1 Overview
128 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.
130 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:
132 * Syntax of the TCL language.
133 * Accessing variables in TCL and Draw.
134 * Control structures.
137 @subsection occt_draw_2_2 Syntax of TCL
139 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.
141 The basic program for TCL is a script. A script consists of one or more commands. Commands are separated by new lines or semicolons.
143 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
147 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
149 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.
151 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.
153 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.
155 The following substitutions are performed by TCL:
157 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.
160 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
161 # set a variable value
162 set file documentation
163 puts $file #to display file contents on the screen
165 # a simple substitution, set psfile to documentation.ps
169 # another substitution, set pfile to documentationPS
173 # delete files NEWdocumentation and OLDdocumentation
174 foreach prefix {NEW OLD} {rm $prefix$file}
175 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177 Command substitution is triggered by the [ ] characters. The brackets must enclose a valid script. The script is evaluated and the result is substituted.
179 Compare command construction in csh.
182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
185 # expr is a command evaluating a numeric expression
186 set radian [expr $pi*$degree/180]
187 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
189 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.
191 TCL uses two forms of *quoting* to prevent substitution and word breaking.
193 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 " ".
196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
197 # set msg to ;the price is 12.00;
199 set msg ;the price is $price;
200 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
202 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.
205 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
207 # this will loop for ever
208 # because while argument is ;0 3;
209 while ;$x 3; {set x [expr $x+1]}
210 # this will terminate as expected because
211 # while argument is {$x 3}
212 while {$x 3} {set x [expr $x+1]}
213 # this can be written also
217 # the following cannot be written
218 # because while requires two arguments
223 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
225 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.
228 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
230 set a 1 # this is not a comment
231 set b 1; # this is a comment
232 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
234 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.
238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
239 # I want to delete two files
243 # this will fail because rm will receive only one argument
244 # and complain that ;foo bar; does not exit
248 # a second evaluation will do it
249 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
251 @subsection occt_draw_2_3 Accessing variables in TCL and Draw
253 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.
255 TCL provides a mechanism to link user data to variables. Using this functionality, Draw defines its variables as TCL variables with associated data.
257 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.
259 There are many kinds of Draw variables, and new ones may be added with C++. Geometric and topological variables are described below.
261 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.
264 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
265 # dset is used for numeric variables
266 # pi is a predefined Draw variable
267 dset angle pi/3 radius 10
268 point p radius*cos(angle) radius*sin(angle) 0
269 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
270 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.
272 @subsubsection occt_draw_2_3_1 set, unset
278 unset varname [varname varname ...]
281 *set* assigns a string value to a variable. If the variable does not already exist, it is created.
283 Without a value, *set* returns the content of the variable.
285 *unset* deletes variables. It is is also used to delete Draw variables.
288 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
295 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
297 **Note**, that the *set* command can set only one variable, unlike the *dset* command.
300 @subsubsection occt_draw_2_3_2 dset, dval
305 dset var1 value1 vr2 value2 ...
309 *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.
311 *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.
315 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
320 # no $ required for Draw commands
323 # *puts* prints a string
324 puts ;x = [dval x], cos(x/pi) = [dval cos(x/pi)];
325 == x = 10, cos(x/pi) = -0.99913874099467914
326 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
328 **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.*
331 @subsection occt_draw_2_4 lists
333 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.
335 This allows you to insert lists within lists.
338 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
339 # a list of 3 strings
342 # a list of two strings the first is a list of 2
344 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
346 Many TCL commands return lists and **foreach** is a useful way to create loops on list elements.
348 @subsubsection occt_draw_2_5 Control Structures
350 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:
352 * You use braces instead of parentheses to enclose conditions.
353 * You do not start the script on the next line of your command.
356 @subsubsection occt_draw_2_5_1 if
361 if condition script [elseif script .... else script]
364 **If** evaluates the condition and the script to see whether the condition is true.
369 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
377 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
379 @subsubsection occt_draw_2_5_2 while, for, foreach
385 while condition script
386 for init condition reinit script
387 foreach varname list script
390 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. \
393 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
396 while {[dval x] 100} {
401 # incr var d, increments a variable of d (default 1)
402 for {set i 0} {$i 10} {incr i} {
404 point p$i cos(angle0 sin(angle) 0
407 foreach object {crapo tomson lucas} {display $object}
408 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
410 @subsubsection occt_draw_2_5_3 break, continue
419 Within loops, the **break** and **continue** commands have the same effect as in C.
421 **break** interrupts the innermost loop and **continue** jumps to the next iteration.
424 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
425 # search the index for which t$i has value ;secret;
426 for {set i 1} {$i = 100} {incr i} {
427 if {[set t$i] == ;secret;} break;
429 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
431 @subsection occt_draw_2_6 Procedures
433 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.
435 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.
437 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.
439 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.
442 @subsubsection occt_draw_2_6_1 proc
447 proc argumentlist script
450 **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.
452 **return** gives a return value to the procedure.
455 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
460 # procedure with arguments and default values
461 proc distance {x1 y1 {x2 0} {y2 0}} {
462 set d [expr (x2-x1)*(x2-x1) + (y2-y1)*(y2-y1)]
463 return [expr sqrt(d)]
466 if {$n == 0} {return 1} else {
467 return [expr n*[fact [expr n -1]]]
470 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
473 @subsubsection occt_draw_2_6_2 global, upvar
478 global varname [varname ...]
479 upvar varname localname [varname localname ...]
483 **global** accesses high level variables. Unlike C, global variables are not visible in procedures.
485 **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.
487 **Note** that in the following examples the \$ character is always necessarily used to access the arguments.
490 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
491 # convert degree to radian
492 # pi is a global variable
493 proc deg2rad (degree} {
494 return [dval pi*$degree/2.]
496 # create line with a point and an angle
497 proc linang {linename x y angle} {
499 line l $x $y cos($angle) sin($angle)
501 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
503 @section occt_draw_3 Basic Commands
505 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:
507 * General commands, which are used for Draw and TCL management.
508 * Variable commands, which are used to manage Draw variables such as storing and dumping.
509 * Graphic commands, which are used to manage the graphic system, and so pertain to views.
510 * Variable display commands, which are used to manage the display of objects within given views.
512 Note that Draw also features a GUI task bar providing an alternative way to give certain general, graphic and display commands
515 @subsection occt_draw_3_1 General commands
517 This section describes several useful commands:
519 * **help** to get information,
520 * **source** to eval a script from a file,
521 * **spy** to capture the commands in a file,
522 * **cpulimit** to limit the process cpu time,
523 * **wait** to waste some time,
524 * **chrono** to time commands.
526 @subsubsection occt_draw_3_1_1 help
531 help [command [helpstring group]]
534 Provides help or modifies the help information.
536 **help** without arguments lists all groups and the commands in each group.
538 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.
541 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
542 # Gives help on all commands starting with *a*
543 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
546 @subsubsection occt_draw_3_1_2 source
555 The **exit** command will terminate the file.
557 @subsubsection occt_draw_3_1_3 spy
565 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.
567 If a command returns an error it is saved with a comment mark.
569 The file created by **spy** can be executed with the **source** command.
572 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
573 # all commands will be saved in the file ;session;
575 # the file ;session; is closed and commands are not saved
577 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
581 @subsubsection occt_draw_3_1_4 cpulimit
589 **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.
592 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
593 #limit cpu to one hour
595 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
597 @subsubsection occt_draw_3_1_5 wait
603 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.
606 # You have ten seconds ...
610 @subsubsection occt_draw_3_1_6 chrono
615 chrono [ name start/stop/reset/show]
618 Without arguments, **chrono** activates Draw chronometers. The elapsed time ,cpu system and cpu user times for each command will be printed.
620 With arguments, **chrono** is used to manage activated chronometers. You can perform the following actions with a chronometer.
621 * run the chronometer (start).
622 * stop the chronometer (stop).
623 * reset the chronometer to 0 (reset).
624 * display the current time (show).
627 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
629 ==Chronometers activated.
631 ==Elapsed time: 0 Hours 0 Minutes 0.0318 Seconds
632 ==CPU user time: 0.01 seconds
633 ==CPU system time: 0 seconds
634 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
636 @subsection occt_draw_3_2 Variable management commands
638 @subsubsection occt_draw_3_2_1 isdraw, directory
646 **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.
648 Use **directory** to return a list of all Draw global variables matching a pattern.
651 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
664 # to destroy all Draw objects with name containing curve
665 foreach var [directory *curve*] {unset $var}
666 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
669 @subsubsection occt_draw_3_2_2 whatis, dump
674 whatis varname [varname ...]
675 dump varname [varname ...]
678 **whatis** returns short information about a Draw variable. This is usually the type name.
680 **dump** returns a brief type description, the coordinates, and if need be, the parameters of a Draw variable.
683 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
690 ***** Dump of c *****
696 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
698 **Note** The behavior of *whatis* on other variables (not Draw) is not excellent.
701 @subsubsection occt_draw_3_2_3 rename, copy
705 rename varname tovarname [varname tovarname ...]
706 copy varname tovarname [varname tovarname ...]
709 * **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.
710 * **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.
713 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
717 # curves are copied, c2 will not be modified
719 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
721 @subsubsection occt_draw_3_2_4 datadir, save, restore
726 save variable [filename]
727 restore filename [variablename]
730 * **datadir** without arguments prints the path of the current data directory.
731 * **datadir** with an argument sets the data directory path. \
733 If the path starts with a dot (.) only the last directory name will be changed in the path.
735 * **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.
736 * **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.
738 The exact content of the file is type-dependent. They are usually ASCII files and so, architecture independent.
741 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
742 # note how TCL accesses shell environment variables
747 datadir $env(WBCONTAINER)/data/default
748 ==/adv_20/BAG/data/default
752 ==/adv_20/BAG/data/default/theBox
754 # when TCL does not find a command it tries a shell command
760 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
762 @subsection occt_draw_3_3 User defined commands
764 *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.
766 *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.
768 @subsubsection occt_draw_3_3_1 set
770 #### In *DrawTrSurf* package:
773 void Set(Standard_CString& Name,const gp_Pnt& G) ;
774 void Set(Standard_CString& Name,const gp_Pnt2d& G) ;
775 void Set(Standard_CString& Name,
776 const Handle(Geom_Geometry)& G) ;
777 void Set(Standard_CString& Name,
778 const Handle(Geom2d_Curve)& C) ;
779 void Set(Standard_CString& Name,
780 const Handle(Poly_Triangulation)& T) ;
781 void Set(Standard_CString& Name,
782 const Handle(Poly_Polygon3D)& P) ;
783 void Set(Standard_CString& Name,
784 const Handle(Poly_Polygon2D)& P) ;
787 #### In *DBRep* package:
790 void Set(const Standard_CString Name,
791 const TopoDS_Shape& S) ;
794 Example of *DrawTrSurf*
797 Handle(Geom2d_Circle) C1 = new Geom2d_Circle
798 (gce_MakeCirc2d (gp_Pnt2d(50,0,) 25));
799 DrawTrSurf::Set(char*, C1);
806 B = BRepPrimAPI_MakeBox (10,10,10);
810 @subsubsection occt_draw_3_3_2 get
812 #### In *DrawTrSurf* package:
815 Handle_Geom_Geometry Get(Standard_CString& Name) ;
818 #### In *DBRep* package:
821 TopoDS_Shape Get(Standard_CString& Name,
822 const TopAbs_ShapeEnum Typ = TopAbs_SHAPE,
823 const Standard_Boolean Complain
827 Example of *DrawTrSurf*
830 Standard_Integer MyCommand
831 (Draw_Interpretor& theCommands,
832 Standard_Integer argc, char** argv)
834 // Creation of a Geom_Geometry from a Draw geometric
836 Handle (Geom_Geometry) aGeom= DrawTrSurf::Get(argv[1]);
843 Standard_Integer MyCommand
844 (Draw_Interpretor& theCommands,
845 Standard_Integer argc, char** argv)
847 // Creation of a TopoDS_Shape from a Draw topological
849 TopoDS_Solid B = DBRep::Get(argv[1]);
853 @section occt_draw_4 Graphic Commands
855 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.
857 @subsection occt_draw_4_1 Axonometric viewer
859 @subsubsection occt_draw_4_1_1 view, delete
863 view index type [X Y W H]
867 **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.
869 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..
871 **delete** deletes a view. If no index is given, all the views are deleted.
873 Type selects from the following range:
875 * *AXON* : Axonometric view
876 * *PERS* : Perspective view
877 * <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.
878 * <i>-2D-</i> : 2d view
880 The index, the type, the current zoom are displayed in the window title .
883 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
884 # this is the content of the mu4 procedure
887 view 1 +X+Z 320 20 400 400
888 view 2 +X+Y 320 450 400 400
889 view 3 +Y+Z 728 20 400 400
890 view 4 AXON 728 450 400 400
892 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
894 See also: **axo, pers, top, bottom, left, right, front, back, mu4, v2d, av2d, smallview**
896 @subsubsection occt_draw_4_1_2 axo, pers, top, ...
907 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.
909 * **axo** creates a large window axonometric view;
910 * **pers** creates a large window perspective view;
911 * **top**, **bottom**, **left**, **right**, **front**, **back** create a large window axis view;
912 * **mu4** creates four small window views: front, left, top and axo.
913 * **v2d** creates a large window 2d view.
914 * **av2d** creates two small window views, one 2d and one axo
915 * **smallview** creates a view at the bottom right of the screen of the given type.
917 See also: **view**, **delete**
919 @subsubsection occt_draw_4_1_3 mu, md, 2dmu, 2dmd, zoom, 2dzoom
930 * **mu** (magnify up) increases the zoom in one or several views by a factor of 10%.
931 * **md** (magnify down) decreases the zoom by the inverse factor. **2dmu** and **2dmd**
932 perform the same on one or all 2d views.
933 * **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.
934 * **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.
937 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
945 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
946 See also: **fit**, **2dfit**
949 @subsubsection occt_draw_4_14 pu, pd, pl, pr, 2dpu, 2dpd, 2dpl, 2dpr
958 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.
960 # you have selected one anonometric view
965 # you have selected an mu4 view; the object in the third view will pan up
968 See also: **fit**, **2dfit**
971 @subsubsection occt_draw_4_1_5 fit, 2dfit
980 **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.
982 When fitting all views a unique zoom is computed for all the views. All views are on the same scale.
985 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
990 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
991 See also: **zoom**, **mu**, **pu**
994 @subsubsection occt_draw_4_1_6 u, d, l, r
1005 **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.
1008 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1009 # rotate the view up
1011 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1013 @subsubsection occt_draw_4_1_7 focal, fu, fd
1022 * **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.
1023 * **fu** and **fd** increase or decrease the focal value by 10%. **fd** makes the eye closer to the object.
1026 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1029 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1031 **Note**: Do not use a negative or null focal value.
1035 @subsubsection occt_draw_4_1_8 color
1043 **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.
1045 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.
1048 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1049 # change the value of blue
1051 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1054 **Note** that the color change will be visible on the next redraw of the views, for example, after *fit* or *mu*, etc.
1056 @subsubsection occt_draw_4_1_9 dtext
1060 dtext [x y [z]] string
1063 **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.
1065 The coordinates are real space coordinates.
1068 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1072 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1074 @subsubsection occt_draw_4_1_10 hardcopy, hcolor, xwd
1079 hcolor index width gray
1080 xwd [index] filename
1083 * **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.
1084 * **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.
1085 * **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**.
1088 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1089 # all blue lines (color 3)
1090 # will be half-width and gray
1093 # make a postscript file and print it
1097 # make an xwd file and display it
1100 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1102 **Note:** When more than one view is present, specify the index of the view.
1104 Only use a postscript printer to print postscript files.
1109 @subsubsection occt_draw_4_1_11 wclick, pick
1114 pick index X Y Z b [nowait]
1117 **wclick** defers an event until the mouse button is clicked. The message <code>just click</code> is displayed.
1119 Use the **pick** command to get graphic input. The arguments must be names for variables where the results are stored.
1120 * index: index of the view where the input was made.
1121 * X,Y,Z: 3d coordinates in real world.
1122 * b: b is the mouse button 1,2 or 3.
1124 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.
1126 This option is useful for tracking the pointer.
1128 **Note** that the results are stored in Draw numeric variables.
1131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1132 # make a circle at mouse location
1134 circle c x y z 0 0 1 1 0 0 0 30
1136 # make a dynamic circle at mouse location
1137 # stop when a button is clicked
1138 # (see the repaint command)
1141 while {[dval b] == 0} {
1142 pick index x y z b nowait
1143 circle c x y z 0 0 1 1 0 0 0 30
1146 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1147 See also: **repaint**
1150 Draw provides commands to manage the display of objects.
1151 * **display**, **donly** are used to display,
1152 * **erase**, **clear**, **2dclear** to erase.
1153 * **autodisplay** command is used to check whether variables are displayed when created.
1155 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.
1156 * 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.
1157 * 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.
1158 * If you do not see what you expected while executing loops or sourcing files, use the **repaint** and **dflush** commands.
1161 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1162 # OK use dot to dump an object on the screen
1167 #Not OK. display points on a curve c
1168 # with dot no variables are created
1169 for {set i 0} {$i = 10} {incr i} {
1170 cvalue c $i/10 x y z
1175 # would have displayed only one point
1176 # because the precedent variable content is erased
1179 # is an other solution, creating variables
1182 # give a name to a graphic object
1184 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1187 @subsubsection occt_draw_4_1_12 autodisplay
1195 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.
1197 When **autodisplay** is off, using the dot return argument is ineffective.
1200 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1209 # c is erased, but not displayed
1211 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1213 @subsubsection occt_draw_4_1_13 display, donly
1217 display varname [varname ...]
1218 donly varname [varname ...]
1221 * **display** makes objects visible.
1222 * **donly** *display only* makes objects visible and erases all other objects. It is very useful to extract one object from a messy screen.
1225 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1226 \# to see all objects
1227 foreach var [directory] {display $var}
1229 \# to select two objects and erase the other ones
1231 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1234 @subsubsection occt_draw_4_1_14 erase, clear, 2dclear
1239 erase [varname varname ...]
1244 **erase** removes objects from all views. **erase** without arguments erases everything in 2d and 3d.
1246 **clear** erases only 3d objects and **2dclear** only 2d objects. **erase** without arguments is similar to **clear; 2dclear**.
1250 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1251 # erase eveerything with a name starting with c_
1252 foreach var [directory c_*] {erase $var}
1256 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1258 @subsubsection occt_draw_4_1_15 repaint, dflush
1268 * **repaint** forces repainting of views.
1269 * **dflush** flushes the graphic buffers.
1271 These commands are useful within loops or in scripts.
1273 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.
1275 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.
1277 See also: <a href="#occt_draw_4_1_11">pick</a> command.
1279 @subsection occt_draw_4_2 AIS viewer – view commands
1281 @subsubsection occt_draw_4_2_1 vinit
1287 Creates the 3D viewer window
1289 @subsubsection occt_draw_4_2_2 vhelp
1295 Displays help in the 3D viewer window. The help consists in a list of hotkeys and their functionalities.
1297 @subsubsection occt_draw_4_2_3 vtop
1304 Displays top view in the 3D viewer window.
1307 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1313 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1315 @subsubsection occt_draw_4_2_4 vaxo
1322 Displays axonometric view in the 3D viewer window.
1325 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1331 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1333 @subsubsection occt_draw_4_2_5 vsetbg
1337 vsetbg imagefile [filltype]
1340 Loads image file as background. *filltype* must be NONE, CENTERED, TILED or STRETCH.
1345 vsetbg myimage.brep CENTERED
1348 @subsubsection occt_draw_4_2_6 vclear
1354 Removes all objects from the viewer.
1356 @subsubsection occt_draw_4_2_7 vrepaint
1362 Forcedly redisplays the shape in the 3D viewer window.
1364 @subsubsection occt_draw_4_2_8 vfit
1370 Automatic zoom/panning. Objects in the view are visualized to occupy the maximum surface.
1372 @subsubsection occt_draw_4_2_9 vzfit
1379 Automatic depth panning. Objects in the view are visualized to occupy the maximum 3d space.
1381 @subsubsection occt_draw_4_2_10 vreadpixel
1385 vreadpixel xPixel yPixel [{rgb|rgba|depth|hls|rgbf|rgbaf}=rgba] [name]
1387 Read pixel value for active view.
1390 @subsubsection occt_draw_4_2_11 vselect
1394 vselect x1 y1 [x2 y2 [x3 y3 ... xn yn]] [shift_selection = 0|1]
1397 Emulates different types of selection:
1399 * single mouse click selection
1400 * selection with a rectangle having the upper left and bottom right corners in <i>(x1,y1)</i> and <i>(x2,y2)</i> respectively
1401 * selection with a polygon having the corners in pixel positions <i>(x1,y1), (x2,y2),…, (xn,yn)</i>
1402 * any of these selections if shift_selection is set to 1.
1404 @subsubsection occt_draw_4_2_12 vmoveto
1411 Emulates cursor movement to pixel position (x,y).
1413 @subsubsection occt_draw_4_2_13 vviewparams
1417 vviewparams [scale center_X center_Y proj_X proj_Y proj_Z up_X up_Y up_Z at_X at_Y at_Z]
1419 Gets or sets the current view characteristics.
1421 @subsubsection occt_draw_4_2_14 vchangeselected
1425 vchangeselected shape
1427 Adds a shape to selection or removes one from it.
1429 @subsubsection occt_draw_4_2_15 vzclipping
1433 vzclipping [mode] [depth width]
1435 Gets or sets ZClipping mode, width and depth, where
1436 - *mode = OFF|BACK|FRONT|SLICE*
1437 - *depth* is a real value from segment [0,1]
1438 - *width* is a real value from segment [0,1]
1440 @subsubsection occt_draw_4_2_16 vnbselected
1446 Returns the number of selected objects in the interactive context.
1448 @subsubsection occt_draw_4_2_17 vantialiasing
1454 Sets antialiasing if the command is called with 1 or unsets otherwise.
1456 @subsubsection occt_draw_4_2_18 vpurgedisplay
1460 vpurgedisplay [CollectorToo = 0|1]
1462 Removes structures which do not belong to objects displayed in neutral point.
1464 @subsubsection occt_draw_4_2_19 vhlr
1468 vhlr is_enabled={on|off}
1470 Switches hidden line removal (computed) mode on/off.
1472 @subsubsection occt_draw_4_2_20 vhlrtype
1476 vhlrtype algo_type={algo|polyalgo} [shape_1 ... shape_n]
1479 Changes the type of HLR algorithm used for shapes.
1480 If the algo_type is algo, the exact HLR algorithm is used, otherwise the polygonal algorithm is used for defined shapes.
1482 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.
1484 **Note** that this command works with instances of *AIS_Shape* or derived classes only, other interactive object types are ignored.
1487 @subsection occt_draw_4_3 AIS viewer – display commands
1489 @subsubsection occt_draw_4_3_1 vdisplay
1493 vdisplay name1 [name2] … [name n]
1496 Displays named objects.
1501 box b 40 40 40 10 10 10
1507 @subsubsection occt_draw_4_3_2 vdonly
1511 vdonly [name1] … [name n]
1514 Displays only selected or named objects. If there are no selected or named objects, nothing is done.
1519 box b 40 40 40 10 10 10
1525 @subsubsection occt_draw_4_3_3 vdisplayall
1532 Displays all created objects.
1537 box b 40 40 40 10 10 10
1543 @subsubsection occt_draw_4_3_4 verase
1547 verase [name1] [name2] … [name n]
1550 Erases some selected or named objects. If there are no selected or named objects, the whole viewer is erased.
1555 box b1 40 40 40 10 10 10
1556 box b2 -40 -40 -40 10 10 10
1560 # erase only first box
1562 # erase second box and sphere
1566 @subsubsection occt_draw_4_3_5 veraseall
1573 Erases all objects displayed in the viewer.
1578 box b1 40 40 40 10 10 10
1579 box b2 -40 -40 -40 10 10 10
1583 # erase only first box
1585 # erase second box and sphere
1589 @subsubsection occt_draw_4_3_6 vsetdispmode
1593 vsetdispmode [name] mode(0,1,2,3)
1596 Sets display mode for all, selected or named objects.
1597 * *0* (*WireFrame*),
1599 * *2* (*Quick HideLineremoval*),
1600 * *3* (*Exact HideLineremoval*).
1611 @subsubsection occt_draw_4_3_7 vdisplaytype
1618 Displays all objects of a given type.
1619 The following types are possible: *Point*, *Axis*, *Trihedron*, *PlaneTrihedron*, *Line*, *Circle*, *Plane*, *Shape*, *ConnectedShape*, *MultiConn.Shape*, *ConnectedInter.*, *MultiConn.*, *Constraint* and *Dimension*.
1621 @subsubsection occt_draw_4_3_8 verasetype
1628 Erases all objects of a given type.
1629 Possible type is *Point*, *Axis*, *Trihedron*, *PlaneTrihedron*, *Line*, *Circle*, *Plane*, *Shape*, *ConnectedShape*, *MultiConn.Shape*, *ConnectedInter.*, *MultiConn.*, *Constraint* and *Dimension*.
1631 @subsubsection occt_draw_4_3_9 vtypes
1638 Makes a list of known types and signatures in AIS.
1640 @subsubsection occt_draw_4_3_10 vsetcolor
1644 vsetcolor [shapename] colorname
1647 Sets color for all, selected or named shapes.
1648 Possible *colorname* is: *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*.
1650 @subsubsection occt_draw_4_3_11 vunsetcolor
1654 vunsetcolor [shapename]
1657 Sets default color for all, selected or named shapes.
1659 @subsubsection occt_draw_4_3_12 vsettransparency
1663 vsettransparency [shapename] coeficient
1666 Sets transparency for all selected or named shapes. The *coefficient* may be between 0.0 (opaque) and 1.0 (fully transparent).
1668 **Warning**: at 1.0 the shape becomes invisible.
1678 vsettransparency b 0.5
1681 @subsubsection occt_draw_4_3_13 vunsettransparency
1685 vunsettransparency [shapename]
1688 Sets default transparency (0.0) for all selected or named shapes.
1690 @subsubsection occt_draw_4_3_14 vsetmaterial
1694 vsetmaterial [shapename] materialname
1697 Sets material for all selected or named shapes.
1699 **materialname** can be *BRASS*, *BRONZE*, *COPPER*, *GOLD*, *PEWTER*, *PLASTER*, *PLASTIC*, *SILVER*, *STEEL*, *STONE*, *SHINY_PLASTIC*, *SATIN*, *METALIZED*, *NEON_GNC*, *CHROME*, *ALUMINIUM*, *OBSIDIAN*, *NEON_PHC* or *JADE*.
1711 @subsubsection occt_draw_4_3_15 vunsetmaterial
1715 vunsetmaterial [shapename]
1718 Sets default material for all selected or named shapes.
1720 @subsubsection occt_draw_4_3_16 vsetwidth
1724 vsetwidth [shapename] coeficient
1727 Sets width of the edges for all selected or named shapes.
1728 The *coefficient* may be between 0.0 and 10.0.
1739 @subsubsection occt_draw_4_3_17 vunsetwidth
1743 vunsetwidth [shapename]
1746 Sets default width of edges (0.0) for all selected or named shapes.
1748 @subsubsection occt_draw_4_3_18 vsetshading
1752 vsetshading shapename [coefficient]
1755 Sets deflection coefficient that defines the quality of the shape’s representation in the shading mode. Default coefficient is 0.0008.
1767 @subsubsection occt_draw_4_3_19 vunsetshading
1771 vunsetshading [shapename]
1774 Sets default deflection coefficient (0.0008) that defines the quality of the shape’s representation in the shading mode. Default coefficient is 0.0008.
1776 @subsubsection occt_draw_4_3_20 vsetam
1780 vsetam [shapename] mode
1783 Activates selection mode for all selected or named shapes:
1784 * *0* for *shape* itself,
1791 * *7* (*compounds*).
1802 @subsubsection occt_draw_4_3_21 vunsetam
1809 Deactivates all selection modes for all shapes.
1811 @subsubsection occt_draw_4_3_22 vdump
1815 vdump <filename>.{png|xwd|bmp}
1818 Extracts the contents of the viewer window to a png, XWD or BMP file.
1820 @subsubsection occt_draw_4_3_23 vdir
1827 Displays the list of displayed objects.
1829 @subsubsection occt_draw_4_3_24 vsub
1833 vsub 0/1(on/off)[shapename]
1836 Hilights/unhilights named or selected objects which are displayed at neutral state with subintensity color.
1849 @subsubsection occt_draw_4_3_25 vardis
1856 Displays active areas (for each activated sensitive entity, one or several 2D bounding boxes are displayed, depending on the implementation of a particular entity).
1858 @subsubsection occt_draw_4_3_26 varera
1865 Erases active areas.
1867 @subsubsection occt_draw_4_3_27 vsensdis
1874 Displays active entities (sensitive entities of one of the standard types corresponding to active selection modes).
1876 Standard entity types are those defined in Select3D package:
1883 * sensitive triangulation
1884 * sensitive triangle
1885 Custom (application-defined) sensitive entity types are not processed by this command.
1887 @subsubsection occt_draw_4_3_28 vsensera
1894 Erases active entities.
1896 @subsubsection occt_draw_4_3_29 vperf
1900 vperf shapename 1/0 (Transformation/Loacation) 1/0 (Primitives sensibles ON/OFF)
1903 Tests the animation of an object along a predefined trajectory.
1916 @subsubsection occt_draw_4_3_30 vr
1923 Reads shape from BREP-format file and displays it in the viewer.
1931 @subsubsection occt_draw_4_3_31 vstate
1935 vstate [name1] … [name n]
1938 Makes a list of the status (**Displayed** or **Not Displayed**) of some selected or named objects.
1941 @subsection occt_draw_4_4 AIS viewer – object commands
1943 @subsubsection occt_draw_4_4_1 vtrihedron
1947 vtrihedron name [X0] [Y0] [Z0] [Zu] [Zv] [Zw] [Xu] [Xv] [Xw]
1950 Creates a new *AIS_Trihedron* object. If no argument is set, the default trihedron (0XYZ) is created.
1958 @subsubsection occt_draw_4_4_2 vplanetri
1965 Creates a plane from a trihedron selection.
1968 @subsubsection occt_draw_4_4_3 vsize
1975 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.
1981 vtrihedron tr2 0 0 0 1 0 0 1 0 0
1985 @subsubsection occt_draw_4_4_4 vaxis
1989 vaxis name [Xa Ya Za Xb Yb Zb]
1992 Creates an axis. If the values are not defined, an axis is created by interactive selection of two vertices or one edge
1998 vaxis axe1 0 0 0 1 0 0
2001 @subsubsection occt_draw_4_4_5 vaxispara
2008 Creates an axis by interactive selection of an edge and a vertex.
2010 @subsubsection occt_draw_4_4_6 vaxisortho
2017 Creates an axis by interactive selection of an edge and a vertex. The axis will be orthogonal to the selected edge.
2019 @subsubsection occt_draw_4_4_7 vpoint
2023 vpoint name [Xa Ya Za]
2026 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).
2034 @subsubsection occt_draw_4_4_8 vplane
2038 vplane name [AxisName] [PointName]
2039 vplane name [PointName] [PointName] [PointName]
2040 vplane name [PlaneName] [PointName]
2043 Creates a plane from named or interactively selected entities.
2049 vaxis axe1 0 0 0 0 0 1
2051 vplane plane1 axe1 p1
2054 @subsubsection occt_draw_4_4_9 vplanepara
2061 Creates a plane from interactively selected vertex and face.
2063 @subsubsection occt_draw_4_4_10 vplaneortho
2070 Creates a plane from interactive selected face and coplanar edge.
2072 @subsubsection occt_draw_4_4_11 vline
2076 vline name [PointName] [PointName]
2077 vline name [Xa Ya Za Xb Yb Zb]
2080 Creates a line from coordinates, named or interactively selected vertices.
2089 vline line2 0 0 0 50 0 1
2092 @subsubsection occt_draw_4_4_12 vcircle
2096 vcircle name [PointName PointName PointName IsFilled]
2097 vcircle name [PlaneName PointName Radius IsFilled]
2100 Creates a circle from named or interactively selected entities. Parameter IsFilled is defined as 0 or 1.
2109 vcircle circle1 p1 p2 p3 1
2112 @subsubsection occt_draw_4_4_13 vtri2d
2119 Creates a plane with a 2D trihedron from an interactively selected face.
2121 @subsubsection occt_draw_4_4_14 vselmode
2125 vselmode [object] mode On/Off
2128 Sets the selection mode for an object. If the object value is not defined, the selection mode is set for all displayed objects.
2129 Value *On* is defined as 1 and *Off* – as 0.
2137 vtriangle triangle1 p1 p2 p3
2140 @subsubsection occt_draw_4_4_15 vconnect, vconnectsh
2144 vconnect name object Xo Yo Zo Xu Xv Xw Zu Zv Zw
2145 vconnectsh name shape Xo Yo Zo Xu Xv Xw Zu Zv Zw
2148 Creates and displays an object with input location connected to a named entity.
2149 The difference between these two commands is that the object created by *vconnect* does not support the selection modes different from 0.
2156 vsegment segment p1 p2
2157 restore CrankArm.brep obj
2159 vconnectsh new obj 100100100 1 0 0 0 0 1
2162 @subsubsection occt_draw_4_4_16 vtriangle
2166 vtriangle name PointName PointName PointName
2169 Creates and displays a filled triangle from named points.
2177 vtriangle triangle1 p1 p2 p3
2180 @subsubsection occt_draw_4_4_17 vsegment
2184 vsegment name PointName PointName
2187 Creates and displays a segment from named points.
2194 vsegment segment p1 p2
2197 @subsection occt_draw_4_5 AIS viewer – Mesh Visualization Service
2199 **MeshVS** (Mesh Visualization Service) component provides flexible means of displaying meshes with associated pre- and post- processor data.
2201 @subsubsection occt_draw_4_5_1 meshfromstl
2205 meshfromstl meshname file
2208 Creates a *MeshVS_Mesh* object based on STL file data. The object will be displayed immediately.
2212 meshfromstl mesh myfile.stl
2215 @subsubsection occt_draw_4_5_2 meshdispmode
2219 meshdispmode meshname displaymode
2222 Changes the display mode of object **meshname**. The **displaymode** is integer, which can be:
2223 * *1* for *wireframe*,
2224 * *2* for *shading* mode, or
2225 * *3* for *shrink* mode.
2230 meshfromstl mesh myfile.stl
2234 @subsubsection occt_draw_4_5_3 meshselmode
2238 meshselmode meshname selectionmode
2241 Changes the selection mode of object **meshname**. The *selectionmode* is integer OR-combination of mode flags. The basic flags are the following:
2242 * *1* – node selection;
2243 * *2* – 0D elements (not supported in STL);
2244 * *4* – links (not supported in STL);
2250 meshfromstl mesh myfile.stl
2254 @subsubsection occt_draw_4_5_4 meshshadcolor
2258 meshshadcolor meshname red green blue
2261 Changes the face interior color of object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*.
2266 meshfromstl mesh myfile.stl
2267 meshshadcolormode mesh 0.5 0.5 0.5
2270 @subsubsection occt_draw_4_5_5 meshlinkcolor
2274 meshlinkcolor meshname red green blue
2277 Changes the color of face borders for object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*.
2282 meshfromstl mesh myfile.stl
2283 meshlinkcolormode mesh 0.5 0.5 0.5
2286 @subsubsection occt_draw_4_5_6 meshmat
2290 meshmat meshname material
2293 Changes the material of object **meshname**.
2295 *material* is represented with an integer value as follows (equivalent to enumeration *Graphic3d_NameOfMaterial*):
2306 * *10 - SHINY_PLASTIC,*
2316 * *20 - UserDefined*
2321 meshfromstl mesh myfile.stl
2325 @subsubsection occt_draw_4_5_7 meshshrcoef
2329 meshshrcoef meshname shrinkcoefficient
2332 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.
2337 meshfromstl mesh myfile.stl
2338 meshshrcoef mesh 0.05
2341 @subsubsection occt_draw_4_5_8 meshshow
2348 Displays **meshname** in the viewer (if it is erased).
2353 meshfromstl mesh myfile.stl
2357 @subsubsection occt_draw_4_5_9 meshhide
2364 Hides **meshname** in the viewer.
2369 meshfromstl mesh myfile.stl
2373 @subsubsection occt_draw_4_5_10 meshhidesel
2377 meshhidesel meshname
2380 Hides only selected entities. The other part of **meshname** remains visible.
2382 @subsubsection occt_draw_4_5_11 meshshowsel
2386 meshshowsel meshname
2389 Shows only selected entities. The other part of **meshname** becomes invisible.
2391 @subsubsection occt_draw_4_5_12 meshshowall
2395 meshshowall meshname
2398 Changes the state of all entities to visible for **meshname**.
2400 @subsubsection occt_draw_4_5_13 meshdelete
2407 Deletes MeshVS_Mesh object **meshname**.
2412 meshfromstl mesh myfile.stl
2416 @section occt_draw_5 OCAF commands
2419 This chapter contains a set of commands for Open CASCADE Technology Application Framework (OCAF).
2422 @subsection occt_draw_5_1 Application commands
2425 @subsubsection occt_draw_5_1_1 NewDocument
2429 NewDocument docname [format]
2432 Creates a new **docname** document with MDTV-Standard or described format.
2436 # Create new document with default (MDTV-Standard) format
2439 # Create new document with BinOcaf format
2440 NewDocument D2 BinOcaf
2443 @subsubsection occt_draw_5_1_2 IsInSession
2450 Returns *0*, if **path** document is managed by the application session, *1* – otherwise.
2454 IsInSession /myPath/myFile.std
2457 @subsubsection occt_draw_5_1_3 ListDocuments
2464 Makes a list of documents handled during the session of the application.
2467 @subsubsection occt_draw_5_1_4 Open
2474 Retrieves the document of file **docname** in the path **path**. Overwrites the document, if it is already in session.
2478 Open /myPath/myFile.std D
2481 @subsubsection occt_draw_5_1_5 Close
2488 Closes **docname** document. The document is no longer handled by the applicative session.
2495 @subsubsection occt_draw_5_1_6 Save
2502 Saves **docname** active document.
2509 @subsubsection occt_draw_5_1_7 SaveAs
2516 Saves the active document in the file **docname** in the path **path**. Overwrites the file if it already exists.
2520 SaveAs D /myPath/myFile.std
2523 @subsection occt_draw_5_2 Basic commands
2525 @subsubsection occt_draw_5_2_1 Label
2533 Creates the label expressed by <i>\<entry\></i> if it does not exist.
2540 @subsubsection occt_draw_5_2_2 NewChild
2545 NewChild docname [taggerlabel = Root label]
2547 Finds (or creates) a *TagSource* attribute located at father label of <i>\<taggerlabel\></i> and makes a new child label.
2551 # Create new child of root label
2554 # Create new child of existing label
2559 @subsubsection occt_draw_5_2_3 Children
2563 Children docname label
2565 Returns the list of attributes of label.
2572 @subsubsection occt_draw_5_2_4 ForgetAll
2576 ForgetAll docname label
2578 Forgets all attributes of the label.
2586 @subsubsection occt_draw_5_3 Application commands
2588 @subsubsection occt_draw_5_3_1 Main
2595 Returns the main label of the framework.
2602 @subsubsection occt_draw_5_3_2 UndoLimit
2606 UndoLimit docname [value=0]
2610 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
2617 @subsubsection occt_draw_5_3_3 Undo
2621 Undo docname [value=1]
2624 Undoes **value** steps.
2631 @subsubsection occt_draw_5_3_4 Redo
2635 Redo docname [value=1]
2638 Redoes **value** steps.
2645 @subsubsection occt_draw_5_3_5 OpenCommand
2652 Opens a new command transaction.
2659 @subsubsection occt_draw_5_3_6 CommitCommand
2663 CommitCommand docname
2666 Commits the Command transaction.
2673 @subsubsection occt_draw_5_3_7 NewCommand
2680 This is a short-cut for Commit and Open transaction.
2687 @subsubsection occt_draw_5_3_8 AbortCommand
2691 AbortCommand docname
2694 Aborts the Command transaction.
2701 @subsubsection occt_draw_5_3_9 Copy
2705 Copy docname entry Xdocname Xentry
2708 Copies the contents of *entry* to *Xentry*. No links are registered.
2715 @subsubsection occt_draw_5_3_10 UpdateLink
2719 UpdateLink docname [entry]
2722 Updates external reference set at *entry*.
2729 @subsubsection occt_draw_5_3_11 CopyWithLink
2733 CopyWithLink docname entry Xdocname Xentry
2736 Aborts the Command transaction.
2737 Copies the content of *entry* to *Xentry*. The link is registered with an *Xlink* attribute at *Xentry* label.
2741 CopyWithLink D1 0:2 D2 0:4
2744 @subsubsection occt_draw_5_3_12 UpdateXLinks
2748 UpdateXLinks docname entry
2751 Sets modifications on labels impacted by external references to the *entry*. The *document* becomes invalid and must be recomputed
2758 @subsubsection occt_draw_5_3_13 DumpDocument
2762 DumpDocument docname
2765 Displays parameters of *docname* document.
2773 @subsection occt_draw_5_4 Data Framework commands
2776 @subsubsection occt_draw_5_4_1 MakeDF
2783 Creates a new data framework.
2790 @subsubsection occt_draw_5_4_2 ClearDF
2797 Clears a data framework.
2804 @subsubsection occt_draw_5_4_3 CopyDF
2808 CopyDF dfname1 entry1 [dfname2] entry2
2811 Copies a data framework.
2818 @subsubsection occt_draw_5_4_4 CopyLabel
2822 CopyLabel dfname fromlabel tolablel
2829 CopyLabel D1 0:2 0:4
2832 @subsubsection occt_draw_5_4_5 MiniDumpDF
2839 Makes a mini-dump of a data framework.
2846 @subsubsection occt_draw_5_4_6 XDumpDF
2853 Makes an extended dump of a data framework.
2860 @subsection occt_draw_5_5 General attributes commands
2863 @subsubsection occt_draw_5_5_1 SetInteger
2867 SetInteger dfname entry value
2870 Finds or creates an Integer attribute at *entry* label and sets *value*.
2874 SetInteger D 0:2 100
2877 @subsubsection occt_draw_5_5_2 GetInteger
2881 GetInteger dfname entry [drawname]
2884 Gets a value of an Integer attribute at *entry* label and sets it to *drawname* variable, if it is defined.
2888 GetInteger D 0:2 Int1
2891 @subsubsection occt_draw_5_5_3 SetReal
2895 SetReal dfname entry value
2898 Finds or creates a Real attribute at *entry* label and sets *value*.
2905 @subsubsection occt_draw_5_5_4 GetReal
2909 GetReal dfname entry [drawname]
2912 Gets a value of a Real attribute at *entry* label and sets it to *drawname* variable, if it is defined.
2919 @subsubsection occt_draw_5_5_5 SetIntArray
2923 SetIntArray dfname entry lower upper value1 value2 …
2926 Finds or creates an IntegerArray attribute at *entry* label with lower and upper bounds and sets **value1*, *value2*...
2930 SetIntArray D 0:2 1 4 100 200 300 400
2933 @subsubsection occt_draw_5_5_6 GetIntArray
2937 GetIntArray dfname entry
2940 Gets a value of an *IntegerArray* attribute at *entry* label.
2947 @subsubsection occt_draw_5_5_7 SetRealArray
2951 SetRealArray dfname entry lower upper value1 value2 …
2954 Finds or creates a RealArray attribute at *entry* label with lower and upper bounds and sets *value1*, *value2*…
2958 GetRealArray D 0:2 1 4 100. 200. 300. 400.
2961 @subsubsection occt_draw_5_5_8 GetRealArray
2965 GetRealArray dfname entry
2968 Gets a value of a RealArray attribute at *entry* label.
2975 @subsubsection occt_draw_5_5_9 SetComment
2979 SetComment dfname entry value
2982 Finds or creates a Comment attribute at *entry* label and sets *value*.
2986 SetComment D 0:2 "My comment"
2989 @subsubsection occt_draw_5_5_10 GetComment
2993 GetComment dfname entry
2996 Gets a value of a Comment attribute at *entry* label.
3003 @subsubsection occt_draw_5_5_11 SetExtStringArray
3007 SetExtStringArray dfname entry lower upper value1 value2 …
3010 Finds or creates an *ExtStringArray* attribute at *entry* label with lower and upper bounds and sets *value1*, *value2*…
3014 SetExtStringArray D 0:2 1 3 *string1* *string2* *string3*
3017 @subsubsection occt_draw_5_5_12 GetExtStringArray
3021 GetExtStringArray dfname entry
3024 Gets a value of an ExtStringArray attribute at *entry* label.
3028 GetExtStringArray D 0:2
3031 @subsubsection occt_draw_5_5_13 SetName
3035 SetName dfname entry value
3038 Finds or creates a Name attribute at *entry* label and sets *value*.
3042 SetName D 0:2 *My name*
3045 @subsubsection occt_draw_5_5_14 GetName
3049 GetName dfname entry
3052 Gets a value of a Name attribute at *entry* label.
3059 @subsubsection occt_draw_5_5_15 SetReference
3063 SetReference dfname entry reference
3066 Creates a Reference attribute at *entry* label and sets *reference*.
3070 SetReference D 0:2 0:4
3073 @subsubsection occt_draw_5_5_16 GetReference
3077 GetReference dfname entry
3080 Gets a value of a Reference attribute at *entry* label.
3087 @subsubsection occt_draw_5_5_17 SetUAttribute
3091 SetUAttribute dfname entry localGUID
3094 Creates a UAttribute attribute at *entry* label with *localGUID*.
3098 set localGUID "c73bd076-22ee-11d2-acde-080009dc4422"
3099 SetUAttribute D 0:2 ${localGUID}
3102 @subsubsection occt_draw_5_5_18 GetUAttribute
3106 GetUAttribute dfname entry loacalGUID
3109 Finds a *UAttribute* at *entry* label with *localGUID*.
3113 set localGUID "c73bd076-22ee-11d2-acde-080009dc4422"
3114 GetUAttribute D 0:2 ${localGUID}
3117 @subsubsection occt_draw_5_5_19 SetFunction
3121 SetFunction dfname entry ID failure
3124 Finds or creates a *Function* attribute at *entry* label with driver ID and *failure* index.
3128 set ID "c73bd076-22ee-11d2-acde-080009dc4422"
3129 SetFunction D 0:2 ${ID} 1
3132 @subsubsection occt_draw_5_5_20 GetFunction
3136 GetFunction dfname entry ID failure
3139 Finds a Function attribute at *entry* label and sets driver ID to *ID* variable and failure index to *failure* variable.
3143 GetFunction D 0:2 ID failure
3146 @subsubsection occt_draw_5_5_21 NewShape
3150 NewShape dfname entry [shape]
3153 Finds or creates a Shape attribute at *entry* label. Creates or updates the associated *NamedShape* attribute by *shape* if *shape* is defined.
3161 @subsubsection occt_draw_5_5_22 SetShape
3165 SetShape dfname entry shape
3168 Creates or updates a *NamedShape* attribute at *entry* label by *shape*.
3176 @subsubsection occt_draw_5_5_23 GetShape
3180 GetShape2 dfname entry shape
3183 Sets a shape from NamedShape attribute associated with *entry* label to *shape* draw variable.
3190 @subsection occt_draw_5_6 Geometric attributes commands
3193 @subsubsection occt_draw_5_6_1 SetPoint
3197 SetPoint dfname entry point
3200 Finds or creates a Point attribute at *entry* label and sets *point* as generated in the associated *NamedShape* attribute.
3208 @subsubsection occt_draw_5_6_2 GetPoint
3212 GetPoint dfname entry [drawname]
3215 Gets a vertex from *NamedShape* attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3222 @subsubsection occt_draw_5_6_3 SetAxis
3226 SetAxis dfname entry axis
3229 Finds or creates an Axis attribute at *entry* label and sets *axis* as generated in the associated *NamedShape* attribute.
3233 line l 10 20 30 100 200 300
3237 @subsubsection occt_draw_5_6_4 GetAxis
3241 GetAxis dfname entry [drawname]
3244 Gets a line from *NamedShape* attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3251 @subsubsection occt_draw_5_6_5 SetPlane
3255 SetPlane dfname entry plane
3258 Finds or creates a Plane attribute at *entry* label and sets *plane* as generated in the associated *NamedShape* attribute.
3262 plane pl 10 20 30 –1 0 0
3266 @subsubsection occt_draw_5_6_6 GetPlane
3270 GetPlane dfname entry [drawname]
3273 Gets a plane from *NamedShape* attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3280 @subsubsection occt_draw_5_6_7 SetGeometry
3284 SetGeometry dfname entry [type] [shape]
3287 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*.
3292 SetGeometry D 0:2 pnt p
3295 @subsubsection occt_draw_5_6_8 GetGeometryType
3299 GetGeometryType dfname entry
3302 Gets a geometry type from Geometry attribute at *entry* label.
3306 GetGeometryType D 0:2
3309 @subsubsection occt_draw_5_6_9 SetConstraint
3313 SetConstraint dfname entry keyword geometrie [geometrie …]
3314 SetConstraint dfname entry "plane" geometrie
3315 SetConstraint dfname entry "value" value
3318 1. Creates a Constraint attribute at *entry* label and sets *keyword* constraint between geometry(ies).
3319 *keyword* must be one of the following:
3320 *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*
3321 2. Sets plane for the existing constraint.
3322 3. Sets value for the existing constraint.
3326 SetConstraint D 0:2 "value" 5
3329 @subsubsection occt_draw_5_6_10 GetConstraint
3333 GetConstraint dfname entry
3336 Dumps a Constraint attribute at *entry* label
3343 @subsubsection occt_draw_5_6_11 SetVariable
3347 SetVariable dfname entry isconstant(0/1) units
3350 Creates a Variable attribute at *entry* label and sets *isconstant* flag and *units* as a string.
3354 SetVariable D 0:2 1 "mm"
3357 @subsubsection occt_draw_5_6_12 GetVariable
3361 GetVariable dfname entry isconstant units
3364 Gets an *isconstant* flag and units of a Variable attribute at *entry* label.
3368 GetVariable D 0:2 isconstant units
3369 puts "IsConstant=${isconstant}"
3370 puts "Units=${units}"
3373 @subsection occt_draw_5_7 Tree attributes commands
3376 @subsubsection occt_draw_5_7_1 RootNode
3380 RootNode dfname treenodeentry [ID]
3383 Returns the ultimate father of *TreeNode* attribute identified by its *treenodeentry* and its *ID* (or default ID, if *ID* is not defined).
3386 @subsubsection occt_draw_5_7_2 SetNode
3390 SetNode dfname treenodeentry [ID]
3393 Creates a *TreeNode* attribute on the *treenodeentry* label with its tree *ID* (or assigns a default ID, if the *ID* is not defined).
3396 @subsubsection occt_draw_5_7_3 AppendNode
3400 AppendNode dfname fatherentry childentry [fatherID]
3404 Inserts a *TreeNode* attribute with its tree *fatherID* (or default ID, if *fatherID* is not defined) on *childentry* as last child of *fatherentry*.
3409 @subsubsection occt_draw_5_7_4 PrependNode
3413 PrependNode dfname fatherentry childentry [fatherID]
3417 Inserts a *TreeNode* attribute with its tree *fatherID* (or default ID, if *fatherID* is not defined) on *childentry* as first child of *fatherentry*.
3420 @subsubsection occt_draw_5_7_5 InsertNodeBefore
3424 InsertNodeBefore dfname treenodeentry beforetreenode [ID]
3427 Inserts a *TreeNode* attribute with tree *ID* (or default ID, if *ID* is not defined) *beforetreenode* before *treenodeentry*.
3430 @subsubsection occt_draw_5_7_6 InsertNodeAfter
3434 InsertNodeAfter dfname treenodeentry aftertreenode [ID]
3437 Inserts a *TreeNode* attribute with tree *ID* (or default ID, if *ID* is not defined) *aftertreenode* after *treenodeentry*.
3440 @subsubsection occt_draw_5_7_7 DetachNode
3444 DetachNode dfname treenodeentry [ID]
3447 Removes a *TreeNode* attribute with tree *ID* (or default ID, if *ID* is not defined) from *treenodeentry*.
3450 @subsubsection occt_draw_5_7_8 ChildNodeIterate
3454 ChildNodeIterate dfname treenodeentry alllevels(0/1) [ID]
3458 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.
3474 AppendNode D 0:2 0:4
3475 AppendNode D 0:2 0:5
3476 PrependNode D 0:4 0:3
3477 PrependNode D 0:4 0:8
3478 PrependNode D 0:4 0:9
3480 InsertNodeBefore D 0:5 0:6
3481 InsertNodeAfter D 0:4 0:7
3487 ChildNodeIterate D 0:2 1
3497 # List only first levels
3498 ChildNodeIterate D 0:2 1
3506 @subsubsection occt_draw_5_7_9 InitChildNodeIterator
3510 InitChildNodeIterator dfname treenodeentry alllevels(0/1) [ID]
3514 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.
3518 InitChildNodeIterate D 0:5 1
3520 for {set i 1} {$i 100} {incr i} {
3521 if {[ChildNodeMore] == *TRUE*} {
3522 puts *Tree node = [ChildNodeValue]*
3527 puts "aChildNumber=$aChildNumber"
3530 @subsubsection occt_draw_5_7_10 ChildNodeMore
3537 Returns TRUE if there is a current item in the iteration.
3540 @subsubsection occt_draw_5_7_11 ChildNodeNext
3547 Moves to the next Item.
3550 @subsubsection occt_draw_5_7_12 ChildNodeValue
3557 Returns the current treenode of *ChildNodeIterator*.
3560 @subsubsection occt_draw_5_7_13 ChildNodeNextBrother
3564 ChildNodeNextBrother
3567 Moves to the next *Brother*. If there is none, goes up. This method is interesting only with *allLevels* behavior.
3570 @subsection occt_draw_5_8 Standard presentation commands
3573 @subsubsection occt_draw_5_8_1 AISInitViewer
3577 AISInitViewer docname
3580 Creates and sets *AISViewer* attribute at root label, creates AIS viewer window.
3587 @subsubsection occt_draw_5_8_2 AISRepaint
3594 Updates the AIS viewer window.
3601 @subsubsection occt_draw_5_8_3 AISDisplay
3605 AISDisplay docname entry [not_update]
3608 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.
3615 @subsubsection occt_draw_5_8_4 AISUpdate
3619 AISUpdate docname entry
3622 Recomputes a presentation of *AISobject* from *entry* label and applies the visualization setting in AIS viewer.
3629 @subsubsection occt_draw_5_8_5 AISErase
3633 AISErase docname entry
3636 Erases *AISobject* of *entry* label in AIS viewer.
3643 @subsubsection occt_draw_5_8_6 AISRemove
3647 AISRemove docname entry
3650 Erases *AISobject* of *entry* label in AIS viewer, then *AISobject* is removed from *AIS_InteractiveContext*.
3657 @subsubsection occt_draw_5_8_7 AISSet
3661 AISSet docname entry ID
3664 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*).
3671 @subsubsection occt_draw_5_8_8 AISDriver
3675 AISDriver docname entry [ID]
3678 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*).
3686 @subsubsection occt_draw_5_8_9 AISUnset
3690 AISUnset docname entry
3693 Deletes *AISPresentation* attribute (if it exists) of an *entry* label.
3700 @subsubsection occt_draw_5_8_10 AISTransparency
3704 AISTransparency docname entry [transparency]
3707 Sets (if *transparency* is defined) or gets the value of transparency for *AISPresentation* attribute of an *entry* label.
3711 AISTransparency D 0:5 0.5
3714 @subsubsection occt_draw_5_8_11 AISHasOwnTransparency
3718 AISHasOwnTransparency docname entry
3721 Tests *AISPresentation* attribute of an *entry* label by own transparency.
3725 AISHasOwnTransparency D 0:5
3728 @subsubsection occt_draw_5_8_12 AISMaterial
3732 AISMaterial docname entry [material]
3735 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).
3742 @subsubsection occt_draw_5_8_13 AISHasOwnMaterial
3746 AISHasOwnMaterial docname entry
3749 Tests *AISPresentation* attribute of an *entry* label by own material.
3753 AISHasOwnMaterial D 0:5
3756 @subsubsection occt_draw_5_8_14 AISColor
3760 AISColor docname entry [color]
3763 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*).
3770 @subsubsection occt_draw_5_8_15 AISHasOwnColor
3774 AISHasOwnColor docname entry
3777 Tests *AISPresentation* attribute of an *entry* label by own color.
3781 AISHasOwnColor D 0:5
3784 @section occt_draw_6 Geometry commands
3786 @subsection occt_draw_6_1 Overview
3788 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.
3790 In the context of Geometry, Draw includes the following types of variable:
3793 * The 2d curve, which corresponds to *Curve* in *Geom2d*.
3794 * 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>.
3796 Draw geometric variables never share data; the *copy* command will always make a complete copy of the content of the variable.
3798 The following topics are covered in the nine sections of this chapter:
3800 * **Curve creation** deals with the various types of curves and how to create them.
3801 * **Surface creation** deals with the different types of surfaces and how to create them.
3802 * **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.
3803 * **Geometric transformations** covers translation, rotation, mirror image and point scaling transformations.
3804 * **Curve and Surface Analysis** deals with the commands used to compute points, derivatives and curvatures.
3805 * **Intersections** presents intersections of surfaces and curves.
3806 * **Approximations** deals with creating curves and surfaces from a set of points.
3807 * **Constraints** concerns construction of 2d circles and lines by constraints such as tangency.
3808 * **Display** describes commands to control the display of curves and surfaces.
3810 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.
3812 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.
3814 @subsection occt_draw_6_2 Curve creation
3816 This section deals with both points and curves. Types of curves are:
3818 * Analytical curves such as lines, circles, ellipses, parabolas, and hyperbolas.
3819 * Polar curves such as bezier curves and bspline curves.
3820 * 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.
3821 * NURBS can be created from other curves using *convert* in the *Surface Creation* section.
3822 * Curves can be created from the isoparametric lines of surfaces by the *uiso* and *viso* commands.
3823 * 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.
3825 Curves are displayed with an arrow showing the last parameter.
3828 @subsubsection occt_draw_6_2_1 point
3835 Creates a 2d or 3d point, depending on the number of arguments.
3846 @subsubsection occt_draw_6_2_2 line
3850 line name x y [z] dx dy [dz]
3854 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.
3856 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.
3860 # a 2d line at 45 degrees of the X axis
3863 # a 3d line through the point 10 0 0 and parallel to Z
3867 @subsubsection occt_draw_6_2_3 circle
3871 circle name x y [z [dx dy dz]] [ux uy [uz]] radius
3874 Creates a 2d or a 3d circle.
3876 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.
3878 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*.
3880 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.
3884 # A 2d circle of radius 5 centered at 10,-2
3887 # another 2d circle with a user defined origin
3888 # the point of parameter 0 on this circle will be
3889 # 1+sqrt(2),1+sqrt(2)
3892 # a 3d circle, center 10 20 -5, axis Z, radius 17
3893 circle c3 10 20 -5 17
3895 # same 3d circle with axis Y
3896 circle c4 10 20 -5 0 1 0 17
3898 # full 3d circle, axis X, origin on Z
3899 circle c5 10 20 -5 1 0 0 0 0 1 17
3902 @subsubsection occt_draw_6_2_4 ellipse
3906 ellipse name x y [z [dx dy dz]] [ux uy [uz]] firstradius secondradius
3909 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:
3912 P(u) = O + firstradius*cos(u)*Xdir + secondradius*sin(u)*Ydir
3916 * P is the point of parameter *u*,
3917 * *O, Xdir* and *Ydir* are respectively the origin, *X Direction* and *Y Direction* of its local coordinate system.
3921 # default 2d ellipse
3922 ellipse e1 10 5 20 10
3924 # 2d ellipse at angle 60 degree
3925 ellipse e2 0 0 1 2 30 5
3927 # 3d ellipse, in the XY plane
3928 ellipse e3 0 0 0 25 5
3930 # 3d ellipse in the X,Z plane with axis 1, 0 ,1
3931 ellipse e4 0 0 0 0 1 0 1 0 1 25 5
3934 @subsubsection occt_draw_6_2_5 hyperbola
3938 hyperbola name x y [z [dx dy dz]] [ux uy [uz]] firstradius secondradius
3941 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.
3943 The Draw hyperbola is parameterized as follows:
3945 P(U) = O + firstradius*Cosh(U)*XDir + secondradius*Sinh(U)*YDir
3949 * *P* is the point of parameter *U*,
3950 * *O, XDir* and *YDir* are respectively the origin, *X Direction* and *YDirection* of its local coordinate system.
3954 # default 2d hyperbola, with asymptotes 1,1 -1,1
3955 hyperbola h1 0 0 30 30
3957 # 2d hyperbola at angle 60 degrees
3958 hyperbola h2 0 0 1 2 20 20
3960 # 3d hyperbola, in the XY plane
3961 hyperbola h3 0 0 0 50 50
3964 @subsubsection occt_draw_6_2_6 parabola
3968 parabola name x y [z [dx dy dz]] [ux uy [uz]] FocalLength
3971 Creates a 2d or 3d parabola. in the axis system defined by the first arguments. The origin is the apex of the parabola.
3973 The *Geom_Parabola* is parameterized as follows:
3976 P(u) = O + u*u/(4.*F)*XDir + u*YDir
3980 * *P* is the point of parameter *u*,
3981 * *O, XDir* and *YDir* are respectively the origin, *X Direction* and *Y Direction* of its local coordinate system,
3982 * *F* is the focal length of the parabola.
3989 # 2d parabola with convexity +Y
3990 parabola p2 0 0 0 1 50
3992 # 3d parabola in the Y-Z plane, convexity +Z
3993 parabola p3 0 0 0 1 0 0 0 0 1 50
3996 @subsubsection occt_draw_6_2_7 beziercurve, 2dbeziercurve
4000 beziercurve name nbpole pole, [weight]
4001 2dbeziercurve name nbpole pole, [weight]
4004 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.
4008 # a rational 2d bezier curve (arc of circle)
4009 2dbeziercurve ci 3 0 0 1 10 0 sqrt(2.)/2. 10 10 1
4011 # a 3d bezier curve, not rational
4012 beziercurve cc 4 0 0 0 10 0 0 10 0 10 10 10 10
4015 @subsubsection occt_draw_6_2_8 bsplinecurve, 2dbsplinecurve, pbsplinecurve, 2dpbsplinecurve
4019 bsplinecurve name degree nbknots knot, umult pole, weight
4020 2dbsplinecurve name degree nbknots knot, umult pole, weight
4022 pbsplinecurve name degree nbknots knot, umult pole, weight (periodic)
4023 2dpbsplinecurve name degree nbknots knot, umult pole, weight (periodic)
4026 Creates 2d or 3d bspline curves; the **pbsplinecurve** and **2dpbsplinecurve** commands create periodic bspline curves.
4028 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.
4030 The table of knots is an increasing sequence of reals without repetition.
4031 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.
4033 The poles must be given with their weights, use weights of 1 for a non rational curve, the number of poles must be:
4035 * For a non periodic curve: Sum of multiplicities - degree + 1
4036 * For a periodic curve: Sum of multiplicities - last multiplicity
4040 # a bspline curve with 4 poles and 3 knots
4041 bsplinecurve bc 2 3 0 3 1 1 2 3 \
4042 10 0 7 1 7 0 7 1 3 0 8 1 0 0 7 1
4043 # a 2d periodic circle (parameter from 0 to 2*pi !!)
4045 2dpbsplinecurve c 2 \
4046 4 0 2 pi/1.5 2 pi/0.75 2 2*pi 2 \
4056 **Note** that you can create the **NURBS** subset of bspline curves and surfaces by trimming analytical curves and surfaces and executing the command *convert*.
4059 @subsubsection occt_draw_6_2_9 uiso, viso
4067 Creates a U or V isoparametric curve from a surface.
4071 # create a cylinder and extract iso curves
4078 **Note** that this cannot be done from offset surfaces.
4081 @subsubsection occt_draw_6_2_10 to3d, to2d
4085 to3d name curve2d [plane]
4086 to2d name curve3d [plane]
4089 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.
4093 # the following commands
4095 plane p -2 1 0 1 2 3
4098 # will create the same circle as
4099 circle c -2 1 0 1 2 3 5
4102 See also: **project**
4105 @subsubsection occt_draw_6_2_11 project
4109 project name curve3d surface
4112 Computes a 2d curve in the parametric space of a surface corresponding to a 3d curve. This can only be used on analytical surfaces.
4114 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.
4123 @subsection occt_draw_6_3 Surface creation
4125 The following types of surfaces exist:
4126 * Analytical surfaces: plane, cylinder, cone, sphere, torus;
4127 * Polar surfaces: bezier surfaces, bspline surfaces;
4128 * Trimmed and Offset surfaces;
4129 * Surfaces produced by Revolution and Extrusion, created from curves with the *revsurf* and *extsurf*;
4132 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.
4134 @subsubsection occt_draw_6_3_1 plane
4138 plane name [x y z [dx dy dz [ux uy uz]]]
4141 Creates an infinite plane.
4143 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.
4145 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*.
4147 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.
4149 Note that this definition will be used for all analytical surfaces.
4153 # a plane through the point 10,0,0 perpendicular to X
4154 # with U direction on Y
4155 plane p1 10 0 0 1 0 0 0 1 0
4157 # an horixontal plane with origin 10, -20, -5
4161 @subsubsection occt_draw_6_3_2 cylinder
4165 cylinder name [x y z [dx dy dz [ux uy uz]]] radius
4168 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.
4172 # a cylinder on the default Z axis, radius 10
4175 # a cylinder, also along the Z axis but with origin 5,
4177 cylinder c2 5 10 -3 10
4179 # a cylinder through the origin and on a diagonal
4180 # with longitude pi/3 and latitude pi/4 (euler angles)
4181 dset lo pi/3. la pi/4.
4182 cylinder c3 0 0 0 cos(la)*cos(lo) cos(la)*sin(lo)
4186 @subsubsection occt_draw_6_3_3 cone
4190 cone name [x y z [dx dy dz [ux uy uz]]] semi-angle radius
4192 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.
4196 # a cone at 45 degrees at the origin on Z
4199 # a cone on axis Z with radius r1 at z1 and r2 at z2
4200 cone c2 0 0 z1 180.*atan2(r2-r1,z2-z1)/pi r1
4203 @subsubsection occt_draw_6_3_4 sphere
4207 sphere name [x y z [dx dy dz [ux uy uz]]] radius
4210 Creates a sphere in the local coordinate system defined in the **plane** command. The sphere is centered at the origin.
4212 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.
4216 # a sphere at the origin
4218 # a sphere at 10 10 10, with poles on the axis 1,1,1
4219 sphere s2 10 10 10 1 1 1 10
4222 @subsubsection occt_draw_6_3_5 torus
4226 torus name [x y z [dx dy dz [ux uy uz]]] major minor
4229 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.
4231 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.
4235 # a torus at the origin
4238 # a torus in another coordinate system
4239 torus t2 10 5 -2 2 1 0 20 5
4243 @subsubsection occt_draw_6_3_6 beziersurf
4247 beziersurf name nbupoles nbvolpes pole, [weight]
4250 Use this command to create a bezier surface, rational or non-rational. First give the numbers of poles in the u and v directions.
4252 Then give the poles in the following order: *pole(1, 1), pole(nbupoles, 1), pole(1, nbvpoles)* and *pole(nbupoles, nbvpoles)*.
4254 Weights may be omitted, but if you give one weight you must give all of them.
4258 # a non-rational degree 2,3 surface
4260 0 0 0 10 0 5 20 0 0 \
4261 0 10 2 10 10 3 20 10 2 \
4262 0 20 10 10 20 20 20 20 10 \
4263 0 30 0 10 30 0 20 30 0
4266 @subsubsection occt_draw_6_3_7 bsplinesurf, upbsplinesurf, vpbsplinesurf, uvpbsplinesurf
4270 bsplinesurf name udegree nbuknots uknot umult ... nbvknot vknot
4271 vmult ... x y z w ...
4277 * **bsplinesurf** generates bspline surfaces;
4278 * **upbsplinesurf** creates a bspline surface periodic in u;
4279 * **vpbsplinesurf** creates one periodic in v;
4280 * **uvpbsplinesurf** creates one periodic in uv.
4282 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.
4284 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.
4288 # create a bspline surface of degree 1 2
4289 # with two knots in U and three in V
4294 0 10 2 1 10 10 3 1 \
4295 0 20 10 1 10 20 20 1 \
4300 @subsubsection occt_draw_6_3_8 trim, trimu, trimv
4304 trim newname name [u1 u2 [v1 v2]]
4309 The **trim** commands create trimmed curves or trimmed surfaces. Note that trimmed curves and surfaces are classes of the *Geom* package.
4310 * *trim* creates either a new trimmed curve from a curve or a new trimmed surface in u and v from a surface.
4311 * *trimu* creates a u-trimmed surface,
4312 * *trimv* creates a v-trimmed surface.
4314 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.
4316 **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.
4320 # create a 3d circle
4323 # trim it, use the same variable, the original is
4327 # the original can be recovered!
4333 # the original is not the trimmed curve but the basis
4336 # as the circle is periodic, the two following commands
4341 # trim an infinite cylinder
4346 @subsubsection occt_draw_6_3_9 offset
4350 offset name basename distance [dx dy dz]
4353 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.
4355 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.
4357 The offset curve or surface copies the basic geometry, which can be modified later.
4361 # graphic demonstration that the outline of a torus
4362 # is the offset of an ellipse
4365 torus t 0 0 0 0 cos(angle) sin(angle) 50 20
4367 ellipse e 0 0 0 50 50*sin(angle)
4368 # note that the distance can be negative
4369 offset l1 e 20 0 0 1
4372 @subsubsection occt_draw_6_3_10 revsurf
4376 revsurf name curvename x y z dx dy dz
4379 Creates a surface of revolution from a 3d curve.
4381 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.
4383 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.
4387 # another way of creating a torus like surface
4389 revsurf s c 0 0 0 0 1 0
4392 @subsubsection occt_draw_6_3*11 extsurf
4396 extsurf newname curvename dx dy dz
4399 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.
4401 In the syntax, *dx,dy,dz* gives the direction of extrusion.
4403 To parameterize a surface of extrusion: *u* is the parameter along the extruded curve; the *v* parameter is along the direction of extrusion.
4407 # an elliptic cylinder
4408 ellipse e 0 0 0 10 5
4414 @subsubsection occt_draw_6_3_12 convert
4418 convert newname name
4421 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.
4425 # turn a 2d arc of a circle into a 2d NURBS
4430 # an easy way to make a planar bspline surface
4436 **Note** that offset curves and surfaces are not processed by this command.
4438 @subsection occt_draw_6_4 Curve and surface modifications
4440 Draw provides commands to modify curves and surfaces, some of them are general, others restricted to bezier curves or bsplines.
4442 General modifications:
4444 * Reversing the parametrization: **reverse**, **ureverse**, **vreverse**
4446 Modifications for both bezier curves and bsplines:
4448 * Exchanging U and V on a surface: **exchuv**
4449 * Segmentation: **segment**, **segsur**
4450 * Increasing the degree: **incdeg**, **incudeg**, **incvdeg**
4451 * Moving poles: **cmovep**, **movep**, **movecolp**, **moverowp**
4453 Modifications for bezier curves:
4455 * Adding and removing poles: **insertpole**, **rempole**, **remcolpole**, **remrowpole**
4457 Modifications for bspline:
4459 * Inserting and removing knots: **insertknot**, **remknot**, **insertuknot**, **remuknot**, **insetvknot**, **remvknot**
4460 * Modifying periodic curves and surfaces: **setperiodic**, **setnotperiodic**, **setorigin**, **setuperiodic**, **setunotperiodic**, **setuorigin**, **setvperiodic**, **setvnotperiodic**, **setvorigin**
4464 @subsubsection occt_draw_6_4_1 reverse, ureverse, vreverse
4470 ureverse surfacename
4471 vreverse surfacename
4474 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.
4476 **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.
4478 Reversing a parameter on an analytical surface may create an indirect coordinate system.
4482 # reverse a trimmed 2d circle
4487 # dumping c will show that it is now trimmed between
4488 # 3*pi/2 and 7*pi/4 i.e. 2*pi-pi/2 and 2*pi-pi/4
4491 @subsubsection occt_draw_6_4_2 exchuv
4498 For a bezier or bspline surface this command exchanges the u and v parameters.
4502 # exchanging u and v on a spline (made from a cylinder)
4509 @subsubsection occt_draw_6_4_3 segment, segsur
4513 segment curve Ufirst Ulast
4514 segsur surface Ufirst Ulast Vfirst Vlast
4517 **segment** and **segsur** segment a bezier curve and a bspline curve or surface respectively.
4519 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*.
4521 This command must not be confused with **trim** which creates a new geometry.
4525 # segment a bezier curve in half
4526 beziercurve c 3 0 0 0 10 0 0 10 10 0
4527 segment c ufirst ulast
4530 @subsubsection occt_draw_6_4_4 iincudeg, incvdeg
4534 incudeg surfacename newdegree
4535 incvdeg surfacename newdegree
4538 **incudeg** and **incvdeg** increase the degree in the U or V parameter of a bezier or bspline surface.
4542 # make a planar bspline and increase the degree to 2 3
4550 **Note** that the geometry is modified.
4553 @subsubsection occt_draw_6_4_5 cmovep, movep, movecolp, moverowp
4557 cmovep curve index dx dy [dz]
4558 movep surface uindex vindex dx dy dz
4559 movecolp surface uindex dx dy dz
4560 moverowp surface vindex dx dy dz
4563 **move** methods translate poles of a bezier curve, a bspline curve or a bspline surface.
4564 * **cmovep** and **movep** translate one pole with a given index.
4565 * **movecolp** and **moverowp** translate a whole column (expressed by the *uindex*) or row (expressed by the *vindex*) of poles.
4569 # start with a plane
4570 # transform to bspline, raise degree and add relief
4572 trim p p -10 10 -10 10
4581 @subsubsection occt_draw_6_4_6 insertpole, rempole, remcolpole, remrowpole
4585 insertpole curvename index x y [z] [weight]
4586 rempole curvename index
4587 remcolpole surfacename index
4588 remrowpole surfacename index
4591 **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.
4593 **rempole** removes a pole from a 2d or 3d bezier curve. Leave at least two poles in the curves.
4595 **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.
4599 # start with a segment, insert a pole at end
4600 # then remove the central pole
4601 beziercurve c 2 0 0 0 10 0 0
4602 insertpole c 2 10 10 0
4606 @subsubsection occt_draw_6_4_7 insertknot, insertuknot, insertvknot
4610 insertknot name knot [mult = 1] [knot mult ...]
4611 insertuknot surfacename knot mult
4612 insertvknot surfacename knot mult
4615 **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.
4617 **insertuknot** and **insertvknot** insert knots in a surface.
4621 # create a cylindrical surface and insert a knot
4623 trim c c 0 pi/2 0 10
4625 insertuknot c1 pi/4 1
4628 @subsubsection occt_draw_6_4_8 remknot, remuknot, remvknot
4632 remknot index [mult] [tol]
4633 remuknot index [mult] [tol]
4634 remvknot index [mult] [tol]
4637 **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.
4639 By default, if no tolerance is given, the knot will always be removed.
4643 # bspline circle, remove a knot
4650 **Note** that Curves or Surfaces may be modified.
4653 @subsubsection occt_draw_6_4_9 setperiodic, setnotperiodic, setuperiodic, setunotperiodic, setvperiodic, setvnotperiodic
4658 setnotperiodic curve
4659 setuperiodic surface
4660 setunotperiodic surface
4661 setvperiodic surface
4662 setvnotperiodic surface
4665 **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.
4667 **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.
4671 # a circle deperiodicized
4677 @subsubsection occt_draw_6_4_10 setorigin, setuorigin, setvorigin
4681 setorigin curvename index
4682 setuorigin surfacename index
4683 setuorigin surfacename index
4686 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.
4690 # a torus with new U and V origins
4698 @subsection occt_draw_6_5 Transformations
4700 Draw provides commands to apply linear transformations to geometric objects: they include translation, rotation, mirroring and scaling.
4702 @subsubsection occt_draw_6_5_1 translate, dtranslate
4706 translate name [names ...] dx dy dz
4707 2dtranslate name [names ...] dx dy
4710 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.
4712 For 2d points or curves, use the **2dtranslate** command.
4719 torus t 10 20 30 5 2
4720 translate p c t 0 0 15
4724 *Objects are modified by this command.*
4726 @subsubsection occt_draw_6_5_2 rotate, 2drotate
4730 rotate name [name ...] x y z dx dy dz angle
4731 2drotate name [name ...] x y angle
4734 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.
4736 For a 2d rotation, you need only give the center point and the angle. In 2d or 3d, the angle can be negative.
4740 # make a helix of circles. create a scripte file with
4741 this code and execute it using **source**.
4743 for {set i 1} {$i = 10} {incr i} {
4744 copy c[expr $i-1] c$i
4746 rotate c$i 0 0 0 0 0 1 36
4750 @subsubsection occt_draw_6_5_3 pmirror, lmirror, smirror, dpmirror, dlmirror
4754 pmirror name [names ...] x y z
4755 lmirror name [names ...] x y z dx dy dz
4756 smirror name [names ...] x y z dx dy dz
4757 2dpmirror name [names ...] x y
4758 2dlmirror name [names ...] x y dx dy
4761 The mirror commands perform a mirror transformation of 2d or 3d geometry.
4763 * **pmirror** is the point mirror, mirroring 3d curves and surfaces about a point of symmetry.
4764 * **lmirror** is the line mirror commamd, mirroring 3d curves and surfaces about an axis of symmetry.
4765 * **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.
4766 * **2dpmirror** is the point mirror in 2D.
4767 * **2dlmirror** is the axis symmetry mirror in 2D.
4771 # build 3 images of a torus
4772 torus t 10 10 10 1 2 3 5 1
4776 lmirror t2 0 0 0 1 0 0
4778 smirror t3 0 0 0 1 0 0
4781 @subsubsection occt_draw_6_5_4 pscale, dpscale
4785 pscale name [name ...] x y z s
4786 2dpscale name [name ...] x y s
4789 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**.
4794 # double the size of a sphere
4799 @subsection occt_draw_6_6 Curve and surface analysis
4801 **Draw** provides methods to compute information about curves and surfaces:
4803 * **coord** to find the coordinates of a point.
4804 * **cvalue** and **2dcvalue** to compute points and derivatives on curves.
4805 * **svalue** to compute points and derivatives on a surface.
4806 * **localprop** and **minmaxcurandif** to compute the curvature on a curve.
4807 * **parameters** to compute (u,v) values for a point on a surface.
4808 * **proj** and **2dproj** to project a point on a curve or a surface.
4809 * **surface_radius** to compute the curvature on a surface.
4811 @subsubsection occt_draw_6_6_1 coord
4818 Sets the x, y (and optionally z) coordinates of the point P.
4830 @subsubsection occt_draw_6_6_2 cvalue, 2dcvalue
4834 cvalue curve U x y z [d1x d1y d1z [d2x d2y d2z]]
4835 2dcvalue curve U x y [d1x d1y [d2x d2y]]
4838 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*.
4842 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* :
4845 2dbeziercurve c 4 0 0 1 1 2 1 3 0
4846 2dcvalue c 0 x y d1x d1y d2x d2y
4848 # values of x y d1x d1y d2x d2y
4852 @subsubsection occt_draw_6_6_3 svalue
4856 svalue surfname U v x y z [dux duy duz dvx dvy dvz [d2ux d2uy d2uz d2vx d2vy d2vz d2uvx d2uvy d2uvz]]
4859 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.
4863 # display points on a sphere
4865 for {dset t 0} {[dval t] = 1} {dset t t+0.01} {
4866 svalue s t*2*pi t*pi-pi/2 x y z
4871 @subsubsection occt_draw_6_6_4 localprop, minmaxcurandinf
4875 localprop curvename U
4876 minmaxcurandinf curve
4879 **localprop** computes the curvature of a curve.
4880 **minmaxcurandinf** computes and prints the parameters of the points where the curvature is minimum and maximum on a 2d curve.
4884 # show curvature at the center of a bezier curve
4885 beziercurve c 3 0 0 0 10 2 0 20 0 0
4890 @subsubsection occt_draw_6_6_5 parameters
4894 parameters surf/curve x y z U [V]
4897 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.
4901 # Compute parameters on a plane
4902 plane p 0 0 10 1 1 0
4903 parameters p 5 5 5 u v
4904 # the values of u and v are : 0 5
4907 @subsubsection occt_draw_6_6_6 proj, dproj
4915 Use **proj** to project a point on a 3d curve or a surface and **2dproj** for a 2d curve.
4917 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, ... *
4921 Let us project a point on a torus
4926 == ext_1 ext_2 ext_3 ext_4
4929 @subsubsection occt_draw_6_6_7 surface_radius
4933 surface_radius surface u v [c1 c2]
4936 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*.
4940 Let us compute curvatures of a cylinder:
4944 surface_radius c pi 3 c1 c2
4945 == Min Radius of Curvature : -5
4946 == Min Radius of Curvature : infinite
4950 @subsection occt_draw_6_7 Intersections
4952 * **intersect** computes intersections of surfaces;
4953 * **2dintersect** computes intersections of 2d curves.
4955 @subsubsection occt_draw_6_7_1 intersect
4959 intersect name surface1 surface2
4962 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*, ...
4968 plane p 0 0 40 0 1 5
4972 @subsubsection occt_draw_6_7_2 dintersect
4976 2dintersect curve1 curve2
4979 Displays the intersection points between two 2d curves.
4983 # intersect two 2d ellipses
4985 ellipse e2 0 0 0 1 5 2
4989 @subsection occt_draw_6_8 Approximations
4991 Draw provides command to create curves and surfaces by approximation.
4993 * **2dapprox** fits a curve through 2d points;
4994 * **appro** fits a curve through 3d points;
4995 * **surfapp** and **grilapp** fit a surface through 3d points;
4996 * **2dinterpolate** interpolates a curve.
4998 @subsubsection occt_draw_6_8_1 appro, dapprox
5002 appro result nbpoint [curve]
5003 2dapprox result nbpoint [curve / x1 y1 x2 y2]
5006 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.
5010 Let us pick points and they will be fitted
5016 @subsubsection occt_draw_6_8_2 surfapp, grilapp
5021 surfapp name nbupoints nbvpoints x y z ....
5022 grilapp name nbupoints nbvpoints xo dx yo dy z11 z12 ...
5025 * **surfapp** fits a surface through an array of u and v points, nbupoints*nbvpoints.
5026 * **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.
5030 # a surface using the same data as in the beziersurf
5033 0 0 0 10 0 5 20 0 0 \
5034 0 10 2 10 10 3 20 10 2 \
5035 0 20 10 10 20 20 20 20 10 \
5036 0 30 0 10 30 0 20 30 0
5039 @subsection occt_draw_6_9 Constraints
5041 * **cirtang** constructs 2d circles tangent to curves;
5042 * **lintan** constructs 2d lines tangent to curves.
5045 @subsubsection occt_draw_6_9_1 cirtang
5049 cirtang cname curve/point/radius curve/point/radius curve/point/radius
5052 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.
5056 # a point, a line and a radius. 2 solutions
5063 @subsubsection occt_draw_6_9_2 lintan
5067 lintan name curve curve [angle]
5070 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.
5074 # lines tangent to 2 circles, 4 solutions
5079 # lines at 15 degrees tangent to a circle and a line, 2
5080 solutions: l1_1 l1_2
5086 @subsection occt_draw_6_10 Display
5088 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.
5090 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.
5092 On surfaces, you can control the number of isoparametric curves displayed on the surface with the **nbiso** command.
5094 On bezier and bspline curve and surface you can toggle the display of the control points with the **clpoles** and **shpoles** commands.
5096 On bspline curves and surfaces you can toggle the display of the knots with the **shknots** and **clknots** commands.
5099 @subsubsection occt_draw_6_10_1 dmod, discr, defle
5103 dmode name [name ...] u/d
5104 discr name [name ...] nbintervals
5105 defle name [name ...] deflection
5108 **dmod** command allows choosing the display mode for a curve or a surface.
5110 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.
5112 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).
5114 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.
5118 # increment the number of points on a big circle
5126 @subsubsection occt_draw_6_10_2 nbiso
5130 nbiso name [names...] nuiso nviso
5133 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.
5137 Let us display 35 meridians and 15 parallels on a sphere:
5143 @subsubsection occt_draw_6_10_3 clpoles, shpoles
5151 On bezier and bspline curves and surfaces, the control polygon is displayed by default: *clpoles* erases it and *shpoles* restores it.
5155 Let us make a bezier curve and erase the poles
5158 beziercurve c 3 0 0 0 10 0 0 10 10 0
5162 @subsubsection occt_draw_6_10_4 clknots, shknots
5170 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.
5174 # hide the knots on a bspline curve
5175 bsplinecurve bc 2 3 0 3 1 1 2 3 \
5176 10 0 7 1 7 0 7 1 3 0 8 1 0 0 7 1
5180 @section occt_draw_7 Topology commands
5182 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.
5184 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.
5186 The <a href="user_guides__modeling_data.html#occt_modat_5">different topological shapes</a> include:
5188 * **COMPOUND**: A group of any type of topological object.
5189 * **COMPSOLID**: A set of solids connected by their faces. This expands the notions of WIRE and SHELL to solids.
5190 * **SOLID**: A part of space limited by shells. It is three dimensional.
5191 * **SHELL**: A set of faces connected by their edges. A shell can be open or closed.
5192 * **FACE**: In 2d, a plane; in 3d, part of a surface. Its geometry is constrained (trimmed) by contours. It is two dimensional.
5193 * **WIRE**: A set of edges connected by their vertices. It can be open or closed depending on whether the edges are linked or not.
5194 * **EDGE**: A topological element corresponding to a restrained curve. An edge is generally limited by vertices. It has one dimension.
5195 * **VERTEX**: A topological element corresponding to a point. It has a zero dimension.
5197 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**).
5199 The following topics are covered in the eight sections of this chapter:
5201 * Basic shape commands to handle the structure of shapes and control the display.
5202 * Curve and surface topology, or methods to create topology from geometry and vice versa.
5203 * Primitive construction commands: box, cylinder, wedge etc.
5204 * Sweeping of shapes.
5205 * Transformations of shapes: translation, copy, etc.
5206 * Topological operations, or booleans.
5207 * Drafting and blending.
5208 * Analysis of shapes.
5211 @subsection occt_draw_7_1 Basic topology
5213 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:
5215 * **isos** and **discretisation** to control display of shape faces by isoparametric curves .
5216 * **orientation**, **complement** and **invert** to modify topological attributes such as orientation.
5217 * **explode**, **exwire** and **nbshapes** to analyze the structure of a shape.
5218 * **emptycopy**, **add**, **compound** to create shapes by stepwise construction.
5220 In Draw, shapes are displayed using isoparametric curves. There is color coding for the edges:
5222 * a red edge is an isolated edge, which belongs to no faces.
5223 * a green edge is a free boundary edge, which belongs to one face,
5224 * a yellow edge is a shared edge, which belongs to at least two faces.
5227 @subsubsection occt_draw_7_1_1 isos, discretisation
5231 isos [name ...][nbisos]
5232 discretisation nbpoints
5235 Determines or changes the number of isoparametric curves on shapes.
5237 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.
5239 *discretisation* changes the default number of points used to display the curves. The default value is 30.
5243 # Display only the edges (the wireframe)
5247 **Warning**: don’t confuse *isos* and *discretisation* with the geometric commands *nbisos* and *discr*.
5250 @subsubsection occt_draw_7_1_2 orientation, complement, invert, normals, range
5254 orientation name [name ...] F/R/E/I
5255 complement name [name ...]
5257 normals s (length = 10), disp normals
5258 range name value value
5261 * **orientation** assigns the orientation of shapes - simple and complex - to one of the following four values: *FORWARD, REVERSED, INTERNAL, EXTERNAL*.
5262 * **complement** changes the current orientation of shapes to its complement, *FORWARD - REVERSED, INTERNAL - EXTERNAL*.
5263 * **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.
5264 * *normals** returns the assignment of colors to orientation values.
5265 * **range** defines the length of a selected edge by defining the values of a starting point and an end point.
5269 # to invert normals of a box
5275 # to assign a value to an edge
5277 # to define the box as edges
5279 b_1 b_2 b_3 b_4 b_5 b_6 b_7 b_8 b_9 b_10 b_11 b_12
5280 # to define as an edge
5282 # to define the length of the edge as starting from 0
5287 @subsubsection occt_draw_7_1_3 explode, exwire, nbshapes
5291 explode name [C/So/Sh/F/W/E/V]
5296 **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.
5298 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.
5300 **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.
5302 **nbshapes** counts the number of shapes of each type in an entity.
5309 # whatis returns the type and various information
5311 = b is a shape SOLID FORWARD Free Modified
5316 = b_1 is a shape SHELL FORWARD Modified Orientable
5319 # extract the edges b_1, ... , b_12
5326 Number of shapes in b
5338 @subsubsection occt_draw_7_1_4 emptycopy, add, compound
5342 emptycopy [newname] name
5344 compound [name ...] compoundname
5347 **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.
5349 **add** inserts shape *C* into shape *S*. Verify that *C* and *S* reference compatible types of objects:
5350 * Any *Shape* can be added to a *Compound*.
5351 * Only a *Solid* can be added to a *CompSolid*.
5352 * Only a *Shell* can *Edge* or a *Vertex* can be added into a *Solid*.
5353 * Only a *Face* can be added to a *Shell*.
5354 * Only a *Wire* and *Vertex* can be added in a *Solid*.
5355 * Only an *Edge* can be added to a *Wire*.
5356 * Only a *Vertex* can be added to an *Edge*.
5357 * Nothing can be added to a *Vertex*.
5359 **emptycopy** and **add** should be used with care.
5361 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.
5365 # a compound with three boxes
5372 @subsubsection occt_draw_7_1_5 checkshape
5376 checkshape [-top] shape [result] [-short]
5380 * *top* – optional parameter, which allows checking only topological validity of a shape.
5381 * *shape*– the only required parameter which represents the name of the shape to check.
5382 * *result* – optional parameter which is the prefix of the output shape names.
5383 * *short* – a short description of the check.
5385 **checkshape** examines the selected object for topological and geometric coherence. The object should be a three dimensional shape.
5389 # checkshape returns a comment valid or invalid
5392 # returns the comment
5393 this shape seems to be valid
5396 **Note** that this test is performed using the tolerance set in the algorithm.
5399 @subsection occt_draw_7_2 Curve and surface topology
5401 This group of commands is used to create topology from shapes and to extract shapes from geometry.
5403 * To create vertices, use the **vertex** command.
5404 * To create edges use, the **edge**, **mkedge** commands.
5405 * To create wires, use the **wire**, **polyline**, **polyvertex** commands.
5406 * To create faces, use the **mkplane**, **mkface** commands.
5407 * To extract the geometry from edges or faces, use the **mkcurve** and **mkface** commands.
5408 * To extract the 2d curves from edges or faces, use the **pcurve** command.
5411 @subsubsection occt_draw_7_2_1 vertex
5415 vertex name [x y z / p edge]
5418 Creates a vertex at either a 3d location x,y,z or the point at parameter p on an edge.
5425 @subsubsection occt_draw_7_2_2 edge, mkedge, uisoedge, visoedge
5429 edge name vertex1 vertex2
5430 mkedge edge curve [surface] [pfirst plast] [vfirst [pfirst] vlast [plast]]
5431 uisoedge edge face u v1 v2
5432 visoedge edge face v u1 u2
5435 * **edge** creates a straight line edge between two vertices.
5436 * **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.
5440 # straight line edge
5445 # make a circular edge
5449 # A similar result may be achieved by trimming the curve
5450 # The trimming is removed by mkedge
5455 * **visoedge** and **uisoedge** are commands that generate a *uiso* parameter edge or a *viso* parameter edge.
5459 # to create an edge between v1 and v2 at point u
5460 # to create the example plane
5469 # to create the edge in the plane at the u axis point
5470 0.5, and between the v axis points v=0.2 and v =0.8
5471 uisoedge e p 0.5 0.20 0.8
5474 @subsubsection occt_draw_7_2_3 wire, polyline, polyvertex
5478 wire wirename e1/w1 [e2/w2 ...]
5479 polyline name x1 y1 z1 x2 y2 z2 ...
5480 polyvertex name v1 v2 ...
5483 **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.
5485 **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.
5487 **polyvertex** creates a polygonal wire from vertices.
5491 # create two polygonal wires
5492 # glue them and define as a single wire
5493 polyline w1 0 0 0 10 0 0 10 10 0
5494 polyline w2 10 10 0 0 10 0 0 0 0
5498 @subsubsection occt_draw_7_2_4 profile
5502 profile name [code values] [code values] ...
5506 **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.
5509 | **Code** | **Values ** | **Action** |
5510 | :------------ | :------------- | :---------------- |
5511 | O | X Y Z | Sets the origin of the plane |
5512 | P | DX DY DZ UX UY UZ | Sets the normal and X of the plane |
5513 | F | X Y | Sets the first point |
5514 | X | DX | Translates a point along X |
5515 | Y | DY | Translates a point along Y |
5516 | L | DL | Translates a point along direction |
5517 | XX | X | Sets point X coordinate |
5518 | YY | Y | Sets point Y coordinate |
5519 | T | DX DY | Translates a point |
5520 | TT | X Y | Sets a point |
5521 | R | Angle | Rotates direction |
5522 | RR | Angle | Sets direction |
5523 | D | DX DY | Sets direction |
5524 | IX | X | Intersects with vertical |
5525 | IY | Y | Intersects with horizontal |
5526 | C | Radius Angle | Arc of circle tangent to direction |
5529 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.
5531 The point [code values] can be repeated any number of times and in any order to create the profile contour.
5535 | No suffix | Makes a closed face |
5536 | W | Make a closed wire |
5537 | WW | Make an open wire |
5539 The profile shape definition is the suffix; no suffix produces a face, *w* is a closed wire, *ww* is an open wire.
5541 Code letters are not case-sensitive.
5545 # to create a trianglular plane using a vertex at the
5546 origin, in the xy plane
5547 profile p O 0 0 0 X 1 Y 0 x 1 y 1
5552 # to create a contour using the different code
5555 # two vertices in the xy plane
5556 profile p F 1 0 x 2 y 1 ww
5558 # to view from a point normal to the plane
5561 # add a circular element of 45 degrees
5562 profile p F 1 0 x 2 y 1 c 1 45 ww
5564 # add a tangential segment with a length value 1
5565 profile p F 1 0 x 2 y 1 c 1 45 l 1 ww
5567 # add a vertex with xy values of 1.5 and 1.5
5568 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 ww
5570 # add a vertex with the x value 0.2, y value is constant
5571 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 xx 0.2 ww
5573 # add a vertex with the y value 2 x value is constant
5574 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 yy 2 ww
5576 # add a circular element with a radius value of 1 and a circular value of 290 degrees
5577 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
5579 # wire continues at a tangent to the intersection x = 0
5580 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
5582 # continue the wire at an angle of 90 degrees until it intersects the y axis at y= -o.3
5583 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
5586 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
5588 # to create the plane with the same contour
5589 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
5592 @subsubsection occt_draw_7_2_5 bsplineprof
5596 bsplineprof name [S face] [W WW]
5599 * for an edge : \<digitizes\> ... <mouse button 2>
5600 * to end profile : <mouse button 3>
5602 Builds a profile in the XY plane from digitizes. By default the profile is closed and a face is built.
5604 **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.
5606 The profile shape definition is the suffix; no suffix produces a face, **w** is a closed wire, **ww** is an open wire.
5610 #to view the xy plane
5612 #to create a 2d curve with the mouse
5614 # click mb1 to start the curve
5615 # click mb1 to create the second vertex
5616 # click mb1 to create a curve
5618 #click mb2 to finish the curve and start a new curve
5620 # click mb1 to create the second curve
5621 # click mb3 to create the face
5624 @subsubsection occt_draw_7_2_6 mkoffset
5628 mkoffset result face/compound of wires nboffset stepoffset
5631 **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.
5633 The offset distance defines the spacing and the positioning of the occurences.
5637 #Create a box and select a face
5640 #Create three exterior parallel contours with an offset
5643 Create one interior parallel contour with an offset
5646 mkoffset r b_1 1 -0.4
5649 **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.
5653 # to create the example contour
5654 profile p F 0 0 x 2 y 4 tt 1 1 tt 0 4 w
5655 # to create an incoherent interior offset
5656 mkoffset r p 1 -0.50
5657 ==p is not a FACE but a WIRE
5658 BRepFill_TrimEdgeTool: incoherent intersection
5659 # to create two incoherent wires
5660 mkoffset r p 1 -0.50
5663 @subsubsection occt_draw_7_2_7 mkplane, mkface
5668 mkface name surface [ufirst ulast vfirst vlast]
5671 **mkplane** generates a face from a planar wire. The planar surface will be constructed with an orientation which keeps the face inside the wire.
5673 **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.
5677 # make a polygonal face
5678 polyline f 0 0 0 20 0 0 20 10 0 10 10 0 10 20 0 0 20 0 0 0 0
5681 # make a cylindrical face
5683 trim g g -pi/3 pi/2 0 15
5687 @subsubsection occt_draw_7_2_8 mkcurve, mksurface
5695 **mkcurve** creates a 3d curve from an edge. The curve will be trimmed to the edge boundaries.
5697 **mksurface** creates a surface from a face. The surface will not be trimmed.
5707 @subsubsection occt_draw_7_2_9 pcurve
5712 pcurve [name edgename] facename
5715 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.
5719 # view the pcurves of a face
5728 @subsubsection occt_draw_7_2_10 chfi2d
5732 chfi2d result face [edge1 edge2 (F radius/CDD d1 d2/CDA d ang) ....
5736 Creates chamfers and fillets on 2D objects. Select two adjacent edges and:
5738 * two respective distance values
5739 * a distance value and an angle
5741 The radius value produces a fillet between the two faces.
5743 The distance is the length value from the edge between the two selected faces in a normal direction.
5747 Let us create a 2d fillet:
5751 profile p x 2 y 2 x -2
5752 chfi2d cfr p . . F 0.3
5759 Let us create a 2d chamfer using two distances:
5762 profile p x 2 y 2 x -2
5763 chfi2d cfr p . . CDD 0.3 0.6
5770 Let us create a 2d chamfer using a defined distance and angle
5774 profile p x 2 y 2 x -2
5775 chfi2d cfr p . . CDA 0.3 75
5782 @subsubsection occt_draw_7_2_11 nproject
5786 nproject pj e1 e2 e3 ... surf -g -d [dmax] [Tol
5787 [continuity [maxdeg [maxseg]]]
5790 Creates a shape projection which is normal to the target surface.
5794 # create a curved surface
5803 translate ll 2 -0.5 0
5809 #display in four views
5812 # create the example shape
5813 circle c 1.8 -0.5 1 0 1 0 1 0 0 0.4
5816 # create the normal projection of the shape(circle)
5821 @subsection occt_draw_7_3 Primitives
5823 Primitive commands make it possible to create simple shapes. They include:
5825 * **box** and **wedge** commands.
5826 * **pcylinder**, **pcone**, **psphere**, **ptorus** commands.
5827 * **halfspace** command
5830 @subsubsection occt_draw_7_3_1 box, wedge
5834 box name [x y z] dx dy dz
5835 wedge name dx dy dz ltx / xmin zmin xmax xmax
5838 **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.
5840 **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*.
5842 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.
5846 # a box at the origin
5850 box b2 30 30 40 10 20 30
5855 # a wedge with a sharp edge (5 faces)
5859 wedge w3 20 20 20 10 10 10 10
5862 @subsubsection occt_draw_7_3_2 pcylinder, pcone, psphere, ptorus
5866 pcylinder name [plane] radius height [angle]
5867 pcone name [plane] radius1 radius2 height [angle]
5868 pcone name [plane] radius1 radius2 height [angle]
5869 psphere name [plane] radius1 [angle1 angle2] [angle]
5870 ptorus name [plane] radius1 radius2 [angle1 angle2] [angle]
5873 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.
5875 **pcylinder** creates a cylindrical block with the given radius and height.
5877 **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.
5879 **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.
5881 **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.
5888 # a quarter of a truncated cone
5889 pcone co 15 10 10 90
5891 # three-quarters of sphere
5898 @subsubsection occt_draw_7_3_3 halfspace
5902 halfspace result face/shell x y z
5905 **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.
5911 ==b_1 b_2 b_3 b_4 b_5 b_6
5912 halfspace hr b_3 0.5 0.5 0.5
5916 @subsection occt_draw_7_4 Sweeping
5918 Sweeping creates shapes by sweeping out a shape along a defined path:
5920 * **prism** sweeps along a direction.
5921 * **revol** sweeps around an axis.
5922 * **pipe** sweeps along a wire.
5923 * **mksweep** and **buildsweep** are commands to create sweeps by defining the arguments and algorithms.
5924 * **thrusections** creates a sweep from wire in different planes.
5927 @subsubsection occt_draw_7_4_1 prism
5931 prism result base dx dy dz [Copy | Inf | SemiInf]
5934 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.
5936 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.
5940 # sweep a planar face to make a solid
5941 polyline f 0 0 0 10 0 0 10 5 0 5 5 0 5 15 0 0 15 0 0 0 0
5945 @subsubsection occt_draw_7_4_2 revol
5949 revol result base x y z dx dy dz angle [Copy]
5952 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.
5956 # shell by wire rotation
5957 polyline w 0 0 0 10 0 0 10 5 0 5 5 0 5 15 0 0 15 0
5958 revol s w 20 0 0 0 1 0 90
5962 @subsubsection occt_draw_7_4_3 pipe
5966 pipe name wire_spine Profile
5969 Creates a new shape by sweeping a shape known as the profile along a wire known as the spine.
5973 # sweep a circle along a bezier curve to make a solid
5976 beziercurve spine 4 0 0 0 10 0 0 10 10 0 20 10 0
5979 circle profile 0 0 0 1 0 0 2
5980 mkedge profile profile
5981 wire profile profile
5982 mkplane profile profile
5983 pipe p spine profile
5986 @subsubsection occt_draw_7_4_4 mksweep, addsweep, setsweep, deletesweep, buildsweep, simulsweep
5991 addsweep wire[vertex][-M][-C] [auxiilaryshape]
5993 setsweep options [arg1 [arg2 [...]]]
5994 simulsweep r [n] [option]
5995 buildsweep [r] [option] [Tol]
5999 * *-FR* : Tangent and Normal are defined by a Frenet trihedron
6000 * *-CF* : Tangent is given by Frenet, the Normal is computed to minimize the torsion
6001 * *-DX Surf* : Tangent and Normal are given by Darboux trihedron, surf must be a shell or a face
6002 * *-CN dx dy dz* : BiNormal is given by *dx dy dz*
6003 * *-FX Tx Ty TZ [Nx Ny Nz]* : Tangent and Normal are fixed
6006 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.
6007 * **mksweep** initializes the sweep creation and defines the wire to be used as the spine.
6008 * **addsweep** defines the wire to be used as the profile.
6009 * **deletesweep** cancels the choice of profile wire, without leaving the mksweep mode. You can re-select a profile wire.
6010 * **setsweep** commands the algorithms used for the construction of the sweep.
6011 * **simulsweep** can be used to create a preview of the shape. [n] is the number of sections that are used to simulate the sweep.
6012 * **buildsweep** creates the sweep using the arguments defined by all the commands.
6016 #create a sweep based on a semi-circular wire using the
6018 #create a circular figure
6019 circle c2 0 0 0 1 0 0 10
6020 trim c2 c2 -pi/2 pi/2
6026 # to display all the options for a sweep
6028 #to create a sweep using the Frenet algorithm where the
6029 #normal is computed to minimise the torsion
6032 # to simulate the sweep with a visual approximation
6036 @subsubsection occt_draw_7_4_5 thrusections
6040 thrusections [-N] result issolid isruled wire1 wire2 [..wire..]
6043 **thrusections** creates a shape using wires that are positioned in different planes. Each wire selected must have the same number of edges and vertices.
6044 A bezier curve is generated between the vertices of each wire. The option *[-N]* means that no check is made on wires for direction.
6048 #create three wires in three planes
6049 polyline w1 0 0 0 5 0 0 5 5 0 2 3 0
6050 polyline w2 0 1 3 4 1 3 4 4 3 1 3 3
6051 polyline w3 0 0 5 5 0 5 5 5 5 2 3 5
6053 thrusections th issolid isruled w1 w2 w3
6054 ==thrusections th issolid isruled w1 w2 w3
6055 Tolerances obtenues -- 3d : 0
6060 @subsection occt_draw_7_5 Topological transformation
6062 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.
6064 * **tcopy** makes a copy of the structure of a shape.
6065 * **ttranslate**, **trotate**, **tmove**, **reset** move a shape.
6066 * **tmirror**, **tscale** always modify the shape.
6069 @subsubsection occt_draw_7_5_1 tcopy
6073 tcopy name toname [name toname ...]
6076 Copies the structure of one shape, including the geometry, into another, newer shape.
6080 # create an edge from a curve and copy it
6081 beziercurve c 3 0 0 0 10 0 0 20 10 0
6086 # now modify the curve, only e1 and e2 will be modified
6089 @subsubsection occt_draw_7_5_2 tmove, treset
6093 tmove name [name ...] shape
6094 reset name [name ...]
6097 **tmove** and **reset** modify the location, or the local coordinate system of a shape.
6099 **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).
6105 box b2 20 0 0 10 10 10
6106 # translate the first box
6107 ttranslate b1 0 10 0
6108 # and apply the same location to b2
6110 # return to original positions
6114 @subsubsection occt_draw_7_5_3 ttranslate, trotate
6118 ttranslate [name ...] dx dy dz
6119 trotate [name ...] x y z dx dy dz angle
6122 **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.
6123 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.)
6125 Locations are very economic in the data structure because multiple occurences of an object share the topological description.
6129 # make rotated copies of a sphere in between two cylinders
6130 # create a file source toto.tcl
6132 for {set i 0} {$i 360} {incr i 20} {
6134 trotate s$i 0 0 0 0 0 1 $i
6137 # create two cylinders
6140 ttranslate c2 0 0 20
6144 ttranslate s 25 0 12.5
6146 # call the source file for multiple copies
6150 @subsubsection occt_draw_7_5_4 tmirror, tscale
6154 tmirror name x y z dx dy dz
6155 tscale name x y z scale
6158 * **tmirror** makes a mirror copy of a shape about a plane x,y,z dx,dy,dz.
6160 * **Tscale** applies a central homotopic mapping to a shape.
6164 # mirror a portion of cylinder about the YZ plane
6165 pcylinder c1 10 10 270
6167 tmirror c2 15 0 0 1 0 0
6173 @subsection occt_draw_7_6 Old Topological operations
6175 * **fuse**, **cut**, **common** are boolean operations.
6176 * **section**, **psection** compute sections.
6177 * **sewing** joins two or more shapes.
6180 @subsubsection occt_draw_7_6_1 fuse, cut, common
6184 fuse name shape1 shape2
6185 cut name shape1 shape2
6186 common name shape1 shape2
6189 **fuse** creates a new shape by a boolean operation on two existing shapes. The new shape contains both originals intact.
6191 **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.
6193 **common** creates a new shape which contains only what is in common between the two original shapes in their intersection.
6197 # all four boolean operations on a box and a cylinder
6199 box b 0 -10 5 20 20 10
6203 ttranslate s1 40 0 0
6206 ttranslate s2 -40 0 0
6209 ttranslate s3 0 40 0
6212 ttranslate s4 0 -40 0
6216 @subsubsection occt_draw_7_6_2 section, psection
6220 section result shape1 shape2
6221 psection name shape plane
6224 **section** creates a compound object consisting of the edges for the intersection curves on the faces of two shapes.
6226 **psection** creates a planar section consisting of the edges for the intersection curves on the faces of a shape and a plane.
6230 # section line between a cylinder and a box
6232 box b 0 0 5 15 15 15
6233 trotate b 0 0 0 1 1 1 20
6236 # planar section of a cone
6238 plane p 0 0 15 1 1 2
6242 @subsubsection occt_draw_7_6_3 sewing
6246 sewing result [tolerance] shape1 shape2 ...
6249 **Sewing** joins shapes by connecting their adjacent or near adjacent edges. Adjacency can be redefined by modifying the tolerance value.
6253 # create two adjacent boxes
6258 sr is a shape COMPOUND FORWARD Free Modified
6261 @subsection occt_draw_7_7 New Topological operations
6264 The new algorithm of Boolean operations avoids a large number of weak points and limitations presented in the old boolean operation algorithm.
6267 @subsubsection occt_draw_7_7_1 bop, bopfuse, bopcut, boptuc, bopcommon,
6269 * **bop** defines *shape1* and *shape2* subject to ulterior Boolean operations
6270 * **bopfuse** creates a new shape by a boolean operation on two existing shapes. The new shape contains both originals intact.
6271 * **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.
6272 * **boptuc** is a reverced **bopcut**.
6273 * **bopcommon** creates a new shape which contains only whatever is in common between the two original shapes in their intersection.
6284 These commands have short variants:
6287 bcommon result shape1 shape2
6288 bfuse result shape1 shape2
6289 bcut result shape1 shape2
6293 **bop** fills data structure (DS) of boolean operation for *shape1* and *shape2*.
6294 **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:
6304 Let us produce all four boolean operations on a box and a cylinder:
6307 box b 0 -10 5 20 20 10
6310 # fills data structure
6314 ttranslate s1 40 0 0
6317 ttranslate s2 -40 0 0
6320 ttranslate s3 0 40 0
6323 ttranslate s4 0 -40 0
6326 Now use short variants of the commands:
6330 ttranslate s11 40 0 100
6333 ttranslate s12 -40 0 100
6336 ttranslate s14 0 -40 100
6339 @subsubsection occt_draw_7_7_2 bopsection
6347 * **bopsection** creates a compound object consisting of the edges for the intersection curves on the faces of two shapes.
6348 * **bop** fills data structure (DS) of boolean operation for *shape1* and *shape2*.
6349 * **bopsection** command used after **bop** command.
6351 Short variant syntax:
6353 bsection result shape1 shape2 [-2d/-2d1/-2s2] [-a]
6356 * <i>-2d</i> - PCurves are computed on both parts.
6357 * <i>-2d1</i> - PCurves are computed on first part.
6358 * <i>-2d2</i> - PCurves are computed on second part.
6359 * <i>-a</i> - built geometries are approximated.
6363 Let us build a section line between a cylinder and a box
6366 box b 0 0 5 15 15 15
6367 trotate b 0 0 0 1 1 1 20
6374 @subsubsection occt_draw_7_7_3 bopcheck, bopargshape
6379 bopargcheck shape1 [[shape2] [-F/O/C/T/S/U] [/R|F|T|V|E|I|P]] [#BF]
6382 **bopcheck** checks a shape for self-interference.
6384 **bopargcheck** checks the validity of argument(s) for boolean operations.
6386 * Boolean Operation - (by default a section is made) :
6393 * Test Options - (by default all options are enabled) :
6394 * **R** (disable small edges (shrank range) test)
6395 * **F** (disable faces verification test)
6396 * **T** (disable tangent faces searching test)
6397 * **V** (disable test possibility to merge vertices)
6398 * **E** (disable test possibility to merge edges)
6399 * **I** (disable self-interference test)
6400 * **P** (disable shape type test)
6401 * Additional Test Options :
6402 * **B** (stop test on first faulty found) - by default it is off;
6403 * **F** (full output for faulty shapes) - by default the output is made in a short format.
6405 **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.
6409 # checks a shape on self-interference
6413 # checks the validity of argument for boolean cut operations
6414 box b2 0 0 0 10 10 10
6415 bopargcheck b1 b2 -C
6418 @subsection occt_draw_7_8 Drafting and blending
6420 Drafting is creation of a new shape by tilting faces through an angle.
6422 Blending is the creation of a new shape by rounding edges to create a fillet.
6424 * Use the **depouille** command for drafting.
6425 * Use the **chamf** command to add a chamfer to an edge
6426 * Use the **blend** command for simple blending.
6427 * Use **fubl** for a fusion + blending operation.
6428 * Use **buildevol**, **mkevol**, **updatevol** to realize varying radius blending.
6431 @subsubsection occt_draw_7_8_1 depouille
6435 dep result shape dirx diry dirz face angle x y x dx dy dz [face angle...]
6438 Creates a new shape by drafting one or more faces of a shape.
6440 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.
6444 # draft a face of a box
6447 == b_1 b_2 b_3 b_4 b_5 b_6
6449 dep a b 0 0 1 b_2 10 0 10 0 1 0 5
6452 @subsubsection occt_draw_7_8_2 chamf
6456 chamf newname shape edge face S dist
6457 chamf newname shape edge face dist1 dist2
6458 chamf newname shape edge face A dist angle
6461 Creates a chamfer along the edge between faces using:
6463 * a equal distances from the edge
6464 * the edge, a face and distance, a second distance
6465 * the edge, a reference face and an angle
6467 Use the dot syntax to select the faces and edges.
6471 Let us create a chamfer based on equal distances from the edge (45 degree angle):
6475 chamf ch b . . S 0.5
6479 # select an adjacent face
6482 Let us create a chamfer based on different distances from the selected edge:
6485 chamf ch b . . 0.3 0.4
6489 # select an adjacent face
6492 Let us create a chamfer based on a distance from the edge and an angle:
6496 chamf ch b . . A 0.4 30
6500 # select an adjacent face
6503 @subsubsection occt_draw_7_8_3 blend
6507 blend result object rad1 ed1 rad2 ed2 ... [R/Q/P]
6510 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.
6514 # blend a box, click on an edge
6517 ==tolerance ang : 0.01
6518 ==tolerance 3d : 0.0001
6519 ==tolerance 2d : 1e-05
6521 ==tolblend 0.01 0.0001 1e-05 0.001
6523 # click on the edge you want ot fillet
6525 ==COMPUTE: temps total 0.1s dont :
6526 ==- Init + ExtentAnalyse 0s
6527 ==- PerformSetOfSurf 0.02s
6528 ==- PerformFilletOnVertex 0.02s
6530 ==- Reconstruction 0.06s
6534 @subsubsection occt_draw_7_8_4 fubl
6538 fubl name shape1 shape2 radius
6541 Creates a boolean fusion of two shapes and then blends (fillets) the intersection edges using the given radius.
6545 # fuse-blend two boxes
6548 ttranslate b2 -10 10 3
6553 @subsubsection occt_draw_7_8_5 mkevol, updatevol, buildevol
6557 mkevol result object (then use updatevol) [R/Q/P]
6558 updatevol edge u1 radius1 [u2 radius2 ...]
6562 These three commands work together to create fillets with evolving radii.
6564 * **mkevol** allows specifying the shape and the name of the result. It returns the tolerances of the fillet.
6565 * **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.
6566 * **buildevol** produces the result described previously in **mkevol** and **updatevol**.
6570 # makes an evolved radius on a box
6573 ==tolerance ang : 0.01
6574 ==tolerance 3d : 0.0001
6575 ==tolerance 2d : 1e-05
6577 ==tolblend 0.01 0.0001 1e-05 0.001
6580 updatevol . 0 1 1 3 2 2
6584 ==Dump of SweepApproximation
6585 ==Error 3d = 1.28548881203818e-14
6586 ==Error 2d = 1.3468326936926e-14 ,
6587 ==1.20292299999388e-14
6588 ==2 Segment(s) of degree 3
6590 ==COMPUTE: temps total 0.91s dont :
6591 ==- Init + ExtentAnalyse 0s
6592 ==- PerformSetOfSurf 0.33s
6593 ==- PerformFilletOnVertex 0.53s
6595 ==- Reconstruction 0.04s
6600 @subsection occt_draw_7_9 Topological analysis
6602 Analysis of shapes includes commands to compute length, area, volumes and inertial properties.
6604 * Use **lprops**, **sprops**, **vprops** to compute integral properties.
6605 * Use **bounding** to display the bounding box of a shape.
6606 * Use **distmini** to calculate the minimum distance between two shapes.
6609 @subsubsection occt_draw_7_9_1 lprops, sprops, vprops
6618 * **lprops** computes the mass properties of all edges in the shape with a linear density of 1;
6619 * **sprops** of all faces with a surface density of 1;
6620 * **vprops** of all solids with a density of 1.
6622 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.
6626 # volume of a cylinder
6630 Mass : 6283.18529981086
6633 X = 4.1004749224903e-06
6634 Y = -2.03392858349861e-16
6638 366519.141445068 5.71451850691484e-12
6640 5.71451850691484e-12 366519.141444962
6641 2.26823064169991e-10 0.257640437382627
6642 2.26823064169991e-10 314159.265358863
6645 IX = 366519.141446336
6646 IY = 366519.141444962
6647 I.Z = 314159.265357595
6651 @subsubsection occt_draw_7_9_2 bounding
6658 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.*
6662 # bounding box of a torus
6665 ==-27.059805107309852 -27.059805107309852 -
6667 ==27.059805107309852 27.059805107309852
6671 @subsubsection occt_draw_7_9_3 distmini
6675 distmini name Shape1 Shape2
6678 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.
6682 box b 0 0 0 10 20 30
6683 box b2 30 30 0 10 20 30
6685 ==the distance value is : 22.3606797749979
6686 ==the number of solutions is :2
6689 ==the type of the solution on the first shape is 0
6690 ==the type of the solution on the second shape is 0
6691 ==the coordinates of the point on the first shape are:
6693 ==the coordinates of the point on the second shape
6697 ==solution number 2:
6698 ==the type of the solution on the first shape is 0
6699 ==the type of the solution on the second shape is 0
6700 ==the coordinates of the point on the first shape are:
6702 ==the coordinates of the point on the second shape
6709 @subsection occt_draw_7_10 Surface creation
6711 Surface creation commands include surfaces created from boundaries and from spaces between shapes.
6712 * **gplate** creates a surface from a boundary definition.
6713 * **filling** creates a surface from a group of surfaces.
6715 @subsubsection occt_draw_7_10_1 gplate,
6719 gplate result nbrcurfront nbrpntconst [SurfInit] [edge 0] [edge tang (1:G1;2:G2) surf]...[point] [u v tang (1:G1;2:G2) surf] ...
6722 Creates a surface from a defined boundary. The boundary can be defined using edges, points, or other surfaces.
6730 beziercurve c1 3 0 0 0 1 0 1 2 0 0
6736 trotate e3 0 0 0 0 0 1 90
6739 # create the surface
6740 gplate r1 4 0 p e1 0 e2 0 e3 0 e4 0
6742 ======== Results ===========
6743 DistMax=8.50014503228635e-16
6745 Calculation time: 0.33
6747 Approximation results
6748 Approximation error : 2.06274907619957e-13
6749 Criterium error : 4.97600631215754e-14
6751 #to create a surface defined by edges and passing through a point
6752 # to define the border edges and the point
6757 beziercurve c1 3 0 0 0 1 0 1 2 0 0
6763 trotate e3 0 0 0 0 0 1 90
6768 # to create the surface
6769 gplate r2 4 1 p e1 0 e2 0 e3 0 e4 0 pp
6771 ======== Results ===========
6772 DistMax=3.65622157610934e-06
6774 Calculculation time: 0.27
6776 Approximation results
6777 Approximation error : 0.000422195884750181
6778 Criterium error : 3.43709808053967e-05
6781 @subsubsection occt_draw_7_10_2 filling, fillingparam
6785 filling result nbB nbC nbP [SurfInit] [edge][face]order...
6786 edge[face]order... point/u v face order...
6789 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.
6791 To define the surface border:
6793 * enter the number of edges, constraints, and points
6794 * enumerate the edges, constraints and points
6796 The surface can pass through other points. These are defined after the border definition.
6798 You can use the *fillingparam* command to access the filling parameters.
6802 * <i>-l</i> : to list current values
6803 * <i>-i</i> : to set default values
6804 * <i>-rdeg nbPonC nbIt anis </i> : to set filling options
6805 * <i>-c t2d t3d tang tcur </i> : to set tolerances
6806 * <i>-a maxdeg maxseg </i> : Approximation option
6810 # to create four curved survaces and a point
6815 beziercurve c1 3 0 0 0 1 0 1 2 0 0
6821 trotate e3 0 0 0 0 0 1 90
6832 # to create a tangential surface
6833 filling r1 4 0 0 p e1 f1 1 e2 f2 1 e3 f3 1 e4 f4 1
6834 # to create a tangential surface passing through point pp
6835 filling r2 4 0 1 p e1 f1 1 e2 f2 1 e3 f3 1 e4 f4 1 pp#
6836 # to visualise the surface in detail
6838 # to display the current filling parameters
6855 @subsection occt_draw_7_11 Complex Topology
6857 Complex topology is the group of commands that modify the topology of shapes. This includes feature modeling.
6860 @subsubsection occt_draw_7_11_1 offsetshape, offsetcompshape
6864 offsetshape r shape offset [tol] [face ...]
6865 offsetcompshape r shape offset [face ...]
6868 **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.
6870 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.
6872 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.
6874 The opening between the object interior and exterior is defined by the argument face or faces.
6880 == b1_1 b1_2 b1_3 b1_4 b1_5 b1_6
6881 offsetcompshape r b1 -1 b1_3
6884 @subsubsection occt_draw_7_11_2 featprism, featdprism, featrevol, featlf, featrf
6888 featprism shape element skface Dirx Diry Dirz Fuse(0/1/2) Modify(0/1)
6889 featdprism shape face skface angle Fuse(0/1/2) Modify(0/1)
6890 featrevol shape element skface Ox Oy Oz Dx Dy Dz Fuse(0/1/2) Modify(0/1)
6891 featlf shape wire plane DirX DirY DirZ DirX DirY DirZ Fuse(0/1/2) Modify(0/1)
6892 featrf shape wire plane X Y Z DirX DirY DirZ Size Size Fuse(0/1/2) Modify(0/1)
6893 featperform prism/revol/pipe/dprism/lf result [[Ffrom] Funtil]
6894 featperformval prism/revol/dprism/lf result value
6897 **featprism** loads the arguments for a prism with contiguous sides normal to the face.
6899 **featdprism** loads the arguments for a prism which is created in a direction normal to the face and includes a draft angle.
6901 **featrevol** loads the arguments for a prism with a circular evolution.
6903 **featlf** loads the arguments for a linear rib or slot. This feature uses planar faces and a wire as a guideline.
6905 **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.
6907 **featperform** loads the arguments to create the feature.
6909 **featperformval** uses the defined arguments to create a feature with a limiting value.
6911 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.
6915 Let us create a feature prism with a draft angle and a normal direction :
6918 # create a box with a wire contour on the upper face
6920 profil f O 0 0 1 F 0.25 0.25 x 0.5 y 0.5 x -0.5
6922 # loads the feature arguments defining the draft angle
6923 featdprism b f b_6 5 1 0
6924 # create the feature
6925 featperformval dprism r 1
6926 ==BRepFeat_MakeDPrism::Perform(Height)
6927 BRepFeat_Form::GlobalPerform ()
6933 Let us create a feature prism with circular direction :
6936 # create a box with a wire contour on the upper face
6938 profil f O 0 0 1 F 0.25 0.25 x 0.5 y 0.5 x -0.5
6940 # loads the feature arguments defining a rotation axis
6941 featrevol b f b_6 1 0 1 0 1 0 1 0
6942 featperformval revol r 45
6943 ==BRepFeat_MakeRevol::Perform(Angle)
6944 BRepFeat_Form::GlobalPerform ()
6951 Let us create a slot using the linear feature :
6954 #create the base model using the multi viewer
6956 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
6958 # create the contour for the linear feature
6959 vertex v1 -0.2 4 0.3
6961 vertex v3 0.2 0.2 0.3
6963 vertex v5 4 -0.2 0.3
6970 plane pl 0.2 0.2 0.3 0 0 1
6971 # loads the linear feature arguments
6972 featlf pr w pl 0 0 0.3 0 0 0 0 1
6973 featperform lf result
6976 Let us create a rib using the revolution feature :
6979 #create the base model using the multi viewer
6982 # create the contour for the revolution feature
6983 profile w c 1 190 WW
6984 trotate w 0 0 0 1 0 0 90
6986 trotate w -3 0 1.5 0 0 1 180
6987 plane pl -3 0 1.5 0 1 0
6988 # loads the revolution feature arguments
6989 featrf c1 w pl 0 0 0 0 0 1 0.3 0.3 1 1
6990 featperform rf result
6993 @subsubsection occt_draw_7_11_3 draft
6997 draft result shape dirx diry dirz angle shape/surf/length [-IN/-OUT] [Ri/Ro] [-Internal]
7000 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.
7002 * The draft angle is measured in radians.
7003 * The draft direction is determined by the argument -INTERNAL
7004 * The argument Ri/Ro deftermines wether the corner edges of the draft surfaces are angular or rounded.
7005 * Arguments that can be used to define the surface distance are:
7006 * length, a defined distance
7007 * shape, until the surface contacts a shape
7008 * surface, until the surface contacts a surface.
7010 **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.
7014 # to create a simple profile
7015 profile p F 0 0 x 2 y 4 tt 0 4 w
7016 # creates a draft with rounded angles
7017 draft res p 0 0 1 3 1 -Ro
7018 # to create a profile with an internal angle
7019 profile p F 0 0 x 2 y 4 tt 1 1.5 tt 0 4 w
7020 # creates a draft with rounded external angles
7021 draft res p 0 0 1 3 1 -Ro
7024 @subsubsection occt_draw_7_11_4 deform
7028 deform newname name CoeffX CoeffY CoeffZ
7031 Modifies the shape using the x, y, and z coefficients. You can reduce or magnify the shape in the x,y, and z directions.
7037 # the conversion to bspline is followed by the
7042 @subsubsection occt_draw_7_11_5 nurbsconvert
7047 nurbsconvert result name [result name]
7050 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.
7053 @subsection occt_draw_7_12 Texture Mapping to a Shape
7055 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.
7057 @subsubsection occt_draw_7_12_1 vtexture
7061 vtexture NameOfShape TextureFile
7062 vtexture NameOfShape
7063 vtexture NameOfShape ?
7064 vtexture NameOfShape IdOfTexture
7067 **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.
7069 @subsubsection occt_draw_7_12_2 vtexscale
7073 vtexscale NameOfShape ScaleU ScaleV
7074 vtexscale NameOfShape ScaleUV
7075 vtexscale NameOfShape
7078 *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.
7080 The syntax without *ScaleU*, *ScaleV* or *ScaleUV* disables texture scaling.
7082 @subsubsection occt_draw_7_12_3 vtexorigin
7086 vtexorigin NameOfShape UOrigin VOrigin
7087 vtexorigin NameOfShape UVOrigin
7088 vtexorigin NameOfShape
7091 *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.
7093 The syntax without *UOrigin*, *VOrigin* or *UVOrigin* disables origin positioning.
7095 @subsubsection occt_draw_7_12_4 vtexrepeat
7099 vtexrepeat NameOfShape URepeat VRepeat
7100 vtexrepeat NameOfShape UVRepeat
7101 vtexrepeat NameOfShape
7104 *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.
7106 The same syntax without *URepeat*, *VRepeat* or *UVRepeat* disables texture repetition.
7108 @subsubsection occt_draw_7_12_5 vtexdefault
7112 vtexdefault NameOfShape
7115 *Vtexdefault* sets or resets the texture mapping default parameters.
7119 * *URepeat = VRepeat = 1* no repetition
7120 * *UOrigin = VOrigin = 1* origin set at (0,0)
7121 * *UScale = VScale = 1* texture covers 100% of the face
7123 @section occt_draw_8 Data Exchange commands
7125 This paragraph presents some general information about Data Exchange (DE) operations.
7127 DE commands are intended for translation files of various formats (IGES,STEP) into OCCT shapes with their attributes (colors, layers etc.)
7129 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
7130 * for <a href="user_guides__step.html#occt_step_1">STEP format</a> and
7131 * for <a href="user_guides__iges.html#occt_iges_1">IGES format</a>.
7133 Each Draw session has an interface model, which is a structure for keeping various information.
7135 The first step of translation is loading information from a file into a model.
7136 The second step is creation of an OpenCASCADE shape from this model.
7138 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.
7140 The model and the map are used for working with most of DE commands.
7142 @subsection occt_draw_8_1 IGES commands
7144 @subsubsection occt_draw_8_1_1 igesread
7148 igesread <file_name> <result_shape_name> [<selection>]
7151 Reads an IGES file to an OCCT shape. This command will interactively ask the user to select a set of entities to be converted.
7154 | N | Mode | Description |
7155 | :-- | :-- | :---------- |
7156 | 0 | End | finish conversion and exit igesbrep |
7157 | 1 | Visible roots | convert only visible roots |
7158 | 2 | All roots | convert all roots |
7159 | 3 | One entity | convert entity with number provided by the user |
7160 | 4 | Selection | convert only entities contained in selection |
7163 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.
7165 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*.
7167 <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.
7169 See also the detailed description of <a href="user_guides__iges.html#occt_iges_2_3_4">Selecting IGES entities</a>.
7173 # translation all roots from file
7174 igesread /disk01/files/model.igs a *
7177 @subsubsection occt_draw_8_1_2 tplosttrim
7181 tplosttrim [<IGES_type>]
7184 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.
7185 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.
7186 Optional parameter <i>\<IGES_type\></i> can be *0TrimmedSurface, BoundedSurface* or *Face* to specify the only type of IGES faces.
7190 tplosttrim TrimmedSurface
7193 @subsubsection occt_draw_8_1_3 brepiges
7197 brepiges <shape_name> <filename.igs>
7200 Writes an OCCT shape to an IGES file.
7204 # write shape with name aa to IGES file
7205 brepiges aa /disk1/tmp/aaa.igs
7206 == unit (write) : MM
7207 == mode write : Faces
7208 == To modifiy : command param
7209 == 1 Shapes written, giving 345 Entities
7210 == Now, to write a file, command : writeall filename
7211 == Output on file : /disk1/tmp/aaa.igs
7215 @subsection occt_draw_8_2 STEP commands
7217 These commands are used during the translation of STEP models.
7220 @subsubsection occt_draw_8_2_1 stepread
7224 stepread file_name result_shape_name [selection]
7227 Read a STEP file to an OCCT shape.
7228 This command will interactively ask the user to select a set of entities to be converted:
7230 | N | Mode | Description |
7231 | :---- | :---- | :---- |
7232 | 0 | End | Finish transfer and exit stepread |
7233 | 1 | root with rank 1 | Transfer first root |
7234 | 2 | root by its rank | Transfer root specified by its rank |
7235 | 3 | One entity | Transfer entity with a number provided by the user |
7236 | 4 | Selection | Transfer only entities contained in selection |
7238 After the selected set of entities is loaded the user will be asked how loaded entities should be converted into OCCT shapes.
7239 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*.
7240 <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.
7242 See also the detailed description of <a href="user_guides__step.html#occt_step_2_3_6">Selecting STEP entities</a>.
7246 # translation all roots from file
7247 stepread /disk01/files/model.stp a *
7250 @subsubsection occt_draw_8_2_2 stepwrite
7254 stepwrite mode shape_name file_name
7257 Writes an OCCT shape to a STEP file.
7259 The following modes are available :
7260 * *a* - as is – mode is selected automatically depending on the type & geometry of the shape;
7261 * *m* - *manifold_solid_brep* or *brep_with_voids*
7262 * *f* - *faceted_brep*
7263 * *w* - *geometric_curve_set*
7264 * *s* - *shell_based_surface_model*
7266 For further information see <a href="#user_guides__step.html#occt_step_6_5">Writing a STEP file</a>.
7270 Let us write shape *a* to a STEP file in mode *0*.
7273 stepwrite 0 a /disk1/tmp/aaa.igs
7277 @subsection occt_draw_8_3 General commands
7279 These are auxilary commands used for the analysis of result of translation of IGES and STEP files.
7281 @subsubsection occt_draw_8_3_1 count
7285 count <counter> [<selection>]
7288 Calculates statistics on the entities in the model and outputs a count of entities.
7290 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.
7292 | Counter | Operation |
7293 | :-------- | :-------- |
7294 | xst-types | Calculates how many entities of each OCCT type exist |
7295 | step214-types | Calculates how many entities of each STEP type exist |
7302 @subsubsection occt_draw_8_3_2 data
7309 Obtains general statistics on the loaded data.
7310 The information printed by this command depends on the symbol specified.
7314 # print full information about warnings and fails
7319 | :------ | :------ |
7320 | g | Prints the information contained in the header of the file |
7321 | 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) |
7322 | t | The same as c or f, with a list of failed or warned entities |
7323 | m or l | The same as t but also prints a status for each entity |
7324 | e | Lists all entities of the model with their numbers, types, validity status etc. |
7325 | R | The same as e but lists only root entities |
7329 @subsubsection occt_draw_8_3_3 elabel
7336 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.
7343 @subsubsection occt_draw_8_3_4 entity
7347 entity <#(D)>_or_<num> <level_of_information>
7350 The content of an IGES or STEP entity can be obtained by using this command.
7351 Entity can be determined by its number or label.
7352 <i>\<level_of_information\></i> has range [0-6]. You can get more information about this level using this command without parameters.
7356 # full information for STEP entity with label 84
7360 @subsubsection occt_draw_8_3_5 enum
7367 Prints a number for the entity with a given label.
7371 # give a number for IGES entity with label 21
7375 @subsubsection occt_draw_8_3_6 estatus
7379 estatus <#(D)>_or_<num>
7382 The list of entities referenced by a given entity and the list of entities referencing to it can be obtained by this command.
7389 @subsubsection occt_draw_8_3_7 fromshape
7393 fromshape <shape_name>
7396 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.
7403 @subsubsection occt_draw_8_3_8 givecount
7407 givecount <selection_name> [<selection_name>]
7411 Prints a number of loaded entities defined by the selection argument.
7412 Possible values of \<selection_name\> you can find in the “IGES FORMAT Users’s Guide”.
7416 givecount xst-model-roots
7419 @subsubsection occt_draw_8_3_9 givelist
7423 givelist <selection_name>
7426 Prints a list of a subset of loaded entities defined by the selection argument:
7427 | Selection | Description |
7428 | :-------- | :----------- |
7429 | xst-model-all | all entities of the model |
7430 | xst-model-roots | all roots |
7431 | xst-pointed | (Interactively) pointed entities (not used in DRAW) |
7432 | xst-transferrable-all | all transferable (recognized) entities |
7433 | xst-transferrable-roots | Transferable roots |
7438 # give a list of all entities of the model
7439 givelist xst-model-all
7442 @subsubsection occt_draw_8_3_10 listcount
7444 Syntax: listcount \<counter\> [\<selection\> ...]
7446 Prints a list of entities per each type matching the criteria defined by arguments.
7447 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:
7449 | Counter | Operation |
7450 | :----- | :------ |
7451 | xst-types | Calculates how many entities of each OCCT type exist |
7452 | iges-types | Calculates how many entities of each IGES type and form exist |
7453 | iges-levels | Calculates how many entities lie in different IGES levels |
7460 @subsubsection occt_draw_8_3_11 listitems
7467 This command prints a list of objects (counters, selections etc.) defined in the current session.
7470 @subsubsection occt_draw_8_3_12 listtypes
7474 listtypes [<selection_name> ...]
7477 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.
7480 @subsubsection occt_draw_8_3_13 newmodel
7487 Clears the current model.
7490 @subsubsection occt_draw_8_3_14 param
7494 param [<parameter>] [<value>]
7497 This command is used to manage translation parameters.
7498 Command without arguments gives a full list of parameters with current values.
7499 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>.
7503 Let us get the information about possible schemes for writing STEP file :
7506 param write.step.schema
7509 @subsubsection occt_draw_8_3_15 sumcount
7513 sumcount <counter> [<selection> ...]
7516 Prints only a number of entities per each type matching the criteria defined by arguments.
7523 @subsubsection occt_draw_8_3_16 tpclear
7530 Clears the map of correspondences between IGES or STEP entities and OCCT shapes.
7534 @subsubsection occt_draw_8_3_17 tpdraw
7538 tpdraw <#(D)>_or_<num>
7546 @subsubsection occt_draw_8_3_18 tpent
7550 tpent <#(D)>_or_<num>
7553 Get information about the result of translation of the given IGES or STEP entity.
7560 @subsubsection occt_draw_8_3_19 tpstat
7564 tpstat [*|?]<symbol> [<selection>]
7568 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:
7570 * *g* - General statistics (a list of results and messages)
7571 * *c* - Count of all warning and fail messages
7572 * *C* - List of all warning and fail messages
7573 * *f* - Count of all fail messages
7574 * *F* - List of all fail messages
7575 * *n* - List of all transferred roots
7576 * *s* - The same, with types of source entity and the type of result
7577 * *b* - The same, with messages
7578 * *t* - Count of roots for geometrical types
7579 * *r* - Count of roots for topological types
7580 * *l* - The same, with the type of the source entity
7582 The sign \* before parameters *n, s, b, t, r* makes it work on all entities (not only on roots).
7584 The sign ? before *n, s, b, t* limits the scope of information to invalid entities.
7586 Optional argument \<selection\> can limit the action of the command to the selection, not to all entities.
7588 To get help, run this command without arguments.
7592 # translation ratio on IGES faces
7593 tpstat *l iges-faces
7596 @subsubsection occt_draw_8_3_20 xload
7603 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.
7607 xload /disk1/tmp/aaa.stp
7611 @subsection occt_draw_8_4 Overview of XDE commands
7613 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:
7614 * XDE translation commands
7615 * XDE general commands
7616 * XDE shape’s commands
7617 * XDE color’s commands
7618 * XDE layer’s commands
7619 * XDE property’s commands
7621 Reminding: All operations of translation are performed with parameters managed by command <a href="#occt_draw_8_3_14">the command *param*</a>.
7623 @subsubsection occt_draw_8_4_1 ReadIges
7627 ReadIges document file_name
7630 Reads information from an IGES file to an XCAF document.
7634 ReadIges D /disk1/tmp/aaa.igs
7635 ==> Document saved with name D
7638 @subsubsection occt_draw_8_4_2 ReadStep
7642 ReadStep <document> <file_name>
7645 Reads information from a STEP file to an XCAF document.
7649 ReadStep D /disk1/tmp/aaa.stp
7650 == Document saved with name D
7653 @subsubsection occt_draw_8_4_3 WriteIges
7657 WriteIges <document> <file_name>
7662 WriteIges D /disk1/tmp/aaa.igs
7665 @subsubsection occt_draw_8_4_4 WriteStep
7669 WriteStep <document> <file_name>
7672 Writes information from an XCAF document to a STEP file.
7676 WriteStep D /disk1/tmp/aaa.stp
7679 @subsubsection occt_draw_8_4_5 XFileCur
7686 Returns the name of file which is set as the current one in the Draw session.
7694 @subsubsection occt_draw_8_4_6 XFileList
7701 Returns a list all files that were transferred by the last transfer. This command is meant (assigned) for the assemble step file.
7706 ==> *as1-ct-Bolt.stp*
7707 ==> *as1-ct-L-Bracktet.stp*
7708 ==> *as1-ct-LBA.stp*
7709 ==> *as1-ct-NBA.stp*
7713 @subsubsection occt_draw_8_4_7 XFileSet
7720 Sets the current file taking it from the components list of the assemble file.
7724 XFileSet as1-ct-NBA.stp
7727 @subsubsection occt_draw_8_4_8 XFromShape
7734 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.
7739 ==> Shape a: imported from entity 217:#26 in file as1-ct-Nut.stp
7742 @subsection occt_draw_8_5 XDE general commands
7744 @subsubsection occt_draw_8_5_1 XNewDoc
7751 Creates a new XCAF document.
7758 @subsubsection occt_draw_8_5_2 XShow
7762 XShow <document> [ <label1> … ]
7765 Shows a shape from a given label in the 3D viewer. If the label is not given – shows all shapes from the document.
7769 # show shape from label 0:1:1:4 from document D
7773 @subsubsection occt_draw_8_5_3 XStat
7780 Prints common information from an XCAF document.
7785 ==>Statistis of shapes in the document:
7789 ==>Total number of labels for shapes in the document = 32
7790 ==>Number of labels with name = 27
7791 ==>Number of labels with color link = 3
7792 ==Number of labels with layer link = 0
7793 ==>Statistis of Props in the document:
7794 ==>Number of Centroid Props = 5
7795 ==>Number of Volume Props = 5
7796 ==>Number of Area Props = 5
7797 ==>Number of colors = 4
7798 ==>BLUE1 RED YELLOW BLUE2
7799 ==>Number of layers = 0
7802 @subsubsection occt_draw_8_5_4 XWdump
7806 XWdump <document> <filename>
7809 Saves the contents of the viewer window as an image (XWD, png or BMP file).
7810 <i>\<filename\></i> must have a corresponding extention.
7814 XWdump D /disk1/tmp/image.png
7817 @subsubsection occt_draw_8_5_5 Xdump
7821 Xdump <document> [int deep {0|1}]
7824 Prints information about the tree structure of the document. If parameter 1 is given, then the tree is printed with a link to shapes.
7829 ==> ASSEMBLY 0:1:1:1 L-BRACKET(0xe8180448)
7830 ==> ASSEMBLY 0:1:1:2 NUT(0xe82151e8)
7831 ==> ASSEMBLY 0:1:1:3 BOLT(0xe829b000)
7832 ==> ASSEMBLY 0:1:1:4 PLATE(0xe8387780)
7833 ==> ASSEMBLY 0:1:1:5 ROD(0xe8475418)
7834 ==> ASSEMBLY 0:1:1:6 AS1(0xe8476968)
7835 ==> ASSEMBLY 0:1:1:7 L-BRACKET-ASSEMBLY(0xe8476230)
7836 ==> ASSEMBLY 0:1:1:1 L-BRACKET(0xe8180448)
7837 ==> ASSEMBLY 0:1:1:8 NUT-BOLT-ASSEMBLY(0xe8475ec0)
7838 ==> ASSEMBLY 0:1:1:2 NUT(0xe82151e8)
7839 ==> ASSEMBLY 0:1:1:3 BOLT(0xe829b000)
7843 @subsection occt_draw_8_6 XDE shape commands
7845 @subsubsection occt_draw_8_6_1 XAddComponent
7849 XAddComponent <document> <label> <shape>
7852 Adds a component shape to assembly.
7856 Let us add shape b as component shape to assembly shape from label *0:1:1:1*
7859 XAddComponent D 0:1:1:1 b
7862 @subsubsection occt_draw_8_6_2 XAddShape
7866 XAddShape <document> <shape> [makeassembly=1]
7869 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.
7873 # add shape b to document D
7876 # if pointed shape is compound and last parameter in
7877 # XAddShape command is used by default (1), then for
7878 # each subshapes new label is created
7881 @subsubsection occt_draw_8_6_3 XFindComponent
7885 XFindComponent <document> <shape>
7888 Prints a sequence of labels of the assembly path.
7895 @subsubsection occt_draw_8_6_4 XFindShape
7899 XFindShape <document> <shape>
7902 Finds and prints a label with an indicated top-level shape.
7909 @subsubsection occt_draw_8_6_5 XGetFreeShapes
7913 XGetFreeShapes <document> [shape_prefix]
7916 Print labels or create DRAW shapes for all free shapes in the document.
7917 If *shape_prefix* is absent – prints labels, else – creates DRAW shapes with names
7918 <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).
7920 **Note**: a free shape is a shape to which no other shape refers to.
7925 == 0:1:1:6 0:1:1:10 0:1:1:12 0:1:1:13
7928 == sh_1 sh_2 sh_3 sh_4
7931 @subsubsection occt_draw_8_6_6 XGetOneShape
7935 XGetOneShape <shape> <document>
7938 Creates one DRAW shape for all free shapes from a document.
7945 @subsubsection occt_draw_8_6_7 XGetReferredShape
7949 XGetReferredShape <document> <label>
7952 Prints a label that contains a top-level shape that corresponds to a shape at a given label.
7956 XGetReferredShape D 0:1:1:1:1
7959 @subsubsection occt_draw_8_6_8 XGetShape
7963 XGetShape <result> <document> <label>
7966 Puts a shape from the indicated label in document to result.
7970 XGetShape b D 0:1:1:3
7973 @subsubsection occt_draw_8_6_9 XGetTopLevelShapes
7977 XGetTopLevelShapes <document>
7980 Prints labels that contain top-level shapes.
7984 XGetTopLevelShapes D
7985 == 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
7989 @subsubsection occt_draw_8_6_10 XLabelInfo
7993 XLabelInfo <document> <label>
7996 Prints information about a shape, stored at an indicated label.
8000 XLabelInfo D 0:1:1:6
8001 ==> There are TopLevel shapes. There is an Assembly. This Shape is not used.
8004 @subsubsection occt_draw_8_6_11 XNewShape
8008 XNewShape <document>
8011 Creates a new empty top-level shape.
8018 @subsubsection occt_draw_8_6_12 XRemoveComponent
8022 XRemoveComponent <document> <label>
8025 Removes a component from the components label.
8029 XRemoveComponent D 0:1:1:1:1
8032 @subsubsection occt_draw_8_6_13 XRemoveShape
8036 XRemoveShape <document> <label>
8039 Removes a shape from a document (by it’s label).
8043 XRemoveShape D 0:1:1:2
8046 @subsubsection occt_draw_8_6_14 XSetShape
8050 XSetShape <document> <label> <shape>
8053 Sets a shape at the indicated label.
8057 XSetShape D 0:1:1:3 b
8061 @subsection occt_draw_8_7_ XDE color commands
8063 @subsubsection occt_draw_8_7_1 XAddColor
8067 XAddColor <document> <R> <G> <B>
8070 Adds color in document to the color table. Parameters R,G,B are real.
8074 XAddColor D 0.5 0.25 0.25
8077 @subsubsection occt_draw_8_7_2 XFindColor
8081 XFindColor <document> <R> <G> <B>
8084 Finds a label where the indicated color is situated.
8088 XFindColor D 0.25 0.25 0.5
8092 @subsubsection occt_draw_8_7_3 XGetAllColors
8096 XGetAllColors <document>
8099 Prints all colors that are defined in the document.
8104 ==> RED DARKORANGE BLUE1 GREEN YELLOW3
8107 @subsubsection occt_draw_8_7_4 XGetColor
8111 XGetColor <document> <label>
8114 Returns a color defined at the indicated label from the color table.
8122 @subsubsection occt_draw_8_7_5 XGetObjVisibility
8126 XGetObjVisibility <document> {<label>|<shape>}
8129 Returns the visibility of a shape.
8133 XGetObjVisibility D 0:1:1:4
8136 @subsubsection occt_draw_8_7_6 XGetShapeColor
8140 XGetShapeColor <document> <label> <colortype(s|c)>
8143 Returns the color defined by label. If <i>colortype</i>=’s’ – returns surface color, else – returns curve color.
8147 XGetShapeColor D 0:1:1:4 c
8150 @subsubsection occt_draw_8_7_7 XRemoveColor
8154 XRemoveColor <document> <label>
8157 Removes a color from the color table in a document.
8161 XRemoveColor D 0:1:2:1
8164 @subsubsection occt_draw_8_7_8 XSetColor
8168 XSetColor <document> {<label>|<shape>} <R> <G> <B>
8171 Sets an RGB color to a shape given by label.
8175 XsetColor D 0:1:1:4 0.5 0.5 0.
8178 @subsubsection occt_draw_8_7_9 XSetObjVisibility
8182 XSetObjVisibility <document> {<label>|<shape>} {0|1}
8185 Sets the visibility of a shape.
8189 # set shape from label 0:1:1:4 as invisible
8190 XSetObjVisibility D 0:1:1:4 0
8193 @subsubsection occt_draw_8_7_10 XUnsetColor
8197 XUnsetColor <document> {<label>|<shape>} <colortype>
8200 Unset a color given type (‘s’ or ‘c’) for the indicated shape.
8204 XUnsetColor D 0:1:1:4 s
8208 @subsection occt_draw_8_8_ XDE layer commands
8210 @subsubsection occt_draw_8_8_1 XAddLayer
8214 XAddLayer <document> <layer>
8217 Adds a new layer in an XCAF document.
8224 @subsubsection occt_draw_8_8_2 XFindLayer
8228 XFindLayer <document> <layer>
8231 Prints a label where a layer is situated.
8239 @subsubsection occt_draw_8_8_3 XGetAllLayers
8243 XGetAllLayers <document>
8246 Prints all layers in an XCAF document.
8251 == *0:1:1:3* *Bolt* *0:1:1:9*
8254 @subsubsection occt_draw_8_8_4 XGetLayers
8258 XGetLayers <document> {<shape>|<label>}
8261 Returns names of layers, which are pointed to by links of an indicated shape.
8265 XGetLayers D 0:1:1:3
8269 @subsubsection occt_draw_8_8_5 XGetOneLayer
8273 XGetOneLayer <document> <label>
8276 Prints the name of a layer at a given label.
8280 XGetOneLayer D 0:1:3:2
8283 @subsubsection occt_draw_8_8_6 XIsVisible
8287 XIsVisible <document> {<label>|<layer>}
8290 Returns 1 if the indicated layer is visible, else returns 0.
8294 XIsVisible D 0:1:3:1
8297 @subsubsection occt_draw_8_8_7 XRemoveAllLayers
8301 XRemoveAllLayers <document>
8304 Removes all layers from an XCAF document.
8311 @subsubsection occt_draw_8_8_8 XRemoveLayer
8315 XRemoveLayer <document> {<label>|<layer>}
8318 Removes the indicated layer from an XCAF document.
8322 XRemoveLayer D layer2
8325 @subsubsection occt_draw_8_8_9 XSetLayer
8329 XSetLayer XSetLayer <document> {<shape>|<label>} <layer> [shape_in_one_layer {0|1}]
8333 Sets a reference between a shape and a layer (adds a layer if it is necessary).
8334 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).
8338 XSetLayer D 0:1:1:2 layer2
8341 @subsubsection occt_draw_8_8_10 XSetVisibility
8345 XSetVisibility <document> {<label>|<layer>} <isvisible {0|1}>
8348 Sets the visibility of a layer.
8352 # set layer at label 0:1:3:2 as invisible
8353 XSetVisibility D 0:1:3:2 0
8356 @subsubsection occt_draw_8_8_11 XUnSetAllLayers
8360 XUnSetAllLayers <document> {<label>|<shape>}
8363 Unsets a shape from all layers.
8367 XUnSetAllLayers D 0:1:1:2
8370 @subsubsection occt_draw_8_8_12 XUnSetLayer
8374 XUnSetLayer <document> {<label>|<shape>} <layer>
8377 Unsets a shape from the indicated layer.
8381 XUnSetLayer D 0:1:1:2 layer1
8384 @subsection occt_draw_8_9 XDE property commands
8386 @subsubsection occt_draw_8_9_1 XCheckProps
8390 XCheckProps <document> [ {0|deflection} [<shape>|<label>] ]
8393 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.
8397 # check properties for shapes at label 0:1:1:1 from
8398 # document using standard Open CASCADE Technology tools
8399 XCheckProps D 0 0:1:1:1
8400 == Label 0:1:1:1 ;L-BRACKET*
8401 == Area defect: -0.0 ( 0%)
8402 == Volume defect: 0.0 ( 0%)
8403 == CG defect: dX=-0.000, dY=0.000, dZ=0.000
8406 @subsubsection occt_draw_8_9_2 XGetArea
8410 XGetArea <document> {<shape>|<label>}
8413 Returns the area of a given shape.
8418 == 24628.31815094999
8421 @subsubsection occt_draw_8_9_3 XGetCentroid
8425 XGetCentroid <document> {<shape>|<label>}
8428 Returns the center of gravity coordinates of a given shape.
8432 XGetCentroid D 0:1:1:1
8435 @subsubsection occt_draw_8_9_4 XGetVolume
8439 XGetVolume <document> {<shape>|<label>}
8442 Returns the volume of a given shape.
8446 XGetVolume D 0:1:1:1
8449 @subsubsection occt_draw_8_9_5 XSetArea
8453 XSetArea <document> {<shape>|<label>} <area>
8456 Sets new area to attribute list ??? given shape.
8460 XSetArea D 0:1:1:1 2233.99
8463 @subsubsection occt_draw_8_9_6 XSetCentroid
8467 XSetCentroid <document> {<shape>|<label>} <x> <y> <z>
8470 Sets new center of gravity to the attribute list given shape.
8474 XSetCentroid D 0:1:1:1 0. 0. 100.
8477 @subsubsection occt_draw_8_9_7 XSetMaterial
8481 XSetMaterial <document> {<shape>|<label>} <name> <density(g/cu sm)>
8484 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.
8488 XSetMaterial D 0:1:1:1 Titanium 8899.77
8491 @subsubsection occt_draw_8_9_8 XSetVolume
8495 XSetVolume <document> {<shape>|<label>} <volume>
8498 Sets new volume to the attribute list ??? given shape.
8502 XSetVolume D 0:1:1:1 444555.33
8505 @subsubsection occt_draw_8_9_9 XShapeMassProps
8509 XShapeMassProps <document> [ <deflection> [{<shape>|<label>}] ]
8512 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.
8517 == Shape from label : 0:1:1:1
8518 == Mass = 193.71681469282299
8519 == CenterOfGravity X = 14.594564763807696,Y =
8520 20.20271885211281,Z = 49.999999385313245
8521 == Shape from label : 0:1:1:2 not have a mass
8525 @subsubsection occt_draw_8_9_10 XShapeVolume
8529 XShapeVolume <shape> <deflection>
8532 Calculates the real volume of a pointed shape with a given deflection.
8539 @section occt_draw_9 Shape Healing commands
8543 @subsection occt_draw_9_1 General commands
8545 @subsubsection occt_draw_9_1_1 bsplres
8549 bsplres <result> <shape> <tol3d> <tol2d< <reqdegree> <reqnbsegments> <continuity3d> <continuity2d> <PriorDeg> <RationalConvert>
8552 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**).
8554 @subsubsection occt_draw_9_1_2 checkfclass2d
8558 checkfclass2d <face> <ucoord> <vcoord>
8561 Shows where a point which is given by coordinates is located in relation to a given face – outbound, inside or at the bounds.
8565 checkfclass2d f 10.5 1.1
8569 @subsubsection occt_draw_9_1_3 checkoverlapedges
8573 checkoverlapedges <edge1> <edge2> [<toler> <domaindist>]
8576 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.
8580 checkoverlapedges e1 e2
8583 @subsubsection occt_draw_9_1_4 comtol
8587 comptol <shape> [nbpoints] [prefix]
8590 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.
8596 ==> Edges tolerance computed by 871 points:
8597 ==> MAX=8.0001130696523449e-008 AVG=6.349346868091096e-009 MIN=0
8598 ==> Relation real tolerance / tolerance set in edge
8599 ==> MAX=0.80001130696523448 AVG=0.06349345591805905 MIN=0
8600 ==> Edge with max tolerance saved to t_edge_tol
8601 ==> Concerned faces saved to shapes t_1, t_2
8604 @subsubsection occt_draw_9_1_5 convtorevol
8608 convtorevol <result> <shape>
8611 Converts all elementary surfaces of a given shape into surfaces of revolution.
8612 Results are put into the shape, which is given as the <i>\<result\></i> parameter.
8619 @subsubsection occt_draw_9_1_6 directfaces
8623 directfaces <result> <shape>
8626 Converts indirect surfaces and returns the results into the shape, which is given as the result parameter.
8633 @subsubsection occt_draw_9_1_7 expshape
8637 expshape <shape> <maxdegree> <maxseg>
8640 Gives statistics for a given shape. This test command is working with Bezier and BSpline entities.
8645 ==> Number of Rational Bspline curves 128
8646 ==> Number of Rational Bspline pcurves 48
8649 @subsubsection occt_draw_9_1_8 fixsmall
8653 fixsmall <result> <shape> [<toler>=1.]
8656 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.
8663 @subsubsection occt_draw_9_1_9 fixsmalledges
8667 fixsmalledges <result> <shape> [<toler> <mode> <maxangle>]
8670 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.
8674 fixsmalledges r a 0.1 1
8677 @subsubsection occt_draw_9_1_10 fixshape
8681 fixshape <result> <shape> [<preci> [<maxpreci>]] [{switches}]
8684 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
8686 The following syntax is used:
8687 * <i>\<symbol\></i> may be
8688 * "-" to set parameter off,
8690 * "*" to set default
8691 * <i>\<parameter\></i> is identified by letters:
8692 * l - FixLackingMode
8693 * o - FixOrientationMode
8694 * h - FixShiftedMode
8695 * m - FixMissingSeamMode
8696 * d - FixDegeneratedMode
8698 * i - FixSelfIntersectionMode
8699 * n - FixNotchedEdgesMode
8700 For enhanced message output, use switch '+?'
8707 @subsubsection occt_draw_9_1_11 fixwgaps
8711 fixwgaps <result> <shape> [<toler>=0]
8714 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.
8721 @subsubsection occt_draw_9_1_12 offsetcurve, offset2dcurve
8725 offsetcurve <result> <curve> <offset> <direction(as point)>
8726 offset2dcurve <result> <curve> <offset>
8729 **offsetcurve** works with the curve in 3d space, **offset2dcurve** in 2d space.
8731 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>.
8736 offsetcurve r c 20 pp
8739 @subsubsection occt_draw_9_1_13 projcurve
8743 projcurve <edge>|<curve3d>|<curve3d first last> <X> <Y> <Z>
8746 **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.
8751 ==Edge k_1 Params from 0 to 1.3
8752 ==Precision (BRepBuilderAPI) : 9.9999999999999995e-008 ==Projection : 0 1 5
8753 ==Result : 0 1.1000000000000001 0
8754 ==Param = -0.20000000000000001 Gap = 5.0009999000199947
8757 @subsubsection occt_draw_9_1_14 projface
8761 projface <face> <X> <Y> [<Z>]
8764 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.
8768 projface a_1 10.0 0.0
8769 == Point UV U = 10 V = 0
8770 == = proj X = -116 Y = -45 Z = 0
8773 @subsubsection occt_draw_9_1_15 scaleshape
8777 scaleshape <result> <shape> <scale>
8780 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.
8784 scaleshape r a_1 0.8
8787 @subsubsection occt_draw_9_1_16 settolerance
8791 settolerance <shape> [<mode>=v-e-w-f-a] <val>(fix value) or
8795 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.
8799 settolerance a 0.001
8802 @subsubsection occt_draw_9_1_17 splitface
8806 splitface <result> <face> [u usplit1 usplit2...] [v vsplit1 vsplit2 ...]
8809 Splits a given face in parametric space and puts the result into the given parameter <i>\<result\></i>.
8810 Returns the status of split face.
8814 # split face f by parameter u = 5
8816 ==> Splitting by U: ,5
8820 @subsubsection occt_draw_9_1_18 statshape
8824 statshape <shape> [particul]
8827 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
8828 surfaces. The last parameter becomes out of date.
8835 ==> 402 Edge (oriented)
8836 ==> 402 Edge (Shared)
8839 ==> 804 Vertex (Oriented)
8840 ==> 402 Vertex (Shared)
8842 ==> 4 Face with more than one wire
8843 ==> 34 bspsur: BSplineSurface
8846 @subsubsection occt_draw_9_1_19 tolerance
8850 tolerance <shape> [<mode>:D v e f c] [<tolmin> <tolmax>:real]
8853 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.
8858 ==> Tolerance MAX=0.31512672416608001 AVG=0.14901359484722074 MIN=9.9999999999999995e-08
8859 ==> FACE : MAX=9.9999999999999995e-08 AVG=9.9999999999999995e-08 MIN=9.9999999999999995e-08
8860 ==> EDGE : MAX=0.31512672416608001 AVG=0.098691334511810405 MIN=9.9999999999999995e-08
8861 ==> VERTEX : MAX=0.31512672416608001 AVG=0.189076074499648 MIN=9.9999999999999995e-08
8863 tolerance a v 0.1 0.001
8864 ==> Analysing Vertices gives 6 Shapes between tol1=0.10000000000000001 and tol2=0.001 , named tol_1 to tol_6
8868 @subsection occt_draw_9_2 Conversion commands
8870 @subsubsection occt_draw_9_2_1 DT_ClosedSplit
8874 DT_ClosedSplit <result> <shape>
8877 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.
8878 Note: Closed face – it’s face with one or more seam.
8885 @subsubsection occt_draw_9_2_2 DT_ShapeConvert, DT_ShapeConvertRev
8889 DT_ShapeConvert <result> <shape> <convert2d> <convert3d>
8890 DT_ShapeConvertRev <result> <shape> <convert2d> <convert3d>
8893 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.
8897 DT_ShapeConvert r a 1 1
8901 @subsubsection occt_draw_9_2_3 DT_ShapeDivide
8905 DT_ShapeDivide <result> <shape> <tol>
8908 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:
8909 * OK : no splitting was done
8910 * Done1 : Some edges were split
8911 * Done2 : Surface was split
8912 * Fail1 : Some errors occurred
8916 DT_ShapeDivide r a 0.001
8920 @subsubsection occt_draw_9_2_4 DT_SplitAngle
8924 DT_SplitAngle <result> <shape> [MaxAngle=95]
8927 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.
8928 This command illustrates how class *ShapeUpgrade_ShapeDivideAngle* works.
8936 @subsubsection occt_draw_9_2_5 DT_SplitCurve
8940 DT_SplitCurve <curve> <tol> <split(0|1)>
8943 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.
8950 @subsubsection occt_draw_9_2_6 DT_SplitCurve2d
8954 DT_SplitCurve2d Curve Tol Split(0/1)
8957 Works just as **DT_SplitCurve** (see above), only with 2d curve.
8964 @subsubsection occt_draw_9_2_7 DT_SplitSurface
8968 DT_SplitSurface <result> <Surface|GridSurf> <tol> <split(0|1)>
8971 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.
8977 # split surface with name "su"
8978 DT_SplitSurface res su 0.1 1
8980 ==> appel a SplitSurface::Init
8981 ==> appel a SplitSurface::Build
8982 ==> appel a SplitSurface::GlobalU/VKnots
8983 ==> nb GlobalU;nb GlobalV=7 2 0 1 2 3 4 5 6.2831853072 0 1
8984 ==> appel a Surfaces
8985 ==> transfert resultat
8986 ==> res1_1_1 res1_2_1 res1_3_1 res1_4_1 res1_5_1 res1_6_1
8990 @subsubsection occt_draw_9_2_8 DT_ToBspl
8994 DT_ToBspl <result> <shape>
8997 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.
9002 == error = 5.20375663162094e-08 spans = 10
9003 == Surface is aproximated with continuity 2
9006 @section occt_draw_10 Performance evaluation commands
9009 @subsection occt_draw_10_1 VDrawSphere
9013 vdrawsphere shapeName Fineness [X=0.0 Y=0.0 Z=0.0] [Radius=100.0] [ToEnableVBO=1] [NumberOfViewerUpdate=1] [ToShowEdges=0]
9016 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.
9018 This command can be used for visualization performance evaluation instead of the outdated Visualization Performance Meter.
9022 vdrawsphere s 200 1 1 1 500 1
9023 == Compute Triangulation...
9024 == NumberOfPoints: 39602
9025 == NumberOfTriangles: 79200
9026 == Amount of memory required for PolyTriangulation without Normals: 2 Mb
9027 == Amount of memory for colors: 0 Mb
9028 == Amount of memory for PolyConnect: 1 Mb
9029 == Amount of graphic card memory required: 2 Mb
9030 == Number of scene redrawings: 1
9031 == CPU user time: 15.6000999999998950 msec
9032 == CPU system time: 0.0000000000000000 msec
9033 == CPU average time of scene redrawing: 15.6000999999998950 msec
9037 @section occt_draw_11 Extending Test Harness with custom commands
9040 The following chapters explain how to extend Test Harness with custom commands and how to activate them using a plug-in mechanism.
9043 @subsection occt_draw_11_1 Custom command implementation
9045 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.
9049 static Standard_Integer myadvcurve(Draw_Interpretor& di, Standard_Integer n, char** a)
9055 For examples of existing commands refer to Open CASCADE Technology (e.g. GeomliteTest.cxx).
9058 @subsection occt_draw_11_2 Registration of commands in Test Harness
9060 To become available in the Test Harness the custom command must be registered in it. This should be done as follows.
9064 void MyPack::CurveCommands(Draw_Interpretor& theCommands)
9067 char* g = "Advanced curves creation";
9069 theCommands.Add ( "myadvcurve", "myadvcurve name p1 p2 p3 – Creates my advanced curve from points",
9070 __FILE__, myadvcurve, g );
9075 @subsection occt_draw_11_3 Creating a toolkit (library) as a plug-in
9077 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.
9079 This exported function *PLUGINFACTORY()* must be implemented only once per library.
9081 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.
9085 #include <Draw_PluginMacro.hxx>
9087 void MyPack::Factory(Draw_Interpretor& theDI)
9091 MyPack::CurveCommands(theDI);
9095 // Declare entry point PLUGINFACTORY
9099 @subsection occt_draw_11_4 Creation of the plug-in resource file
9101 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 (;:;).
9102 For every created plug-in there must be a key. For better readability and comprehension it is recommended to have some meaningful name.
9103 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.
9104 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.
9106 **Examples** (file MyDrawPlugin):
9108 ! Hierarchy of plug-ins
9109 ALL : ADVMODELING, MESHING
9111 ADVMODELING : ADVSURF, ADVCURV
9113 ! Mapping from naming to toolkits (libraries)
9114 ADVSURF : TKMyAdvSurf
9115 ADVCURV : TKMyAdvCurv
9119 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.
9122 @subsection occt_draw_11_5 Dynamic loading and activation
9124 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.
9126 The procedure consists in defining the system variables and using the pload commands in the Test Harness session.
9130 Draw[]> set env(CSF_MyDrawPluginDefaults) /users/test
9131 Draw[]> pload -MyDrawPlugin ALL