1 Draw Test Harness {#occt_user_guides__test_harness}
2 ===============================
6 @section occt_draw_1 Introduction
8 This manual explains how to use Draw, the test harness for Open CASCADE Technology (**OCCT**).
9 Draw is a command interpreter based on TCL and a graphical system used to test and demonstrate Open CASCADE Technology modeling libraries.
11 @subsection occt_draw_1_1 Overview
13 Draw is a test harness for Open CASCADE Technology. It provides a flexible and easy to use means of testing and demonstrating the OCCT modeling libraries.
15 Draw can be used interactively to create, display and modify objects such as curves, surfaces and topological shapes.
17 Scripts may be written to customize Draw and perform tests. New types of objects and new commands may be added using the C++ programing language.
21 * A command interpreter based on the TCL command language.
22 * A 3d graphic viewer based on the X system.
23 * A basic set of commands covering scripts, variables and graphics.
24 * A set of geometric commands allowing the user to create and modify curves and surfaces and to use OCCT geometry algorithms. This set of commands is optional.
25 * A set of topological commands allowing the user to create and modify BRep shapes and to use the OCCT topology algorithms.
28 There is also a set of commands for each delivery unit in the modeling libraries:
37 @subsection occt_draw_1_2 Contents of this documentation
39 This documentation describes:
41 * The command language.
42 * The basic set of commands.
43 * The graphical commands.
44 * The Geometry set of commands.
45 * The Topology set of commands.
47 This document does not describe other sets of commands and does not explain how to extend Draw using C++.
49 This document is a reference manual. It contains a full description of each command. All descriptions have the format illustrated below for the exit command.
55 Terminates the Draw, TCL session. If the commands are read from a file using the source command, this will terminate the file.
60 # this is a very short example
65 @subsection occt_draw_1_3 Getting started
67 Install Draw and launch Emacs. Get a command line in Emacs using *Esc x* and key in *woksh*.
69 All DRAW Test Harness can be activated in the common executable called **DRAWEXE**. They are grouped in toolkits and can be loaded at run-time thereby implementing dynamically loaded plug-ins. Thus, it is possible to work only with the required commands adding them dynamically without leaving the Test Harness session.
71 Declaration of available plug-ins is done through the special resource file(s). The *pload* command loads the plug-in in accordance with the specified resource file and activates the commands implemented in the plug-in.
73 @subsubsection occt_draw_1_3_1 Launching DRAW Test Harness
75 Test Harness executable *DRAWEXE* is located in the <i>$CASROOT/\<platform\>/bin</i> directory (where \<platform\> is Win for Windows and Linux for Linux operating systems). Prior to launching it is important to make sure that the environment is correctly set-up (usually this is done automatically after the installation process on Windows or after launching specific scripts on Linux).
78 @subsubsection occt_draw_1_3_2 Plug-in resource file
80 Open CASCADE Technology is shipped with the DrawPlugin resource file located in the <i>$CASROOT/src/DrawResources</i> directory.
82 The format of the file is compliant with standard Open CASCADE Technology resource files (see the *Resource_Manager.cdl* file for details).
84 Each key defines a sequence of either further (nested) keys or a name of the dynamic library. Keys can be nested down to an arbitrary level. However, cyclic dependencies between the keys are not checked.
86 **Example:** (excerpt from DrawPlugin):
87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
88 OCAF : VISUALIZATION, OCAFKERNEL
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
96 @subsubsection occt_draw_1_3_3 Activation of commands implemented in the plug-in
98 To load a plug-in declared in the resource file and to activate the commands the following command must be used in Test Harness:
101 pload [-PluginFileName] [[Key1] [Key2]...]
106 * <i>-PluginFileName</i> - defines the name of a plug-in resource file (prefix "-" is mandatory) described above. If this parameter is omitted then the default name *DrawPlugin* is used.
107 * *Key…* - defines the key(s) enumerating plug-ins to be loaded. If no keys are specified then the key named *DEFAULT* is used (if there is no such key in the file then no plug-ins are loaded).
109 According to the OCCT resource file management rules, to access the resource file the environment variable *CSF_PluginFileNameDefaults* (and optionally *CSF_PluginFileNameUserDefaults*) must be set and point to the directory storing the resource file. If it is omitted then the plug-in resource file will be searched in the <i>$CASROOT/src/DrawResources</i> directory.
112 Draw[] pload -DrawPlugin OCAF
114 This command will search the resource file *DrawPlugin* using variable *CSF_DrawPluginDefaults* (and *CSF_DrawPluginUserDefaults*) and will start with the OCAF key. Since the *DrawPlugin* is the file shipped with Open CASCADE Technology it will be found in the <i>$CASROOT/src/DrawResources</i> directory (unless this location is redefined by user's variables). The OCAF key will be recursively extracted into two toolkits/plug-ins: *TKDCAF* and *TKViewerTest* (e.g. on Windows they correspond to *TKDCAF.dll* and *TKViewerTest.dll*). Thus, commands implemented for Visualization and OCAF will be loaded and activated in Test Harness.
117 Draw[] pload (equivalent to pload -DrawPlugin DEFAULT).
119 This command will find the default DrawPlugin file and the DEFAULT key. The latter finally maps to the TKTopTest toolkit which implements basic modeling commands.
122 @section occt_draw_2 The Command Language
124 @subsection occt_draw_2_1 Overview
126 The command language used in Draw is Tcl. Tcl documentation such as "TCL and the TK Toolkit" by John K. Ousterhout (Addison-Wesley) will prove useful if you intend to use Draw extensively.
128 This chapter is designed to give you a short outline of both the TCL language and some extensions included in Draw. The following topics are covered:
130 * Syntax of the TCL language.
131 * Accessing variables in TCL and Draw.
132 * Control structures.
135 @subsection occt_draw_2_2 Syntax of TCL
137 TCL is an interpreted command language, not a structured language like C, Pascal, LISP or Basic. It uses a shell similar to that of csh. TCL is, however, easier to use than csh because control structures and procedures are easier to define. As well, because TCL does not assign a process to each command, it is faster than csh.
139 The basic program for TCL is a script. A script consists of one or more commands. Commands are separated by new lines or semicolons.
141 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
147 Each command consists of one or more *words*; the first word is the name of a command and additional words are arguments to that command.
149 Words are separated by spaces or tabs. In the preceding example each of the four commands has three words. A command may contain any number of words and each word is a string of arbitrary length.
151 The evaluation of a command by TCL is done in two steps. In the first step, the command is parsed and broken into words. Some substitutions are also performed. In the second step, the command procedure corresponding to the first word is called and the other words are interpreted as arguments. In the first step, there is only string manipulation, The words only acquire *meaning* in the second step by the command procedure.
153 The following substitutions are performed by TCL:
155 Variable substitution is triggered by the $ character (as with csh), the content of the variable is substitued; { } may be used as in csh to enclose the name of the variable.
158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
159 # set a variable value
160 set file documentation
161 puts $file #to display file contents on the screen
163 # a simple substitution, set psfile to documentation.ps
167 # another substitution, set pfile to documentationPS
171 # delete files NEWdocumentation and OLDdocumentation
172 foreach prefix {NEW OLD} {rm $prefix$file}
173 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175 Command substitution is triggered by the [ ] characters. The brackets must enclose a valid script. The script is evaluated and the result is substituted.
177 Compare command construction in csh.
180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
183 # expr is a command evaluating a numeric expression
184 set radian [expr $pi*$degree/180]
185 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
187 Backslash substitution is triggered by the backslash character. It is used to insert special characters like $, [ , ] , etc. It is also useful to insert a new line, a backslash terminated line is continued on the following line.
189 TCL uses two forms of *quoting* to prevent substitution and word breaking.
191 Double quote *quoting* enables the definition of a string with space and tabs as a single word. Substitutions are still performed inside the inverted commas " ".
194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
195 # set msg to ;the price is 12.00;
197 set msg ;the price is $price;
198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
200 Braces *quoting* prevents all substitutions. Braces are also nested. The main use of braces is to defer evaluation when defining procedures and control structures. Braces are used for a clearer presentation of TCL scripts on several lines.
203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
205 # this will loop for ever
206 # because while argument is ;0 3;
207 while ;$x 3; {set x [expr $x+1]}
208 # this will terminate as expected because
209 # while argument is {$x 3}
210 while {$x 3} {set x [expr $x+1]}
211 # this can be written also
215 # the following cannot be written
216 # because while requires two arguments
221 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
223 Comments start with a \# character as the first non-blank character in a command. To add a comment at the end of the line, the comment must be preceded by a semi-colon to end the preceding command.
226 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
228 set a 1 # this is not a comment
229 set b 1; # this is a comment
230 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
232 The number of words is never changed by substitution when parsing in TCL. For example, the result of a substitution is always a single word. This is different from csh but convenient as the behavior of the parser is more predictable. It may sometimes be necessary to force a second round of parsing. **eval** accomplishes this: it accepts several arguments, concatenates them and executes the resulting script.
236 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
237 # I want to delete two files
241 # this will fail because rm will receive only one argument
242 # and complain that ;foo bar; does not exit
246 # a second evaluation will do it
247 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
249 @subsection occt_draw_2_3 Accessing variables in TCL and Draw
251 TCL variables have only string values. Note that even numeric values are stored as string literals, and computations using the **expr** command start by parsing the strings. Draw, however, requires variables with other kinds of values such as curves, surfaces or topological shapes.
253 TCL provides a mechanism to link user data to variables. Using this functionality, Draw defines its variables as TCL variables with associated data.
255 The string value of a Draw variable is meaningless. It is usually set to the name of the variable itself. Consequently, preceding a Draw variable with a <i>$</i> does not change the result of a command. The content of a Draw variable is accessed using appropriate commands.
257 There are many kinds of Draw variables, and new ones may be added with C++. Geometric and topological variables are described below.
259 Draw numeric variables can be used within an expression anywhere a Draw command requires a numeric value. The *expr* command is useless in this case as the variables are stored not as strings but as floating point values.
262 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
263 # dset is used for numeric variables
264 # pi is a predefined Draw variable
265 dset angle pi/3 radius 10
266 point p radius*cos(angle) radius*sin(angle) 0
267 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
268 It is recommended that you use TCL variables only for strings and Draw for numerals. That way, you will avoid the *expr* command. As a rule, Geometry and Topology require numbers but no strings.
270 @subsubsection occt_draw_2_3_1 set, unset
276 unset varname [varname varname ...]
279 *set* assigns a string value to a variable. If the variable does not already exist, it is created.
281 Without a value, *set* returns the content of the variable.
283 *unset* deletes variables. It is is also used to delete Draw variables.
286 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
293 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
295 **Note**, that the *set* command can set only one variable, unlike the *dset* command.
298 @subsubsection occt_draw_2_3_2 dset, dval
303 dset var1 value1 vr2 value2 ...
307 *dset* assigns values to Draw numeric variables. The argument can be any numeric expression including Draw numeric variables. Since all Draw commands expect a numeric expression, there is no need to use $ or *expr*. The *dset* command can assign several variables. If there is an odd number of arguments, the last variable will be assigned a value of 0. If the variable does not exist, it will be created.
309 *dval* evaluates an expression containing Draw numeric variables and returns the result as a string, even in the case of a single variable. This is not used in Draw commands as these usually interpret the expression. It is used for basic TCL commands expecting strings.
313 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
318 # no $ required for Draw commands
321 # "puts" prints a string
322 puts ;x = [dval x], cos(x/pi) = [dval cos(x/pi)];
323 == x = 10, cos(x/pi) = -0.99913874099467914
324 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
326 **Note,** that in TCL, parentheses are not considered to be special characters. Do not forget to quote an expression if it contains spaces in order to avoid parsing different words. <i>(a + b)</i> is parsed as three words: <i>"(a + b)"</i> or <i>(a+b)</i> are correct.
329 @subsection occt_draw_2_4 lists
331 TCL uses lists. A list is a string containing elements separated by spaces or tabs. If the string contains braces, the braced part accounts as one element.
333 This allows you to insert lists within lists.
336 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
337 # a list of 3 strings
340 # a list of two strings the first is a list of 2
342 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
344 Many TCL commands return lists and **foreach** is a useful way to create loops on list elements.
346 @subsubsection occt_draw_2_5 Control Structures
348 TCL allows looping using control structures. The control structures are implemented by commands and their syntax is very similar to that of their C counterparts (**if**, **while**, **switch**, etc.). In this case, there are two main differences between TCL and C:
350 * You use braces instead of parentheses to enclose conditions.
351 * You do not start the script on the next line of your command.
354 @subsubsection occt_draw_2_5_1 if
359 if condition script [elseif script .... else script]
362 **If** evaluates the condition and the script to see whether the condition is true.
367 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
375 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
377 @subsubsection occt_draw_2_5_2 while, for, foreach
383 while condition script
384 for init condition reinit script
385 foreach varname list script
388 The three loop structures are similar to their C or csh equivalent. It is important to use braces to delay evaluation. **foreach** will assign the elements of the list to the variable before evaluating the script. \
391 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
394 while {[dval x] 100} {
399 # incr var d, increments a variable of d (default 1)
400 for {set i 0} {$i 10} {incr i} {
402 point p$i cos(angle0 sin(angle) 0
405 foreach object {crapo tomson lucas} {display $object}
406 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
408 @subsubsection occt_draw_2_5_3 break, continue
417 Within loops, the **break** and **continue** commands have the same effect as in C.
419 **break** interrupts the innermost loop and **continue** jumps to the next iteration.
422 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
423 # search the index for which t$i has value ;secret;
424 for {set i 1} {$i = 100} {incr i} {
425 if {[set t$i] == ;secret;} break;
427 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
429 @subsection occt_draw_2_6 Procedures
431 TCL can be extended by defining procedures using the **proc** command, which sets up a context of local variables, binds arguments and executes a TCL script.
433 The only problematic aspect of procedures is that variables are strictly local, and as they are implicitly created when used, it may be difficult to detect errors.
435 There are two means of accessing a variable outside the scope of the current procedures: **global** declares a global variable (a variable outside all procedures); **upvar** accesses a variable in the scope of the caller. Since arguments in TCL are always string values, the only way to pass Draw variables is by reference, i.e. passing the name of the variable and using the **upvar** command as in the following examples.
437 As TCL is not a strongly typed language it is very difficult to detect programming errors and debugging can be tedious. TCL procedures are, of course, not designed for large scale software development but for testing and simple command or interactive writing.
440 @subsubsection occt_draw_2_6_1 proc
445 proc argumentlist script
448 **proc** defines a procedure. An argument may have a default value. It is then a list of the form {argument value}. The script is the body of the procedure.
450 **return** gives a return value to the procedure.
453 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
458 # procedure with arguments and default values
459 proc distance {x1 y1 {x2 0} {y2 0}} {
460 set d [expr (x2-x1)*(x2-x1) + (y2-y1)*(y2-y1)]
461 return [expr sqrt(d)]
464 if {$n == 0} {return 1} else {
465 return [expr n*[fact [expr n -1]]]
468 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
471 @subsubsection occt_draw_2_6_2 global, upvar
476 global varname [varname ...]
477 upvar varname localname [varname localname ...]
481 **global** accesses high level variables. Unlike C, global variables are not visible in procedures.
483 **upvar** gives a local name to a variable in the caller scope. This is useful when an argument is the name of a variable instead of a value. This is a call by reference and is the only way to use Draw variables as arguments.
485 **Note** that in the following examples the \$ character is always necessarily used to access the arguments.
488 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
489 # convert degree to radian
490 # pi is a global variable
491 proc deg2rad (degree} {
492 return [dval pi*$degree/2.]
494 # create line with a point and an angle
495 proc linang {linename x y angle} {
497 line l $x $y cos($angle) sin($angle)
499 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
501 @section occt_draw_3 Basic Commands
503 This chapter describes all the commands defined in the basic Draw package. Some are TCL commands, but most of them have been formulated in Draw. These commands are found in all Draw applications. The commands are grouped into four sections:
505 * General commands, which are used for Draw and TCL management.
506 * Variable commands, which are used to manage Draw variables such as storing and dumping.
507 * Graphic commands, which are used to manage the graphic system, and so pertain to views.
508 * Variable display commands, which are used to manage the display of objects within given views.
510 Note that Draw also features a GUI task bar providing an alternative way to give certain general, graphic and display commands
513 @subsection occt_draw_3_1 General commands
515 This section describes several useful commands:
517 * **help** to get information,
518 * **source** to eval a script from a file,
519 * **spy** to capture the commands in a file,
520 * **cpulimit** to limit the process cpu time,
521 * **wait** to waste some time,
522 * **chrono** to time commands.
524 @subsubsection occt_draw_3_1_1 help
529 help [command [helpstring group]]
532 Provides help or modifies the help information.
534 **help** without arguments lists all groups and the commands in each group.
536 Specifying the command returns its syntax and in some cases, information on the command, The joker \* is automatically added at the end so that all completing commands are returned as well.
539 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
540 # Gives help on all commands starting with *a*
541 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
544 @subsubsection occt_draw_3_1_2 source
553 The **exit** command will terminate the file.
555 @subsubsection occt_draw_3_1_3 spy
563 Saves interactive commands in the file. If spying has already been performed, the current file is closed. **spy** without an argument closes the current file and stops spying. If a file already exists, the file is overwritten. Commands are not appended.
565 If a command returns an error it is saved with a comment mark.
567 The file created by **spy** can be executed with the **source** command.
570 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
571 # all commands will be saved in the file ;session;
573 # the file ;session; is closed and commands are not saved
575 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
579 @subsubsection occt_draw_3_1_4 cpulimit
587 **cpulimit**limits a process after the number of seconds specified in nbseconds. It is used in tests to avoid infinite loops. **cpulimit** without arguments removes all existing limits.
590 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
591 #limit cpu to one hour
593 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
595 @subsubsection occt_draw_3_1_5 wait
601 Suspends execution for the number of seconds specified in *nbseconds*. The default value is ten (10) seconds. This is a useful command for a slide show.
604 # You have ten seconds ...
608 @subsubsection occt_draw_3_1_6 chrono
613 chrono [ name start/stop/reset/show]
616 Without arguments, **chrono** activates Draw chronometers. The elapsed time ,cpu system and cpu user times for each command will be printed.
618 With arguments, **chrono** is used to manage activated chronometers. You can perform the following actions with a chronometer.
619 * run the chronometer (start).
620 * stop the chronometer (stop).
621 * reset the chronometer to 0 (reset).
622 * display the current time (show).
625 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
627 ==Chronometers activated.
629 ==Elapsed time: 0 Hours 0 Minutes 0.0318 Seconds
630 ==CPU user time: 0.01 seconds
631 ==CPU system time: 0 seconds
632 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
634 @subsection occt_draw_3_2 Variable management commands
636 @subsubsection occt_draw_3_2_1 isdraw, directory
644 **isdraw** tests to see if a variable is a Draw variable. **isdraw** will return 1 if there is a Draw value attached to the variable.
646 Use **directory** to return a list of all Draw global variables matching a pattern.
649 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
662 # to destroy all Draw objects with name containing curve
663 foreach var [directory *curve*] {unset $var}
664 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
667 @subsubsection occt_draw_3_2_2 whatis, dump
672 whatis varname [varname ...]
673 dump varname [varname ...]
676 **whatis** returns short information about a Draw variable. This is usually the type name.
678 **dump** returns a brief type description, the coordinates, and if need be, the parameters of a Draw variable.
681 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
688 ***** Dump of c *****
694 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
696 **Note** The behavior of *whatis* on other variables (not Draw) is not excellent.
699 @subsubsection occt_draw_3_2_3 rename, copy
703 rename varname tovarname [varname tovarname ...]
704 copy varname tovarname [varname tovarname ...]
707 * **rename** changes the name of a Draw variable. The original variable will no longer exist. Note that the content is not modified. Only the name is changed.
708 * **copy** creates a new variable with a copy of the content of an existing variable. The exact behavior of **copy** is type dependent; in the case of certain topological variables, the content may still be shared.
711 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
715 # curves are copied, c2 will not be modified
717 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
719 @subsubsection occt_draw_3_2_4 datadir, save, restore
724 save variable [filename]
725 restore filename [variablename]
728 * **datadir** without arguments prints the path of the current data directory.
729 * **datadir** with an argument sets the data directory path. \
731 If the path starts with a dot (.) only the last directory name will be changed in the path.
733 * **save** writes a file in the data directory with the content of a variable. By default the name of the file is the name of the variable. To give a different name use a second argument.
734 * **restore** reads the content of a file in the data directory in a local variable. By default, the name of the variable is the name of the file. To give a different name, use a second argument.
736 The exact content of the file is type-dependent. They are usually ASCII files and so, architecture independent.
739 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
740 # note how TCL accesses shell environment variables
745 datadir $env(WBCONTAINER)/data/default
746 ==/adv_20/BAG/data/default
750 ==/adv_20/BAG/data/default/theBox
752 # when TCL does not find a command it tries a shell command
758 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
760 @subsection occt_draw_3_3 User defined commands
762 *DrawTrSurf* provides commands to create and display a Draw **geometric** variable from a *Geom_Geometry* object and also get a *Geom_Geometry* object from a Draw geometric variable name.
764 *DBRep* provides commands to create and display a Draw **topological** variable from a *TopoDS_Shape* object and also get a *TopoDS_Shape* object from a Draw topological variable name.
766 @subsubsection occt_draw_3_3_1 set
768 #### In *DrawTrSurf* package:
771 void Set(Standard_CString& Name,const gp_Pnt& G) ;
772 void Set(Standard_CString& Name,const gp_Pnt2d& G) ;
773 void Set(Standard_CString& Name,
774 const Handle(Geom_Geometry)& G) ;
775 void Set(Standard_CString& Name,
776 const Handle(Geom2d_Curve)& C) ;
777 void Set(Standard_CString& Name,
778 const Handle(Poly_Triangulation)& T) ;
779 void Set(Standard_CString& Name,
780 const Handle(Poly_Polygon3D)& P) ;
781 void Set(Standard_CString& Name,
782 const Handle(Poly_Polygon2D)& P) ;
785 #### In *DBRep* package:
788 void Set(const Standard_CString Name,
789 const TopoDS_Shape& S) ;
792 Example of *DrawTrSurf*
795 Handle(Geom2d_Circle) C1 = new Geom2d_Circle
796 (gce_MakeCirc2d (gp_Pnt2d(50,0,) 25));
797 DrawTrSurf::Set(char*, C1);
804 B = BRepPrimAPI_MakeBox (10,10,10);
808 @subsubsection occt_draw_3_3_2 get
810 #### In *DrawTrSurf* package:
813 Handle_Geom_Geometry Get(Standard_CString& Name) ;
816 #### In *DBRep* package:
819 TopoDS_Shape Get(Standard_CString& Name,
820 const TopAbs_ShapeEnum Typ = TopAbs_SHAPE,
821 const Standard_Boolean Complain
825 Example of *DrawTrSurf*
828 Standard_Integer MyCommand
829 (Draw_Interpretor& theCommands,
830 Standard_Integer argc, char** argv)
832 // Creation of a Geom_Geometry from a Draw geometric
834 Handle (Geom_Geometry) aGeom= DrawTrSurf::Get(argv[1]);
841 Standard_Integer MyCommand
842 (Draw_Interpretor& theCommands,
843 Standard_Integer argc, char** argv)
845 // Creation of a TopoDS_Shape from a Draw topological
847 TopoDS_Solid B = DBRep::Get(argv[1]);
851 @section occt_draw_4 Graphic Commands
853 Graphic commands are used to manage the Draw graphic system. Draw provides a 2d and a 3d viewer with up to 30 views. Views are numbered and the index of the view is displayed in the window’s title. Objects are displayed in all 2d views or in all 3d views, depending on their type. 2d objects can only be viewed in 2d views while 3d objects – only in 3d views correspondingly.
855 @subsection occt_draw_4_1 Axonometric viewer
857 @subsubsection occt_draw_4_1_1 view, delete
861 view index type [X Y W H]
865 **view** is the basic view creation command: it creates a new view with the given index. If a view with this index already exits, it is deleted. The view is created with default parameters and X Y W H are the position and dimensions of the window on the screen. Default values are 0, 0, 500, 500.
867 As a rule it is far simpler either to use the procedures **axo**, **top**, **left** or to click on the desired view type in the menu under *Views* in the task bar..
869 **delete** deletes a view. If no index is given, all the views are deleted.
871 Type selects from the following range:
873 * *AXON* : Axonometric view
874 * *PERS* : Perspective view
875 * <i>+X+Y</i> : View on both axes (i.e. a top view), other codes are <i>-X+Y</i>, <i>+Y-Z</i>, etc.
876 * <i>-2D-</i> : 2d view
878 The index, the type, the current zoom are displayed in the window title .
881 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
882 # this is the content of the mu4 procedure
885 view 1 +X+Z 320 20 400 400
886 view 2 +X+Y 320 450 400 400
887 view 3 +Y+Z 728 20 400 400
888 view 4 AXON 728 450 400 400
890 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
892 See also: **axo, pers, top, bottom, left, right, front, back, mu4, v2d, av2d, smallview**
894 @subsubsection occt_draw_4_1_2 axo, pers, top, ...
905 All these commands are procedures used to define standard screen layout. They delete all existing views and create new ones. The layout usually complies with the European convention, i.e. a top view is under a front view.
907 * **axo** creates a large window axonometric view;
908 * **pers** creates a large window perspective view;
909 * **top**, **bottom**, **left**, **right**, **front**, **back** create a large window axis view;
910 * **mu4** creates four small window views: front, left, top and axo.
911 * **v2d** creates a large window 2d view.
912 * **av2d** creates two small window views, one 2d and one axo
913 * **smallview** creates a view at the bottom right of the screen of the given type.
915 See also: **view**, **delete**
917 @subsubsection occt_draw_4_1_3 mu, md, 2dmu, 2dmd, zoom, 2dzoom
928 * **mu** (magnify up) increases the zoom in one or several views by a factor of 10%.
929 * **md** (magnify down) decreases the zoom by the inverse factor. **2dmu** and **2dmd**
930 perform the same on one or all 2d views.
931 * **zoom** and **2dzoom** set the zoom factor to a value specified by you. The current zoom factor is always displayed in the window’s title bar. Zoom 20 represents a full screen view in a large window; zoom 10, a full screen view in a small one.
932 * **wzoom** (window zoom) allows you to select the area you want to zoom in on with the mouse. You will be prompted to give two of the corners of the area that you want to magnify and the rectangle so defined will occupy the window of the view.
935 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
943 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
944 See also: **fit**, **2dfit**
947 @subsubsection occt_draw_4_14 pu, pd, pl, pr, 2dpu, 2dpd, 2dpl, 2dpr
956 The <i>p_</i> commands are used to pan. **pu** and **pd** pan up and down respectively; **pl** and **pr** pan to the left and to the right respectively. Each time the view is displaced by 40 pixels. When no index is given, all views will pan in the direction specified.
958 # you have selected one anonometric view
963 # you have selected an mu4 view; the object in the third view will pan up
966 See also: **fit**, **2dfit**
969 @subsubsection occt_draw_4_1_5 fit, 2dfit
978 **fit** computes the best zoom and pans on the content of the view. The content of the view will be centered and fit the whole window.
980 When fitting all views a unique zoom is computed for all the views. All views are on the same scale.
983 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
988 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
989 See also: **zoom**, **mu**, **pu**
992 @subsubsection occt_draw_4_1_6 u, d, l, r
1003 **u**, **d**, **l**, **r** Rotate the object in view around its axis by five degrees up, down, left or right respectively. This command is restricted to axonometric and perspective views.
1006 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1007 # rotate the view up
1009 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1011 @subsubsection occt_draw_4_1_7 focal, fu, fd
1020 * **focal** changes the vantage point in perspective views. A low f value increases the perspective effect; a high one give a perspective similar to that of an axonometric view. The default value is 500.
1021 * **fu** and **fd** increase or decrease the focal value by 10%. **fd** makes the eye closer to the object.
1024 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1027 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1029 **Note**: Do not use a negative or null focal value.
1033 @subsubsection occt_draw_4_1_8 color
1041 **color** sets the color to a value. The index of the *color* is a value between 0 and 15. The name is an X window color name. The list of these can be found in the file *rgb.txt* in the X library directory.
1043 The default values are: 0 White, 1 Red, 2 Green, 3 Blue, 4 Cyan, 5 Gold, 6 Magenta, 7 Marron, 8 Orange, 9 Pink, 10 Salmon, 11 Violet, 12 Yellow, 13 Khaki, 14 Coral.
1046 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1047 # change the value of blue
1049 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1052 **Note** that the color change will be visible on the next redraw of the views, for example, after *fit* or *mu*, etc.
1054 @subsubsection occt_draw_4_1_9 dtext
1058 dtext [x y [z]] string
1061 **dtext** displays a string in all 3d or 2d views. If no coordinates are given, a graphic selection is required. If two coordinates are given, the text is created in a 2d view at the position specified. With 3 coordinates, the text is created in a 3d view.
1063 The coordinates are real space coordinates.
1066 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1070 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1072 @subsubsection occt_draw_4_1_10 hardcopy, hcolor, xwd
1077 hcolor index width gray
1078 xwd [index] filename
1081 * **hardcopy** creates a postcript file called a4.ps in the current directory. This file contains the postscript description of the view index, and will allow you to print the view.
1082 * **hcolor** lets you change the aspect of lines in the postscript file. It allows to specify a width and a gray level for one of the 16 colors. **width** is measured in points with default value as 1, **gray** is the gray level from 0 = black to 1 = white with default value as 0. All colors are bound to the default values at the beginning.
1083 * **xwd** creates an X window xwd file from an active view. By default, the index is set to1. To visualize an xwd file, use the unix command **xwud**.
1086 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1087 # all blue lines (color 3)
1088 # will be half-width and gray
1091 # make a postscript file and print it
1095 # make an xwd file and display it
1098 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1100 **Note:** When more than one view is present, specify the index of the view.
1102 Only use a postscript printer to print postscript files.
1107 @subsubsection occt_draw_4_1_11 wclick, pick
1112 pick index X Y Z b [nowait]
1115 **wclick** defers an event until the mouse button is clicked. The message <code>just click</code> is displayed.
1117 Use the **pick** command to get graphic input. The arguments must be names for variables where the results are stored.
1118 * index: index of the view where the input was made.
1119 * X,Y,Z: 3d coordinates in real world.
1120 * b: b is the mouse button 1,2 or 3.
1122 When there is an extra argument, its value is not used and the command does not wait for a click; the value of b may then be 0 if there has not been a click.
1124 This option is useful for tracking the pointer.
1126 **Note** that the results are stored in Draw numeric variables.
1129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1130 # make a circle at mouse location
1132 circle c x y z 0 0 1 1 0 0 0 30
1134 # make a dynamic circle at mouse location
1135 # stop when a button is clicked
1136 # (see the repaint command)
1139 while {[dval b] == 0} {
1140 pick index x y z b nowait
1141 circle c x y z 0 0 1 1 0 0 0 30
1144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1145 See also: **repaint**
1148 Draw provides commands to manage the display of objects.
1149 * **display**, **donly** are used to display,
1150 * **erase**, **clear**, **2dclear** to erase.
1151 * **autodisplay** command is used to check whether variables are displayed when created.
1153 The variable name "." (dot) has a special status in Draw. Any Draw command expecting a Draw object as argument can be passed a dot. The meaning of the dot is the following.
1154 * If the dot is an input argument, a graphic selection will be made. Instead of getting the object from a variable, Draw will ask you to select an object in a view.
1155 * If the dot is an output argument, an unnamed object will be created. Of course this makes sense only for graphic objects: if you create an unnamed number you will not be able to access it. This feature is used when you want to create objects for display only.
1156 * If you do not see what you expected while executing loops or sourcing files, use the **repaint** and **dflush** commands.
1159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1160 # OK use dot to dump an object on the screen
1165 #Not OK. display points on a curve c
1166 # with dot no variables are created
1167 for {set i 0} {$i = 10} {incr i} {
1168 cvalue c $i/10 x y z
1173 # would have displayed only one point
1174 # because the precedent variable content is erased
1177 # is an other solution, creating variables
1180 # give a name to a graphic object
1182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1185 @subsubsection occt_draw_4_1_12 autodisplay
1193 By default, Draw automatically displays any graphic object as soon as it is created. This behavior known as autodisplay can be removed with the command **autodisplay**. Without arguments, **autodisplay** toggles the autodisplay mode. The command always returns the current mode.
1195 When **autodisplay** is off, using the dot return argument is ineffective.
1198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1207 # c is erased, but not displayed
1209 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1211 @subsubsection occt_draw_4_1_13 display, donly
1215 display varname [varname ...]
1216 donly varname [varname ...]
1219 * **display** makes objects visible.
1220 * **donly** *display only* makes objects visible and erases all other objects. It is very useful to extract one object from a messy screen.
1223 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1224 \# to see all objects
1225 foreach var [directory] {display $var}
1227 \# to select two objects and erase the other ones
1229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1232 @subsubsection occt_draw_4_1_14 erase, clear, 2dclear
1237 erase [varname varname ...]
1242 **erase** removes objects from all views. **erase** without arguments erases everything in 2d and 3d.
1244 **clear** erases only 3d objects and **2dclear** only 2d objects. **erase** without arguments is similar to **clear; 2dclear**.
1248 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1249 # erase eveerything with a name starting with c_
1250 foreach var [directory c_*] {erase $var}
1254 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1256 @subsubsection occt_draw_4_1_15 repaint, dflush
1266 * **repaint** forces repainting of views.
1267 * **dflush** flushes the graphic buffers.
1269 These commands are useful within loops or in scripts.
1271 When an object is modified or erased, the whole view must be repainted. To avoid doing this too many times, Draw sets up a flag and delays the repaint to the end of the command in which the new prompt is issued. In a script, you may want to display the result of a change immediately. If the flag is raised, **repaint** will repaint the views and clear the flag.
1273 Graphic operations are buffered by Draw (and also by the X system). Usually the buffer is flushed at the end of a command and before graphic selection. If you want to flush the buffer from inside a script, use the **dflush** command.
1275 See also: <a href="#occt_draw_4_1_11">pick</a> command.
1277 @subsection occt_draw_4_2 AIS viewer – view commands
1279 @subsubsection occt_draw_4_2_1 vinit
1285 Creates new View window with specified name view_name.
1286 By default the new view is created in the viewer and in graphic driver shared with active view.
1287 * *name* = {driverName/viewerName/viewName | viewerName/viewName | viewName}.
1288 If driverName isn't specified the driver will be shared with active view.
1289 If viewerName isn't specified the viewer will be shared with active view.
1291 @subsubsection occt_draw_4_2_2 vhelp
1297 Displays help in the 3D viewer window. The help consists in a list of hotkeys and their functionalities.
1299 @subsubsection occt_draw_4_2_3 vtop
1306 Displays top view in the 3D viewer window. Orientation +X+Y.
1309 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1315 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1317 @subsubsection occt_draw_4_2_4 vaxo
1324 Displays axonometric view in the 3D viewer window. Orientation +X-Y+Z.
1327 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1333 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1335 @subsubsection occt_draw_4_2_5 vsetbg
1339 vsetbg imagefile [filltype]
1342 Loads image file as background. *filltype* must be NONE, CENTERED, TILED or STRETCH.
1347 vsetbg myimage.brep CENTERED
1350 @subsubsection occt_draw_4_2_6 vclear
1356 Removes all objects from the viewer.
1358 @subsubsection occt_draw_4_2_7 vrepaint
1364 Forcebly redisplays the shape in the 3D viewer window.
1366 @subsubsection occt_draw_4_2_8 vfit
1372 Automatic zoom/panning. Objects in the view are visualized to occupy the maximum surface.
1374 @subsubsection occt_draw_4_2_9 vzfit
1381 Automatic depth panning. Objects in the view are visualized to occupy the maximum 3d space.
1383 @subsubsection occt_draw_4_2_10 vreadpixel
1387 vreadpixel xPixel yPixel [{rgb|rgba|depth|hls|rgbf|rgbaf}=rgba] [name]
1389 Read pixel value for active view.
1392 @subsubsection occt_draw_4_2_11 vselect
1396 vselect x1 y1 [x2 y2 [x3 y3 ... xn yn]] [-allowoverlap 0|1] [shift_selection = 0|1]
1399 Emulates different types of selection:
1401 * single mouse click selection
1402 * selection with a rectangle having the upper left and bottom right corners in <i>(x1,y1)</i> and <i>(x2,y2)</i> respectively
1403 * selection with a polygon having the corners in pixel positions <i>(x1,y1), (x2,y2),…, (xn,yn)</i>
1404 * -allowoverlap manages overlap and inclusion detection in rectangular selection. If the flag is set to 1, both sensitives that were included completely and overlapped partially by defined rectangle will be detected, otherwise algorithm will chose only fully included sensitives. Default behavior is to detect only full inclusion.
1405 * any of these selections if shift_selection is set to 1.
1407 @subsubsection occt_draw_4_2_12 vmoveto
1414 Emulates cursor movement to pixel position (x,y).
1416 @subsubsection occt_draw_4_2_13 vviewparams
1420 vviewparams [-scale [s]] [-eye [x y z]] [-at [x y z]] [-up [x y z]] [-proj [x y z]] [-center x y] [-size sx]
1422 Gets or sets current view parameters.
1423 * If called without arguments, all view parameters are printed.
1425 * -scale [s] : prints or sets viewport relative scale.
1426 * -eye [x y z] : prints or sets eye location.
1427 * -at [x y z] : prints or sets center of look.
1428 * -up [x y z] : prints or sets direction of up vector.
1429 * -proj [x y z] : prints or sets direction of look.
1430 * -center x y : sets location of center of the screen in pixels.
1431 * -size [sx] : prints viewport projection width and height sizes or changes the size of its maximum dimension.
1433 @subsubsection occt_draw_4_2_14 vchangeselected
1437 vchangeselected shape
1439 Adds a shape to selection or removes one from it.
1441 @subsubsection occt_draw_4_2_15 vzclipping
1445 vzclipping [mode] [depth width]
1447 Gets or sets ZClipping mode, width and depth, where
1448 - *mode = OFF|BACK|FRONT|SLICE*
1449 - *depth* is a real value from segment [0,1]
1450 - *width* is a real value from segment [0,1]
1452 @subsubsection occt_draw_4_2_16 vnbselected
1458 Returns the number of selected objects in the interactive context.
1460 @subsubsection occt_draw_4_2_17 vantialiasing
1466 Sets antialiasing if the command is called with 1 or unsets otherwise.
1468 @subsubsection occt_draw_4_2_18 vpurgedisplay
1472 vpurgedisplay [CollectorToo = 0|1]
1474 Removes structures which do not belong to objects displayed in neutral point.
1476 @subsubsection occt_draw_4_2_19 vhlr
1480 vhlr is_enabled={on|off} [show_hidden={1|0}]
1482 Hidden line removal algorithm:
1483 * is_enabled: if is on HLR algorithm is applied.
1484 * show_hidden: if equals to 1, hidden lines are drawn as dotted ones.
1486 @subsubsection occt_draw_4_2_20 vhlrtype
1490 vhlrtype algo_type={algo|polyalgo} [shape_1 ... shape_n]
1493 Changes the type of HLR algorithm used for shapes.
1494 If the algo_type is algo, the exact HLR algorithm is used, otherwise the polygonal algorithm is used for defined shapes.
1496 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.
1498 **Note** that this command works with instances of *AIS_Shape* or derived classes only, other interactive object types are ignored.
1500 @subsubsection occt_draw_4_2_21 vcamera
1504 vcamera [-ortho] [-projtype]
1506 [-fovy [Angle]] [-distance [Distance]]
1507 [-stereo] [-leftEye] [-rightEye]
1508 [-iod [Distance]] [-iodType [absolute|relative]]
1509 [-zfocus [Value]] [-zfocusType [absolute|relative]]
1512 Manage camera parameters.
1513 Prints current value when option called without argument.
1514 Orthographic camera:
1515 * -ortho activate orthographic projection
1517 * -persp activate perspective projection (mono)
1518 * -fovy field of view in y axis, in degrees
1519 * -distance distance of eye from camera center
1520 Stereoscopic camera:
1521 * -stereo perspective projection (stereo)
1522 * -leftEye perspective projection (left eye)
1523 * -rightEye perspective projection (right eye)
1524 * -iod intraocular distance value
1525 * -iodType distance type, absolute or relative
1526 * -zfocus stereographic focus value
1527 * -zfocusType focus type, absolute or relative"
1538 @subsubsection occt_draw_4_2_22 vstereo
1542 vstereo [0|1] [-mode Mode] [-reverse {0|1}] [-anaglyph Filter]
1545 Control stereo output mode.
1546 Available modes for -mode:
1547 * quadBuffer - OpenGL QuadBuffer stereo, requires driver support. Should be called BEFORE vinit!
1548 * anaglyph - Anaglyph glasses
1549 * rowInterlaced - row-interlaced display
1550 * columnInterlaced - column-interlaced display
1551 * chessBoard - chess-board output
1552 * sideBySide - horizontal pair
1553 * overUnder - vertical pair
1554 Available Anaglyph filters for -anaglyph:
1555 * redCyan, redCyanSimple, yellowBlue, yellowBlueSimple, greenMagentaSimple
1564 vcamera -stereo -iod 1
1569 @subsubsection occt_draw_4_2_23 vfrustumculling
1573 vfrustumculling [toEnable]
1576 Enables/disables objects clipping.
1579 @subsection occt_draw_4_3 AIS viewer – display commands
1581 @subsubsection occt_draw_4_3_1 vdisplay
1585 vdisplay [-noupdate|-update] [-local] [-mutable] [-neutral]
1586 [-trsfPers {pan|zoom|rotate|trihedron|full|none}=none] [-trsfPersPos X Y [Z]] [-3d|-2d|-2dTopDown]
1587 [-dispMode mode] [-highMode mode]
1588 [-layer index] [-top|-topmost|-overlay|-underlay]
1590 name1 [name2] ... [name n]
1593 Displays named objects.
1594 Option -local enables displaying of objects in local selection context.
1595 Local selection context will be opened if there is not any.
1597 * *noupdate* suppresses viewer redraw call.
1598 * *mutable* enables optimizations for mutable objects.
1599 * *neutral* draws objects in main viewer.
1600 * *layer* sets z-layer for objects. It can use '-overlay|-underlay|-top|-topmost' instead of '-layer index' for the default z-layers.
1601 * *top* draws objects on top of main presentations but below topmost.
1602 * *topmost* draws in overlay for 3D presentations with independent Depth.
1603 * *overlay* draws objects in overlay for 2D presentations (On-Screen-Display).
1604 * *underlay* draws objects in underlay for 2D presentations (On-Screen-Display).
1605 * *selectable|-noselect* controls selection of objects.
1606 * *trsfPers* sets a transform persistence flags. Flag 'full' is pan, zoom and rotate.
1607 * *trsfPersPos* sets an anchor point for transform persistence.
1608 * *2d|-2dTopDown* displays object in screen coordinates.
1609 * *dispmode* sets display mode for objects.
1610 * *highmode* sets hilight mode for objects.
1611 * *redisplay* recomputes presentation of objects.
1616 box b 40 40 40 10 10 10
1622 @subsubsection occt_draw_4_3_2 vdonly
1626 vdonly [-noupdate|-update] [name1] ... [name n]
1629 Displays only selected or named objects. If there are no selected or named objects, nothing is done.
1634 box b 40 40 40 10 10 10
1640 @subsubsection occt_draw_4_3_3 vdisplayall
1644 vdisplayall [-local]
1647 Displays all erased interactive objects (see vdir and vstate).
1648 Option -local enables displaying of the objects in local selection context.
1653 box b 40 40 40 10 10 10
1659 @subsubsection occt_draw_4_3_4 verase
1663 verase [name1] [name2] … [name n]
1666 Erases some selected or named objects. If there are no selected or named objects, the whole viewer is erased.
1671 box b1 40 40 40 10 10 10
1672 box b2 -40 -40 -40 10 10 10
1676 # erase only first box
1678 # erase second box and sphere
1682 @subsubsection occt_draw_4_3_5 veraseall
1689 Erases all objects displayed in the viewer.
1694 box b1 40 40 40 10 10 10
1695 box b2 -40 -40 -40 10 10 10
1699 # erase only first box
1701 # erase second box and sphere
1705 @subsubsection occt_draw_4_3_6 vsetdispmode
1709 vsetdispmode [name] mode(0,1,2,3)
1712 Sets display mode for all, selected or named objects.
1713 * *0* (*WireFrame*),
1715 * *2* (*Quick HideLineremoval*),
1716 * *3* (*Exact HideLineremoval*).
1727 @subsubsection occt_draw_4_3_7 vdisplaytype
1734 Displays all objects of a given type.
1735 The following types are possible: *Point*, *Axis*, *Trihedron*, *PlaneTrihedron*, *Line*, *Circle*, *Plane*, *Shape*, *ConnectedShape*, *MultiConn.Shape*, *ConnectedInter.*, *MultiConn.*, *Constraint* and *Dimension*.
1737 @subsubsection occt_draw_4_3_8 verasetype
1744 Erases all objects of a given type.
1745 Possible type is *Point*, *Axis*, *Trihedron*, *PlaneTrihedron*, *Line*, *Circle*, *Plane*, *Shape*, *ConnectedShape*, *MultiConn.Shape*, *ConnectedInter.*, *MultiConn.*, *Constraint* and *Dimension*.
1747 @subsubsection occt_draw_4_3_9 vtypes
1754 Makes a list of known types and signatures in AIS.
1756 @subsubsection occt_draw_4_3_10 vaspects
1760 vaspects [-noupdate|-update] [name1 [name2 [...]] | -defaults]
1761 [-setVisibility 0|1]
1762 [-setColor ColorName] [-setcolor R G B] [-unsetColor]
1763 [-setMaterial MatName] [-unsetMaterial]
1764 [-setTransparency Transp] [-unsetTransparency]
1765 [-setWidth LineWidth] [-unsetWidth]
1766 [-setLineType {solid|dash|dot|dotDash}] [-unsetLineType]
1767 [-freeBoundary {off/on | 0/1}]
1768 [-setFreeBoundaryWidth Width] [-unsetFreeBoundaryWidth]
1769 [-setFreeBoundaryColor {ColorName | R G B}] [-unsetFreeBoundaryColor]
1770 [-subshapes subname1 [subname2 [...]]]
1771 [-isoontriangulation 0|1]
1772 [-setMaxParamValue {value}]
1776 Manage presentation properties of all, selected or named objects.
1777 When *-subshapes* is specified than following properties will be assigned to specified sub-shapes.
1778 When *-defaults* is specified than presentation properties will be assigned to all objects that have not their own specified properties and to all objects to be displayed in the future.
1779 If *-defaults* is used there should not be any objects' names and -subshapes specifier.
1783 vsetcolor [-noupdate|-update] [name] ColorName
1788 Manages presentation properties (color, material, transparency) of all objects, selected or named.
1790 **Color**. The *ColorName* can be: *BLACK*, *MATRAGRAY*, *MATRABLUE*, *ALICEBLUE*, *ANTIQUEWHITE*, *ANTIQUEWHITE1*, *ANTIQUEWHITE2*, *ANTIQUEWHITE3*, *ANTIQUEWHITE4*, *AQUAMARINE1*, *AQUAMARINE2*, *AQUAMARINE4*, *AZURE*, *AZURE2*, *AZURE3*, *AZURE4*, *BEIGE*, *BISQUE*, *BISQUE2*, *BISQUE3*, *BISQUE4*, *BLANCHEDALMOND*, *BLUE1*, *BLUE2*, *BLUE3*, *BLUE4*, *BLUEVIOLET*, *BROWN*, *BROWN1*, *BROWN2*, *BROWN3*, *BROWN4*, *BURLYWOOD*, *BURLYWOOD1*, *BURLYWOOD2*, *BURLYWOOD3*, *BURLYWOOD4*, *CADETBLUE*, *CADETBLUE1*, *CADETBLUE2*, *CADETBLUE3*, *CADETBLUE4*, *CHARTREUSE*, *CHARTREUSE1*, *CHARTREUSE2*, *CHARTREUSE3*, *CHARTREUSE4*, *CHOCOLATE*, *CHOCOLATE1*, *CHOCOLATE2*, *CHOCOLATE3*, *CHOCOLATE4*, *CORAL*, *CORAL1*, *CORAL2*, *CORAL3*, *CORAL4*, *CORNFLOWERBLUE*, *CORNSILK1*, *CORNSILK2*, *CORNSILK3*, *CORNSILK4*, *CYAN1*, *CYAN2*, *CYAN3*, *CYAN4*, *DARKGOLDENROD*, *DARKGOLDENROD1*, *DARKGOLDENROD2*, *DARKGOLDENROD3*, *DARKGOLDENROD4*, *DARKGREEN*, *DARKKHAKI*, *DARKOLIVEGREEN*, *DARKOLIVEGREEN1*, *DARKOLIVEGREEN2*, *DARKOLIVEGREEN3*, *DARKOLIVEGREEN4*, *DARKORANGE*, *DARKORANGE1*, *DARKORANGE2*, *DARKORANGE3*, *DARKORANGE4*, *DARKORCHID*, *DARKORCHID1*, *DARKORCHID2*, *DARKORCHID3*, *DARKORCHID4*, *DARKSALMON*, *DARKSEAGREEN*, *DARKSEAGREEN1*, *DARKSEAGREEN2*, *DARKSEAGREEN3*, *DARKSEAGREEN4*, *DARKSLATEBLUE*, *DARKSLATEGRAY1*, *DARKSLATEGRAY2*, *DARKSLATEGRAY3*, *DARKSLATEGRAY4*, *DARKSLATEGRAY*, *DARKTURQUOISE*, *DARKVIOLET*, *DEEPPINK*, *DEEPPINK2*, *DEEPPINK3*, *DEEPPINK4*, *DEEPSKYBLUE1*, *DEEPSKYBLUE2*, *DEEPSKYBLUE3*, *DEEPSKYBLUE4*, *DODGERBLUE1*, *DODGERBLUE2*, *DODGERBLUE3*, *DODGERBLUE4*, *FIREBRICK*, *FIREBRICK1*, *FIREBRICK2*, *FIREBRICK3*, *FIREBRICK4*, *FLORALWHITE*, *FORESTGREEN*, *GAINSBORO*, *GHOSTWHITE*, *GOLD*, *GOLD1*, *GOLD2*, *GOLD3*, *GOLD4*, *GOLDENROD*, *GOLDENROD1*, *GOLDENROD2*, *GOLDENROD3*, *GOLDENROD4*, *GRAY*, *GRAY0*, *GRAY1*, *GRAY10*, *GRAY11*, *GRAY12*, *GRAY13*, *GRAY14*, *GRAY15*, *GRAY16*, *GRAY17*, *GRAY18*, *GRAY19*, *GRAY2*, *GRAY20*, *GRAY21*, *GRAY22*, *GRAY23*, *GRAY24*, *GRAY25*, *GRAY26*, *GRAY27*, *GRAY28*, *GRAY29*, *GRAY3*, *GRAY30*, *GRAY31*, *GRAY32*, *GRAY33*, *GRAY34*, *GRAY35*, *GRAY36*, *GRAY37*, *GRAY38*, *GRAY39*, *GRAY4*, *GRAY40*, *GRAY41*, *GRAY42*, *GRAY43*, *GRAY44*, *GRAY45*, *GRAY46*, *GRAY47*, *GRAY48*, *GRAY49*, *GRAY5*, *GRAY50*, *GRAY51*, *GRAY52*, *GRAY53*, *GRAY54*, *GRAY55*, *GRAY56*, *GRAY57*, *GRAY58*, *GRAY59*, *GRAY6*, *GRAY60*, *GRAY61*, *GRAY62*, *GRAY63*, *GRAY64*, *GRAY65*, *GRAY66*, *GRAY67*, *GRAY68*, *GRAY69*, *GRAY7*, *GRAY70*, *GRAY71*, *GRAY72*, *GRAY73*, *GRAY74*, *GRAY75*, *GRAY76*, *GRAY77*, *GRAY78*, *GRAY79*, *GRAY8*, *GRAY80*, *GRAY81*, *GRAY82*, *GRAY83*, *GRAY85*, *GRAY86*, *GRAY87*, *GRAY88*, *GRAY89*, *GRAY9*, *GRAY90*, *GRAY91*, *GRAY92*, *GRAY93*, *GRAY94*, *GRAY95*, *GREEN*, *GREEN1*, *GREEN2*, *GREEN3*, *GREEN4*, *GREENYELLOW*, *GRAY97*, *GRAY98*, *GRAY99*, *HONEYDEW*, *HONEYDEW2*, *HONEYDEW3*, *HONEYDEW4*, *HOTPINK*, *HOTPINK1*, *HOTPINK2*, *HOTPINK3*, *HOTPINK4*, *INDIANRED*, *INDIANRED1*, *INDIANRED2*, *INDIANRED3*, *INDIANRED4*, *IVORY*, *IVORY2*, *IVORY3*, *IVORY4*, *KHAKI*, *KHAKI1*, *KHAKI2*, *KHAKI3*, *KHAKI4*, *LAVENDER*, *LAVENDERBLUSH1*, *LAVENDERBLUSH2*, *LAVENDERBLUSH3*, *LAVENDERBLUSH4*, *LAWNGREEN*, *LEMONCHIFFON1*, *LEMONCHIFFON2*, *LEMONCHIFFON3*, *LEMONCHIFFON4*, *LIGHTBLUE*, *LIGHTBLUE1*, *LIGHTBLUE2*, *LIGHTBLUE3*, *LIGHTBLUE4*, *LIGHTCORAL*, *LIGHTCYAN1*, *LIGHTCYAN2*, *LIGHTCYAN3*, *LIGHTCYAN4*, *LIGHTGOLDENROD*, *LIGHTGOLDENROD1*, *LIGHTGOLDENROD2*, *LIGHTGOLDENROD3*, *LIGHTGOLDENROD4*, *LIGHTGOLDENRODYELLOW*, *LIGHTGRAY*, *LIGHTPINK*, *LIGHTPINK1*, *LIGHTPINK2*, *LIGHTPINK3*, *LIGHTPINK4*, *LIGHTSALMON1*, *LIGHTSALMON2*, *LIGHTSALMON3*, *LIGHTSALMON4*, *LIGHTSEAGREEN*, *LIGHTSKYBLUE*, *LIGHTSKYBLUE1*, *LIGHTSKYBLUE2*, *LIGHTSKYBLUE3*, *LIGHTSKYBLUE4*, *LIGHTSLATEBLUE*, *LIGHTSLATEGRAY*, *LIGHTSTEELBLUE*, *LIGHTSTEELBLUE1*, *LIGHTSTEELBLUE2*, *LIGHTSTEELBLUE3*, *LIGHTSTEELBLUE4*, *LIGHTYELLOW*, *LIGHTYELLOW2*, *LIGHTYELLOW3*, *LIGHTYELLOW4*, *LIMEGREEN*, *LINEN*, *MAGENTA1*, *MAGENTA2*, *MAGENTA3*, *MAGENTA4*, *MAROON*, *MAROON1*, *MAROON2*, *MAROON3*, *MAROON4*, *MEDIUMAQUAMARINE*, *MEDIUMORCHID*, *MEDIUMORCHID1*, *MEDIUMORCHID2*, *MEDIUMORCHID3*, *MEDIUMORCHID4*, *MEDIUMPURPLE*, *MEDIUMPURPLE1*, *MEDIUMPURPLE2*, *MEDIUMPURPLE3*, *MEDIUMPURPLE4*, *MEDIUMSEAGREEN*, *MEDIUMSLATEBLUE*, *MEDIUMSPRINGGREEN*, *MEDIUMTURQUOISE*, *MEDIUMVIOLETRED*, *MIDNIGHTBLUE*, *MINTCREAM*, *MISTYROSE*, *MISTYROSE2*, *MISTYROSE3*, *MISTYROSE4*, *MOCCASIN*, *NAVAJOWHITE1*, *NAVAJOWHITE2*, *NAVAJOWHITE3*, *NAVAJOWHITE4*, *NAVYBLUE*, *OLDLACE*, *OLIVEDRAB*, *OLIVEDRAB1*, *OLIVEDRAB2*, *OLIVEDRAB3*, *OLIVEDRAB4*, *ORANGE*, *ORANGE1*, *ORANGE2*, *ORANGE3*, *ORANGE4*, *ORANGERED*, *ORANGERED1*, *ORANGERED2*, *ORANGERED3*, *ORANGERED4*, *ORCHID*, *ORCHID1*, *ORCHID2*, *ORCHID3*, *ORCHID4*, *PALEGOLDENROD*, *PALEGREEN*, *PALEGREEN1*, *PALEGREEN2*, *PALEGREEN3*, *PALEGREEN4*, *PALETURQUOISE*, *PALETURQUOISE1*, *PALETURQUOISE2*, *PALETURQUOISE3*, *PALETURQUOISE4*, *PALEVIOLETRED*, *PALEVIOLETRED1*, *PALEVIOLETRED2*, *PALEVIOLETRED3*, *PALEVIOLETRED4*, *PAPAYAWHIP*, *PEACHPUFF*, *PEACHPUFF2*, *PEACHPUFF3*, *PEACHPUFF4*, *PERU*, *PINK*, *PINK1*, *PINK2*, *PINK3*, *PINK4*, *PLUM*, *PLUM1*, *PLUM2*, *PLUM3*, *PLUM4*, *POWDERBLUE*, *PURPLE*, *PURPLE1*, *PURPLE2*, *PURPLE3*, *PURPLE4*, *RED*, *RED1*, *RED2*, *RED3*, *RED4*, *ROSYBROWN*, *ROSYBROWN1*, *ROSYBROWN2*, *ROSYBROWN3*, *ROSYBROWN4*, *ROYALBLUE*, *ROYALBLUE1*, *ROYALBLUE2*, *ROYALBLUE3*, *ROYALBLUE4*, *SADDLEBROWN*, *SALMON*, *SALMON1*, *SALMON2*, *SALMON3*, *SALMON4*, *SANDYBROWN*, *SEAGREEN*, *SEAGREEN1*, *SEAGREEN2*, *SEAGREEN3*, *SEAGREEN4*, *SEASHELL*, *SEASHELL2*, *SEASHELL3*, *SEASHELL4*, *BEET*, *TEAL*, *SIENNA*, *SIENNA1*, *SIENNA2*, *SIENNA3*, *SIENNA4*, *SKYBLUE*, *SKYBLUE1*, *SKYBLUE2*, *SKYBLUE3*, *SKYBLUE4*, *SLATEBLUE*, *SLATEBLUE1*, *SLATEBLUE2*, *SLATEBLUE3*, *SLATEBLUE4*, *SLATEGRAY1*, *SLATEGRAY2*, *SLATEGRAY3*, *SLATEGRAY4*, *SLATEGRAY*, *SNOW*, *SNOW2*, *SNOW3*, *SNOW4*, *SPRINGGREEN*, *SPRINGGREEN2*, *SPRINGGREEN3*, *SPRINGGREEN4*, *STEELBLUE*, *STEELBLUE1*, *STEELBLUE2*, *STEELBLUE3*, *STEELBLUE4*, *TAN*, *TAN1*, *TAN2*, *TAN3*, *TAN4*, *THISTLE*, *THISTLE1*, *THISTLE2*, *THISTLE3*, *THISTLE4*, *TOMATO*, *TOMATO1*, *TOMATO2*, *TOMATO3*, *TOMATO4*, *TURQUOISE*, *TURQUOISE1*, *TURQUOISE2*, *TURQUOISE3*, *TURQUOISE4*, *VIOLET*, *VIOLETRED*, *VIOLETRED1*, *VIOLETRED2*, *VIOLETRED3*, *VIOLETRED4*, *WHEAT*, *WHEAT1*, *WHEAT2*, *WHEAT3*, *WHEAT4*, *WHITE*, *WHITESMOKE*, *YELLOW*, *YELLOW1*, *YELLOW2*, *YELLOW3*, *YELLOW4* and *YELLOWGREEN*.
1792 vaspects [name] [-setcolor ColorName] [-setcolor R G B] [-unsetcolor]
1793 vsetcolor [name] ColorName
1797 **Transparency. The *Transp* may be between 0.0 (opaque) and 1.0 (fully transparent).
1798 **Warning**: at 1.0 the shape becomes invisible.
1800 vaspects [name] [-settransparency Transp] [-unsettransparency]
1801 vsettransparency [name] Transp
1802 vunsettransparency [name]
1805 **Material**. The *MatName* can be *BRASS*, *BRONZE*, *COPPER*, *GOLD*, *PEWTER*, *PLASTER*, *PLASTIC*, *SILVER*, *STEEL*, *STONE*, *SHINY_PLASTIC*, *SATIN*, *METALIZED*, *NEON_GNC*, *CHROME*, *ALUMINIUM*, *OBSIDIAN*, *NEON_PHC*, *JADE*, *WATER*, *GLASS*, *DIAMOND* or *CHARCOAL*.
1807 vaspects [name] [-setmaterial MatName] [-unsetmaterial]
1808 vsetmaterial [name] MatName
1809 vunsetmaterial [name]
1812 **Line width**. Specifies width of the edges. The *LineWidth* may be between 0.0 and 10.0.
1814 vaspects [name] [-setwidth LineWidth] [-unsetwidth]
1815 vsetwidth [name] LineWidth
1827 vaspects -setcolor red -settransparency 0.2
1836 @subsubsection occt_draw_4_3_11 vsetshading
1840 vsetshading shapename [coefficient]
1843 Sets deflection coefficient that defines the quality of the shape’s representation in the shading mode. Default coefficient is 0.0008.
1855 @subsubsection occt_draw_4_3_12 vunsetshading
1859 vunsetshading [shapename]
1862 Sets default deflection coefficient (0.0008) that defines the quality of the shape’s representation in the shading mode.
1864 @subsubsection occt_draw_4_3_13 vsetam
1868 vsetam [shapename] mode
1871 Activates selection mode for all selected or named shapes:
1872 * *0* for *shape* itself,
1879 * *7* (*compounds*).
1890 @subsubsection occt_draw_4_3_14 vunsetam
1897 Deactivates all selection modes for all shapes.
1899 @subsubsection occt_draw_4_3_15 vdump
1903 vdump <filename>.{png|bmp|jpg|gif} [-width Width -height Height]
1904 [-buffer rgb|rgba|depth=rgb]
1905 [-stereo mono|left|right|blend|sideBySide|overUnder=mono]
1909 Extracts the contents of the viewer window to a image file.
1911 @subsubsection occt_draw_4_3_16 vdir
1918 Displays the list of displayed objects.
1920 @subsubsection occt_draw_4_3_17 vsub
1924 vsub 0/1(on/off)[shapename]
1927 Hilights/unhilights named or selected objects which are displayed at neutral state with subintensity color.
1940 @subsubsection occt_draw_4_3_20 vsensdis
1947 Displays active entities (sensitive entities of one of the standard types corresponding to active selection modes).
1949 Standard entity types are those defined in Select3D package:
1956 * sensitive triangulation
1957 * sensitive triangle
1958 Custom (application-defined) sensitive entity types are not processed by this command.
1960 @subsubsection occt_draw_4_3_21 vsensera
1967 Erases active entities.
1969 @subsubsection occt_draw_4_3_22 vperf
1973 vperf shapename 1/0 (Transformation/Loacation) 1/0 (Primitives sensibles ON/OFF)
1976 Tests the animation of an object along a predefined trajectory.
1989 @subsubsection occt_draw_4_3_23 vr
1996 Reads shape from BREP-format file and displays it in the viewer.
2004 @subsubsection occt_draw_4_3_24 vstate
2008 vstate [-entities] [-hasSelected] [name1] ... [nameN]
2011 Reports show/hidden state for selected or named objects
2012 * *entities* - print low-level information about detected entities
2013 * *hasSelected* - prints 1 if context has selected shape and 0 otherwise
2015 @subsubsection occt_draw_4_3_25 vraytrace
2022 Turns on/off ray tracing renderer.
2024 @subsubsection occt_draw_4_3_26 vrenderparams
2028 vrenderparams [-rayTrace|-raster] [-rayDepth 0..10] [-shadows {on|off}]
2029 [-reflections {on|off}] [-fsaa {on|off}] [-gleam {on|off}]
2030 [-gi {on|off}] [-brng {on|off}] [-env {on|off}]
2031 [-shadin {color|flat|gouraud|phong}]
2034 Manages rendering parameters:
2035 * rayTrace - Enables GPU ray-tracing
2036 * raster - Disables GPU ray-tracing
2037 * rayDepth - Defines maximum ray-tracing depth
2038 * shadows - Enables/disables shadows rendering
2039 * reflections - Enables/disables specular reflections
2040 * fsaa - Enables/disables adaptive anti-aliasing
2041 * gleam - Enables/disables transparency shadow effects
2042 * gi - Enables/disables global illumination effects
2043 * brng - Enables/disables blocked RNG (fast coherent PT)
2044 * env - Enables/disables environment map background
2045 * shadingModel - Controls shading model from enumeration color, flat, gouraud, phong
2047 Unlike vcaps, these parameters dramatically change visual properties.
2048 Command is intended to control presentation quality depending on hardware capabilities and performance.
2057 vrenderparams -shadows 1 -reflections 1 -fsaa 1
2059 @subsubsection occt_draw_4_3_27 vshaderprog
2063 'vshaderprog [name] pathToVertexShader pathToFragmentShader'
2064 or 'vshaderprog [name] off' to disable GLSL program
2065 or 'vshaderprog [name] phong' to enable per-pixel lighting calculations
2068 Enables rendering using a shader program.
2070 @subsubsection occt_draw_4_3_28 vsetcolorbg
2077 Sets background color.
2082 vsetcolorbg 200 0 200
2085 @subsection occt_draw_4_4 AIS viewer – object commands
2087 @subsubsection occt_draw_4_4_1 vtrihedron
2091 vtrihedron name [X0] [Y0] [Z0] [Zu] [Zv] [Zw] [Xu] [Xv] [Xw]
2094 Creates a new *AIS_Trihedron* object. If no argument is set, the default trihedron (0XYZ) is created.
2102 @subsubsection occt_draw_4_4_2 vplanetri
2109 Create a plane from a trihedron selection. If no arguments are set, the default
2112 @subsubsection occt_draw_4_4_3 vsize
2119 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.
2125 vtrihedron tr2 0 0 0 1 0 0 1 0 0
2129 @subsubsection occt_draw_4_4_4 vaxis
2133 vaxis name [Xa Ya Za Xb Yb Zb]
2136 Creates an axis. If the values are not defined, an axis is created by interactive selection of two vertices or one edge
2142 vaxis axe1 0 0 0 1 0 0
2145 @subsubsection occt_draw_4_4_5 vaxispara
2152 Creates an axis by interactive selection of an edge and a vertex.
2154 @subsubsection occt_draw_4_4_6 vaxisortho
2161 Creates an axis by interactive selection of an edge and a vertex. The axis will be orthogonal to the selected edge.
2163 @subsubsection occt_draw_4_4_7 vpoint
2167 vpoint name [Xa Ya Za]
2170 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).
2178 @subsubsection occt_draw_4_4_8 vplane
2182 vplane name [AxisName] [PointName]
2183 vplane name [PointName] [PointName] [PointName]
2184 vplane name [PlaneName] [PointName]
2187 Creates a plane from named or interactively selected entities.
2196 vaxis axe1 0 0 0 0 0 1
2198 vplane plane1 axe1 p1
2201 @subsubsection occt_draw_4_4_9 vplanepara
2208 Creates a plane from interactively selected vertex and face.
2210 @subsubsection occt_draw_4_4_10 vplaneortho
2217 Creates a plane from interactive selected face and coplanar edge.
2219 @subsubsection occt_draw_4_4_11 vline
2223 vline name [PointName] [PointName]
2224 vline name [Xa Ya Za Xb Yb Zb]
2227 Creates a line from coordinates, named or interactively selected vertices.
2236 vline line2 0 0 0 50 0 1
2239 @subsubsection occt_draw_4_4_12 vcircle
2243 vcircle name [PointName PointName PointName IsFilled]
2244 vcircle name [PlaneName PointName Radius IsFilled]
2247 Creates a circle from named or interactively selected entities. Parameter IsFilled is defined as 0 or 1.
2256 vcircle circle1 p1 p2 p3 1
2259 @subsubsection occt_draw_4_4_13 vtri2d
2266 Creates a plane with a 2D trihedron from an interactively selected face.
2268 @subsubsection occt_draw_4_4_14 vselmode
2272 vselmode [object] mode_number is_turned_on=(1|0)
2275 Sets the selection mode for an object. If the object value is not defined, the selection mode is set for all displayed objects.
2276 *Mode_number* is non-negative integer that has different meaning for different interactive object classes.
2277 For shapes the following *mode_number* values are allowed:
2288 * 1 if mode is to be switched on
2289 * 0 if mode is to be switched off
2297 vtriangle triangle1 p1 p2 p3
2300 @subsubsection occt_draw_4_4_15 vconnect
2304 vconnect vconnect name Xo Yo Zo object1 object2 ... [color=NAME]
2307 Creates and displays AIS_ConnectedInteractive object from input object and location
2314 vsegment segment p1 p2
2315 restore CrankArm.brep obj
2317 vconnect new obj 100100100 1 0 0 0 0 1
2320 @subsubsection occt_draw_4_4_16 vtriangle
2324 vtriangle name PointName PointName PointName
2327 Creates and displays a filled triangle from named points.
2335 vtriangle triangle1 p1 p2 p3
2338 @subsubsection occt_draw_4_4_17 vsegment
2342 vsegment name PointName PointName
2345 Creates and displays a segment from named points.
2352 vsegment segment p1 p2
2355 @subsubsection occt_draw_4_4_18 vpointcloud
2359 vpointcloud name shape [-randColor] [-normals] [-noNormals]
2362 Creates an interactive object for an arbitary set of points from the triangulated shape.
2364 * *randColor* - generate random color per point
2365 * *normals* - generate normal per point (default)
2366 * *noNormals* - do not generate normal per point
2369 vpointcloud name x y z r npts {surface|volume} [-randColor] [-normals] [-noNormals]
2371 Creates an arbitrary set of points (npts) randomly distributed on a spheric surface or within a spheric volume (x y z r).
2373 * *randColor* - generate random color per point
2374 * *normals* - generate normal per point (default)
2375 * *noNormals* - do not generate normal per point
2380 vpointcloud pc 0 0 0 100 100000 surface -randColor
2384 @subsubsection occt_draw_4_4_19 vclipplane
2388 vclipplane maxplanes <view_name> - gets plane limit for the view.
2389 vclipplane create <plane_name> - creates a new plane.
2390 vclipplane delete <plane_name> - delete a plane.
2391 vclipplane clone <source_plane> <plane_name> - clones the plane definition.
2392 vclipplane set/unset <plane_name> object <object list> - sets/unsets the plane for an IO.
2393 vclipplane set/unset <plane_name> view <view list> - sets/unsets plane for a view.
2394 vclipplane change <plane_name> on/off - turns clipping on/off.
2395 vclipplane change <plane_name> equation <a> <b> <c> <d> - changes plane equation.
2396 vclipplane change <plane_name> capping on/off - turns capping on/off.
2397 vclipplane change <plane_name> capping color <r> <g> <b> - sets color.
2398 vclipplane change <plane name> capping texname <texture> - sets texture.
2399 vclipplane change <plane_name> capping texscale <sx> <sy> - sets texture scale.
2400 vclipplane change <plane_name> capping texorigin <tx> <ty> - sets texture origin.
2401 vclipplane change <plane_name> capping texrotate <angle> - sets texture rotation.
2402 vclipplane change <plane_name> capping hatch on/off/<id> - sets hatching mask.
2405 Manages clipping planes
2410 vclipplane create pln1
2411 vclipplane change pln1 equation 1 0 0 -0.1
2412 vclipplane set pln1 view Driver1/Viewer1/View1
2421 @subsubsection occt_draw_4_4_20 vdimension
2425 vdimension name {-angle|-length|-radius|-diameter} -shapes shape1 [shape2 [shape3]]
2426 [-text 3d|2d wf|sh|wireframe|shading IntegerSize]
2427 [-label left|right|hcenter|hfit top|bottom|vcenter|vfit]
2428 [-arrow external|internal|fit] [{-arrowlength|-arlen} RealArrowLength]
2429 [{-arrowangle|-arangle} ArrowAngle(degrees)] [-plane xoy|yoz|zox]
2430 [-flyout FloatValue -extension FloatValue] [-value CustomNumberValue]
2431 [-dispunits DisplayUnitsString] [-modelunits ModelUnitsString]
2432 [-showunits | -hideunits]
2435 Builds angle, length, radius or diameter dimension interactive object **name**.
2437 **Attension:** length dimension can't be built without working plane.
2443 vdimension dim1 -length -plane xoy -shapes p1 p2
2446 vdimension dim2 -angle -shapes p1 p2 p3
2448 vcircle circle p1 p2 p3 0
2449 vdimension dim3 -radius -shapes circle
2453 @subsubsection occt_draw_4_4_21 vdimparam
2457 vdimparam name [-text 3d|2d wf|sh|wireframe|shading IntegerSize]
2458 [-label left|right|hcenter|hfit top|bottom|vcenter|vfit]
2459 [-arrow external|internal|fit]
2460 [{-arrowlength|-arlen} RealArrowLength]
2461 [{-arrowangle|-arangle} ArrowAngle(degrees)]
2462 [-plane xoy|yoz|zox]
2463 [-flyout FloatValue -extension FloatValue]
2464 [-value CustomNumberValue]
2465 [-dispunits DisplayUnitsString]
2466 [-modelunits ModelUnitsString]
2467 [-showunits | -hideunits]
2470 Sets parameters for angle, length, radius and diameter dimension **name**.
2476 vdimension dim1 -length -plane xoy -shapes p1 p2
2477 vdimparam dim1 -flyout -15 -arrowlength 4 -showunits -value 10
2480 @subsubsection occt_draw_4_4_22 vmovedim
2484 vmovedim [name] [x y z]
2487 Moves picked or named (if **name** parameter is defined) dimension
2488 to picked mouse position or input point with coordinates **x**,**y**,**z**.
2489 Text label of dimension **name** is moved to position, another parts of dimension
2496 vdimension dim1 -length -plane xoy -shapes p1 p2
2497 vmovedim dim1 -10 30 0
2501 @subsection occt_draw_4_5 AIS viewer – Mesh Visualization Service
2503 **MeshVS** (Mesh Visualization Service) component provides flexible means of displaying meshes with associated pre- and post- processor data.
2505 @subsubsection occt_draw_4_5_1 meshfromstl
2509 meshfromstl meshname file
2512 Creates a *MeshVS_Mesh* object based on STL file data. The object will be displayed immediately.
2516 meshfromstl mesh myfile.stl
2519 @subsubsection occt_draw_4_5_2 meshdispmode
2523 meshdispmode meshname displaymode
2526 Changes the display mode of object **meshname**. The **displaymode** is integer, which can be:
2527 * *1* for *wireframe*,
2528 * *2* for *shading* mode, or
2529 * *3* for *shrink* mode.
2534 meshfromstl mesh myfile.stl
2538 @subsubsection occt_draw_4_5_3 meshselmode
2542 meshselmode meshname selectionmode
2545 Changes the selection mode of object **meshname**. The *selectionmode* is integer OR-combination of mode flags. The basic flags are the following:
2546 * *1* – node selection;
2547 * *2* – 0D elements (not supported in STL);
2548 * *4* – links (not supported in STL);
2554 meshfromstl mesh myfile.stl
2558 @subsubsection occt_draw_4_5_4 meshshadcolor
2562 meshshadcolor meshname red green blue
2565 Changes the face interior color of object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*.
2570 meshfromstl mesh myfile.stl
2571 meshshadcolormode mesh 0.5 0.5 0.5
2574 @subsubsection occt_draw_4_5_5 meshlinkcolor
2578 meshlinkcolor meshname red green blue
2581 Changes the color of face borders for object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*.
2586 meshfromstl mesh myfile.stl
2587 meshlinkcolormode mesh 0.5 0.5 0.5
2590 @subsubsection occt_draw_4_5_6 meshmat
2594 meshmat meshname material
2597 Changes the material of object **meshname**.
2599 *material* is represented with an integer value as follows (equivalent to enumeration *Graphic3d_NameOfMaterial*):
2610 * *10 - SHINY_PLASTIC,*
2620 * *20 - UserDefined*
2625 meshfromstl mesh myfile.stl
2629 @subsubsection occt_draw_4_5_7 meshshrcoef
2633 meshshrcoef meshname shrinkcoefficient
2636 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.
2641 meshfromstl mesh myfile.stl
2642 meshshrcoef mesh 0.05
2645 @subsubsection occt_draw_4_5_8 meshshow
2652 Displays **meshname** in the viewer (if it is erased).
2657 meshfromstl mesh myfile.stl
2661 @subsubsection occt_draw_4_5_9 meshhide
2668 Hides **meshname** in the viewer.
2673 meshfromstl mesh myfile.stl
2677 @subsubsection occt_draw_4_5_10 meshhidesel
2681 meshhidesel meshname
2684 Hides only selected entities. The other part of **meshname** remains visible.
2686 @subsubsection occt_draw_4_5_11 meshshowsel
2690 meshshowsel meshname
2693 Shows only selected entities. The other part of **meshname** becomes invisible.
2695 @subsubsection occt_draw_4_5_12 meshshowall
2699 meshshowall meshname
2702 Changes the state of all entities to visible for **meshname**.
2704 @subsubsection occt_draw_4_5_13 meshdelete
2711 Deletes MeshVS_Mesh object **meshname**.
2716 meshfromstl mesh myfile.stl
2720 @subsection occt_draw_4_6 VIS Viewer commands
2722 A specific plugin with alias *VIS* should be loaded to have access to VIS functionality in DRAW Test Harness:
2728 @subsubsection occt_draw_4_6_1 ivtkinit
2735 Creates a window for VTK viewer.
2737 @figure{/user_guides/draw_test_harness/images/draw_image001.png}
2739 @subsection occt_draw_4_6_2 ivtkdisplay
2743 ivtkdisplay name1 [name2] …[name n]
2746 Displays named objects.
2756 @figure{/user_guides/draw_test_harness/images/draw_image002.png}
2758 @subsection occt_draw_4_6_3 ivtkerase
2762 ivtkerase [name1] [name2] … [name n]
2765 Erases named objects. If no arguments are passed, erases all displayed objects.
2778 # erase only the cylinder
2780 # erase the sphere and the cone
2784 @subsection occt_draw_4_6_4 ivtkfit
2791 Automatic zoom/panning.
2793 @subsection occt_draw_4_6_5 ivtkdispmode
2797 ivtksetdispmode [name] {0|1}
2800 Sets display mode for a named object. If no arguments are passed, sets the given display mode for all displayed objects
2801 The possible modes are: 0 (WireFrame) and 1 (Shading).
2810 # set shading mode for the cone
2814 @figure{/user_guides/draw_test_harness/images/draw_image003.png}
2816 @subsection occt_draw_4_6_6 ivtksetselmode
2820 ivtksetselmode [name] mode {0|1}
2823 Sets selection mode for a named object. If no arguments are passed, sets the given selection mode for all the displayed objects.
2828 # load a shape from file
2829 restore CrankArm.brep a
2830 # display the loaded shape
2832 # set the face selection mode
2833 ivtksetselmode a 4 1
2836 @figure{/user_guides/draw_test_harness/images/draw_image004.png}
2838 @subsection occt_draw_4_6_7 ivtkmoveto
2845 Imitates mouse cursor moving to point with the given display coordinates **x**,**y**.
2855 @subsection occt_draw_4_6_8 ivtkselect
2862 Imitates mouse cursor moving to point with the given display coordinates and performs selection at this point.
2872 @subsection occt_draw_4_6_9 ivtkdump
2876 ivtkdump *filename* [buffer={rgb|rgba|depth}] [width height] [stereoproj={L|R}]
2879 Dumps the contents of VTK viewer to image. It supports:
2880 * dumping in different raster graphics formats: PNG, BMP, JPEG, TIFF or PNM.
2881 * dumping of different buffers: RGB, RGBA or depth buffer.
2882 * defining of image sizes (width and height in pixels).
2883 * dumping of stereo projections (left or right).
2890 ivtkdump D:/ConeSnapshot.png rgb 768 768
2893 @subsection occt_draw_4_6_10 ivtkbgcolor
2898 ivtkbgcolor r g b [r2 g2 b2]
2901 Sets uniform background color or gradient background if second triple of parameters is set. Color parameters r,g,b have to be chosen in the interval [0..255].
2906 ivtkbgcolor 200 220 250
2909 @figure{/user_guides/draw_test_harness/images/draw_image005.png}
2912 ivtkbgcolor 10 30 80 255 255 255
2915 @figure{/user_guides/draw_test_harness/images/draw_image006.png}
2918 @section occt_draw_5 OCAF commands
2921 This chapter contains a set of commands for Open CASCADE Technology Application Framework (OCAF).
2924 @subsection occt_draw_5_1 Application commands
2927 @subsubsection occt_draw_5_1_1 NewDocument
2931 NewDocument docname [format]
2934 Creates a new **docname** document with MDTV-Standard or described format.
2938 # Create new document with default (MDTV-Standard) format
2941 # Create new document with BinOcaf format
2942 NewDocument D2 BinOcaf
2945 @subsubsection occt_draw_5_1_2 IsInSession
2952 Returns *0*, if **path** document is managed by the application session, *1* – otherwise.
2956 IsInSession /myPath/myFile.std
2959 @subsubsection occt_draw_5_1_3 ListDocuments
2966 Makes a list of documents handled during the session of the application.
2969 @subsubsection occt_draw_5_1_4 Open
2976 Retrieves the document of file **docname** in the path **path**. Overwrites the document, if it is already in session.
2980 Open /myPath/myFile.std D
2983 @subsubsection occt_draw_5_1_5 Close
2990 Closes **docname** document. The document is no longer handled by the applicative session.
2997 @subsubsection occt_draw_5_1_6 Save
3004 Saves **docname** active document.
3011 @subsubsection occt_draw_5_1_7 SaveAs
3018 Saves the active document in the file **docname** in the path **path**. Overwrites the file if it already exists.
3022 SaveAs D /myPath/myFile.std
3025 @subsection occt_draw_5_2 Basic commands
3027 @subsubsection occt_draw_5_2_1 Label
3035 Creates the label expressed by <i>\<entry\></i> if it does not exist.
3042 @subsubsection occt_draw_5_2_2 NewChild
3047 NewChild docname [taggerlabel = Root label]
3049 Finds (or creates) a *TagSource* attribute located at father label of <i>\<taggerlabel\></i> and makes a new child label.
3053 # Create new child of root label
3056 # Create new child of existing label
3061 @subsubsection occt_draw_5_2_3 Children
3065 Children docname label
3067 Returns the list of attributes of label.
3074 @subsubsection occt_draw_5_2_4 ForgetAll
3078 ForgetAll docname label
3080 Forgets all attributes of the label.
3088 @subsubsection occt_draw_5_3 Application commands
3090 @subsubsection occt_draw_5_3_1 Main
3097 Returns the main label of the framework.
3104 @subsubsection occt_draw_5_3_2 UndoLimit
3108 UndoLimit docname [value=0]
3112 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
3119 @subsubsection occt_draw_5_3_3 Undo
3123 Undo docname [value=1]
3126 Undoes **value** steps.
3133 @subsubsection occt_draw_5_3_4 Redo
3137 Redo docname [value=1]
3140 Redoes **value** steps.
3147 @subsubsection occt_draw_5_3_5 OpenCommand
3154 Opens a new command transaction.
3161 @subsubsection occt_draw_5_3_6 CommitCommand
3165 CommitCommand docname
3168 Commits the Command transaction.
3175 @subsubsection occt_draw_5_3_7 NewCommand
3182 This is a short-cut for Commit and Open transaction.
3189 @subsubsection occt_draw_5_3_8 AbortCommand
3193 AbortCommand docname
3196 Aborts the Command transaction.
3203 @subsubsection occt_draw_5_3_9 Copy
3207 Copy docname entry Xdocname Xentry
3210 Copies the contents of *entry* to *Xentry*. No links are registered.
3217 @subsubsection occt_draw_5_3_10 UpdateLink
3221 UpdateLink docname [entry]
3224 Updates external reference set at *entry*.
3231 @subsubsection occt_draw_5_3_11 CopyWithLink
3235 CopyWithLink docname entry Xdocname Xentry
3238 Aborts the Command transaction.
3239 Copies the content of *entry* to *Xentry*. The link is registered with an *Xlink* attribute at *Xentry* label.
3243 CopyWithLink D1 0:2 D2 0:4
3246 @subsubsection occt_draw_5_3_12 UpdateXLinks
3250 UpdateXLinks docname entry
3253 Sets modifications on labels impacted by external references to the *entry*. The *document* becomes invalid and must be recomputed
3260 @subsubsection occt_draw_5_3_13 DumpDocument
3264 DumpDocument docname
3267 Displays parameters of *docname* document.
3275 @subsection occt_draw_5_4 Data Framework commands
3278 @subsubsection occt_draw_5_4_1 MakeDF
3285 Creates a new data framework.
3292 @subsubsection occt_draw_5_4_2 ClearDF
3299 Clears a data framework.
3306 @subsubsection occt_draw_5_4_3 CopyDF
3310 CopyDF dfname1 entry1 [dfname2] entry2
3313 Copies a data framework.
3320 @subsubsection occt_draw_5_4_4 CopyLabel
3324 CopyLabel dfname fromlabel tolablel
3331 CopyLabel D1 0:2 0:4
3334 @subsubsection occt_draw_5_4_5 MiniDumpDF
3341 Makes a mini-dump of a data framework.
3348 @subsubsection occt_draw_5_4_6 XDumpDF
3355 Makes an extended dump of a data framework.
3362 @subsection occt_draw_5_5 General attributes commands
3365 @subsubsection occt_draw_5_5_1 SetInteger
3369 SetInteger dfname entry value
3372 Finds or creates an Integer attribute at *entry* label and sets *value*.
3376 SetInteger D 0:2 100
3379 @subsubsection occt_draw_5_5_2 GetInteger
3383 GetInteger dfname entry [drawname]
3386 Gets a value of an Integer attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3390 GetInteger D 0:2 Int1
3393 @subsubsection occt_draw_5_5_3 SetReal
3397 SetReal dfname entry value
3400 Finds or creates a Real attribute at *entry* label and sets *value*.
3407 @subsubsection occt_draw_5_5_4 GetReal
3411 GetReal dfname entry [drawname]
3414 Gets a value of a Real attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3421 @subsubsection occt_draw_5_5_5 SetIntArray
3425 SetIntArray dfname entry lower upper value1 value2 …
3428 Finds or creates an IntegerArray attribute at *entry* label with lower and upper bounds and sets **value1*, *value2*...
3432 SetIntArray D 0:2 1 4 100 200 300 400
3435 @subsubsection occt_draw_5_5_6 GetIntArray
3439 GetIntArray dfname entry
3442 Gets a value of an *IntegerArray* attribute at *entry* label.
3449 @subsubsection occt_draw_5_5_7 SetRealArray
3453 SetRealArray dfname entry lower upper value1 value2 …
3456 Finds or creates a RealArray attribute at *entry* label with lower and upper bounds and sets *value1*, *value2*…
3460 GetRealArray D 0:2 1 4 100. 200. 300. 400.
3463 @subsubsection occt_draw_5_5_8 GetRealArray
3467 GetRealArray dfname entry
3470 Gets a value of a RealArray attribute at *entry* label.
3477 @subsubsection occt_draw_5_5_9 SetComment
3481 SetComment dfname entry value
3484 Finds or creates a Comment attribute at *entry* label and sets *value*.
3488 SetComment D 0:2 "My comment"
3491 @subsubsection occt_draw_5_5_10 GetComment
3495 GetComment dfname entry
3498 Gets a value of a Comment attribute at *entry* label.
3505 @subsubsection occt_draw_5_5_11 SetExtStringArray
3509 SetExtStringArray dfname entry lower upper value1 value2 …
3512 Finds or creates an *ExtStringArray* attribute at *entry* label with lower and upper bounds and sets *value1*, *value2*…
3516 SetExtStringArray D 0:2 1 3 *string1* *string2* *string3*
3519 @subsubsection occt_draw_5_5_12 GetExtStringArray
3523 GetExtStringArray dfname entry
3526 Gets a value of an ExtStringArray attribute at *entry* label.
3530 GetExtStringArray D 0:2
3533 @subsubsection occt_draw_5_5_13 SetName
3537 SetName dfname entry value
3540 Finds or creates a Name attribute at *entry* label and sets *value*.
3544 SetName D 0:2 *My name*
3547 @subsubsection occt_draw_5_5_14 GetName
3551 GetName dfname entry
3554 Gets a value of a Name attribute at *entry* label.
3561 @subsubsection occt_draw_5_5_15 SetReference
3565 SetReference dfname entry reference
3568 Creates a Reference attribute at *entry* label and sets *reference*.
3572 SetReference D 0:2 0:4
3575 @subsubsection occt_draw_5_5_16 GetReference
3579 GetReference dfname entry
3582 Gets a value of a Reference attribute at *entry* label.
3589 @subsubsection occt_draw_5_5_17 SetUAttribute
3593 SetUAttribute dfname entry localGUID
3596 Creates a UAttribute attribute at *entry* label with *localGUID*.
3600 set localGUID "c73bd076-22ee-11d2-acde-080009dc4422"
3601 SetUAttribute D 0:2 ${localGUID}
3604 @subsubsection occt_draw_5_5_18 GetUAttribute
3608 GetUAttribute dfname entry loacalGUID
3611 Finds a *UAttribute* at *entry* label with *localGUID*.
3615 set localGUID "c73bd076-22ee-11d2-acde-080009dc4422"
3616 GetUAttribute D 0:2 ${localGUID}
3619 @subsubsection occt_draw_5_5_19 SetFunction
3623 SetFunction dfname entry ID failure
3626 Finds or creates a *Function* attribute at *entry* label with driver ID and *failure* index.
3630 set ID "c73bd076-22ee-11d2-acde-080009dc4422"
3631 SetFunction D 0:2 ${ID} 1
3634 @subsubsection occt_draw_5_5_20 GetFunction
3638 GetFunction dfname entry ID failure
3641 Finds a Function attribute at *entry* label and sets driver ID to *ID* variable and failure index to *failure* variable.
3645 GetFunction D 0:2 ID failure
3648 @subsubsection occt_draw_5_5_21 NewShape
3652 NewShape dfname entry [shape]
3655 Finds or creates a Shape attribute at *entry* label. Creates or updates the associated *NamedShape* attribute by *shape* if *shape* is defined.
3663 @subsubsection occt_draw_5_5_22 SetShape
3667 SetShape dfname entry shape
3670 Creates or updates a *NamedShape* attribute at *entry* label by *shape*.
3678 @subsubsection occt_draw_5_5_23 GetShape
3682 GetShape2 dfname entry shape
3685 Sets a shape from NamedShape attribute associated with *entry* label to *shape* draw variable.
3692 @subsection occt_draw_5_6 Geometric attributes commands
3695 @subsubsection occt_draw_5_6_1 SetPoint
3699 SetPoint dfname entry point
3702 Finds or creates a Point attribute at *entry* label and sets *point* as generated in the associated *NamedShape* attribute.
3710 @subsubsection occt_draw_5_6_2 GetPoint
3714 GetPoint dfname entry [drawname]
3717 Gets a vertex from *NamedShape* attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3724 @subsubsection occt_draw_5_6_3 SetAxis
3728 SetAxis dfname entry axis
3731 Finds or creates an Axis attribute at *entry* label and sets *axis* as generated in the associated *NamedShape* attribute.
3735 line l 10 20 30 100 200 300
3739 @subsubsection occt_draw_5_6_4 GetAxis
3743 GetAxis dfname entry [drawname]
3746 Gets a line from *NamedShape* attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3753 @subsubsection occt_draw_5_6_5 SetPlane
3757 SetPlane dfname entry plane
3760 Finds or creates a Plane attribute at *entry* label and sets *plane* as generated in the associated *NamedShape* attribute.
3764 plane pl 10 20 30 –1 0 0
3768 @subsubsection occt_draw_5_6_6 GetPlane
3772 GetPlane dfname entry [drawname]
3775 Gets a plane from *NamedShape* attribute at *entry* label and sets it to *drawname* variable, if it is defined.
3782 @subsubsection occt_draw_5_6_7 SetGeometry
3786 SetGeometry dfname entry [type] [shape]
3789 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*.
3794 SetGeometry D 0:2 pnt p
3797 @subsubsection occt_draw_5_6_8 GetGeometryType
3801 GetGeometryType dfname entry
3804 Gets a geometry type from Geometry attribute at *entry* label.
3808 GetGeometryType D 0:2
3811 @subsubsection occt_draw_5_6_9 SetConstraint
3815 SetConstraint dfname entry keyword geometrie [geometrie …]
3816 SetConstraint dfname entry "plane" geometrie
3817 SetConstraint dfname entry "value" value
3820 1. Creates a Constraint attribute at *entry* label and sets *keyword* constraint between geometry(ies).
3821 *keyword* must be one of the following:
3822 *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*
3823 2. Sets plane for the existing constraint.
3824 3. Sets value for the existing constraint.
3828 SetConstraint D 0:2 "value" 5
3831 @subsubsection occt_draw_5_6_10 GetConstraint
3835 GetConstraint dfname entry
3838 Dumps a Constraint attribute at *entry* label
3845 @subsubsection occt_draw_5_6_11 SetVariable
3849 SetVariable dfname entry isconstant(0/1) units
3852 Creates a Variable attribute at *entry* label and sets *isconstant* flag and *units* as a string.
3856 SetVariable D 0:2 1 "mm"
3859 @subsubsection occt_draw_5_6_12 GetVariable
3863 GetVariable dfname entry isconstant units
3866 Gets an *isconstant* flag and units of a Variable attribute at *entry* label.
3870 GetVariable D 0:2 isconstant units
3871 puts "IsConstant=${isconstant}"
3872 puts "Units=${units}"
3875 @subsection occt_draw_5_7 Tree attributes commands
3878 @subsubsection occt_draw_5_7_1 RootNode
3882 RootNode dfname treenodeentry [ID]
3885 Returns the ultimate father of *TreeNode* attribute identified by its *treenodeentry* and its *ID* (or default ID, if *ID* is not defined).
3888 @subsubsection occt_draw_5_7_2 SetNode
3892 SetNode dfname treenodeentry [ID]
3895 Creates a *TreeNode* attribute on the *treenodeentry* label with its tree *ID* (or assigns a default ID, if the *ID* is not defined).
3898 @subsubsection occt_draw_5_7_3 AppendNode
3902 AppendNode dfname fatherentry childentry [fatherID]
3906 Inserts a *TreeNode* attribute with its tree *fatherID* (or default ID, if *fatherID* is not defined) on *childentry* as last child of *fatherentry*.
3911 @subsubsection occt_draw_5_7_4 PrependNode
3915 PrependNode dfname fatherentry childentry [fatherID]
3919 Inserts a *TreeNode* attribute with its tree *fatherID* (or default ID, if *fatherID* is not defined) on *childentry* as first child of *fatherentry*.
3922 @subsubsection occt_draw_5_7_5 InsertNodeBefore
3926 InsertNodeBefore dfname treenodeentry beforetreenode [ID]
3929 Inserts a *TreeNode* attribute with tree *ID* (or default ID, if *ID* is not defined) *beforetreenode* before *treenodeentry*.
3932 @subsubsection occt_draw_5_7_6 InsertNodeAfter
3936 InsertNodeAfter dfname treenodeentry aftertreenode [ID]
3939 Inserts a *TreeNode* attribute with tree *ID* (or default ID, if *ID* is not defined) *aftertreenode* after *treenodeentry*.
3942 @subsubsection occt_draw_5_7_7 DetachNode
3946 DetachNode dfname treenodeentry [ID]
3949 Removes a *TreeNode* attribute with tree *ID* (or default ID, if *ID* is not defined) from *treenodeentry*.
3952 @subsubsection occt_draw_5_7_8 ChildNodeIterate
3956 ChildNodeIterate dfname treenodeentry alllevels(0/1) [ID]
3960 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.
3976 AppendNode D 0:2 0:4
3977 AppendNode D 0:2 0:5
3978 PrependNode D 0:4 0:3
3979 PrependNode D 0:4 0:8
3980 PrependNode D 0:4 0:9
3982 InsertNodeBefore D 0:5 0:6
3983 InsertNodeAfter D 0:4 0:7
3989 ChildNodeIterate D 0:2 1
3999 # List only first levels
4000 ChildNodeIterate D 0:2 1
4008 @subsubsection occt_draw_5_7_9 InitChildNodeIterator
4012 InitChildNodeIterator dfname treenodeentry alllevels(0/1) [ID]
4016 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.
4020 InitChildNodeIterate D 0:5 1
4022 for {set i 1} {$i 100} {incr i} {
4023 if {[ChildNodeMore] == *TRUE*} {
4024 puts *Tree node = [ChildNodeValue]*
4029 puts "aChildNumber=$aChildNumber"
4032 @subsubsection occt_draw_5_7_10 ChildNodeMore
4039 Returns TRUE if there is a current item in the iteration.
4042 @subsubsection occt_draw_5_7_11 ChildNodeNext
4049 Moves to the next Item.
4052 @subsubsection occt_draw_5_7_12 ChildNodeValue
4059 Returns the current treenode of *ChildNodeIterator*.
4062 @subsubsection occt_draw_5_7_13 ChildNodeNextBrother
4066 ChildNodeNextBrother
4069 Moves to the next *Brother*. If there is none, goes up. This method is interesting only with *allLevels* behavior.
4072 @subsection occt_draw_5_8 Standard presentation commands
4075 @subsubsection occt_draw_5_8_1 AISInitViewer
4079 AISInitViewer docname
4082 Creates and sets *AISViewer* attribute at root label, creates AIS viewer window.
4089 @subsubsection occt_draw_5_8_2 AISRepaint
4096 Updates the AIS viewer window.
4103 @subsubsection occt_draw_5_8_3 AISDisplay
4107 AISDisplay docname entry [not_update]
4110 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.
4117 @subsubsection occt_draw_5_8_4 AISUpdate
4121 AISUpdate docname entry
4124 Recomputes a presentation of *AISobject* from *entry* label and applies the visualization setting in AIS viewer.
4131 @subsubsection occt_draw_5_8_5 AISErase
4135 AISErase docname entry
4138 Erases *AISobject* of *entry* label in AIS viewer.
4145 @subsubsection occt_draw_5_8_6 AISRemove
4149 AISRemove docname entry
4152 Erases *AISobject* of *entry* label in AIS viewer, then *AISobject* is removed from *AIS_InteractiveContext*.
4159 @subsubsection occt_draw_5_8_7 AISSet
4163 AISSet docname entry ID
4166 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*).
4173 @subsubsection occt_draw_5_8_8 AISDriver
4177 AISDriver docname entry [ID]
4180 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*).
4188 @subsubsection occt_draw_5_8_9 AISUnset
4192 AISUnset docname entry
4195 Deletes *AISPresentation* attribute (if it exists) of an *entry* label.
4202 @subsubsection occt_draw_5_8_10 AISTransparency
4206 AISTransparency docname entry [transparency]
4209 Sets (if *transparency* is defined) or gets the value of transparency for *AISPresentation* attribute of an *entry* label.
4213 AISTransparency D 0:5 0.5
4216 @subsubsection occt_draw_5_8_11 AISHasOwnTransparency
4220 AISHasOwnTransparency docname entry
4223 Tests *AISPresentation* attribute of an *entry* label by own transparency.
4227 AISHasOwnTransparency D 0:5
4230 @subsubsection occt_draw_5_8_12 AISMaterial
4234 AISMaterial docname entry [material]
4237 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).
4244 @subsubsection occt_draw_5_8_13 AISHasOwnMaterial
4248 AISHasOwnMaterial docname entry
4251 Tests *AISPresentation* attribute of an *entry* label by own material.
4255 AISHasOwnMaterial D 0:5
4258 @subsubsection occt_draw_5_8_14 AISColor
4262 AISColor docname entry [color]
4265 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*).
4272 @subsubsection occt_draw_5_8_15 AISHasOwnColor
4276 AISHasOwnColor docname entry
4279 Tests *AISPresentation* attribute of an *entry* label by own color.
4283 AISHasOwnColor D 0:5
4286 @section occt_draw_6 Geometry commands
4288 @subsection occt_draw_6_1 Overview
4290 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.
4292 In the context of Geometry, Draw includes the following types of variable:
4295 * The 2d curve, which corresponds to *Curve* in *Geom2d*.
4296 * 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>.
4298 Draw geometric variables never share data; the *copy* command will always make a complete copy of the content of the variable.
4300 The following topics are covered in the nine sections of this chapter:
4302 * **Curve creation** deals with the various types of curves and how to create them.
4303 * **Surface creation** deals with the different types of surfaces and how to create them.
4304 * **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.
4305 * **Geometric transformations** covers translation, rotation, mirror image and point scaling transformations.
4306 * **Curve and Surface Analysis** deals with the commands used to compute points, derivatives and curvatures.
4307 * **Intersections** presents intersections of surfaces and curves.
4308 * **Approximations** deals with creating curves and surfaces from a set of points.
4309 * **Constraints** concerns construction of 2d circles and lines by constraints such as tangency.
4310 * **Display** describes commands to control the display of curves and surfaces.
4312 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.
4314 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.
4316 @subsection occt_draw_6_2 Curve creation
4318 This section deals with both points and curves. Types of curves are:
4320 * Analytical curves such as lines, circles, ellipses, parabolas, and hyperbolas.
4321 * Polar curves such as bezier curves and bspline curves.
4322 * 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.
4323 * NURBS can be created from other curves using *convert* in the *Surface Creation* section.
4324 * Curves can be created from the isoparametric lines of surfaces by the *uiso* and *viso* commands.
4325 * 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.
4327 Curves are displayed with an arrow showing the last parameter.
4330 @subsubsection occt_draw_6_2_1 point
4337 Creates a 2d or 3d point, depending on the number of arguments.
4348 @subsubsection occt_draw_6_2_2 line
4352 line name x y [z] dx dy [dz]
4356 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.
4358 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.
4362 # a 2d line at 45 degrees of the X axis
4365 # a 3d line through the point 10 0 0 and parallel to Z
4369 @subsubsection occt_draw_6_2_3 circle
4373 circle name x y [z [dx dy dz]] [ux uy [uz]] radius
4376 Creates a 2d or a 3d circle.
4378 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.
4380 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*.
4382 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.
4386 # A 2d circle of radius 5 centered at 10,-2
4389 # another 2d circle with a user defined origin
4390 # the point of parameter 0 on this circle will be
4391 # 1+sqrt(2),1+sqrt(2)
4394 # a 3d circle, center 10 20 -5, axis Z, radius 17
4395 circle c3 10 20 -5 17
4397 # same 3d circle with axis Y
4398 circle c4 10 20 -5 0 1 0 17
4400 # full 3d circle, axis X, origin on Z
4401 circle c5 10 20 -5 1 0 0 0 0 1 17
4404 @subsubsection occt_draw_6_2_4 ellipse
4408 ellipse name x y [z [dx dy dz]] [ux uy [uz]] firstradius secondradius
4411 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:
4414 P(u) = O + firstradius*cos(u)*Xdir + secondradius*sin(u)*Ydir
4418 * P is the point of parameter *u*,
4419 * *O, Xdir* and *Ydir* are respectively the origin, *X Direction* and *Y Direction* of its local coordinate system.
4423 # default 2d ellipse
4424 ellipse e1 10 5 20 10
4426 # 2d ellipse at angle 60 degree
4427 ellipse e2 0 0 1 2 30 5
4429 # 3d ellipse, in the XY plane
4430 ellipse e3 0 0 0 25 5
4432 # 3d ellipse in the X,Z plane with axis 1, 0 ,1
4433 ellipse e4 0 0 0 0 1 0 1 0 1 25 5
4436 @subsubsection occt_draw_6_2_5 hyperbola
4440 hyperbola name x y [z [dx dy dz]] [ux uy [uz]] firstradius secondradius
4443 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.
4445 The Draw hyperbola is parameterized as follows:
4447 P(U) = O + firstradius*Cosh(U)*XDir + secondradius*Sinh(U)*YDir
4451 * *P* is the point of parameter *U*,
4452 * *O, XDir* and *YDir* are respectively the origin, *X Direction* and *YDirection* of its local coordinate system.
4456 # default 2d hyperbola, with asymptotes 1,1 -1,1
4457 hyperbola h1 0 0 30 30
4459 # 2d hyperbola at angle 60 degrees
4460 hyperbola h2 0 0 1 2 20 20
4462 # 3d hyperbola, in the XY plane
4463 hyperbola h3 0 0 0 50 50
4466 @subsubsection occt_draw_6_2_6 parabola
4470 parabola name x y [z [dx dy dz]] [ux uy [uz]] FocalLength
4473 Creates a 2d or 3d parabola. in the axis system defined by the first arguments. The origin is the apex of the parabola.
4475 The *Geom_Parabola* is parameterized as follows:
4478 P(u) = O + u*u/(4.*F)*XDir + u*YDir
4482 * *P* is the point of parameter *u*,
4483 * *O, XDir* and *YDir* are respectively the origin, *X Direction* and *Y Direction* of its local coordinate system,
4484 * *F* is the focal length of the parabola.
4491 # 2d parabola with convexity +Y
4492 parabola p2 0 0 0 1 50
4494 # 3d parabola in the Y-Z plane, convexity +Z
4495 parabola p3 0 0 0 1 0 0 0 0 1 50
4498 @subsubsection occt_draw_6_2_7 beziercurve, 2dbeziercurve
4502 beziercurve name nbpole pole, [weight]
4503 2dbeziercurve name nbpole pole, [weight]
4506 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.
4510 # a rational 2d bezier curve (arc of circle)
4511 2dbeziercurve ci 3 0 0 1 10 0 sqrt(2.)/2. 10 10 1
4513 # a 3d bezier curve, not rational
4514 beziercurve cc 4 0 0 0 10 0 0 10 0 10 10 10 10
4517 @subsubsection occt_draw_6_2_8 bsplinecurve, 2dbsplinecurve, pbsplinecurve, 2dpbsplinecurve
4521 bsplinecurve name degree nbknots knot, umult pole, weight
4522 2dbsplinecurve name degree nbknots knot, umult pole, weight
4524 pbsplinecurve name degree nbknots knot, umult pole, weight (periodic)
4525 2dpbsplinecurve name degree nbknots knot, umult pole, weight (periodic)
4528 Creates 2d or 3d bspline curves; the **pbsplinecurve** and **2dpbsplinecurve** commands create periodic bspline curves.
4530 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.
4532 The table of knots is an increasing sequence of reals without repetition.
4533 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.
4535 The poles must be given with their weights, use weights of 1 for a non rational curve, the number of poles must be:
4537 * For a non periodic curve: Sum of multiplicities - degree + 1
4538 * For a periodic curve: Sum of multiplicities - last multiplicity
4542 # a bspline curve with 4 poles and 3 knots
4543 bsplinecurve bc 2 3 0 3 1 1 2 3 \
4544 10 0 7 1 7 0 7 1 3 0 8 1 0 0 7 1
4545 # a 2d periodic circle (parameter from 0 to 2*pi !!)
4547 2dpbsplinecurve c 2 \
4548 4 0 2 pi/1.5 2 pi/0.75 2 2*pi 2 \
4558 **Note** that you can create the **NURBS** subset of bspline curves and surfaces by trimming analytical curves and surfaces and executing the command *convert*.
4561 @subsubsection occt_draw_6_2_9 uiso, viso
4569 Creates a U or V isoparametric curve from a surface.
4573 # create a cylinder and extract iso curves
4580 **Note** that this cannot be done from offset surfaces.
4583 @subsubsection occt_draw_6_2_10 to3d, to2d
4587 to3d name curve2d [plane]
4588 to2d name curve3d [plane]
4591 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.
4595 # the following commands
4597 plane p -2 1 0 1 2 3
4600 # will create the same circle as
4601 circle c -2 1 0 1 2 3 5
4604 See also: **project**
4607 @subsubsection occt_draw_6_2_11 project
4611 project name curve3d surface
4614 Computes a 2d curve in the parametric space of a surface corresponding to a 3d curve. This can only be used on analytical surfaces.
4616 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.
4625 @subsection occt_draw_6_3 Surface creation
4627 The following types of surfaces exist:
4628 * Analytical surfaces: plane, cylinder, cone, sphere, torus;
4629 * Polar surfaces: bezier surfaces, bspline surfaces;
4630 * Trimmed and Offset surfaces;
4631 * Surfaces produced by Revolution and Extrusion, created from curves with the *revsurf* and *extsurf*;
4634 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.
4636 @subsubsection occt_draw_6_3_1 plane
4640 plane name [x y z [dx dy dz [ux uy uz]]]
4643 Creates an infinite plane.
4645 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.
4647 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*.
4649 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.
4651 Note that this definition will be used for all analytical surfaces.
4655 # a plane through the point 10,0,0 perpendicular to X
4656 # with U direction on Y
4657 plane p1 10 0 0 1 0 0 0 1 0
4659 # an horixontal plane with origin 10, -20, -5
4663 @subsubsection occt_draw_6_3_2 cylinder
4667 cylinder name [x y z [dx dy dz [ux uy uz]]] radius
4670 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.
4674 # a cylinder on the default Z axis, radius 10
4677 # a cylinder, also along the Z axis but with origin 5,
4679 cylinder c2 5 10 -3 10
4681 # a cylinder through the origin and on a diagonal
4682 # with longitude pi/3 and latitude pi/4 (euler angles)
4683 dset lo pi/3. la pi/4.
4684 cylinder c3 0 0 0 cos(la)*cos(lo) cos(la)*sin(lo)
4688 @subsubsection occt_draw_6_3_3 cone
4692 cone name [x y z [dx dy dz [ux uy uz]]] semi-angle radius
4694 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.
4698 # a cone at 45 degrees at the origin on Z
4701 # a cone on axis Z with radius r1 at z1 and r2 at z2
4702 cone c2 0 0 z1 180.*atan2(r2-r1,z2-z1)/pi r1
4705 @subsubsection occt_draw_6_3_4 sphere
4709 sphere name [x y z [dx dy dz [ux uy uz]]] radius
4712 Creates a sphere in the local coordinate system defined in the **plane** command. The sphere is centered at the origin.
4714 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.
4718 # a sphere at the origin
4720 # a sphere at 10 10 10, with poles on the axis 1,1,1
4721 sphere s2 10 10 10 1 1 1 10
4724 @subsubsection occt_draw_6_3_5 torus
4728 torus name [x y z [dx dy dz [ux uy uz]]] major minor
4731 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.
4733 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.
4737 # a torus at the origin
4740 # a torus in another coordinate system
4741 torus t2 10 5 -2 2 1 0 20 5
4745 @subsubsection occt_draw_6_3_6 beziersurf
4749 beziersurf name nbupoles nbvolpes pole, [weight]
4752 Use this command to create a bezier surface, rational or non-rational. First give the numbers of poles in the u and v directions.
4754 Then give the poles in the following order: *pole(1, 1), pole(nbupoles, 1), pole(1, nbvpoles)* and *pole(nbupoles, nbvpoles)*.
4756 Weights may be omitted, but if you give one weight you must give all of them.
4760 # a non-rational degree 2,3 surface
4762 0 0 0 10 0 5 20 0 0 \
4763 0 10 2 10 10 3 20 10 2 \
4764 0 20 10 10 20 20 20 20 10 \
4765 0 30 0 10 30 0 20 30 0
4768 @subsubsection occt_draw_6_3_7 bsplinesurf, upbsplinesurf, vpbsplinesurf, uvpbsplinesurf
4772 bsplinesurf name udegree nbuknots uknot umult ... nbvknot vknot
4773 vmult ... x y z w ...
4779 * **bsplinesurf** generates bspline surfaces;
4780 * **upbsplinesurf** creates a bspline surface periodic in u;
4781 * **vpbsplinesurf** creates one periodic in v;
4782 * **uvpbsplinesurf** creates one periodic in uv.
4784 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.
4786 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.
4790 # create a bspline surface of degree 1 2
4791 # with two knots in U and three in V
4796 0 10 2 1 10 10 3 1 \
4797 0 20 10 1 10 20 20 1 \
4802 @subsubsection occt_draw_6_3_8 trim, trimu, trimv
4806 trim newname name [u1 u2 [v1 v2]]
4811 The **trim** commands create trimmed curves or trimmed surfaces. Note that trimmed curves and surfaces are classes of the *Geom* package.
4812 * *trim* creates either a new trimmed curve from a curve or a new trimmed surface in u and v from a surface.
4813 * *trimu* creates a u-trimmed surface,
4814 * *trimv* creates a v-trimmed surface.
4816 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.
4818 **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.
4822 # create a 3d circle
4825 # trim it, use the same variable, the original is
4829 # the original can be recovered!
4835 # the original is not the trimmed curve but the basis
4838 # as the circle is periodic, the two following commands
4843 # trim an infinite cylinder
4848 @subsubsection occt_draw_6_3_9 offset
4852 offset name basename distance [dx dy dz]
4855 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.
4857 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.
4859 The offset curve or surface copies the basic geometry, which can be modified later.
4863 # graphic demonstration that the outline of a torus
4864 # is the offset of an ellipse
4867 torus t 0 0 0 0 cos(angle) sin(angle) 50 20
4869 ellipse e 0 0 0 50 50*sin(angle)
4870 # note that the distance can be negative
4871 offset l1 e 20 0 0 1
4874 @subsubsection occt_draw_6_3_10 revsurf
4878 revsurf name curvename x y z dx dy dz
4881 Creates a surface of revolution from a 3d curve.
4883 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.
4885 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.
4889 # another way of creating a torus like surface
4891 revsurf s c 0 0 0 0 1 0
4894 @subsubsection occt_draw_6_3_11 extsurf
4898 extsurf newname curvename dx dy dz
4901 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.
4903 In the syntax, *dx,dy,dz* gives the direction of extrusion.
4905 To parameterize a surface of extrusion: *u* is the parameter along the extruded curve; the *v* parameter is along the direction of extrusion.
4909 # an elliptic cylinder
4910 ellipse e 0 0 0 10 5
4916 @subsubsection occt_draw_6_3_12 convert
4920 convert newname name
4923 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.
4927 # turn a 2d arc of a circle into a 2d NURBS
4932 # an easy way to make a planar bspline surface
4938 **Note** that offset curves and surfaces are not processed by this command.
4940 @subsection occt_draw_6_4 Curve and surface modifications
4942 Draw provides commands to modify curves and surfaces, some of them are general, others restricted to bezier curves or bsplines.
4944 General modifications:
4946 * Reversing the parametrization: **reverse**, **ureverse**, **vreverse**
4948 Modifications for both bezier curves and bsplines:
4950 * Exchanging U and V on a surface: **exchuv**
4951 * Segmentation: **segment**, **segsur**
4952 * Increasing the degree: **incdeg**, **incudeg**, **incvdeg**
4953 * Moving poles: **cmovep**, **movep**, **movecolp**, **moverowp**
4955 Modifications for bezier curves:
4957 * Adding and removing poles: **insertpole**, **rempole**, **remcolpole**, **remrowpole**
4959 Modifications for bspline:
4961 * Inserting and removing knots: **insertknot**, **remknot**, **insertuknot**, **remuknot**, **insetvknot**, **remvknot**
4962 * Modifying periodic curves and surfaces: **setperiodic**, **setnotperiodic**, **setorigin**, **setuperiodic**, **setunotperiodic**, **setuorigin**, **setvperiodic**, **setvnotperiodic**, **setvorigin**
4966 @subsubsection occt_draw_6_4_1 reverse, ureverse, vreverse
4972 ureverse surfacename
4973 vreverse surfacename
4976 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.
4978 **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.
4980 Reversing a parameter on an analytical surface may create an indirect coordinate system.
4984 # reverse a trimmed 2d circle
4989 # dumping c will show that it is now trimmed between
4990 # 3*pi/2 and 7*pi/4 i.e. 2*pi-pi/2 and 2*pi-pi/4
4993 @subsubsection occt_draw_6_4_2 exchuv
5000 For a bezier or bspline surface this command exchanges the u and v parameters.
5004 # exchanging u and v on a spline (made from a cylinder)
5011 @subsubsection occt_draw_6_4_3 segment, segsur
5015 segment curve Ufirst Ulast
5016 segsur surface Ufirst Ulast Vfirst Vlast
5019 **segment** and **segsur** segment a bezier curve and a bspline curve or surface respectively.
5021 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*.
5023 This command must not be confused with **trim** which creates a new geometry.
5027 # segment a bezier curve in half
5028 beziercurve c 3 0 0 0 10 0 0 10 10 0
5029 segment c ufirst ulast
5032 @subsubsection occt_draw_6_4_4 iincudeg, incvdeg
5036 incudeg surfacename newdegree
5037 incvdeg surfacename newdegree
5040 **incudeg** and **incvdeg** increase the degree in the U or V parameter of a bezier or bspline surface.
5044 # make a planar bspline and increase the degree to 2 3
5052 **Note** that the geometry is modified.
5055 @subsubsection occt_draw_6_4_5 cmovep, movep, movecolp, moverowp
5059 cmovep curve index dx dy [dz]
5060 movep surface uindex vindex dx dy dz
5061 movecolp surface uindex dx dy dz
5062 moverowp surface vindex dx dy dz
5065 **move** methods translate poles of a bezier curve, a bspline curve or a bspline surface.
5066 * **cmovep** and **movep** translate one pole with a given index.
5067 * **movecolp** and **moverowp** translate a whole column (expressed by the *uindex*) or row (expressed by the *vindex*) of poles.
5071 # start with a plane
5072 # transform to bspline, raise degree and add relief
5074 trim p p -10 10 -10 10
5083 @subsubsection occt_draw_6_4_6 insertpole, rempole, remcolpole, remrowpole
5087 insertpole curvename index x y [z] [weight]
5088 rempole curvename index
5089 remcolpole surfacename index
5090 remrowpole surfacename index
5093 **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.
5095 **rempole** removes a pole from a 2d or 3d bezier curve. Leave at least two poles in the curves.
5097 **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.
5101 # start with a segment, insert a pole at end
5102 # then remove the central pole
5103 beziercurve c 2 0 0 0 10 0 0
5104 insertpole c 2 10 10 0
5108 @subsubsection occt_draw_6_4_7 insertknot, insertuknot, insertvknot
5112 insertknot name knot [mult = 1] [knot mult ...]
5113 insertuknot surfacename knot mult
5114 insertvknot surfacename knot mult
5117 **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.
5119 **insertuknot** and **insertvknot** insert knots in a surface.
5123 # create a cylindrical surface and insert a knot
5125 trim c c 0 pi/2 0 10
5127 insertuknot c1 pi/4 1
5130 @subsubsection occt_draw_6_4_8 remknot, remuknot, remvknot
5134 remknot index [mult] [tol]
5135 remuknot index [mult] [tol]
5136 remvknot index [mult] [tol]
5139 **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.
5141 By default, if no tolerance is given, the knot will always be removed.
5145 # bspline circle, remove a knot
5152 **Note** that Curves or Surfaces may be modified.
5155 @subsubsection occt_draw_6_4_9 setperiodic, setnotperiodic, setuperiodic, setunotperiodic, setvperiodic, setvnotperiodic
5160 setnotperiodic curve
5161 setuperiodic surface
5162 setunotperiodic surface
5163 setvperiodic surface
5164 setvnotperiodic surface
5167 **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.
5169 **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.
5173 # a circle deperiodicized
5179 @subsubsection occt_draw_6_4_10 setorigin, setuorigin, setvorigin
5183 setorigin curvename index
5184 setuorigin surfacename index
5185 setuorigin surfacename index
5188 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.
5192 # a torus with new U and V origins
5200 @subsection occt_draw_6_5 Transformations
5202 Draw provides commands to apply linear transformations to geometric objects: they include translation, rotation, mirroring and scaling.
5204 @subsubsection occt_draw_6_5_1 translate, dtranslate
5208 translate name [names ...] dx dy dz
5209 2dtranslate name [names ...] dx dy
5212 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.
5214 For 2d points or curves, use the **2dtranslate** command.
5221 torus t 10 20 30 5 2
5222 translate p c t 0 0 15
5226 *Objects are modified by this command.*
5228 @subsubsection occt_draw_6_5_2 rotate, 2drotate
5232 rotate name [name ...] x y z dx dy dz angle
5233 2drotate name [name ...] x y angle
5236 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.
5238 For a 2d rotation, you need only give the center point and the angle. In 2d or 3d, the angle can be negative.
5242 # make a helix of circles. create a scripte file with
5243 this code and execute it using **source**.
5245 for {set i 1} {$i = 10} {incr i} {
5246 copy c[expr $i-1] c$i
5248 rotate c$i 0 0 0 0 0 1 36
5252 @subsubsection occt_draw_6_5_3 pmirror, lmirror, smirror, dpmirror, dlmirror
5256 pmirror name [names ...] x y z
5257 lmirror name [names ...] x y z dx dy dz
5258 smirror name [names ...] x y z dx dy dz
5259 2dpmirror name [names ...] x y
5260 2dlmirror name [names ...] x y dx dy
5263 The mirror commands perform a mirror transformation of 2d or 3d geometry.
5265 * **pmirror** is the point mirror, mirroring 3d curves and surfaces about a point of symmetry.
5266 * **lmirror** is the line mirror commamd, mirroring 3d curves and surfaces about an axis of symmetry.
5267 * **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.
5268 * **2dpmirror** is the point mirror in 2D.
5269 * **2dlmirror** is the axis symmetry mirror in 2D.
5273 # build 3 images of a torus
5274 torus t 10 10 10 1 2 3 5 1
5278 lmirror t2 0 0 0 1 0 0
5280 smirror t3 0 0 0 1 0 0
5283 @subsubsection occt_draw_6_5_4 pscale, dpscale
5287 pscale name [name ...] x y z s
5288 2dpscale name [name ...] x y s
5291 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**.
5296 # double the size of a sphere
5301 @subsection occt_draw_6_6 Curve and surface analysis
5303 **Draw** provides methods to compute information about curves and surfaces:
5305 * **coord** to find the coordinates of a point.
5306 * **cvalue** and **2dcvalue** to compute points and derivatives on curves.
5307 * **svalue** to compute points and derivatives on a surface.
5308 * **localprop** and **minmaxcurandif** to compute the curvature on a curve.
5309 * **parameters** to compute (u,v) values for a point on a surface.
5310 * **proj** and **2dproj** to project a point on a curve or a surface.
5311 * **surface_radius** to compute the curvature on a surface.
5313 @subsubsection occt_draw_6_6_1 coord
5320 Sets the x, y (and optionally z) coordinates of the point P.
5332 @subsubsection occt_draw_6_6_2 cvalue, 2dcvalue
5336 cvalue curve U x y z [d1x d1y d1z [d2x d2y d2z]]
5337 2dcvalue curve U x y [d1x d1y [d2x d2y]]
5340 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*.
5344 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* :
5347 2dbeziercurve c 4 0 0 1 1 2 1 3 0
5348 2dcvalue c 0 x y d1x d1y d2x d2y
5350 # values of x y d1x d1y d2x d2y
5354 @subsubsection occt_draw_6_6_3 svalue
5358 svalue surfname U v x y z [dux duy duz dvx dvy dvz [d2ux d2uy d2uz d2vx d2vy d2vz d2uvx d2uvy d2uvz]]
5361 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.
5365 # display points on a sphere
5367 for {dset t 0} {[dval t] = 1} {dset t t+0.01} {
5368 svalue s t*2*pi t*pi-pi/2 x y z
5373 @subsubsection occt_draw_6_6_4 localprop, minmaxcurandinf
5377 localprop curvename U
5378 minmaxcurandinf curve
5381 **localprop** computes the curvature of a curve.
5382 **minmaxcurandinf** computes and prints the parameters of the points where the curvature is minimum and maximum on a 2d curve.
5386 # show curvature at the center of a bezier curve
5387 beziercurve c 3 0 0 0 10 2 0 20 0 0
5392 @subsubsection occt_draw_6_6_5 parameters
5396 parameters surf/curve x y z U [V]
5399 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.
5403 # Compute parameters on a plane
5404 plane p 0 0 10 1 1 0
5405 parameters p 5 5 5 u v
5406 # the values of u and v are : 0 5
5409 @subsubsection occt_draw_6_6_6 proj, dproj
5417 Use **proj** to project a point on a 3d curve or a surface and **2dproj** for a 2d curve.
5419 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, ... *
5423 Let us project a point on a torus
5428 == ext_1 ext_2 ext_3 ext_4
5431 @subsubsection occt_draw_6_6_7 surface_radius
5435 surface_radius surface u v [c1 c2]
5438 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*.
5442 Let us compute curvatures of a cylinder:
5446 surface_radius c pi 3 c1 c2
5447 == Min Radius of Curvature : -5
5448 == Min Radius of Curvature : infinite
5452 @subsection occt_draw_6_7 Intersections
5454 * **intersect** computes intersections of surfaces;
5455 * **2dintersect** computes intersections of 2d curves.
5457 @subsubsection occt_draw_6_7_1 intersect
5461 intersect name surface1 surface2
5464 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*, ...
5470 plane p 0 0 40 0 1 5
5474 @subsubsection occt_draw_6_7_2 dintersect
5478 2dintersect curve1 curve2
5481 Displays the intersection points between two 2d curves.
5485 # intersect two 2d ellipses
5487 ellipse e2 0 0 0 1 5 2
5491 @subsection occt_draw_6_8 Approximations
5493 Draw provides command to create curves and surfaces by approximation.
5495 * **2dapprox** fits a curve through 2d points;
5496 * **appro** fits a curve through 3d points;
5497 * **surfapp** and **grilapp** fit a surface through 3d points;
5498 * **2dinterpolate** interpolates a curve.
5500 @subsubsection occt_draw_6_8_1 appro, dapprox
5504 appro result nbpoint [curve]
5505 2dapprox result nbpoint [curve / x1 y1 x2 y2]
5508 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.
5512 Let us pick points and they will be fitted
5518 @subsubsection occt_draw_6_8_2 surfapp, grilapp
5523 surfapp name nbupoints nbvpoints x y z ....
5524 grilapp name nbupoints nbvpoints xo dx yo dy z11 z12 ...
5527 * **surfapp** fits a surface through an array of u and v points, nbupoints*nbvpoints.
5528 * **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.
5532 # a surface using the same data as in the beziersurf
5535 0 0 0 10 0 5 20 0 0 \
5536 0 10 2 10 10 3 20 10 2 \
5537 0 20 10 10 20 20 20 20 10 \
5538 0 30 0 10 30 0 20 30 0
5541 @subsection occt_draw_6_9 Constraints
5543 * **cirtang** constructs 2d circles tangent to curves;
5544 * **lintan** constructs 2d lines tangent to curves.
5547 @subsubsection occt_draw_6_9_1 cirtang
5551 cirtang cname curve/point/radius curve/point/radius curve/point/radius
5554 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.
5558 # a point, a line and a radius. 2 solutions
5565 @subsubsection occt_draw_6_9_2 lintan
5569 lintan name curve curve [angle]
5572 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.
5576 # lines tangent to 2 circles, 4 solutions
5581 # lines at 15 degrees tangent to a circle and a line, 2
5582 solutions: l1_1 l1_2
5588 @subsection occt_draw_6_10 Display
5590 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.
5592 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.
5594 On surfaces, you can control the number of isoparametric curves displayed on the surface with the **nbiso** command.
5596 On bezier and bspline curve and surface you can toggle the display of the control points with the **clpoles** and **shpoles** commands.
5598 On bspline curves and surfaces you can toggle the display of the knots with the **shknots** and **clknots** commands.
5601 @subsubsection occt_draw_6_10_1 dmod, discr, defle
5605 dmode name [name ...] u/d
5606 discr name [name ...] nbintervals
5607 defle name [name ...] deflection
5610 **dmod** command allows choosing the display mode for a curve or a surface.
5612 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.
5614 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).
5616 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.
5620 # increment the number of points on a big circle
5628 @subsubsection occt_draw_6_10_2 nbiso
5632 nbiso name [names...] nuiso nviso
5635 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.
5639 Let us display 35 meridians and 15 parallels on a sphere:
5645 @subsubsection occt_draw_6_10_3 clpoles, shpoles
5653 On bezier and bspline curves and surfaces, the control polygon is displayed by default: *clpoles* erases it and *shpoles* restores it.
5657 Let us make a bezier curve and erase the poles
5660 beziercurve c 3 0 0 0 10 0 0 10 10 0
5664 @subsubsection occt_draw_6_10_4 clknots, shknots
5672 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.
5676 # hide the knots on a bspline curve
5677 bsplinecurve bc 2 3 0 3 1 1 2 3 \
5678 10 0 7 1 7 0 7 1 3 0 8 1 0 0 7 1
5683 @section occt_draw_7 Topology commands
5685 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.
5687 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.
5689 The <a href="user_guides__modeling_data.html#occt_modat_5">different topological shapes</a> include:
5691 * **COMPOUND**: A group of any type of topological object.
5692 * **COMPSOLID**: A set of solids connected by their faces. This expands the notions of WIRE and SHELL to solids.
5693 * **SOLID**: A part of space limited by shells. It is three dimensional.
5694 * **SHELL**: A set of faces connected by their edges. A shell can be open or closed.
5695 * **FACE**: In 2d, a plane; in 3d, part of a surface. Its geometry is constrained (trimmed) by contours. It is two dimensional.
5696 * **WIRE**: A set of edges connected by their vertices. It can be open or closed depending on whether the edges are linked or not.
5697 * **EDGE**: A topological element corresponding to a restrained curve. An edge is generally limited by vertices. It has one dimension.
5698 * **VERTEX**: A topological element corresponding to a point. It has a zero dimension.
5700 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**).
5702 The following topics are covered in the eight sections of this chapter:
5704 * Basic shape commands to handle the structure of shapes and control the display.
5705 * Curve and surface topology, or methods to create topology from geometry and vice versa.
5706 * Primitive construction commands: box, cylinder, wedge etc.
5707 * Sweeping of shapes.
5708 * Transformations of shapes: translation, copy, etc.
5709 * Topological operations, or booleans.
5710 * Drafting and blending.
5711 * Analysis of shapes.
5714 @subsection occt_draw_7_1 Basic topology
5716 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:
5718 * **isos** and **discretisation** to control display of shape faces by isoparametric curves .
5719 * **orientation**, **complement** and **invert** to modify topological attributes such as orientation.
5720 * **explode**, **exwire** and **nbshapes** to analyze the structure of a shape.
5721 * **emptycopy**, **add**, **compound** to create shapes by stepwise construction.
5723 In Draw, shapes are displayed using isoparametric curves. There is color coding for the edges:
5725 * a red edge is an isolated edge, which belongs to no faces.
5726 * a green edge is a free boundary edge, which belongs to one face,
5727 * a yellow edge is a shared edge, which belongs to at least two faces.
5730 @subsubsection occt_draw_7_1_1 isos, discretisation
5734 isos [name ...][nbisos]
5735 discretisation nbpoints
5738 Determines or changes the number of isoparametric curves on shapes.
5740 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.
5742 *discretisation* changes the default number of points used to display the curves. The default value is 30.
5746 # Display only the edges (the wireframe)
5750 **Warning**: don’t confuse *isos* and *discretisation* with the geometric commands *nbisos* and *discr*.
5753 @subsubsection occt_draw_7_1_2 orientation, complement, invert, normals, range
5757 orientation name [name ...] F/R/E/I
5758 complement name [name ...]
5760 normals s (length = 10), disp normals
5761 range name value value
5764 * **orientation** assigns the orientation of shapes - simple and complex - to one of the following four values: *FORWARD, REVERSED, INTERNAL, EXTERNAL*.
5765 * **complement** changes the current orientation of shapes to its complement, *FORWARD - REVERSED, INTERNAL - EXTERNAL*.
5766 * **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.
5767 * *normals** returns the assignment of colors to orientation values.
5768 * **range** defines the length of a selected edge by defining the values of a starting point and an end point.
5772 # to invert normals of a box
5778 # to assign a value to an edge
5780 # to define the box as edges
5782 b_1 b_2 b_3 b_4 b_5 b_6 b_7 b_8 b_9 b_10 b_11 b_12
5783 # to define as an edge
5785 # to define the length of the edge as starting from 0
5790 @subsubsection occt_draw_7_1_3 explode, exwire, nbshapes
5794 explode name [C/So/Sh/F/W/E/V]
5799 **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.
5801 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.
5803 **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.
5805 **nbshapes** counts the number of shapes of each type in an entity.
5812 # whatis returns the type and various information
5814 = b is a shape SOLID FORWARD Free Modified
5819 = b_1 is a shape SHELL FORWARD Modified Orientable
5822 # extract the edges b_1, ... , b_12
5829 Number of shapes in b
5841 @subsubsection occt_draw_7_1_4 emptycopy, add, compound
5845 emptycopy [newname] name
5847 compound [name ...] compoundname
5850 **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.
5852 **add** inserts shape *C* into shape *S*. Verify that *C* and *S* reference compatible types of objects:
5853 * Any *Shape* can be added to a *Compound*.
5854 * Only a *Solid* can be added to a *CompSolid*.
5855 * Only a *Shell* can *Edge* or a *Vertex* can be added into a *Solid*.
5856 * Only a *Face* can be added to a *Shell*.
5857 * Only a *Wire* and *Vertex* can be added in a *Solid*.
5858 * Only an *Edge* can be added to a *Wire*.
5859 * Only a *Vertex* can be added to an *Edge*.
5860 * Nothing can be added to a *Vertex*.
5862 **emptycopy** and **add** should be used with care.
5864 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.
5868 # a compound with three boxes
5875 @subsubsection occt_draw_7_1_5 checkshape
5879 checkshape [-top] shape [result] [-short]
5883 * *top* – optional parameter, which allows checking only topological validity of a shape.
5884 * *shape*– the only required parameter which represents the name of the shape to check.
5885 * *result* – optional parameter which is the prefix of the output shape names.
5886 * *short* – a short description of the check.
5888 **checkshape** examines the selected object for topological and geometric coherence. The object should be a three dimensional shape.
5892 # checkshape returns a comment valid or invalid
5895 # returns the comment
5896 this shape seems to be valid
5899 **Note** that this test is performed using the tolerance set in the algorithm.
5902 @subsection occt_draw_7_2 Curve and surface topology
5904 This group of commands is used to create topology from shapes and to extract shapes from geometry.
5906 * To create vertices, use the **vertex** command.
5907 * To create edges use, the **edge**, **mkedge** commands.
5908 * To create wires, use the **wire**, **polyline**, **polyvertex** commands.
5909 * To create faces, use the **mkplane**, **mkface** commands.
5910 * To extract the geometry from edges or faces, use the **mkcurve** and **mkface** commands.
5911 * To extract the 2d curves from edges or faces, use the **pcurve** command.
5914 @subsubsection occt_draw_7_2_1 vertex
5918 vertex name [x y z / p edge]
5921 Creates a vertex at either a 3d location x,y,z or the point at parameter p on an edge.
5928 @subsubsection occt_draw_7_2_2 edge, mkedge, uisoedge, visoedge
5932 edge name vertex1 vertex2
5933 mkedge edge curve [surface] [pfirst plast] [vfirst [pfirst] vlast [plast]]
5934 uisoedge edge face u v1 v2
5935 visoedge edge face v u1 u2
5938 * **edge** creates a straight line edge between two vertices.
5939 * **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.
5943 # straight line edge
5948 # make a circular edge
5952 # A similar result may be achieved by trimming the curve
5953 # The trimming is removed by mkedge
5958 * **visoedge** and **uisoedge** are commands that generate a *uiso* parameter edge or a *viso* parameter edge.
5962 # to create an edge between v1 and v2 at point u
5963 # to create the example plane
5972 # to create the edge in the plane at the u axis point
5973 0.5, and between the v axis points v=0.2 and v =0.8
5974 uisoedge e p 0.5 0.20 0.8
5977 @subsubsection occt_draw_7_2_3 wire, polyline, polyvertex
5981 wire wirename e1/w1 [e2/w2 ...]
5982 polyline name x1 y1 z1 x2 y2 z2 ...
5983 polyvertex name v1 v2 ...
5986 **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.
5988 **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.
5990 **polyvertex** creates a polygonal wire from vertices.
5994 # create two polygonal wires
5995 # glue them and define as a single wire
5996 polyline w1 0 0 0 10 0 0 10 10 0
5997 polyline w2 10 10 0 0 10 0 0 0 0
6001 @subsubsection occt_draw_7_2_4 profile
6005 profile name [code values] [code values] ...
6009 **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.
6012 | **Code** | **Values ** | **Action** |
6013 | :------------ | :------------- | :---------------- |
6014 | O | X Y Z | Sets the origin of the plane |
6015 | P | DX DY DZ UX UY UZ | Sets the normal and X of the plane |
6016 | F | X Y | Sets the first point |
6017 | X | DX | Translates a point along X |
6018 | Y | DY | Translates a point along Y |
6019 | L | DL | Translates a point along direction |
6020 | XX | X | Sets point X coordinate |
6021 | YY | Y | Sets point Y coordinate |
6022 | T | DX DY | Translates a point |
6023 | TT | X Y | Sets a point |
6024 | R | Angle | Rotates direction |
6025 | RR | Angle | Sets direction |
6026 | D | DX DY | Sets direction |
6027 | IX | X | Intersects with vertical |
6028 | IY | Y | Intersects with horizontal |
6029 | C | Radius Angle | Arc of circle tangent to direction |
6032 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.
6034 The point [code values] can be repeated any number of times and in any order to create the profile contour.
6038 | No suffix | Makes a closed face |
6039 | W | Make a closed wire |
6040 | WW | Make an open wire |
6042 The profile shape definition is the suffix; no suffix produces a face, *w* is a closed wire, *ww* is an open wire.
6044 Code letters are not case-sensitive.
6048 # to create a trianglular plane using a vertex at the
6049 origin, in the xy plane
6050 profile p O 0 0 0 X 1 Y 0 x 1 y 1
6055 # to create a contour using the different code
6058 # two vertices in the xy plane
6059 profile p F 1 0 x 2 y 1 ww
6061 # to view from a point normal to the plane
6064 # add a circular element of 45 degrees
6065 profile p F 1 0 x 2 y 1 c 1 45 ww
6067 # add a tangential segment with a length value 1
6068 profile p F 1 0 x 2 y 1 c 1 45 l 1 ww
6070 # add a vertex with xy values of 1.5 and 1.5
6071 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 ww
6073 # add a vertex with the x value 0.2, y value is constant
6074 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 xx 0.2 ww
6076 # add a vertex with the y value 2 x value is constant
6077 profile p F 1 0 x 2 y 1 c 1 45 l 1 tt 1.5 1.5 yy 2 ww
6079 # add a circular element with a radius value of 1 and a circular value of 290 degrees
6080 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
6082 # wire continues at a tangent to the intersection x = 0
6083 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
6085 # continue the wire at an angle of 90 degrees until it intersects the y axis at y= -o.3
6086 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
6089 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
6091 # to create the plane with the same contour
6092 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
6095 @subsubsection occt_draw_7_2_5 bsplineprof
6099 bsplineprof name [S face] [W WW]
6102 * for an edge : \<digitizes\> ... <mouse button 2>
6103 * to end profile : <mouse button 3>
6105 Builds a profile in the XY plane from digitizes. By default the profile is closed and a face is built.
6107 **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.
6109 The profile shape definition is the suffix; no suffix produces a face, **w** is a closed wire, **ww** is an open wire.
6113 #to view the xy plane
6115 #to create a 2d curve with the mouse
6117 # click mb1 to start the curve
6118 # click mb1 to create the second vertex
6119 # click mb1 to create a curve
6121 #click mb2 to finish the curve and start a new curve
6123 # click mb1 to create the second curve
6124 # click mb3 to create the face
6127 @subsubsection occt_draw_7_2_6 mkoffset
6131 mkoffset result face/compound of wires nboffset stepoffset
6134 **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.
6136 The offset distance defines the spacing and the positioning of the occurences.
6140 #Create a box and select a face
6143 #Create three exterior parallel contours with an offset
6146 Create one interior parallel contour with an offset
6149 mkoffset r b_1 1 -0.4
6152 **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.
6156 # to create the example contour
6157 profile p F 0 0 x 2 y 4 tt 1 1 tt 0 4 w
6158 # to create an incoherent interior offset
6159 mkoffset r p 1 -0.50
6160 ==p is not a FACE but a WIRE
6161 BRepFill_TrimEdgeTool: incoherent intersection
6162 # to create two incoherent wires
6163 mkoffset r p 1 -0.50
6166 @subsubsection occt_draw_7_2_7 mkplane, mkface
6171 mkface name surface [ufirst ulast vfirst vlast]
6174 **mkplane** generates a face from a planar wire. The planar surface will be constructed with an orientation which keeps the face inside the wire.
6176 **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.
6180 # make a polygonal face
6181 polyline f 0 0 0 20 0 0 20 10 0 10 10 0 10 20 0 0 20 0 0 0 0
6184 # make a cylindrical face
6186 trim g g -pi/3 pi/2 0 15
6190 @subsubsection occt_draw_7_2_8 mkcurve, mksurface
6198 **mkcurve** creates a 3d curve from an edge. The curve will be trimmed to the edge boundaries.
6200 **mksurface** creates a surface from a face. The surface will not be trimmed.
6210 @subsubsection occt_draw_7_2_9 pcurve
6215 pcurve [name edgename] facename
6218 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.
6222 # view the pcurves of a face
6231 @subsubsection occt_draw_7_2_10 chfi2d
6235 chfi2d result face [edge1 edge2 (F radius/CDD d1 d2/CDA d ang) ....
6239 Creates chamfers and fillets on 2D objects. Select two adjacent edges and:
6241 * two respective distance values
6242 * a distance value and an angle
6244 The radius value produces a fillet between the two faces.
6246 The distance is the length value from the edge between the two selected faces in a normal direction.
6250 Let us create a 2d fillet:
6254 profile p x 2 y 2 x -2
6255 chfi2d cfr p . . F 0.3
6262 Let us create a 2d chamfer using two distances:
6265 profile p x 2 y 2 x -2
6266 chfi2d cfr p . . CDD 0.3 0.6
6273 Let us create a 2d chamfer using a defined distance and angle
6277 profile p x 2 y 2 x -2
6278 chfi2d cfr p . . CDA 0.3 75
6285 @subsubsection occt_draw_7_2_11 nproject
6289 nproject pj e1 e2 e3 ... surf -g -d [dmax] [Tol
6290 [continuity [maxdeg [maxseg]]]
6293 Creates a shape projection which is normal to the target surface.
6297 # create a curved surface
6306 translate ll 2 -0.5 0
6312 #display in four views
6315 # create the example shape
6316 circle c 1.8 -0.5 1 0 1 0 1 0 0 0.4
6319 # create the normal projection of the shape(circle)
6324 @subsection occt_draw_7_3 Primitives
6326 Primitive commands make it possible to create simple shapes. They include:
6328 * **box** and **wedge** commands.
6329 * **pcylinder**, **pcone**, **psphere**, **ptorus** commands.
6330 * **halfspace** command
6333 @subsubsection occt_draw_7_3_1 box, wedge
6337 box name [x y z] dx dy dz
6338 wedge name dx dy dz ltx / xmin zmin xmax xmax
6341 **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.
6343 **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*.
6345 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.
6349 # a box at the origin
6353 box b2 30 30 40 10 20 30
6358 # a wedge with a sharp edge (5 faces)
6362 wedge w3 20 20 20 10 10 10 10
6365 @subsubsection occt_draw_7_3_2 pcylinder, pcone, psphere, ptorus
6369 pcylinder name [plane] radius height [angle]
6370 pcone name [plane] radius1 radius2 height [angle]
6371 pcone name [plane] radius1 radius2 height [angle]
6372 psphere name [plane] radius1 [angle1 angle2] [angle]
6373 ptorus name [plane] radius1 radius2 [angle1 angle2] [angle]
6376 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.
6378 **pcylinder** creates a cylindrical block with the given radius and height.
6380 **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.
6382 **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.
6384 **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.
6391 # a quarter of a truncated cone
6392 pcone co 15 10 10 90
6394 # three-quarters of sphere
6401 @subsubsection occt_draw_7_3_3 halfspace
6405 halfspace result face/shell x y z
6408 **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.
6414 ==b_1 b_2 b_3 b_4 b_5 b_6
6415 halfspace hr b_3 0.5 0.5 0.5
6419 @subsection occt_draw_7_4 Sweeping
6421 Sweeping creates shapes by sweeping out a shape along a defined path:
6423 * **prism** sweeps along a direction.
6424 * **revol** sweeps around an axis.
6425 * **pipe** sweeps along a wire.
6426 * **mksweep** and **buildsweep** are commands to create sweeps by defining the arguments and algorithms.
6427 * **thrusections** creates a sweep from wire in different planes.
6430 @subsubsection occt_draw_7_4_1 prism
6434 prism result base dx dy dz [Copy | Inf | SemiInf]
6437 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.
6439 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.
6443 # sweep a planar face to make a solid
6444 polyline f 0 0 0 10 0 0 10 5 0 5 5 0 5 15 0 0 15 0 0 0 0
6448 @subsubsection occt_draw_7_4_2 revol
6452 revol result base x y z dx dy dz angle [Copy]
6455 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.
6459 # shell by wire rotation
6460 polyline w 0 0 0 10 0 0 10 5 0 5 5 0 5 15 0 0 15 0
6461 revol s w 20 0 0 0 1 0 90
6465 @subsubsection occt_draw_7_4_3 pipe
6469 pipe name wire_spine Profile
6472 Creates a new shape by sweeping a shape known as the profile along a wire known as the spine.
6476 # sweep a circle along a bezier curve to make a solid
6479 beziercurve spine 4 0 0 0 10 0 0 10 10 0 20 10 0
6482 circle profile 0 0 0 1 0 0 2
6483 mkedge profile profile
6484 wire profile profile
6485 mkplane profile profile
6486 pipe p spine profile
6489 @subsubsection occt_draw_7_4_4 mksweep, addsweep, setsweep, deletesweep, buildsweep, simulsweep
6494 addsweep wire[vertex][-M][-C] [auxiilaryshape]
6496 setsweep options [arg1 [arg2 [...]]]
6497 simulsweep r [n] [option]
6498 buildsweep [r] [option] [Tol]
6502 * *-FR* : Tangent and Normal are defined by a Frenet trihedron
6503 * *-CF* : Tangent is given by Frenet, the Normal is computed to minimize the torsion
6504 * *-DX Surf* : Tangent and Normal are given by Darboux trihedron, surf must be a shell or a face
6505 * *-CN dx dy dz* : BiNormal is given by *dx dy dz*
6506 * *-FX Tx Ty TZ [Nx Ny Nz]* : Tangent and Normal are fixed
6509 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.
6510 * **mksweep** initializes the sweep creation and defines the wire to be used as the spine.
6511 * **addsweep** defines the wire to be used as the profile.
6512 * **deletesweep** cancels the choice of profile wire, without leaving the mksweep mode. You can re-select a profile wire.
6513 * **setsweep** commands the algorithms used for the construction of the sweep.
6514 * **simulsweep** can be used to create a preview of the shape. [n] is the number of sections that are used to simulate the sweep.
6515 * **buildsweep** creates the sweep using the arguments defined by all the commands.
6519 #create a sweep based on a semi-circular wire using the
6521 #create a circular figure
6522 circle c2 0 0 0 1 0 0 10
6523 trim c2 c2 -pi/2 pi/2
6529 # to display all the options for a sweep
6531 #to create a sweep using the Frenet algorithm where the
6532 #normal is computed to minimise the torsion
6535 # to simulate the sweep with a visual approximation
6539 @subsubsection occt_draw_7_4_5 thrusections
6543 thrusections [-N] result issolid isruled wire1 wire2 [..wire..]
6546 **thrusections** creates a shape using wires that are positioned in different planes. Each wire selected must have the same number of edges and vertices.
6547 A bezier curve is generated between the vertices of each wire. The option *[-N]* means that no check is made on wires for direction.
6551 #create three wires in three planes
6552 polyline w1 0 0 0 5 0 0 5 5 0 2 3 0
6553 polyline w2 0 1 3 4 1 3 4 4 3 1 3 3
6554 polyline w3 0 0 5 5 0 5 5 5 5 2 3 5
6556 thrusections th issolid isruled w1 w2 w3
6557 ==thrusections th issolid isruled w1 w2 w3
6558 Tolerances obtenues -- 3d : 0
6563 @subsection occt_draw_7_5 Topological transformation
6565 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.
6567 * **tcopy** makes a copy of the structure of a shape.
6568 * **ttranslate**, **trotate**, **tmove**, **reset** move a shape.
6569 * **tmirror**, **tscale** always modify the shape.
6572 @subsubsection occt_draw_7_5_1 tcopy
6576 tcopy name toname [name toname ...]
6579 Copies the structure of one shape, including the geometry, into another, newer shape.
6583 # create an edge from a curve and copy it
6584 beziercurve c 3 0 0 0 10 0 0 20 10 0
6589 # now modify the curve, only e1 and e2 will be modified
6592 @subsubsection occt_draw_7_5_2 tmove, treset
6596 tmove name [name ...] shape
6597 reset name [name ...]
6600 **tmove** and **reset** modify the location, or the local coordinate system of a shape.
6602 **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).
6608 box b2 20 0 0 10 10 10
6609 # translate the first box
6610 ttranslate b1 0 10 0
6611 # and apply the same location to b2
6613 # return to original positions
6617 @subsubsection occt_draw_7_5_3 ttranslate, trotate
6621 ttranslate [name ...] dx dy dz
6622 trotate [name ...] x y z dx dy dz angle
6625 **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.
6626 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.)
6628 Locations are very economic in the data structure because multiple occurences of an object share the topological description.
6632 # make rotated copies of a sphere in between two cylinders
6633 # create a file source toto.tcl
6635 for {set i 0} {$i 360} {incr i 20} {
6637 trotate s$i 0 0 0 0 0 1 $i
6640 # create two cylinders
6643 ttranslate c2 0 0 20
6647 ttranslate s 25 0 12.5
6649 # call the source file for multiple copies
6653 @subsubsection occt_draw_7_5_4 tmirror, tscale
6657 tmirror name x y z dx dy dz
6658 tscale name x y z scale
6661 * **tmirror** makes a mirror copy of a shape about a plane x,y,z dx,dy,dz.
6663 * **Tscale** applies a central homotopic mapping to a shape.
6667 # mirror a portion of cylinder about the YZ plane
6668 pcylinder c1 10 10 270
6670 tmirror c2 15 0 0 1 0 0
6676 @subsection occt_draw_7_6 Old Topological operations
6678 * **fuse**, **cut**, **common** are boolean operations.
6679 * **section**, **psection** compute sections.
6680 * **sewing** joins two or more shapes.
6683 @subsubsection occt_draw_7_6_1 fuse, cut, common
6687 fuse name shape1 shape2
6688 cut name shape1 shape2
6689 common name shape1 shape2
6692 **fuse** creates a new shape by a boolean operation on two existing shapes. The new shape contains both originals intact.
6694 **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.
6696 **common** creates a new shape which contains only what is in common between the two original shapes in their intersection.
6700 # all four boolean operations on a box and a cylinder
6702 box b 0 -10 5 20 20 10
6706 ttranslate s1 40 0 0
6709 ttranslate s2 -40 0 0
6712 ttranslate s3 0 40 0
6715 ttranslate s4 0 -40 0
6719 @subsubsection occt_draw_7_6_2 section, psection
6723 section result shape1 shape2
6724 psection name shape plane
6727 **section** creates a compound object consisting of the edges for the intersection curves on the faces of two shapes.
6729 **psection** creates a planar section consisting of the edges for the intersection curves on the faces of a shape and a plane.
6733 # section line between a cylinder and a box
6735 box b 0 0 5 15 15 15
6736 trotate b 0 0 0 1 1 1 20
6739 # planar section of a cone
6741 plane p 0 0 15 1 1 2
6745 @subsubsection occt_draw_7_6_3 sewing
6749 sewing result [tolerance] shape1 shape2 ...
6752 **Sewing** joins shapes by connecting their adjacent or near adjacent edges. Adjacency can be redefined by modifying the tolerance value.
6756 # create two adjacent boxes
6761 sr is a shape COMPOUND FORWARD Free Modified
6764 @subsection occt_draw_7_7 New Topological operations
6767 The new algorithm of Boolean operations avoids a large number of weak points and limitations presented in the old boolean operation algorithm.
6770 @subsubsection occt_draw_7_7_1 bparallelmode
6772 * **bparallelmode** enable or disable parallel mode for boolean operations. Sequential computing is used by default.
6780 Without arguments, bparallelmode shows current state of parallel mode for boolean operations.
6782 * *0* Disable parallel mode,
6783 * *1* Enable parallel mode
6787 # Enable parallel mode for boolean operations.
6790 # Show state of parallel mode for boolean operations.
6794 @subsubsection occt_draw_7_7_2 bop, bopfuse, bopcut, boptuc, bopcommon
6796 * **bop** defines *shape1* and *shape2* subject to ulterior Boolean operations
6797 * **bopfuse** creates a new shape by a boolean operation on two existing shapes. The new shape contains both originals intact.
6798 * **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.
6799 * **boptuc** is a reverced **bopcut**.
6800 * **bopcommon** creates a new shape which contains only whatever is in common between the two original shapes in their intersection.
6811 These commands have short variants:
6814 bcommon result shape1 shape2
6815 bfuse result shape1 shape2
6816 bcut result shape1 shape2
6820 **bop** fills data structure (DS) of boolean operation for *shape1* and *shape2*.
6821 **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:
6831 Let us produce all four boolean operations on a box and a cylinder:
6834 box b 0 -10 5 20 20 10
6837 # fills data structure
6841 ttranslate s1 40 0 0
6844 ttranslate s2 -40 0 0
6847 ttranslate s3 0 40 0
6850 ttranslate s4 0 -40 0
6853 Now use short variants of the commands:
6857 ttranslate s11 40 0 100
6860 ttranslate s12 -40 0 100
6863 ttranslate s14 0 -40 100
6866 @subsubsection occt_draw_7_7_3 bopsection
6874 * **bopsection** creates a compound object consisting of the edges for the intersection curves on the faces of two shapes.
6875 * **bop** fills data structure (DS) of boolean operation for *shape1* and *shape2*.
6876 * **bopsection** command used after **bop** command.
6878 Short variant syntax:
6880 bsection result shape1 shape2 [-2d/-2d1/-2s2] [-a]
6883 * <i>-2d</i> - PCurves are computed on both parts.
6884 * <i>-2d1</i> - PCurves are computed on first part.
6885 * <i>-2d2</i> - PCurves are computed on second part.
6886 * <i>-a</i> - built geometries are approximated.
6890 Let us build a section line between a cylinder and a box
6893 box b 0 0 5 15 15 15
6894 trotate b 0 0 0 1 1 1 20
6901 @subsubsection occt_draw_7_7_4 bopcheck, bopargshape
6906 bopargcheck shape1 [[shape2] [-F/O/C/T/S/U] [/R|F|T|V|E|I|P]] [#BF]
6909 **bopcheck** checks a shape for self-interference.
6911 **bopargcheck** checks the validity of argument(s) for boolean operations.
6913 * Boolean Operation - (by default a section is made) :
6920 * Test Options - (by default all options are enabled) :
6921 * **R** (disable small edges (shrank range) test)
6922 * **F** (disable faces verification test)
6923 * **T** (disable tangent faces searching test)
6924 * **V** (disable test possibility to merge vertices)
6925 * **E** (disable test possibility to merge edges)
6926 * **I** (disable self-interference test)
6927 * **P** (disable shape type test)
6928 * Additional Test Options :
6929 * **B** (stop test on first faulty found) - by default it is off;
6930 * **F** (full output for faulty shapes) - by default the output is made in a short format.
6932 **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.
6936 # checks a shape on self-interference
6940 # checks the validity of argument for boolean cut operations
6941 box b2 0 0 0 10 10 10
6942 bopargcheck b1 b2 -C
6945 @subsection occt_draw_7_8 Drafting and blending
6947 Drafting is creation of a new shape by tilting faces through an angle.
6949 Blending is the creation of a new shape by rounding edges to create a fillet.
6951 * Use the **depouille** command for drafting.
6952 * Use the **chamf** command to add a chamfer to an edge
6953 * Use the **blend** command for simple blending.
6954 * Use **fubl** for a fusion + blending operation.
6955 * Use **buildevol**, **mkevol**, **updatevol** to realize varying radius blending.
6958 @subsubsection occt_draw_7_8_1 depouille
6962 dep result shape dirx diry dirz face angle x y x dx dy dz [face angle...]
6965 Creates a new shape by drafting one or more faces of a shape.
6967 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.
6971 # draft a face of a box
6974 == b_1 b_2 b_3 b_4 b_5 b_6
6976 dep a b 0 0 1 b_2 10 0 10 0 1 0 5
6979 @subsubsection occt_draw_7_8_2 chamf
6983 chamf newname shape edge face S dist
6984 chamf newname shape edge face dist1 dist2
6985 chamf newname shape edge face A dist angle
6988 Creates a chamfer along the edge between faces using:
6990 * a equal distances from the edge
6991 * the edge, a face and distance, a second distance
6992 * the edge, a reference face and an angle
6994 Use the dot syntax to select the faces and edges.
6998 Let us create a chamfer based on equal distances from the edge (45 degree angle):
7002 chamf ch b . . S 0.5
7006 # select an adjacent face
7009 Let us create a chamfer based on different distances from the selected edge:
7012 chamf ch b . . 0.3 0.4
7016 # select an adjacent face
7019 Let us create a chamfer based on a distance from the edge and an angle:
7023 chamf ch b . . A 0.4 30
7027 # select an adjacent face
7030 @subsubsection occt_draw_7_8_3 blend
7034 blend result object rad1 ed1 rad2 ed2 ... [R/Q/P]
7037 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.
7041 # blend a box, click on an edge
7044 ==tolerance ang : 0.01
7045 ==tolerance 3d : 0.0001
7046 ==tolerance 2d : 1e-05
7048 ==tolblend 0.01 0.0001 1e-05 0.001
7050 # click on the edge you want ot fillet
7052 ==COMPUTE: temps total 0.1s dont :
7053 ==- Init + ExtentAnalyse 0s
7054 ==- PerformSetOfSurf 0.02s
7055 ==- PerformFilletOnVertex 0.02s
7057 ==- Reconstruction 0.06s
7061 @subsubsection occt_draw_7_8_4 fubl
7065 fubl name shape1 shape2 radius
7068 Creates a boolean fusion of two shapes and then blends (fillets) the intersection edges using the given radius.
7072 # fuse-blend two boxes
7075 ttranslate b2 -10 10 3
7080 @subsubsection occt_draw_7_8_5 mkevol, updatevol, buildevol
7084 mkevol result object (then use updatevol) [R/Q/P]
7085 updatevol edge u1 radius1 [u2 radius2 ...]
7089 These three commands work together to create fillets with evolving radii.
7091 * **mkevol** allows specifying the shape and the name of the result. It returns the tolerances of the fillet.
7092 * **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.
7093 * **buildevol** produces the result described previously in **mkevol** and **updatevol**.
7097 # makes an evolved radius on a box
7100 ==tolerance ang : 0.01
7101 ==tolerance 3d : 0.0001
7102 ==tolerance 2d : 1e-05
7104 ==tolblend 0.01 0.0001 1e-05 0.001
7107 updatevol . 0 1 1 3 2 2
7111 ==Dump of SweepApproximation
7112 ==Error 3d = 1.28548881203818e-14
7113 ==Error 2d = 1.3468326936926e-14 ,
7114 ==1.20292299999388e-14
7115 ==2 Segment(s) of degree 3
7117 ==COMPUTE: temps total 0.91s dont :
7118 ==- Init + ExtentAnalyse 0s
7119 ==- PerformSetOfSurf 0.33s
7120 ==- PerformFilletOnVertex 0.53s
7122 ==- Reconstruction 0.04s
7127 @subsection occt_draw_7_9 Analysis of topology and geometry
7129 Analysis of shapes includes commands to compute length, area, volumes and inertial properties.
7131 * Use **lprops**, **sprops**, **vprops** to compute integral properties.
7132 * Use **bounding** to display the bounding box of a shape.
7133 * Use **distmini** to calculate the minimum distance between two shapes.
7134 * Use **xdistef**, **xdistcs**, **xdistcc**, **xdistc2dc2dss**, **xdistcc2ds** to check the distance between two objects on even grid.
7137 @subsubsection occt_draw_7_9_1 lprops, sprops, vprops
7146 * **lprops** computes the mass properties of all edges in the shape with a linear density of 1;
7147 * **sprops** of all faces with a surface density of 1;
7148 * **vprops** of all solids with a density of 1.
7150 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.
7154 # volume of a cylinder
7158 Mass : 6283.18529981086
7161 X = 4.1004749224903e-06
7162 Y = -2.03392858349861e-16
7166 366519.141445068 5.71451850691484e-12
7168 5.71451850691484e-12 366519.141444962
7169 2.26823064169991e-10 0.257640437382627
7170 2.26823064169991e-10 314159.265358863
7173 IX = 366519.141446336
7174 IY = 366519.141444962
7175 I.Z = 314159.265357595
7179 @subsubsection occt_draw_7_9_2 bounding
7186 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.*
7190 # bounding box of a torus
7193 ==-27.059805107309852 -27.059805107309852 -
7195 ==27.059805107309852 27.059805107309852
7199 @subsubsection occt_draw_7_9_3 distmini
7203 distmini name Shape1 Shape2
7206 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.
7210 box b 0 0 0 10 20 30
7211 box b2 30 30 0 10 20 30
7213 ==the distance value is : 22.3606797749979
7214 ==the number of solutions is :2
7217 ==the type of the solution on the first shape is 0
7218 ==the type of the solution on the second shape is 0
7219 ==the coordinates of the point on the first shape are:
7221 ==the coordinates of the point on the second shape
7225 ==solution number 2:
7226 ==the type of the solution on the first shape is 0
7227 ==the type of the solution on the second shape is 0
7228 ==the coordinates of the point on the first shape are:
7230 ==the coordinates of the point on the second shape
7237 @subsubsection occt_draw_7_9_4 xdistef, xdistcs, xdistcc, xdistc2dc2dss, xdistcc2ds
7242 xdistcs curve surface firstParam lastParam [NumberOfSamplePoints]
7243 xdistcc curve1 curve2 startParam finishParam [NumberOfSamplePoints]
7244 xdistcc2ds c curve2d surf startParam finishParam [NumberOfSamplePoints]
7245 xdistc2dc2dss curve2d_1 curve2d_2 surface_1 surface_2 startParam finishParam [NumberOfSamplePoints]
7248 It is assumed that curves have the same parametrization range and *startParam* is less than *finishParam*.
7250 Commands with prefix *xdist* allow checking the distance between two objects on even grid:
7251 * **xdistef** - distance between edge and face;
7252 * **xdistcs** - distance between curve and surface. This means that the projection of each sample point to the surface is computed;
7253 * **xdistcc** - distance between two 3D curves;
7254 * **xdistcc2ds** - distance between 3d curve and 2d curve on surface;
7255 * **xdistc2dc2dss** - distance between two 2d curves on surface.
7262 xdistcs c_1 s1 0 1 100
7263 xdistcc2ds c_1 c2d2_1 s2 0 1
7264 xdistc2dc2dss c2d1_1 c2d2_1 s1 s2 0 1 1000
7268 @subsection occt_draw_7_10 Surface creation
7270 Surface creation commands include surfaces created from boundaries and from spaces between shapes.
7271 * **gplate** creates a surface from a boundary definition.
7272 * **filling** creates a surface from a group of surfaces.
7274 @subsubsection occt_draw_7_10_1 gplate,
7278 gplate result nbrcurfront nbrpntconst [SurfInit] [edge 0] [edge tang (1:G1;2:G2) surf]...[point] [u v tang (1:G1;2:G2) surf] ...
7281 Creates a surface from a defined boundary. The boundary can be defined using edges, points, or other surfaces.
7289 beziercurve c1 3 0 0 0 1 0 1 2 0 0
7295 trotate e3 0 0 0 0 0 1 90
7298 # create the surface
7299 gplate r1 4 0 p e1 0 e2 0 e3 0 e4 0
7301 ======== Results ===========
7302 DistMax=8.50014503228635e-16
7304 Calculation time: 0.33
7306 Approximation results
7307 Approximation error : 2.06274907619957e-13
7308 Criterium error : 4.97600631215754e-14
7310 #to create a surface defined by edges and passing through a point
7311 # to define the border edges and the point
7316 beziercurve c1 3 0 0 0 1 0 1 2 0 0
7322 trotate e3 0 0 0 0 0 1 90
7327 # to create the surface
7328 gplate r2 4 1 p e1 0 e2 0 e3 0 e4 0 pp
7330 ======== Results ===========
7331 DistMax=3.65622157610934e-06
7333 Calculculation time: 0.27
7335 Approximation results
7336 Approximation error : 0.000422195884750181
7337 Criterium error : 3.43709808053967e-05
7340 @subsubsection occt_draw_7_10_2 filling, fillingparam
7344 filling result nbB nbC nbP [SurfInit] [edge][face]order...
7345 edge[face]order... point/u v face order...
7348 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.
7350 To define the surface border:
7352 * enter the number of edges, constraints, and points
7353 * enumerate the edges, constraints and points
7355 The surface can pass through other points. These are defined after the border definition.
7357 You can use the *fillingparam* command to access the filling parameters.
7361 * <i>-l</i> : to list current values
7362 * <i>-i</i> : to set default values
7363 * <i>-rdeg nbPonC nbIt anis </i> : to set filling options
7364 * <i>-c t2d t3d tang tcur </i> : to set tolerances
7365 * <i>-a maxdeg maxseg </i> : Approximation option
7369 # to create four curved survaces and a point
7374 beziercurve c1 3 0 0 0 1 0 1 2 0 0
7380 trotate e3 0 0 0 0 0 1 90
7391 # to create a tangential surface
7392 filling r1 4 0 0 p e1 f1 1 e2 f2 1 e3 f3 1 e4 f4 1
7393 # to create a tangential surface passing through point pp
7394 filling r2 4 0 1 p e1 f1 1 e2 f2 1 e3 f3 1 e4 f4 1 pp#
7395 # to visualise the surface in detail
7397 # to display the current filling parameters
7414 @subsection occt_draw_7_11 Complex Topology
7416 Complex topology is the group of commands that modify the topology of shapes. This includes feature modeling.
7419 @subsubsection occt_draw_7_11_1 offsetshape, offsetcompshape
7423 offsetshape r shape offset [tol] [face ...]
7424 offsetcompshape r shape offset [face ...]
7427 **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.
7429 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.
7431 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.
7433 The opening between the object interior and exterior is defined by the argument face or faces.
7439 == b1_1 b1_2 b1_3 b1_4 b1_5 b1_6
7440 offsetcompshape r b1 -1 b1_3
7443 @subsubsection occt_draw_7_11_2 featprism, featdprism, featrevol, featlf, featrf
7447 featprism shape element skface Dirx Diry Dirz Fuse(0/1/2) Modify(0/1)
7448 featdprism shape face skface angle Fuse(0/1/2) Modify(0/1)
7449 featrevol shape element skface Ox Oy Oz Dx Dy Dz Fuse(0/1/2) Modify(0/1)
7450 featlf shape wire plane DirX DirY DirZ DirX DirY DirZ Fuse(0/1/2) Modify(0/1)
7451 featrf shape wire plane X Y Z DirX DirY DirZ Size Size Fuse(0/1/2) Modify(0/1)
7452 featperform prism/revol/pipe/dprism/lf result [[Ffrom] Funtil]
7453 featperformval prism/revol/dprism/lf result value
7456 **featprism** loads the arguments for a prism with contiguous sides normal to the face.
7458 **featdprism** loads the arguments for a prism which is created in a direction normal to the face and includes a draft angle.
7460 **featrevol** loads the arguments for a prism with a circular evolution.
7462 **featlf** loads the arguments for a linear rib or slot. This feature uses planar faces and a wire as a guideline.
7464 **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.
7466 **featperform** loads the arguments to create the feature.
7468 **featperformval** uses the defined arguments to create a feature with a limiting value.
7470 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.
7474 Let us create a feature prism with a draft angle and a normal direction :
7477 # create a box with a wire contour on the upper face
7479 profil f O 0 0 1 F 0.25 0.25 x 0.5 y 0.5 x -0.5
7481 # loads the feature arguments defining the draft angle
7482 featdprism b f b_6 5 1 0
7483 # create the feature
7484 featperformval dprism r 1
7485 ==BRepFeat_MakeDPrism::Perform(Height)
7486 BRepFeat_Form::GlobalPerform ()
7492 Let us create a feature prism with circular direction :
7495 # create a box with a wire contour on the upper face
7497 profil f O 0 0 1 F 0.25 0.25 x 0.5 y 0.5 x -0.5
7499 # loads the feature arguments defining a rotation axis
7500 featrevol b f b_6 1 0 1 0 1 0 1 0
7501 featperformval revol r 45
7502 ==BRepFeat_MakeRevol::Perform(Angle)
7503 BRepFeat_Form::GlobalPerform ()
7510 Let us create a slot using the linear feature :
7513 #create the base model using the multi viewer
7515 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
7517 # create the contour for the linear feature
7518 vertex v1 -0.2 4 0.3
7520 vertex v3 0.2 0.2 0.3
7522 vertex v5 4 -0.2 0.3
7529 plane pl 0.2 0.2 0.3 0 0 1
7530 # loads the linear feature arguments
7531 featlf pr w pl 0 0 0.3 0 0 0 0 1
7532 featperform lf result
7535 Let us create a rib using the revolution feature :
7538 #create the base model using the multi viewer
7541 # create the contour for the revolution feature
7542 profile w c 1 190 WW
7543 trotate w 0 0 0 1 0 0 90
7545 trotate w -3 0 1.5 0 0 1 180
7546 plane pl -3 0 1.5 0 1 0
7547 # loads the revolution feature arguments
7548 featrf c1 w pl 0 0 0 0 0 1 0.3 0.3 1 1
7549 featperform rf result
7552 @subsubsection occt_draw_7_11_3 draft
7556 draft result shape dirx diry dirz angle shape/surf/length [-IN/-OUT] [Ri/Ro] [-Internal]
7559 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.
7561 * The draft angle is measured in radians.
7562 * The draft direction is determined by the argument -INTERNAL
7563 * The argument Ri/Ro deftermines wether the corner edges of the draft surfaces are angular or rounded.
7564 * Arguments that can be used to define the surface distance are:
7565 * length, a defined distance
7566 * shape, until the surface contacts a shape
7567 * surface, until the surface contacts a surface.
7569 **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.
7573 # to create a simple profile
7574 profile p F 0 0 x 2 y 4 tt 0 4 w
7575 # creates a draft with rounded angles
7576 draft res p 0 0 1 3 1 -Ro
7577 # to create a profile with an internal angle
7578 profile p F 0 0 x 2 y 4 tt 1 1.5 tt 0 4 w
7579 # creates a draft with rounded external angles
7580 draft res p 0 0 1 3 1 -Ro
7583 @subsubsection occt_draw_7_11_4 deform
7587 deform newname name CoeffX CoeffY CoeffZ
7590 Modifies the shape using the x, y, and z coefficients. You can reduce or magnify the shape in the x,y, and z directions.
7596 # the conversion to bspline is followed by the
7601 @subsubsection occt_draw_7_11_5 nurbsconvert
7606 nurbsconvert result name [result name]
7609 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.
7612 @subsection occt_draw_7_12 Texture Mapping to a Shape
7614 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.
7616 @subsubsection occt_draw_7_12_1 vtexture
7620 vtexture NameOfShape TextureFile
7621 vtexture NameOfShape
7622 vtexture NameOfShape ?
7623 vtexture NameOfShape IdOfTexture
7626 **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.
7628 @subsubsection occt_draw_7_12_2 vtexscale
7632 vtexscale NameOfShape ScaleU ScaleV
7633 vtexscale NameOfShape ScaleUV
7634 vtexscale NameOfShape
7637 *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.
7639 The syntax without *ScaleU*, *ScaleV* or *ScaleUV* disables texture scaling.
7641 @subsubsection occt_draw_7_12_3 vtexorigin
7645 vtexorigin NameOfShape UOrigin VOrigin
7646 vtexorigin NameOfShape UVOrigin
7647 vtexorigin NameOfShape
7650 *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.
7652 The syntax without *UOrigin*, *VOrigin* or *UVOrigin* disables origin positioning.
7654 @subsubsection occt_draw_7_12_4 vtexrepeat
7658 vtexrepeat NameOfShape URepeat VRepeat
7659 vtexrepeat NameOfShape UVRepeat
7660 vtexrepeat NameOfShape
7663 *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.
7665 The same syntax without *URepeat*, *VRepeat* or *UVRepeat* disables texture repetition.
7667 @subsubsection occt_draw_7_12_5 vtexdefault
7671 vtexdefault NameOfShape
7674 *Vtexdefault* sets or resets the texture mapping default parameters.
7678 * *URepeat = VRepeat = 1* no repetition
7679 * *UOrigin = VOrigin = 1* origin set at (0,0)
7680 * *UScale = VScale = 1* texture covers 100% of the face
7683 @section occt_draw_20 General Fuse Algorithm commands
7685 This chapter describes existing commands of Open CASCADE Draw Test Harness that are used for debugging of General Fuse Algorithm (GFA). It is also applicable for Boolean Operations Algorithm (BOA) and Partition Algorithm (PA) because these algorithms are subclasses of GFA.
7687 See @ref occt_user_guides__boolean_operations "Boolean operations" user's guide for the description of these algorithms.
7689 @subsection occt_draw_20_1 Definitions
7691 The following terms and definitions are used in this document:
7692 * **Objects** – list of shapes that are arguments of the algorithm.
7693 * **Tools** – list of shapes that are arguments of the algorithm. Difference between Objects and Tools is defined by specific requirements of the operations (Boolean Operations, Partition Operation).
7694 * **DS** – internal data structure used by the algorithm (*BOPDS_DS* object).
7695 * **PaveFiller** – intersection part of the algorithm (*BOPAlgo_PaveFiller* object).
7696 * **Builder** – builder part of the algorithm (*BOPAlgo_Builder* object).
7697 * **IDS Index** – the index of the vector *myLines*.
7699 @subsection occt_draw_20_2 General commands
7701 * **bclearobjects** - clears the list of Objects;
7702 * **bcleartools** - clears the list of Tools;
7703 * **baddobjects** *S1 S2...Sn* - adds shapes *S1, S2, ... Sn* as Objects;
7704 * **baddtools** *S1 S2...Sn* - adds shapes *S1, S2, ... Sn* as Tools;
7705 * **bfillds** - performs the Intersection Part of the Algorithm;
7706 * **bbuild** *r* - performs the Building Part of the Algorithm; *r* is the resulting shape.
7708 @subsection occt_draw_20_3 Commands for Intersection Part
7710 All commands listed below are available when the Intersection Part of the algorithm is done (i.e. after the command *bfillds*).
7712 @subsubsection occt_draw_20_3_1 bopds
7720 * all BRep shapes of arguments that are in the DS [default];
7721 * <i>–v</i> : only vertices of arguments that are in the DS;
7722 * <i>–e</i> : only edges of arguments that are in the DS;
7723 * <i>–f</i> : only faces of arguments that are in the DS.
7725 @subsubsection occt_draw_20_3_2 bopdsdump
7727 Prints contents of the DS.
7734 Ranges:2 number of ranges
7735 range: 0 33 indices for range 1
7736 range: 34 67 indices for range 2
7737 Shapes:68 total number of source shapes
7739 1 : SHELL { 2 12 22 26 30 32 }
7740 2 : FACE { 4 5 6 7 8 9 10 11 }
7741 3 : WIRE { 4 7 9 11 }
7749 @code 0 : SOLID { 1 } @endcode has the following meaning:
7750 * *0* – index in the DS;
7751 * *SOLID* – type of the shape;
7752 * <i>{ 1 }</i> – a DS index of the successors.
7754 @subsubsection occt_draw_20_3_3 bopindex
7760 Prints DS index of shape *S*.
7762 @subsubsection occt_draw_20_3_4 bopiterator
7769 Prints pairs of DS indices of source shapes that are intersected in terms of bounding boxes.
7771 <i>[t1 t2]</i> are types of the shapes:
7778 Draw[104]> bopiterator 6 4
7787 * *bopiterator 6 4* prints pairs of indices for types: edge/face;
7788 * *z58 z12* - DS indices of intersecting edge and face.
7791 @subsubsection occt_draw_20_3_5 bopinterf
7798 Prints contents of *myInterfTB* for the type of interference *t*:
7799 * *t=0* : vertex/vertex;
7800 * *t=1* : vertex/edge;
7801 * *t=2* : edge/edge;
7802 * *t=3* : vertex/face;
7803 * *t=4* : edge/face.
7807 Draw[108]> bopinterf 4
7808 EF: (58, 12, 68), (17, 56, 69), (19, 64, 70), (45, 26, 71), (29, 36, 72), (38, 32, 73), 6 EF found.
7811 Here, record <i>(58, 12, 68)</i> means:
7812 * *58* – a DS index of the edge;
7813 * *12* – a DS index of the face;
7814 * *68* – a DS index of the new vertex.
7816 @subsubsection occt_draw_20_3_6 bopsp
7818 Displays split edges.
7823 edge 58 : z58_74 z58_75
7824 edge 17 : z17_76 z17_77
7825 edge 19 : z19_78 z19_79
7826 edge 45 : z45_80 z45_81
7827 edge 29 : z29_82 z29_83
7828 edge 38 : z38_84 z38_85
7831 * *edge 58* – 58 is a DS index of the original edge.
7832 * *z58_74 z58_75* – split edges, where 74, 75 are DS indices of the split edges.
7834 @subsubsection occt_draw_20_3_7 bopcb
7841 Prints Common Blocks for:
7842 * all source edges (by default);
7843 * the source edge with the specified index *nE*.
7849 PB:{ E:71 orE:17 Pave1: { 68 3.000 } Pave2: { 18 10.000 } }
7853 This command dumps common blocks for the source edge with index 17.
7854 * *PB* – information about the Pave Block;
7855 * *71* – a DS index of the split edge
7856 * *17* – a DS index of the original edge
7857 * <i>Pave1 : { 68 3.000 }</i> – information about the Pave:
7858 * *68* – a DS index of the vertex of the pave
7859 * *3.000* – a parameter of vertex 68 on edge 17
7860 * *Faces: 36* – 36 is a DS index of the face the common block belongs to.
7863 @subsubsection occt_draw_20_3_8 bopfin
7870 Prints Face Info about IN-parts for the face with DS index *nF*.
7876 PB:{ E:71 orE:17 Pave1: { 68 3.000 } Pave2: { 18 10.000 } }
7877 PB:{ E:75 orE:19 Pave1: { 69 3.000 } Pave2: { 18 10.000 } }
7883 * <i>PB:{ E:71 orE:17 Pave1: { 68 3.000 } Pave2: { 18 10.000 } }</i> – information about the Pave Block;
7884 * <i>vrts In ... 18 – 18</i> a DS index of the vertex IN the face.
7886 @subsubsection occt_draw_20_3_9 bopfon
7892 Print Face Info about ON-parts for the face with DS index *nF*.
7898 PB:{ E:72 orE:38 Pave1: { 69 0.000 } Pave2: { 68 10.000 } }
7899 PB:{ E:76 orE:45 Pave1: { 69 0.000 } Pave2: { 71 10.000 } }
7900 PB:{ E:78 orE:43 Pave1: { 71 0.000 } Pave2: { 70 10.000 } }
7901 PB:{ E:74 orE:41 Pave1: { 68 0.000 } Pave2: { 70 10.000 } }
7906 * <i>PB:{ E:72 orE:38 Pave1: { 69 0.000 } Pave2: { 68 10.000 } }</i> – information about the Pave Block;
7907 * <i>vrts On: ... 68 69 70 71 – 68, 69, 70, 71 </i> DS indices of the vertices ON the face.
7909 @subsubsection occt_draw_20_3_10 bopwho
7916 Prints the information about the shape with DS index *nF*.
7924 * *rank: 0* – means that shape 5 results from the Argument with index 0.
7928 Draw[118]> bopwho 68
7931 FF curves: (12, 56),
7932 FF curves: (12, 64),
7935 This means that shape 68 is a result of the following interferences:
7936 * *EF: (58, 12)* – edge 58 / face 12
7937 * *FF curves: (12, 56)* – edge from the intersection curve between faces 12 and 56
7938 * *FF curves: (12, 64)* – edge from the intersection curve between faces 12 and 64
7940 @subsubsection occt_draw_20_3_11 bopnews
7947 * <i>-v</i> - displays all new vertices produced during the operation;
7948 * <i>-e</i> - displays all new edges produced during the operation.
7950 @subsection occt_draw_20_4 Commands for the Building Part
7952 The commands listed below are available when the Building Part of the algorithm is done (i.e. after the command *bbuild*).
7954 @subsubsection occt_draw_20_4_1 bopim
7961 Shows the compound of shapes that are images of shape *S* from the argument.
7964 @section occt_draw_8 Data Exchange commands
7966 This chapter presents some general information about Data Exchange (DE) operations.
7968 DE commands are intended for translation files of various formats (IGES,STEP) into OCCT shapes with their attributes (colors, layers etc.)
7970 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
7971 * for <a href="user_guides__step.html#occt_step_1">STEP format</a> and
7972 * for <a href="user_guides__iges.html#occt_iges_1">IGES format</a>.
7974 Each Draw session has an interface model, which is a structure for keeping various information.
7976 The first step of translation is loading information from a file into a model.
7977 The second step is creation of an OpenCASCADE shape from this model.
7979 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.
7981 The model and the map are used for working with most of DE commands.
7983 @subsection occt_draw_8_1 IGES commands
7985 @subsubsection occt_draw_8_1_1 igesread
7989 igesread <file_name> <result_shape_name> [<selection>]
7992 Reads an IGES file to an OCCT shape. This command will interactively ask the user to select a set of entities to be converted.
7995 | N | Mode | Description |
7996 | :-- | :-- | :---------- |
7997 | 0 | End | finish conversion and exit igesbrep |
7998 | 1 | Visible roots | convert only visible roots |
7999 | 2 | All roots | convert all roots |
8000 | 3 | One entity | convert entity with number provided by the user |
8001 | 4 | Selection | convert only entities contained in selection |
8004 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.
8006 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*.
8008 <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.
8010 See also the detailed description of <a href="user_guides__iges.html#occt_iges_2_3_4">Selecting IGES entities</a>.
8014 # translation all roots from file
8015 igesread /disk01/files/model.igs a *
8018 @subsubsection occt_draw_8_1_2 tplosttrim
8022 tplosttrim [<IGES_type>]
8025 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.
8026 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.
8027 Optional parameter <i>\<IGES_type\></i> can be *0TrimmedSurface, BoundedSurface* or *Face* to specify the only type of IGES faces.
8031 tplosttrim TrimmedSurface
8034 @subsubsection occt_draw_8_1_3 brepiges
8038 brepiges <shape_name> <filename.igs>
8041 Writes an OCCT shape to an IGES file.
8045 # write shape with name aa to IGES file
8046 brepiges aa /disk1/tmp/aaa.igs
8047 == unit (write) : MM
8048 == mode write : Faces
8049 == To modifiy : command param
8050 == 1 Shapes written, giving 345 Entities
8051 == Now, to write a file, command : writeall filename
8052 == Output on file : /disk1/tmp/aaa.igs
8056 @subsection occt_draw_8_2 STEP commands
8058 These commands are used during the translation of STEP models.
8061 @subsubsection occt_draw_8_2_1 stepread
8065 stepread file_name result_shape_name [selection]
8068 Read a STEP file to an OCCT shape.
8069 This command will interactively ask the user to select a set of entities to be converted:
8071 | N | Mode | Description |
8072 | :---- | :---- | :---- |
8073 | 0 | End | Finish transfer and exit stepread |
8074 | 1 | root with rank 1 | Transfer first root |
8075 | 2 | root by its rank | Transfer root specified by its rank |
8076 | 3 | One entity | Transfer entity with a number provided by the user |
8077 | 4 | Selection | Transfer only entities contained in selection |
8079 After the selected set of entities is loaded the user will be asked how loaded entities should be converted into OCCT shapes.
8080 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*.
8081 <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.
8083 See also the detailed description of <a href="user_guides__step.html#occt_step_2_3_6">Selecting STEP entities</a>.
8087 # translation all roots from file
8088 stepread /disk01/files/model.stp a *
8091 @subsubsection occt_draw_8_2_2 stepwrite
8095 stepwrite mode shape_name file_name
8098 Writes an OCCT shape to a STEP file.
8100 The following modes are available :
8101 * *a* - as is – mode is selected automatically depending on the type & geometry of the shape;
8102 * *m* - *manifold_solid_brep* or *brep_with_voids*
8103 * *f* - *faceted_brep*
8104 * *w* - *geometric_curve_set*
8105 * *s* - *shell_based_surface_model*
8107 For further information see <a href="#user_guides__step.html#occt_step_6_5">Writing a STEP file</a>.
8111 Let us write shape *a* to a STEP file in mode *0*.
8114 stepwrite 0 a /disk1/tmp/aaa.igs
8118 @subsection occt_draw_8_3 General commands
8120 These are auxilary commands used for the analysis of result of translation of IGES and STEP files.
8122 @subsubsection occt_draw_8_3_1 count
8126 count <counter> [<selection>]
8129 Calculates statistics on the entities in the model and outputs a count of entities.
8131 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.
8133 | Counter | Operation |
8134 | :-------- | :-------- |
8135 | xst-types | Calculates how many entities of each OCCT type exist |
8136 | step214-types | Calculates how many entities of each STEP type exist |
8143 @subsubsection occt_draw_8_3_2 data
8150 Obtains general statistics on the loaded data.
8151 The information printed by this command depends on the symbol specified.
8155 # print full information about warnings and fails
8160 | :------ | :------ |
8161 | g | Prints the information contained in the header of the file |
8162 | 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) |
8163 | t | The same as c or f, with a list of failed or warned entities |
8164 | m or l | The same as t but also prints a status for each entity |
8165 | e | Lists all entities of the model with their numbers, types, validity status etc. |
8166 | R | The same as e but lists only root entities |
8170 @subsubsection occt_draw_8_3_3 elabel
8177 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.
8184 @subsubsection occt_draw_8_3_4 entity
8188 entity <#(D)>_or_<num> <level_of_information>
8191 The content of an IGES or STEP entity can be obtained by using this command.
8192 Entity can be determined by its number or label.
8193 <i>\<level_of_information\></i> has range [0-6]. You can get more information about this level using this command without parameters.
8197 # full information for STEP entity with label 84
8201 @subsubsection occt_draw_8_3_5 enum
8208 Prints a number for the entity with a given label.
8212 # give a number for IGES entity with label 21
8216 @subsubsection occt_draw_8_3_6 estatus
8220 estatus <#(D)>_or_<num>
8223 The list of entities referenced by a given entity and the list of entities referencing to it can be obtained by this command.
8230 @subsubsection occt_draw_8_3_7 fromshape
8234 fromshape <shape_name>
8237 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.
8244 @subsubsection occt_draw_8_3_8 givecount
8248 givecount <selection_name> [<selection_name>]
8252 Prints a number of loaded entities defined by the selection argument.
8253 Possible values of \<selection_name\> you can find in the “IGES FORMAT Users’s Guide”.
8257 givecount xst-model-roots
8260 @subsubsection occt_draw_8_3_9 givelist
8264 givelist <selection_name>
8267 Prints a list of a subset of loaded entities defined by the selection argument:
8268 | Selection | Description |
8269 | :-------- | :----------- |
8270 | xst-model-all | all entities of the model |
8271 | xst-model-roots | all roots |
8272 | xst-pointed | (Interactively) pointed entities (not used in DRAW) |
8273 | xst-transferrable-all | all transferable (recognized) entities |
8274 | xst-transferrable-roots | Transferable roots |
8279 # give a list of all entities of the model
8280 givelist xst-model-all
8283 @subsubsection occt_draw_8_3_10 listcount
8285 Syntax: listcount \<counter\> [\<selection\> ...]
8287 Prints a list of entities per each type matching the criteria defined by arguments.
8288 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:
8290 | Counter | Operation |
8291 | :----- | :------ |
8292 | xst-types | Calculates how many entities of each OCCT type exist |
8293 | iges-types | Calculates how many entities of each IGES type and form exist |
8294 | iges-levels | Calculates how many entities lie in different IGES levels |
8301 @subsubsection occt_draw_8_3_11 listitems
8308 This command prints a list of objects (counters, selections etc.) defined in the current session.
8311 @subsubsection occt_draw_8_3_12 listtypes
8315 listtypes [<selection_name> ...]
8318 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.
8321 @subsubsection occt_draw_8_3_13 newmodel
8328 Clears the current model.
8331 @subsubsection occt_draw_8_3_14 param
8335 param [<parameter>] [<value>]
8338 This command is used to manage translation parameters.
8339 Command without arguments gives a full list of parameters with current values.
8340 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>.
8344 Let us get the information about possible schemes for writing STEP file :
8347 param write.step.schema
8350 @subsubsection occt_draw_8_3_15 sumcount
8354 sumcount <counter> [<selection> ...]
8357 Prints only a number of entities per each type matching the criteria defined by arguments.
8364 @subsubsection occt_draw_8_3_16 tpclear
8371 Clears the map of correspondences between IGES or STEP entities and OCCT shapes.
8375 @subsubsection occt_draw_8_3_17 tpdraw
8379 tpdraw <#(D)>_or_<num>
8387 @subsubsection occt_draw_8_3_18 tpent
8391 tpent <#(D)>_or_<num>
8394 Get information about the result of translation of the given IGES or STEP entity.
8401 @subsubsection occt_draw_8_3_19 tpstat
8405 tpstat [*|?]<symbol> [<selection>]
8409 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:
8411 * *g* - General statistics (a list of results and messages)
8412 * *c* - Count of all warning and fail messages
8413 * *C* - List of all warning and fail messages
8414 * *f* - Count of all fail messages
8415 * *F* - List of all fail messages
8416 * *n* - List of all transferred roots
8417 * *s* - The same, with types of source entity and the type of result
8418 * *b* - The same, with messages
8419 * *t* - Count of roots for geometrical types
8420 * *r* - Count of roots for topological types
8421 * *l* - The same, with the type of the source entity
8423 The sign \* before parameters *n, s, b, t, r* makes it work on all entities (not only on roots).
8425 The sign ? before *n, s, b, t* limits the scope of information to invalid entities.
8427 Optional argument \<selection\> can limit the action of the command to the selection, not to all entities.
8429 To get help, run this command without arguments.
8433 # translation ratio on IGES faces
8434 tpstat *l iges-faces
8437 @subsubsection occt_draw_8_3_20 xload
8444 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.
8448 xload /disk1/tmp/aaa.stp
8452 @subsection occt_draw_8_4 Overview of XDE commands
8454 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:
8455 * XDE translation commands
8456 * XDE general commands
8457 * XDE shape’s commands
8458 * XDE color’s commands
8459 * XDE layer’s commands
8460 * XDE property’s commands
8462 Reminding: All operations of translation are performed with parameters managed by command <a href="#occt_draw_8_3_14">the command *param*</a>.
8464 @subsubsection occt_draw_8_4_1 ReadIges
8468 ReadIges document file_name
8471 Reads information from an IGES file to an XCAF document.
8475 ReadIges D /disk1/tmp/aaa.igs
8476 ==> Document saved with name D
8479 @subsubsection occt_draw_8_4_2 ReadStep
8483 ReadStep <document> <file_name>
8486 Reads information from a STEP file to an XCAF document.
8490 ReadStep D /disk1/tmp/aaa.stp
8491 == Document saved with name D
8494 @subsubsection occt_draw_8_4_3 WriteIges
8498 WriteIges <document> <file_name>
8503 WriteIges D /disk1/tmp/aaa.igs
8506 @subsubsection occt_draw_8_4_4 WriteStep
8510 WriteStep <document> <file_name>
8513 Writes information from an XCAF document to a STEP file.
8517 WriteStep D /disk1/tmp/aaa.stp
8520 @subsubsection occt_draw_8_4_5 XFileCur
8527 Returns the name of file which is set as the current one in the Draw session.
8535 @subsubsection occt_draw_8_4_6 XFileList
8542 Returns a list all files that were transferred by the last transfer. This command is meant (assigned) for the assemble step file.
8547 ==> *as1-ct-Bolt.stp*
8548 ==> *as1-ct-L-Bracktet.stp*
8549 ==> *as1-ct-LBA.stp*
8550 ==> *as1-ct-NBA.stp*
8554 @subsubsection occt_draw_8_4_7 XFileSet
8561 Sets the current file taking it from the components list of the assemble file.
8565 XFileSet as1-ct-NBA.stp
8568 @subsubsection occt_draw_8_4_8 XFromShape
8575 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.
8580 ==> Shape a: imported from entity 217:#26 in file as1-ct-Nut.stp
8583 @subsection occt_draw_8_5 XDE general commands
8585 @subsubsection occt_draw_8_5_1 XNewDoc
8592 Creates a new XCAF document.
8599 @subsubsection occt_draw_8_5_2 XShow
8603 XShow <document> [ <label1> … ]
8606 Shows a shape from a given label in the 3D viewer. If the label is not given – shows all shapes from the document.
8610 # show shape from label 0:1:1:4 from document D
8614 @subsubsection occt_draw_8_5_3 XStat
8621 Prints common information from an XCAF document.
8626 ==>Statistis of shapes in the document:
8630 ==>Total number of labels for shapes in the document = 32
8631 ==>Number of labels with name = 27
8632 ==>Number of labels with color link = 3
8633 ==Number of labels with layer link = 0
8634 ==>Statistis of Props in the document:
8635 ==>Number of Centroid Props = 5
8636 ==>Number of Volume Props = 5
8637 ==>Number of Area Props = 5
8638 ==>Number of colors = 4
8639 ==>BLUE1 RED YELLOW BLUE2
8640 ==>Number of layers = 0
8643 @subsubsection occt_draw_8_5_4 XWdump
8647 XWdump <document> <filename>
8650 Saves the contents of the viewer window as an image (XWD, png or BMP file).
8651 <i>\<filename\></i> must have a corresponding extention.
8655 XWdump D /disk1/tmp/image.png
8658 @subsubsection occt_draw_8_5_5 Xdump
8662 Xdump <document> [int deep {0|1}]
8665 Prints information about the tree structure of the document. If parameter 1 is given, then the tree is printed with a link to shapes.
8670 ==> ASSEMBLY 0:1:1:1 L-BRACKET(0xe8180448)
8671 ==> ASSEMBLY 0:1:1:2 NUT(0xe82151e8)
8672 ==> ASSEMBLY 0:1:1:3 BOLT(0xe829b000)
8673 ==> ASSEMBLY 0:1:1:4 PLATE(0xe8387780)
8674 ==> ASSEMBLY 0:1:1:5 ROD(0xe8475418)
8675 ==> ASSEMBLY 0:1:1:6 AS1(0xe8476968)
8676 ==> ASSEMBLY 0:1:1:7 L-BRACKET-ASSEMBLY(0xe8476230)
8677 ==> ASSEMBLY 0:1:1:1 L-BRACKET(0xe8180448)
8678 ==> ASSEMBLY 0:1:1:8 NUT-BOLT-ASSEMBLY(0xe8475ec0)
8679 ==> ASSEMBLY 0:1:1:2 NUT(0xe82151e8)
8680 ==> ASSEMBLY 0:1:1:3 BOLT(0xe829b000)
8684 @subsection occt_draw_8_6 XDE shape commands
8686 @subsubsection occt_draw_8_6_1 XAddComponent
8690 XAddComponent <document> <label> <shape>
8693 Adds a component shape to assembly.
8697 Let us add shape b as component shape to assembly shape from label *0:1:1:1*
8700 XAddComponent D 0:1:1:1 b
8703 @subsubsection occt_draw_8_6_2 XAddShape
8707 XAddShape <document> <shape> [makeassembly=1]
8710 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.
8714 # add shape b to document D
8717 # if pointed shape is compound and last parameter in
8718 # XAddShape command is used by default (1), then for
8719 # each subshapes new label is created
8722 @subsubsection occt_draw_8_6_3 XFindComponent
8726 XFindComponent <document> <shape>
8729 Prints a sequence of labels of the assembly path.
8736 @subsubsection occt_draw_8_6_4 XFindShape
8740 XFindShape <document> <shape>
8743 Finds and prints a label with an indicated top-level shape.
8750 @subsubsection occt_draw_8_6_5 XGetFreeShapes
8754 XGetFreeShapes <document> [shape_prefix]
8757 Print labels or create DRAW shapes for all free shapes in the document.
8758 If *shape_prefix* is absent – prints labels, else – creates DRAW shapes with names
8759 <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).
8761 **Note**: a free shape is a shape to which no other shape refers to.
8766 == 0:1:1:6 0:1:1:10 0:1:1:12 0:1:1:13
8769 == sh_1 sh_2 sh_3 sh_4
8772 @subsubsection occt_draw_8_6_6 XGetOneShape
8776 XGetOneShape <shape> <document>
8779 Creates one DRAW shape for all free shapes from a document.
8786 @subsubsection occt_draw_8_6_7 XGetReferredShape
8790 XGetReferredShape <document> <label>
8793 Prints a label that contains a top-level shape that corresponds to a shape at a given label.
8797 XGetReferredShape D 0:1:1:1:1
8800 @subsubsection occt_draw_8_6_8 XGetShape
8804 XGetShape <result> <document> <label>
8807 Puts a shape from the indicated label in document to result.
8811 XGetShape b D 0:1:1:3
8814 @subsubsection occt_draw_8_6_9 XGetTopLevelShapes
8818 XGetTopLevelShapes <document>
8821 Prints labels that contain top-level shapes.
8825 XGetTopLevelShapes D
8826 == 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
8830 @subsubsection occt_draw_8_6_10 XLabelInfo
8834 XLabelInfo <document> <label>
8837 Prints information about a shape, stored at an indicated label.
8841 XLabelInfo D 0:1:1:6
8842 ==> There are TopLevel shapes. There is an Assembly. This Shape is not used.
8845 @subsubsection occt_draw_8_6_11 XNewShape
8849 XNewShape <document>
8852 Creates a new empty top-level shape.
8859 @subsubsection occt_draw_8_6_12 XRemoveComponent
8863 XRemoveComponent <document> <label>
8866 Removes a component from the components label.
8870 XRemoveComponent D 0:1:1:1:1
8873 @subsubsection occt_draw_8_6_13 XRemoveShape
8877 XRemoveShape <document> <label>
8880 Removes a shape from a document (by it’s label).
8884 XRemoveShape D 0:1:1:2
8887 @subsubsection occt_draw_8_6_14 XSetShape
8891 XSetShape <document> <label> <shape>
8894 Sets a shape at the indicated label.
8898 XSetShape D 0:1:1:3 b
8902 @subsection occt_draw_8_7_ XDE color commands
8904 @subsubsection occt_draw_8_7_1 XAddColor
8908 XAddColor <document> <R> <G> <B>
8911 Adds color in document to the color table. Parameters R,G,B are real.
8915 XAddColor D 0.5 0.25 0.25
8918 @subsubsection occt_draw_8_7_2 XFindColor
8922 XFindColor <document> <R> <G> <B>
8925 Finds a label where the indicated color is situated.
8929 XFindColor D 0.25 0.25 0.5
8933 @subsubsection occt_draw_8_7_3 XGetAllColors
8937 XGetAllColors <document>
8940 Prints all colors that are defined in the document.
8945 ==> RED DARKORANGE BLUE1 GREEN YELLOW3
8948 @subsubsection occt_draw_8_7_4 XGetColor
8952 XGetColor <document> <label>
8955 Returns a color defined at the indicated label from the color table.
8963 @subsubsection occt_draw_8_7_5 XGetObjVisibility
8967 XGetObjVisibility <document> {<label>|<shape>}
8970 Returns the visibility of a shape.
8974 XGetObjVisibility D 0:1:1:4
8977 @subsubsection occt_draw_8_7_6 XGetShapeColor
8981 XGetShapeColor <document> <label> <colortype(s|c)>
8984 Returns the color defined by label. If <i>colortype</i>=’s’ – returns surface color, else – returns curve color.
8988 XGetShapeColor D 0:1:1:4 c
8991 @subsubsection occt_draw_8_7_7 XRemoveColor
8995 XRemoveColor <document> <label>
8998 Removes a color from the color table in a document.
9002 XRemoveColor D 0:1:2:1
9005 @subsubsection occt_draw_8_7_8 XSetColor
9009 XSetColor <document> {<label>|<shape>} <R> <G> <B>
9012 Sets an RGB color to a shape given by label.
9016 XsetColor D 0:1:1:4 0.5 0.5 0.
9019 @subsubsection occt_draw_8_7_9 XSetObjVisibility
9023 XSetObjVisibility <document> {<label>|<shape>} {0|1}
9026 Sets the visibility of a shape.
9030 # set shape from label 0:1:1:4 as invisible
9031 XSetObjVisibility D 0:1:1:4 0
9034 @subsubsection occt_draw_8_7_10 XUnsetColor
9038 XUnsetColor <document> {<label>|<shape>} <colortype>
9041 Unset a color given type (‘s’ or ‘c’) for the indicated shape.
9045 XUnsetColor D 0:1:1:4 s
9049 @subsection occt_draw_8_8_ XDE layer commands
9051 @subsubsection occt_draw_8_8_1 XAddLayer
9055 XAddLayer <document> <layer>
9058 Adds a new layer in an XCAF document.
9065 @subsubsection occt_draw_8_8_2 XFindLayer
9069 XFindLayer <document> <layer>
9072 Prints a label where a layer is situated.
9080 @subsubsection occt_draw_8_8_3 XGetAllLayers
9084 XGetAllLayers <document>
9087 Prints all layers in an XCAF document.
9092 == *0:1:1:3* *Bolt* *0:1:1:9*
9095 @subsubsection occt_draw_8_8_4 XGetLayers
9099 XGetLayers <document> {<shape>|<label>}
9102 Returns names of layers, which are pointed to by links of an indicated shape.
9106 XGetLayers D 0:1:1:3
9110 @subsubsection occt_draw_8_8_5 XGetOneLayer
9114 XGetOneLayer <document> <label>
9117 Prints the name of a layer at a given label.
9121 XGetOneLayer D 0:1:3:2
9124 @subsubsection occt_draw_8_8_6 XIsVisible
9128 XIsVisible <document> {<label>|<layer>}
9131 Returns 1 if the indicated layer is visible, else returns 0.
9135 XIsVisible D 0:1:3:1
9138 @subsubsection occt_draw_8_8_7 XRemoveAllLayers
9142 XRemoveAllLayers <document>
9145 Removes all layers from an XCAF document.
9152 @subsubsection occt_draw_8_8_8 XRemoveLayer
9156 XRemoveLayer <document> {<label>|<layer>}
9159 Removes the indicated layer from an XCAF document.
9163 XRemoveLayer D layer2
9166 @subsubsection occt_draw_8_8_9 XSetLayer
9170 XSetLayer XSetLayer <document> {<shape>|<label>} <layer> [shape_in_one_layer {0|1}]
9174 Sets a reference between a shape and a layer (adds a layer if it is necessary).
9175 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).
9179 XSetLayer D 0:1:1:2 layer2
9182 @subsubsection occt_draw_8_8_10 XSetVisibility
9186 XSetVisibility <document> {<label>|<layer>} <isvisible {0|1}>
9189 Sets the visibility of a layer.
9193 # set layer at label 0:1:3:2 as invisible
9194 XSetVisibility D 0:1:3:2 0
9197 @subsubsection occt_draw_8_8_11 XUnSetAllLayers
9201 XUnSetAllLayers <document> {<label>|<shape>}
9204 Unsets a shape from all layers.
9208 XUnSetAllLayers D 0:1:1:2
9211 @subsubsection occt_draw_8_8_12 XUnSetLayer
9215 XUnSetLayer <document> {<label>|<shape>} <layer>
9218 Unsets a shape from the indicated layer.
9222 XUnSetLayer D 0:1:1:2 layer1
9225 @subsection occt_draw_8_9 XDE property commands
9227 @subsubsection occt_draw_8_9_1 XCheckProps
9231 XCheckProps <document> [ {0|deflection} [<shape>|<label>] ]
9234 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.
9238 # check properties for shapes at label 0:1:1:1 from
9239 # document using standard Open CASCADE Technology tools
9240 XCheckProps D 0 0:1:1:1
9241 == Label 0:1:1:1 ;L-BRACKET*
9242 == Area defect: -0.0 ( 0%)
9243 == Volume defect: 0.0 ( 0%)
9244 == CG defect: dX=-0.000, dY=0.000, dZ=0.000
9247 @subsubsection occt_draw_8_9_2 XGetArea
9251 XGetArea <document> {<shape>|<label>}
9254 Returns the area of a given shape.
9259 == 24628.31815094999
9262 @subsubsection occt_draw_8_9_3 XGetCentroid
9266 XGetCentroid <document> {<shape>|<label>}
9269 Returns the center of gravity coordinates of a given shape.
9273 XGetCentroid D 0:1:1:1
9276 @subsubsection occt_draw_8_9_4 XGetVolume
9280 XGetVolume <document> {<shape>|<label>}
9283 Returns the volume of a given shape.
9287 XGetVolume D 0:1:1:1
9290 @subsubsection occt_draw_8_9_5 XSetArea
9294 XSetArea <document> {<shape>|<label>} <area>
9297 Sets new area to attribute list ??? given shape.
9301 XSetArea D 0:1:1:1 2233.99
9304 @subsubsection occt_draw_8_9_6 XSetCentroid
9308 XSetCentroid <document> {<shape>|<label>} <x> <y> <z>
9311 Sets new center of gravity to the attribute list given shape.
9315 XSetCentroid D 0:1:1:1 0. 0. 100.
9318 @subsubsection occt_draw_8_9_7 XSetMaterial
9322 XSetMaterial <document> {<shape>|<label>} <name> <density(g/cu sm)>
9325 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.
9329 XSetMaterial D 0:1:1:1 Titanium 8899.77
9332 @subsubsection occt_draw_8_9_8 XSetVolume
9336 XSetVolume <document> {<shape>|<label>} <volume>
9339 Sets new volume to the attribute list ??? given shape.
9343 XSetVolume D 0:1:1:1 444555.33
9346 @subsubsection occt_draw_8_9_9 XShapeMassProps
9350 XShapeMassProps <document> [ <deflection> [{<shape>|<label>}] ]
9353 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.
9358 == Shape from label : 0:1:1:1
9359 == Mass = 193.71681469282299
9360 == CenterOfGravity X = 14.594564763807696,Y =
9361 20.20271885211281,Z = 49.999999385313245
9362 == Shape from label : 0:1:1:2 not have a mass
9366 @subsubsection occt_draw_8_9_10 XShapeVolume
9370 XShapeVolume <shape> <deflection>
9373 Calculates the real volume of a pointed shape with a given deflection.
9380 @section occt_draw_9 Shape Healing commands
9384 @subsection occt_draw_9_1 General commands
9386 @subsubsection occt_draw_9_1_1 bsplres
9390 bsplres <result> <shape> <tol3d> <tol2d< <reqdegree> <reqnbsegments> <continuity3d> <continuity2d> <PriorDeg> <RationalConvert>
9393 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**).
9395 @subsubsection occt_draw_9_1_2 checkfclass2d
9399 checkfclass2d <face> <ucoord> <vcoord>
9402 Shows where a point which is given by coordinates is located in relation to a given face – outbound, inside or at the bounds.
9406 checkfclass2d f 10.5 1.1
9410 @subsubsection occt_draw_9_1_3 checkoverlapedges
9414 checkoverlapedges <edge1> <edge2> [<toler> <domaindist>]
9417 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.
9421 checkoverlapedges e1 e2
9424 @subsubsection occt_draw_9_1_4 comtol
9428 comptol <shape> [nbpoints] [prefix]
9431 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.
9437 ==> Edges tolerance computed by 871 points:
9438 ==> MAX=8.0001130696523449e-008 AVG=6.349346868091096e-009 MIN=0
9439 ==> Relation real tolerance / tolerance set in edge
9440 ==> MAX=0.80001130696523448 AVG=0.06349345591805905 MIN=0
9441 ==> Edge with max tolerance saved to t_edge_tol
9442 ==> Concerned faces saved to shapes t_1, t_2
9445 @subsubsection occt_draw_9_1_5 convtorevol
9449 convtorevol <result> <shape>
9452 Converts all elementary surfaces of a given shape into surfaces of revolution.
9453 Results are put into the shape, which is given as the <i>\<result\></i> parameter.
9460 @subsubsection occt_draw_9_1_6 directfaces
9464 directfaces <result> <shape>
9467 Converts indirect surfaces and returns the results into the shape, which is given as the result parameter.
9474 @subsubsection occt_draw_9_1_7 expshape
9478 expshape <shape> <maxdegree> <maxseg>
9481 Gives statistics for a given shape. This test command is working with Bezier and BSpline entities.
9486 ==> Number of Rational Bspline curves 128
9487 ==> Number of Rational Bspline pcurves 48
9490 @subsubsection occt_draw_9_1_8 fixsmall
9494 fixsmall <result> <shape> [<toler>=1.]
9497 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.
9504 @subsubsection occt_draw_9_1_9 fixsmalledges
9508 fixsmalledges <result> <shape> [<toler> <mode> <maxangle>]
9511 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.
9515 fixsmalledges r a 0.1 1
9518 @subsubsection occt_draw_9_1_10 fixshape
9522 fixshape <result> <shape> [<preci> [<maxpreci>]] [{switches}]
9525 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
9527 The following syntax is used:
9528 * <i>\<symbol\></i> may be
9529 * "-" to set parameter off,
9531 * "*" to set default
9532 * <i>\<parameter\></i> is identified by letters:
9533 * l - FixLackingMode
9534 * o - FixOrientationMode
9535 * h - FixShiftedMode
9536 * m - FixMissingSeamMode
9537 * d - FixDegeneratedMode
9539 * i - FixSelfIntersectionMode
9540 * n - FixNotchedEdgesMode
9541 For enhanced message output, use switch '+?'
9548 @subsubsection occt_draw_9_1_11 fixwgaps
9552 fixwgaps <result> <shape> [<toler>=0]
9555 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.
9562 @subsubsection occt_draw_9_1_12 offsetcurve, offset2dcurve
9566 offsetcurve <result> <curve> <offset> <direction(as point)>
9567 offset2dcurve <result> <curve> <offset>
9570 **offsetcurve** works with the curve in 3d space, **offset2dcurve** in 2d space.
9572 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>.
9577 offsetcurve r c 20 pp
9580 @subsubsection occt_draw_9_1_13 projcurve
9584 projcurve <edge>|<curve3d>|<curve3d first last> <X> <Y> <Z>
9587 **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.
9592 ==Edge k_1 Params from 0 to 1.3
9593 ==Precision (BRepBuilderAPI) : 9.9999999999999995e-008 ==Projection : 0 1 5
9594 ==Result : 0 1.1000000000000001 0
9595 ==Param = -0.20000000000000001 Gap = 5.0009999000199947
9598 @subsubsection occt_draw_9_1_14 projface
9602 projface <face> <X> <Y> [<Z>]
9605 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.
9609 projface a_1 10.0 0.0
9610 == Point UV U = 10 V = 0
9611 == = proj X = -116 Y = -45 Z = 0
9614 @subsubsection occt_draw_9_1_15 scaleshape
9618 scaleshape <result> <shape> <scale>
9621 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.
9625 scaleshape r a_1 0.8
9628 @subsubsection occt_draw_9_1_16 settolerance
9632 settolerance <shape> [<mode>=v-e-w-f-a] <val>(fix value) or
9636 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.
9640 settolerance a 0.001
9643 @subsubsection occt_draw_9_1_17 splitface
9647 splitface <result> <face> [u usplit1 usplit2...] [v vsplit1 vsplit2 ...]
9650 Splits a given face in parametric space and puts the result into the given parameter <i>\<result\></i>.
9651 Returns the status of split face.
9655 # split face f by parameter u = 5
9657 ==> Splitting by U: ,5
9661 @subsubsection occt_draw_9_1_18 statshape
9665 statshape <shape> [particul]
9668 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
9669 surfaces. The last parameter becomes out of date.
9676 ==> 402 Edge (oriented)
9677 ==> 402 Edge (Shared)
9680 ==> 804 Vertex (Oriented)
9681 ==> 402 Vertex (Shared)
9683 ==> 4 Face with more than one wire
9684 ==> 34 bspsur: BSplineSurface
9687 @subsubsection occt_draw_9_1_19 tolerance
9691 tolerance <shape> [<mode>:D v e f c] [<tolmin> <tolmax>:real]
9694 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.
9699 ==> Tolerance MAX=0.31512672416608001 AVG=0.14901359484722074 MIN=9.9999999999999995e-08
9700 ==> FACE : MAX=9.9999999999999995e-08 AVG=9.9999999999999995e-08 MIN=9.9999999999999995e-08
9701 ==> EDGE : MAX=0.31512672416608001 AVG=0.098691334511810405 MIN=9.9999999999999995e-08
9702 ==> VERTEX : MAX=0.31512672416608001 AVG=0.189076074499648 MIN=9.9999999999999995e-08
9704 tolerance a v 0.1 0.001
9705 ==> Analysing Vertices gives 6 Shapes between tol1=0.10000000000000001 and tol2=0.001 , named tol_1 to tol_6
9709 @subsection occt_draw_9_2 Conversion commands
9711 @subsubsection occt_draw_9_2_1 DT_ClosedSplit
9715 DT_ClosedSplit <result> <shape>
9718 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.
9719 Note: Closed face – it’s face with one or more seam.
9726 @subsubsection occt_draw_9_2_2 DT_ShapeConvert, DT_ShapeConvertRev
9730 DT_ShapeConvert <result> <shape> <convert2d> <convert3d>
9731 DT_ShapeConvertRev <result> <shape> <convert2d> <convert3d>
9734 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.
9738 DT_ShapeConvert r a 1 1
9742 @subsubsection occt_draw_9_2_3 DT_ShapeDivide
9746 DT_ShapeDivide <result> <shape> <tol>
9749 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:
9750 * OK : no splitting was done
9751 * Done1 : Some edges were split
9752 * Done2 : Surface was split
9753 * Fail1 : Some errors occurred
9757 DT_ShapeDivide r a 0.001
9761 @subsubsection occt_draw_9_2_4 DT_SplitAngle
9765 DT_SplitAngle <result> <shape> [MaxAngle=95]
9768 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.
9769 This command illustrates how class *ShapeUpgrade_ShapeDivideAngle* works.
9777 @subsubsection occt_draw_9_2_5 DT_SplitCurve
9781 DT_SplitCurve <curve> <tol> <split(0|1)>
9784 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.
9791 @subsubsection occt_draw_9_2_6 DT_SplitCurve2d
9795 DT_SplitCurve2d Curve Tol Split(0/1)
9798 Works just as **DT_SplitCurve** (see above), only with 2d curve.
9805 @subsubsection occt_draw_9_2_7 DT_SplitSurface
9809 DT_SplitSurface <result> <Surface|GridSurf> <tol> <split(0|1)>
9812 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.
9818 # split surface with name "su"
9819 DT_SplitSurface res su 0.1 1
9821 ==> appel a SplitSurface::Init
9822 ==> appel a SplitSurface::Build
9823 ==> appel a SplitSurface::GlobalU/VKnots
9824 ==> nb GlobalU;nb GlobalV=7 2 0 1 2 3 4 5 6.2831853072 0 1
9825 ==> appel a Surfaces
9826 ==> transfert resultat
9827 ==> res1_1_1 res1_2_1 res1_3_1 res1_4_1 res1_5_1 res1_6_1
9831 @subsubsection occt_draw_9_2_8 DT_ToBspl
9835 DT_ToBspl <result> <shape>
9838 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.
9843 == error = 5.20375663162094e-08 spans = 10
9844 == Surface is aproximated with continuity 2
9847 @section occt_draw_10 Performance evaluation commands
9850 @subsection occt_draw_10_1 VDrawSphere
9854 vdrawsphere shapeName Fineness [X=0.0 Y=0.0 Z=0.0] [Radius=100.0] [ToEnableVBO=1] [NumberOfViewerUpdate=1] [ToShowEdges=0]
9857 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.
9859 This command can be used for visualization performance evaluation instead of the outdated Visualization Performance Meter.
9863 vdrawsphere s 200 1 1 1 500 1
9864 == Compute Triangulation...
9865 == NumberOfPoints: 39602
9866 == NumberOfTriangles: 79200
9867 == Amount of memory required for PolyTriangulation without Normals: 2 Mb
9868 == Amount of memory for colors: 0 Mb
9869 == Amount of memory for PolyConnect: 1 Mb
9870 == Amount of graphic card memory required: 2 Mb
9871 == Number of scene redrawings: 1
9872 == CPU user time: 15.6000999999998950 msec
9873 == CPU system time: 0.0000000000000000 msec
9874 == CPU average time of scene redrawing: 15.6000999999998950 msec
9878 @section occt_draw_11 Extending Test Harness with custom commands
9881 The following chapters explain how to extend Test Harness with custom commands and how to activate them using a plug-in mechanism.
9884 @subsection occt_draw_11_1 Custom command implementation
9886 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.
9890 static Standard_Integer myadvcurve(Draw_Interpretor& di, Standard_Integer n, char** a)
9896 For examples of existing commands refer to Open CASCADE Technology (e.g. GeomliteTest.cxx).
9899 @subsection occt_draw_11_2 Registration of commands in Test Harness
9901 To become available in the Test Harness the custom command must be registered in it. This should be done as follows.
9905 void MyPack::CurveCommands(Draw_Interpretor& theCommands)
9908 char* g = "Advanced curves creation";
9910 theCommands.Add ( "myadvcurve", "myadvcurve name p1 p2 p3 – Creates my advanced curve from points",
9911 __FILE__, myadvcurve, g );
9916 @subsection occt_draw_11_3 Creating a toolkit (library) as a plug-in
9918 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.
9920 This exported function *PLUGINFACTORY()* must be implemented only once per library.
9922 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.
9926 #include <Draw_PluginMacro.hxx>
9928 void MyPack::Factory(Draw_Interpretor& theDI)
9932 MyPack::CurveCommands(theDI);
9936 // Declare entry point PLUGINFACTORY
9940 @subsection occt_draw_11_4 Creation of the plug-in resource file
9942 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 (;:;).
9943 For every created plug-in there must be a key. For better readability and comprehension it is recommended to have some meaningful name.
9944 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.
9945 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.
9947 **Examples** (file MyDrawPlugin):
9949 ! Hierarchy of plug-ins
9950 ALL : ADVMODELING, MESHING
9952 ADVMODELING : ADVSURF, ADVCURV
9954 ! Mapping from naming to toolkits (libraries)
9955 ADVSURF : TKMyAdvSurf
9956 ADVCURV : TKMyAdvCurv
9960 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.
9963 @subsection occt_draw_11_5 Dynamic loading and activation
9965 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.
9967 The procedure consists in defining the system variables and using the pload commands in the Test Harness session.
9971 Draw[]> set env(CSF_MyDrawPluginDefaults) /users/test
9972 Draw[]> pload -MyDrawPlugin ALL