Some pre-release updates, reviewing and implementation of some adequate remarks from JMA:
- redundant chapters in IGES and STEP guides
- proofreading of recent insertions in Draw, and tests guides
- mathjax information
- data, version, addresses, system requirements in overview.md
Corrections
**MathJax** is used for rendering math formulas in browser (HTML and CHM outputs): http://www.mathjax.org.
-By default MathJAX scripts and fonts are taken from http://cdn.mathjax.org/mathjax/latest and no installation of MathJAX is necessary if Internet is accessible.
-If you need to use OCCT documentation while off-line, you can install a local copy of MatJAX, see http://www.mathjax.org/download/.
+By default MathJAX scripts and fonts work on-line and no installation of MathJAX is necessary if Internet is accessible.
+If you need to use OCCT documentation while off-line, you can install a local copy of MatJAX, see https://docs.mathjax.org/en/v2.6-latest/start.html#installing-your-own-copy-of-mathjax.
See \ref OCCT_DM_SECTION_A_9 for more details on inserting mathematical expressions.
@section OCCT_DM_SECTION_2_1 Documentation Generation
3. In the test script:
* Load all necessary DRAW modules by command *pload*.
* Use command *locate_data_file* to get a path to data files used by test script. (Make sure to have this command not inside catch statement if it is used.)
- * Use DRAW commands to reproduce the situation being tested.
- * Make sure that in case of failure the test produces message containing word "Error" or other recognized by test system as error (add new error patterns in file parse.rules if necessary).
- * If test case reports error due to existing problem and the fix is not available, add @ref testmanual_3_6 "TODO" statement for each error to mark it as known problem. The TODO statements must be specific so as to match the actually generated messages but not all similar errors.
- * To check expected output which should be obtained as a result of a test, add @ref testmanual_3_7 "REQUIRED" statement for each line of output to mark it as required.
- * If test case produces error messages (contained in parse.rules) which are expected in that test and should not be considered as its failure (e.g. test for checkshape command), add REQUIRED statement for each error to mark it as required output.
-4. If the test uses data file(s) not yet present in the test database, these can be put to (sub)directory pointed out by *CSF_TestDataPath* variable for running test. The files should be attached to Mantis issue corresponding to the modification being tested.
-5. Check that the test case runs as expected (test for fix: OK with the fix, FAILED without the fix; test for existing problem: BAD), and integrate to Git branch created for the issue.
+ * Use DRAW commands to reproduce the tested situation.
+ * Make sure that in case of failure the test produces a message containing word "Error" or other recognized by the test system as error (add new error patterns in file parse.rules if necessary).
+ * If the test case reports error due to an existing problem and the fix is not available, add @ref testmanual_3_6 "TODO" statement for each error to mark it as a known problem. The TODO statements must be specific so as to match the actually generated messages but not all similar errors.
+ * To check expected output which should be obtained as the test result, add @ref testmanual_3_7 "REQUIRED" statement for each line of output to mark it as required.
+ * If the test case produces error messages (contained in parse.rules), which are expected in that test and should not be considered as its failure (e.g. test for *checkshape* command), add REQUIRED statement for each error to mark it as required output.
+4. If the test uses data file(s) that are not yet present in the test database, it is possible to put them to (sub)directory pointed out by *CSF_TestDataPath* variable for running test. The files should be attached to the Mantis issue corresponding to the tested modification.
+5. Check that the test case runs as expected (test for fix: OK with the fix, FAILED without the fix; test for existing problem: BAD), and integrate it to the Git branch created for the issue.
Example:
Each line in the file should specify a status (single word), followed by a regular expression delimited by slashes (*/*) that will be matched against lines in the test output log to check if it corresponds to this status.
-The regular expressions should follow <a href="http://www.tcl.tk/man/tcl/TclCmd/re_syntax.htm">Tcl syntax</a>, with special exception that "\b" is considered as word limit (Perl-style), in addition to "\y" used in Tcl.
+The regular expressions should follow <a href="http://www.tcl.tk/man/tcl/TclCmd/re_syntax.htm">Tcl syntax</a>, with a special exception that "\b" is considered as word limit (Perl-style), in addition to "\y" used in Tcl.
The rest of the line can contain a comment message, which will be added to the test report when this status is detected.
@subsection testmanual_3_7 Marking required output
-To check expected output which must be obtained as a result of a test for it to be considered correct, add REQUIRED statement for each specific message.
-For that, the following statement should be added to such a test script:
+To check the obtained test output matches the expected results considered correct, add REQUIRED statement for each specific message.
+For that, the following statement should be added to the corresponding test script:
~~~~~
puts "REQUIRED ListOfPlatforms: RegularExpression"
Here *ListOfPlatforms* and *RegularExpression* have the same meaning as in TODO statements described above.
-The REQUIRED statement can also be used to mask message that would normally be interpreted as error (according to rules defined in *parse.rules*) but should not be considered as such within current test.
+The REQUIRED statement can also be used to mask the message that would normally be interpreted as error (according to the rules defined in *parse.rules*) but should not be considered as such within the current test.
Example:
~~~~~
@section OCCT_OVW_SECTION_2 Copyrights
Open CASCADE Technology and all materials, including this documentation, is
-Copyright (c) 1999-2015 by OPEN CASCADE S.A.S. All rights reserved.
+Copyright (c) 1999-2016 by OPEN CASCADE S.A.S. All rights reserved.
@htmlonly<center>@endhtmlonly
http://www.opencascade.com
**Qt** is a cross-platform application framework that is widely used for developing application software
with graphical user interface (GUI). Qt is free and open source software distributed under
the terms of the GNU Lesser General Public License. In OCCT Qt is used for programming samples.
-If you need further information on Qt, please, refer to Qt Homepage (http://qt.digia.com).
+If you need further information on Qt, please, refer to Qt Homepage (http://www.qt.io/)
**Tcl** is a high-level programming language. Tk is a graphical user interface (GUI) toolkit,
with buttons, menus, listboxes, scrollbars, and so on. Taken together Tcl and Tk provide a solution
| Linux | Mandriva 2010, CentOS 6.3, Fedora 18, Ubuntu 14.10 - 15.10, Debian 6.0, Debian 7.0 |
| OS X | 10.10 Yosemite / 10.9 Mavericks / 10.8 Mountain Lion / 10.7 Lion |
| Android | 6.x, 5.x, 4.0.4+ |
+| iOS | iOS 7 |
@subsection overview_req_cpp C++ Compiler / IDE
| OS | Compiler |
| --------- | ----------- |
-| Windows | Microsoft Visual Studio: 2010 SP1\*, 2012 Update 4, 2013 Update 5, 2015 <br> Intel C++ Composer XE 2013 SP1 |
+| Windows | Microsoft Visual Studio: 2010 SP1<sup>1</sup>, 2012 Update 4, 2013 Update 5, 2015 <br> Intel C++ Composer XE 2013 SP1 <br> GCC 4.3+ (Mingw-w64)|
| Linux | GNU gcc 4.3+ <br> LLVM CLang 3.6+ |
| OS X | XCode 6 or newer |
| Android | NDK r10, GNU gcc 4.8 or newer |
-* VC++ 10 64-bit is used for regular testing and for building
+1) VC++ 10 64-bit is used for regular testing and for building
binary package of official release of OCCT on Windows.
@subsection overview_req_libs Third-party libraries
| --------- | ----------- |
| Graphic library | OpenGL 3.3+, OpenGL ES 2.0+ <br> Direct3D 9 |
| Qt (for samples and demos) | Desktop: Qt 4.8.6+ http://www.qt.io/download/ <br> Android: Qt 5.3.2+ http://www.qt.io/download/ |
-| TCL (for testing tools) | Tcl/Tk 8.6.3+ http://www.tcl.tk/software/tcltk/download.html |
-| Freetype (for text rendering) | freetype-2.5.3+ http://sourceforge.net/projects/freetype/files/ |
-| FreeImage (optional, for support of common 2D graphic formats) | FreeImage 3.16.0+ http://sourceforge.net/projects/freeimage/files |
+| TCL (for testing tools) | Tcl/Tk 8.6.3+ http://www.tcl.tk/software/tcltk/download.html <br> or ActiveTcl 8.6 http://www.activestate.com/activetcl/downloads (for Windows)|
+| Freetype (for text rendering) | FreeType 2.4.11-2.5.5 http://sourceforge.net/projects/freetype/files/ |
+| FreeImage (optional, for support of common 2D graphic formats) | FreeImage 3.17.0+ http://sourceforge.net/projects/freeimage/files |
| gl2ps (optional, for export contents of OCCT viewer to vector formats) | gl2ps-1.3.8+ http://geuz.org/gl2ps/ |
| Intel TBB (optional, for multithreaded algorithms) | TBB 4.x or 5.x http://www.threadingbuildingblocks.org/ |
| VTK (for VTK Integration Services | VTK 6.1+ http://www.vtk.org/VTK/resources/software.html |
+| Doxygen (optional for building documentation) | Doxygen 1.8.5+ http://www.stack.nl/~dimitri/doxygen/download.html |
@subsection overview_req_hw Hardware
| Free disk space (complete installation) | 600 MB approx. |
On desktop, 3D viewer for optimal performance requires graphics processing unit (GPU) supporting OpenGL 3.3 or above.
-Ray tracing requires OpenGL 4.0+ or OpenGL 3.3+ with GL_ARB_texture_buffer_object_rgb32 extension.
-Textures within ray tracing will be available only when GL_ARB_bindless_texture extension is provided by driver.
+Ray tracing requires OpenGL 4.0+ or OpenGL 3.3+ with *GL_ARB_texture_buffer_object_rgb32* extension.
+Textures within ray tracing will be available only when *GL_ARB_bindless_texture extension* is provided by driver.
On mobile platforms, OpenGL ES 2.0+ is required for 3D viewer. The ray tracing is not yet available on mobile platforms.
Some old hardware might be unable to execute complex GLSL programs (e.g. with high number of light sources, clipping planes).
@image html /overview/images/overview_3rdparty.png
@image latex /overview/images/overview_3rdparty.png
-The contents of the OCCT-6.9.0 directory (called further "OCCT root", or $CASROOT) are as follows:
+The contents of the OCCT-7.0.0 directory (called further "OCCT root", or $CASROOT) are as follows:
@image html /overview/images/overview_installation.png "The directory tree"
@image latex /overview/images/overview_installation.png "The directory tree"
You can add new custom test harness commands to Draw in order to test
or demonstrate a new functionality, which you are developing.
-Currently DRAW Test Harness is a single executable called DRAWEXE.
+Currently DRAW Test Harness is a single executable called *DRAWEXE*.
Commands grouped in toolkits can be loaded at run-time thereby implementing dynamically loaded plug-ins.
Thus you can work only with the commands that suit your needs adding
the commands dynamically without leaving the Test Harness session.
Declaration of available plug-ins is done through special resource file(s).
-The pload command loads the plug-in in accordance with
+The *pload* command loads the plug-in in accordance with
the specified resource file and activates the commands implemented in the plug-in.
The whole process of using the plug-in mechanism as well as the instructions for extending Test Harness is described in the @ref occt_user_guides__test_harness.
* For Boolean operation Fuse all arguments should have equal dimensions.
* For Boolean operation Cut the minimal dimension of *S2* should not be less than the maximal dimension of *S1*.
-* For Boolean operation Common the arguments could have any dimension.
+* For Boolean operation Common the arguments can have any dimension.
@subsection occt_algorithms_9_3 Results. General Rules
* The result of the operation Fuse is defined for arguments *S1* and *S2* that have the same dimension value : *Dim(S1)=Dim(S2)*. If the arguments have different dimension values the result of the operation Fuse is not defined. The dimension of the result is equal to the dimension of the arguments. For example, it is impossible to fuse an edge and a face.
* The result of the operation Fuse for arguments *S1* and *S2* contains the parts of arguments that have states **OUT** relative to the opposite arguments.
* The result of the operation Fuse for arguments *S1* and *S2* having dimension value 3 (Solids) is refined by removing all possible internal faces to provide minimal number of solids.
-* The result of the operation Common for arguments *S1* and *S2* is defined for all values of the dimensions of the arguments. The result can contain the shapes of different dimension, but the minimal dimension of the result will be equal to the minimal dimension of the arguments. For example, the result of the operation Common between edges cannot be a vertex.
+* The result of the operation Common for arguments *S1* and *S2* is defined for all values of the dimensions of the arguments. The result can contain shapes of different dimensions, but the minimal dimension of the result will be equal to the minimal dimension of the arguments. For example, the result of the operation Common between edges cannot be a vertex.
* The result of the operation Common for the arguments *S1* and *S2* contains the parts of the argument that have states **IN** and **ON** relative to the opposite argument.
-* The result of the operation Cut is defined for arguments *S1* and *S2* that have values of dimensions *Dim(S2)* that should not be less than *Dim(S1)*. The result can contain the shapes of different dimension, but the minimal dimension of the result will be equal to the minimal dimension of the objects *Dim(S1)*. The result of the operation *Cut12* is not defined for other cases. For example, it is impossible to cut an edge from a solid, because a solid without an edge is not defined.
+* The result of the operation Cut is defined for arguments *S1* and *S2* that have values of dimensions *Dim(S2)* that should not be less than *Dim(S1)*. The result can contain shapes of different dimensions, but the minimal dimension of the result will be equal to the minimal dimension of the objects *Dim(S1)*. The result of the operation *Cut12* is not defined for other cases. For example, it is impossible to cut an edge from a solid, because a solid without an edge is not defined.
* The result of the operation *Cut12* for arguments *S1* and *S2* contains the parts of argument *S1* that have state **OUT** relative to the opposite argument *S2*.
* The result of the operation *Cut21* for arguments *S1* and *S2* contains the parts of argument *S2* that have state **OUT** relative to the opposite argument *S1*.
-* For the argumenst of collection type (WIRE, SHELL, COMPSOLID) the type will be passed in the result. For example, the result of Common operation between Shell and Wire will be compound containing Wire.
+* For the arguments of collection type (WIRE, SHELL, COMPSOLID) the type will be passed in the result. For example, the result of Common operation between Shell and Wire will be a compound containing Wire.
@subsection occt_algorithms_9_4 Examples
@figure{/user_guides/boolean_operations/images/boolean_image138.png}
-* The result of *Cut21* operation is not defined as the objects have lower dimension than the tool.
+* The result of *Cut21* operation is not defined as the objects have a lower dimension than the tool.
@subsection occt_algorithms_9_5 Class BOPAlgo_BOP
~~~~~
vinit
~~~~~
-Creates new View window with specified name view_name.
-By default the new view is created in the viewer and in graphic driver shared with active view.
-* *name* = {driverName/viewerName/viewName | viewerName/viewName | viewName}.
-If driverName isn't specified the driver will be shared with active view.
-If viewerName isn't specified the viewer will be shared with active view.
+Creates a new View window with the specified *view_name*.
+By default the view is created in the viewer and in the graphic driver shared with the active view.
+
+~~~~
+name = {driverName/viewerName/viewName | viewerName/viewName | viewName}
+~~~~
+
+If *driverName* is not specified the driver will be shared with the active view.
+If *viewerName* is not specified the viewer will be shared with the active view.
@subsubsection occt_draw_4_2_2 vhelp
~~~~~
vrepaint
~~~~~
-Forcebly redisplays the shape in the 3D viewer window.
+Forcibly redisplays the shape in the 3D viewer window.
@subsubsection occt_draw_4_2_8 vfit
* single mouse click selection
* selection with a rectangle having the upper left and bottom right corners in <i>(x1,y1)</i> and <i>(x2,y2)</i> respectively
* selection with a polygon having the corners in pixel positions <i>(x1,y1), (x2,y2),…, (xn,yn)</i>
- * -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.
+ * <i> -allowoverlap </i> 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.
* any of these selections if shift_selection is set to 1.
@subsubsection occt_draw_4_2_12 vmoveto
~~~~~
vviewparams [-scale [s]] [-eye [x y z]] [-at [x y z]] [-up [x y z]] [-proj [x y z]] [-center x y] [-size sx]
~~~~~
-Gets or sets current view parameters.
+Gets or sets the current view parameters.
* If called without arguments, all view parameters are printed.
* The options are:
-* -scale [s] : prints or sets viewport relative scale.
-* -eye [x y z] : prints or sets eye location.
-* -at [x y z] : prints or sets center of look.
-* -up [x y z] : prints or sets direction of up vector.
-* -proj [x y z] : prints or sets direction of look.
-* -center x y : sets location of center of the screen in pixels.
+* -scale [s] : prints or sets the relative scale of viewport.
+* -eye [x y z] : prints or sets the eye location.
+* -at [x y z] : prints or sets the view center.
+* -up [x y z] : prints or sets the up vector direction.
+* -proj [x y z] : prints or sets the view direction.
+* -center x y : sets the screen center location in pixels.
* -size [sx] : prints viewport projection width and height sizes or changes the size of its maximum dimension.
@subsubsection occt_draw_4_2_14 vchangeselected
vhlr is_enabled={on|off} [show_hidden={1|0}]
~~~~~
Hidden line removal algorithm:
- * is_enabled: if is on HLR algorithm is applied.
- * show_hidden: if equals to 1, hidden lines are drawn as dotted ones.
+ * <i>is_enabled</i> applies HLR algorithm.
+ * <i>show_hidden</i> if equals to 1, hidden lines are drawn as dotted ones.
@subsubsection occt_draw_4_2_20 vhlrtype
[-zfocus [Value]] [-zfocusType [absolute|relative]]
~~~~~
-Manage camera parameters.
-Prints current value when option called without argument.
+Manages camera parameters.
+Prints the current value when the option is called without argument.
+
Orthographic camera:
- * -ortho activate orthographic projection
+ * -ortho -- activates orthographic projection.
+
Perspective camera:
- * -persp activate perspective projection (mono)
- * -fovy field of view in y axis, in degrees
- * -distance distance of eye from camera center
+ * -persp -- activated perspective projection (mono);
+ * -fovy -- field of view in y axis, in degrees;
+ * -distance -- distance of eye from the camera center.
+
Stereoscopic camera:
- * -stereo perspective projection (stereo)
- * -leftEye perspective projection (left eye)
- * -rightEye perspective projection (right eye)
- * -iod intraocular distance value
- * -iodType distance type, absolute or relative
- * -zfocus stereographic focus value
- * -zfocusType focus type, absolute or relative"
+ * -stereo -- perspective projection (stereo);
+ * -leftEye -- perspective projection (left eye);
+ * -rightEye -- perspective projection (right eye);
+ * -iod -- intraocular distance value;
+ * -iodType -- distance type, absolute or relative;
+ * -zfocus -- stereographic focus value;
+ * -zfocusType -- focus type, absolute or relative.
**Example:**
~~~~~
vstereo [0|1] [-mode Mode] [-reverse {0|1}] [-anaglyph Filter]
~~~~~
-Control stereo output mode.
-Available modes for -mode:
- * quadBuffer -- OpenGL QuadBuffer stereo, requires driver support. Should be called BEFORE vinit!
- * anaglyph -- Anaglyph glasses
- * rowInterlaced -- row-interlaced display
- * columnInterlaced -- column-interlaced display
- * chessBoard -- chess-board output
- * sideBySide -- horizontal pair
- * overUnder -- vertical pair
+Defines the stereo output mode. The following modes are available:
+ * quadBuffer -- OpenGL QuadBuffer stereo, requires driver support. Should be called BEFORE *vinit*!
+ * anaglyph -- Anaglyph glasses;
+ * rowInterlaced -- row-interlaced display;
+ * columnInterlaced -- column-interlaced display;
+ * chessBoard -- chess-board output;
+ * sideBySide -- horizontal pair;
+ * overUnder -- vertical pair;
Available Anaglyph filters for -anaglyph:
- * redCyan, redCyanSimple, yellowBlue, yellowBlueSimple, greenMagentaSimple
+ * redCyan, redCyanSimple, yellowBlue, yellowBlueSimple, greenMagentaSimple.
**Example:**
~~~~~
~~~~~
Displays named objects.
-Option -local enables displaying of objects in local selection context.
+Option <i>-local</i> enables display of objects in the local selection context.
Local selection context will be opened if there is not any.
* *noupdate* suppresses viewer redraw call.
-* *mutable* enables optimizations for mutable objects.
-* *neutral* draws objects in main viewer.
-* *layer* sets z-layer for objects. It can use '-overlay|-underlay|-top|-topmost' instead of '-layer index' for the default z-layers.
-* *top* draws objects on top of main presentations but below topmost.
+* *mutable* enables optimization for mutable objects.
+* *neutral* draws objects in the main viewer.
+* *layer* sets z-layer for objects. It can use <i>-overlay|-underlay|-top|-topmost</i> instead of <i>-layer index</i> for the default z-layers.
+* *top* draws objects on top of main presentations but below the topmost level.
* *topmost* draws in overlay for 3D presentations with independent Depth.
* *overlay* draws objects in overlay for 2D presentations (On-Screen-Display).
* *underlay* draws objects in underlay for 2D presentations (On-Screen-Display).
* *selectable|-noselect* controls selection of objects.
-* *trsfPers* sets a transform persistence flags. Flag 'full' is pan, zoom and rotate.
+* *trsfPers* sets transform persistence flags. Flag *full* allows to pan, zoom and rotate.
* *trsfPersPos* sets an anchor point for transform persistence.
* *2d|-2dTopDown* displays object in screen coordinates.
* *dispmode* sets display mode for objects.
~~~~~
Displays all erased interactive objects (see vdir and vstate).
-Option -local enables displaying of the objects in local selection context.
+Option <i>-local</i> enables displaying objects in the local selection context.
**Example:**
~~~~~
~~~~~
-Manage presentation properties of all, selected or named objects.
-When *-subshapes* is specified than following properties will be assigned to specified sub-shapes.
-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.
-If *-defaults* is used there should not be any names of objects and *-subshapes* specifier.
+Manages presentation properties of all, selected or named objects.
+* *-subshapes* -- assigns presentation properties to the specified sub-shapes.
+* *-defaults* -- assigns presentation properties to all objects that do not have their own specified properties and to all objects to be displayed in the future.
+If *-defaults* option is used there should not be any names of objects and *-subshapes* specifier.
Aliases:
~~~~~
vstate [-entities] [-hasSelected] [name1] ... [nameN]
~~~~~
-Reports show/hidden state for selected or named objects
+Reports show/hidden state for selected or named objects:
* *entities* -- prints low-level information about detected entities;
* *hasSelected* -- prints 1 if the context has a selected shape and 0 otherwise.
* env -- Enables/disables environment map background
* shadingModel -- Controls shading model from enumeration color, flat, gouraud, phong
-Unlike vcaps, these parameters dramatically change visual properties.
-Command is intended to control presentation quality depending on hardware capabilities and performance.
+Unlike *vcaps*, these parameters dramatically change visual properties.
+The command is intended to control presentation quality depending on hardware capabilities and performance.
**Example:**
~~~~~
vplanetri name
~~~~~
-Create a plane from a trihedron selection. If no arguments are set, the default
+Creates a plane from a trihedron selection. If no arguments are set, the default plane is created.
@subsubsection occt_draw_4_4_3 vsize
~~~~~
Sets the selection mode for an object. If the object value is not defined, the selection mode is set for all displayed objects.
-*Mode_number* is non-negative integer that has different meaning for different interactive object classes.
+*Mode_number* is a non-negative integer encoding different interactive object classes.
For shapes the following *mode_number* values are allowed:
* 0 -- shape
* 1 -- vertex
vconnect vconnect name Xo Yo Zo object1 object2 ... [color=NAME]
~~~~~
-Creates and displays AIS_ConnectedInteractive object from input object and location
+Creates *AIS_ConnectedInteractive* object from the input object and location and displays it.
**Example:**
~~~~~
vpointcloud name shape [-randColor] [-normals] [-noNormals]
~~~~~
-Creates an interactive object for an arbitary set of points from the triangulated shape.
+Creates an interactive object for an arbitrary set of points from the triangulated shape.
Additional options:
- * *randColor* -- generate random color per point
- * *normals* -- generate normal per point (default)
- * *noNormals* -- do not generate normal per point
+ * *randColor* -- generates a random color per point;
+ * *normals* -- generates a normal per point (default);
+ * *noNormals* -- does not generate a normal per point.
~~~~~
vpointcloud name x y z r npts {surface|volume} [-randColor] [-normals] [-noNormals]
~~~~~
Creates an arbitrary set of points (npts) randomly distributed on a spheric surface or within a spheric volume (x y z r).
Additional options:
- * *randColor* -- generate random color per point
- * *normals* -- generate normal per point (default)
- * *noNormals* -- do not generate normal per point
+ * *randColor* -- generates a random color per point;
+ * *normals* -- generates a normal per point (default);
+ * *noNormals* -- does not generate a normal per point.
**Example:**
~~~~~
~~~~~
Allows writing the prepared model to a file with name *filename.igs*.
-@section occt_iges_5_ Reading from and writing to XDE
+@section occt_iges_5 Reading from and writing to IGES
-@subsection occt_iges_5_1 Loading an IGES file
+@subsection occt_iges_5_1 Reading from IGES
+
+### Load an IGES file
Before performing any other operation, you must load an IGES file with:
~~~~~
~~~~~
Loading the file only memorizes, but does not translate the data.
-@subsection occt_iges_5_2 Checking the loaded IGES file
+### Check the loaded IGES file
This step is not obligatory. See the description of @ref occt_iges_2_3_2 "Checking the IGES file" above.
-@subsection occt_iges_5_3 Setting parameters for translation to XDE
+### Set parameters for translation to XDE
+
See the description of @ref occt_iges_2_3_3 "Setting translation parameters" above.
In addition, the following parameters can be set for XDE translation of attributes:
reader.SetNameMode(mode);
// mode can be Standard_True or Standard_False
~~~~~
-@subsection occt_iges_5_4 Performing the translation of an IGES file to XDE
+
+### Translate an IGES file to XDE
+
The following function performs a translation of the whole document:
~~~~~
Standard_Boolean ok = reader.Transfer(doc);
~~~~~
where *doc* is a variable which contains a handle to the output document and should have a type *Handle(TDocStd_Document)*.
-@subsection occt_iges_5_5 Initializing the process of translation from XDE to IGES
-The process can be initialized as follows:
+
+@subsection occt_iges_5_2 Writing to IGES
+
+The translation from XDE to IGES can be initialized as follows:
~~~~~
IGESCAFControl_Writer aWriter(XSDRAW::Session(),Standard_False);
~~~~~
-@subsection occt_iges_5_6 Setting parameters for translation from XDE to IGES
+
+### Set parameters for translation from XDE to IGES
The following parameters can be set for translation of attributes to IGES:
* For transferring colors:
aWriter.SetNameMode(mode);
// mode can be Standard_True or Standard_False
~~~~~
-@subsection occt_iges_5_7 Performing the translation of an XDE document to IGES
+
+### Translate an XDE document to IGES
You can perform the translation of a document by calling the function:
~~~~~
~~~~~
where "doc" is a variable which contains a handle to the input document for transferring and should have a type *Handle(TDocStd_Document)*.
-@subsection occt_iges_5_8 Writing an IGES file
+### Write an IGES file
+
Write an IGES file with:
~~~~~
IFSelect_ReturnStatus statw = aWriter.WriteFile("filename.igs");
~~~~~
It is necessary to call command *newmodel* to perform a new translation of the next OCCT shape.
-@section occt_step_7 Reading from and writing to XDE
-The *STEPCAFControl* package (TKXDESTEP toolkit) provides tools to read and write STEP files to and from XDE format (see XDE User’s Guide).
+@section occt_step_7 Reading from and writing to STEP
+
+The *STEPCAFControl* package (TKXDESTEP toolkit) provides tools to read and write STEP files (see XDE User’s Guide).
In addition to the translation of shapes implemented in basic translator, it provides the following:
* STEP assemblies, read as OCCT compounds by basic translator, are translated to XDE assemblies;
* Colors, layers, materials and validation properties assigned to parts or subparts are translated;
* STEP dimensional tolerances are translated.
-@subsection occt_step_7_1 Description of the process
+@subsection occt_step_7_1 Reading from STEP
-@subsubsection occt_step_7_1_1 Loading a STEP file
+### Load a STEP file
Before performing any other operation, you must load a STEP file with:
~~~~~
STEPCAFControl_Reader reader(XSDRAW::Session(), Standard_False);
~~~~~
Loading the file only memorizes the data, it does not translate it.
-@subsubsection occt_step_7_1_2 Checking the loaded STEP file
+### Check the loaded STEP file
This step is not obligatory. See a description of this step in section @ref occt_step_2_3_2 "Checking the STEP file".
-@subsubsection occt_step_7_1_3 Setting the parameters for translation to XDE
+### Set parameters for translation to XDE
+
See a description of this step in section @ref occt_step_2_3_3 "Setting the translation parameters".
In addition, the following parameters can be set for XDE translation of attributes:
reader.SetNameMode(mode);
// mode can be Standard_True or Standard_False
~~~~~
-@subsubsection occt_step_7_1_4 Performing the translation of a STEP file to XDE
+
+### Translate a STEP file to XDE
+
The following function performs a translation of the whole document:
~~~~~
Standard_Boolean ok = reader.Transfer(doc);
~~~~~
where *doc* is a variable which contains a handle to the output document and should have a type *Handle(TDocStd_Document)*.
-@subsubsection occt_step_7_1_5 Initializing the process of translation from XDE to STEP
-Here is how to initialize the process:
+
+@subsection occt_step_7_2 Writing to STEP
+
+The translation from XDE to STEP can be initialized as follows:
~~~~~
STEPCAFControl_Writer aWriter(XSDRAW::Session(),Standard_False);
~~~~~
-@subsubsection occt_step_7_1_6 Setting the parameters for translation from XDE to STEP
+
+### Set parameters for translation from XDE to STEP
The following parameters can be set for a translation of attributes to STEP:
- * Parameter for transferring colors:
+ * For transferring colors:
~~~~~
aWriter.SetColorMode(mode);
// mode can be Standard_True or Standard_False
~~~~~
- * Parameter for transferring names:
+ * For transferring names:
~~~~~
aWriter.SetNameMode(mode);
// mode can be Standard_True or Standard_False
~~~~~
-@subsubsection occt_step_7_1_7 Performing the translation of an XDE document to STEP
+
+### Translate an XDE document to STEP
+
You can perform the translation of document by calling the function:
~~~~~
IFSelect_ReturnStatus aRetSt = aWriter.Transfer(doc);
~~~~~
where *doc* is a variable, which contains a handle to the input document for transferring and should have a type *Handle(TDocStd_Document)*.
-@subsubsection occt_step_7_18 Writing a STEP file
+### Write a STEP file
+
Write a STEP file with:
~~~~~
IFSelect_ReturnStatus statw = aWriter.WriteFile("filename.stp");
projects / occt.git / commitdiff