lili/OCCT
1
0
Fork 0
mirror of https://github.com/Open-Cascade-SAS/OCCT.git synced 2026-05-31 08:01:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

0028179: Update documentation of Boolean Component

Browse Source
This commit is contained in:
emv
2017-04-05 07:59:14 +03:00
committed by bugmaster
parent e473b95fe9
commit aeee70d353
6 changed files with 145 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/BRepAlgoAPI/BRepAlgoAPI_Splitter.hxx
View File

@@ -21,14 +21,26 @@
#include <BRepAlgoAPI_BuilderAlgo.hxx>
//! The class contains API level of the Splitter algorithm.<br>
//! It provides means to split an arbitrary number of shapes of arbitrary
//! dimensions by other arbitrary shapes.<br>
//! The arguments of the operation are divided on two groups - Objects
//! (shapes that will be split) and Tools (shapes by which the objects will be split).<br>
//! The result of the operation contains only the split parts of the Objects.<br>
//! The split parts of the Tools are excluded from the result.<br>
//! If there are no Tool shapes, the operation will be equivalent to General Fuse.<br>
//! The class contains API level of the **Splitter** algorithm,
//! which allows splitting a group of arbitrary shapes by the
//! other group of arbitrary shapes.<br>
//! The arguments of the operation are divided on two groups:<br>
//! *Objects* - shapes that will be split;<br>
//! *Tools* - shapes by which the *Objects* will be split.<br>
//! The result of the operation contains only the split parts
//! of the shapes from the group of *Objects*.<br>
//! The split parts of the shapes from the group of *Tools* are excluded
//! from the result.<br>
//! The shapes can be split by the other shapes from the same group
//! (in case these shapes are interfering).
//!
//! The class is a General Fuse based algorithm. Thus, all options
//! of the General Fuse algorithm such as Fuzzy mode, safe processing mode,
//! parallel processing mode, gluing mode and history support are also
//! available in this algorithm.<br>
//! There is no requirement on the existence of the *Tools* shapes.
//! And if there are no *Tools* shapes, the result of the splitting
//! operation will be equivalent to the General Fuse result.
//!
//! The algorithm returns the following Error statuses:<br>
//! - 0 - in case of success;<br>