MantisBT - Community
View Issue Details
0023640Community[OCCT] OCCT:Documentationpublic2012-12-13 18:452015-07-27 14:09
Timo 
bugmaster 
normalfeature 
closedfixed 
[OCCT] 6.5.4 
[OCCT] 6.9.0[OCCT] 6.9.0 
Not needed
0023640: Documentation for local sewing with BRepBuilderAPI_Sewing is missing
In http://www.opencascade.org/org/forum/thread_24171/?forum=3 [^] it was asked how local sewing can be performed in OpenCascade.

The answer was:
First you should Load() a context shape
and after use Add() for sub-shapes which should be locally sewed.

The forum supervisor wrote:
Unfortunately this feature still is not documented.
Therefore I suggest you to register the corresponding issue in Mantis Bug Tracker.

It would be helpful if a use case for local sewing is explained and how it can be used to get better performance than with global sewing.

Documentation about local sewing should be added to the Modeling Algorithms User's Guide as well as to the Doxygen Code documentation.
Not applicable.
No tags attached.
related to 0025390closed bugmaster Open CASCADE Redesign of Technical Overview 
Issue History
2012-12-13 18:45TimoNew Issue
2012-12-13 18:45TimoAssigned To => atp
2012-12-13 19:13szyTarget Version => 6.6.0
2012-12-14 15:57atpAssigned Toatp => gka
2013-02-26 15:50abvTarget Version6.6.0 => 6.7.0
2013-12-16 16:20gkaFile Added: Surface_0.brep
2013-12-16 16:20gkaFile Added: Surface_1.brep
2013-12-16 16:29gkaFile Deleted: Surface_0.brep
2013-12-16 16:29gkaFile Deleted: Surface_1.brep
2013-12-21 10:13abvTarget Version6.7.0 => 6.7.1
2014-04-04 18:27abvTarget Version6.7.1 => 6.8.0
2014-07-25 14:42TimoNote Added: 0030424
2014-10-29 13:57abvAssigned Togka => ysn
2014-10-29 13:57abvStatusnew => assigned
2014-10-29 14:31ysnNote Added: 0033825
2014-10-29 15:05ysnAssigned Toysn => Timo
2014-10-29 15:05ysnStatusassigned => feedback
2014-10-29 15:21TimoNote Added: 0033834
2014-10-29 15:22TimoAssigned ToTimo => ysn
2014-10-29 15:22TimoStatusfeedback => assigned
2014-10-29 15:39ysnAssigned Toysn => gka
2014-10-29 15:39ysnNote Added: 0033837
2014-11-06 06:37abvTarget Version6.8.0 => 7.1.0
2014-11-18 10:58TimoNote Added: 0034468
2014-11-18 11:30gkaAssigned Togka => ysn
2014-12-08 16:22gitNote Added: 0035142
2014-12-08 16:22ysnNote Added: 0035143
2014-12-08 16:29ysnAssigned Toysn => msv
2014-12-08 16:30ysnNote Added: 0035144
2014-12-08 16:30ysnStatusassigned => feedback
2014-12-08 23:32gitNote Added: 0035175
2014-12-08 23:35msvNote Added: 0035176
2014-12-08 23:35msvAssigned Tomsv => ysn
2014-12-08 23:35msvStatusfeedback => resolved
2014-12-08 23:35msvSteps to Reproduce Updatedbug_revision_view_page.php?rev_id=8785#r8785
2014-12-09 11:02ysnAssigned Toysn => abv
2014-12-09 11:03ysnNote Added: 0035191
2015-01-26 14:28abvNote Added: 0036647
2015-01-26 14:28abvAssigned Toabv => bugmaster
2015-01-26 14:28abvStatusresolved => reviewed
2015-01-26 19:01apnTest case number => Not needed
2015-01-26 19:01apnStatusreviewed => tested
2015-01-30 14:00bugmasterChangeset attached => occt master e2b55410
2015-01-30 14:00bugmasterStatustested => verified
2015-01-30 14:00bugmasterResolutionopen => fixed
2015-01-30 14:03TimoNote Added: 0036888
2015-02-09 11:05bugmasterTarget Version7.1.0 => 6.9.0
2015-05-05 21:26abvRelationship addedrelated to 0025390
2015-05-14 15:28aivStatusverified => closed
2015-05-14 15:30aivFixed in Version => 6.9.0
2015-07-27 14:09gitNote Added: 0043559

Notes
(0030424)
Timo   
2014-07-25 14:42   
I found some information about Local Sewing on http://www.opencascade.org/occt/overview/compocc7/sewing/sewing10/ [^]

It might be useful to for the proposed documentation enhancement:

"In case when a shape still has some unsewed faces or edges after sewing, it is possible to use local sewing with a greater tolerance.

Local sewing is especially good for open shells.
Local sewing allows to sew a hole in one part of the shape and to keep a required hole smaller than the specified working tolerance for local sewing. Local sewing is much faster than sewing on the whole shape.

All pre-existing connections of the whole shape are kept after local sewing."


There are also some other pieces of information about sewing on the website, but some of it is not up-to-date, like mentioning BRepAlgo_Sewing on http://www.opencascade.org/occt/overview/compocc7/sewing/sewing2/ [^]
(0033825)
ysn   
2014-10-29 14:31   
Dear Timo, actually, there is a section about sewing in the Technical Overview http://dev.opencascade.org/doc/overview/html/technical_overview.html#OCCT_TOVW_SECTION_4_9 [^]

As you can see, it is exactly based on the site contents.

Do you suggest somehow enhancing this?
(0033834)
Timo   
2014-10-29 15:21   
I rather meant to describe local sewing also in the Modeling User's guide and API reference documentation. I mean, how to actually apply local sewing using the Load- and Add-method. Not much text would be needed but at least to mention this possibility and the benefits.

For me, it wasn't clear in case of local sewing:
Load(): Can the context shape also be a compound containing a shell and additional faces to be sewed or does it have to be a shell containing all faces?
Add(): Should I add here the faces to be sewed or specify certain edges of faces which should be sewed?

Additionally, some parts seem not up-to-date in the Technical overview, at least BRepAlgo_Sewing is mentionend, but it doesn't exist anymore.
(0033837)
ysn   
2014-10-29 15:39   
OK. The section about sewing will be soon moved to the Modeling User's guide.

Dear Galina, could you do the following:

1) Review the description of Sewing to check if there is no outdated information.
2) Add a code example illustrating the usage of Local Sewing with proper comments. (And expand the section further if necessary).
(0034468)
Timo   
2014-11-18 10:58   
Here is an example code for local sewing which I received in the frame of a support query and which could be used in the documentation:

"In order to use local sewing it is necessary to create a compound from two full sewed shapes then load full compound using method BRepBuilderAPI_Sewing::Load().
After that it is necessary to add local sub-shapes which should be sewed using method BRepBuilderAPI_Sewing::Add(). The result of sewing can be got using method BRepBuilderAPI_Sewing::SewedShape().
For example:
//initial sewed shapes
TopoDS_Shape aS1, aS2;
TopoDS_Shape aComp;
BRep_Builder aB;
aB.MakeCompound(aComp);
aB.Add(aComp, aS1);
aB.Add(aComp, aS2);
................................
aSewing.Load(aComp);

//sub shapes which should be locally sewed
aSewing.Add(aF1);
aSewing.Add(aF2);
//performing sewing
aSewing.Perform();
//result shape
TopoDS_Shape aRes = aSewing.SewedShape();
(0035142)
git   
2014-12-08 16:22   
Branch CR23640 has been created by ysn.

SHA-1: 3abaadd12ebffcff81a78133c27cc806bede2ea2


Detailed log of new commits:

Author: ysn
Date: Mon Dec 8 16:21:48 2014 +0300

    Fix for bug 23640. What's more important: merging the rest of Technical Overview content into User's Guides.
    However, Technical Overview itself is left intact and will be replaced by a shortened document only at the next stage.
(0035143)
ysn   
2014-12-08 16:22   
I've made a fix for bug 23640 in the corresponding branch, adding the requested example.

What's more important: merging the rest of Technical Overview content into User's Guides.
However, Technical Overview itself is left intact and will be replaced by a shortened document only at the next stage.
(0035144)
ysn   
2014-12-08 16:30   
Dear Michail, please, have a look at the proposed changes.
(0035175)
git   
2014-12-08 23:32   
Branch CR23640 has been updated by msv.

SHA-1: a9b85ac3c0d3e57c080d4d0b40e3316ce015d576


Detailed log of new commits:

Author: msv
Date: Mon Dec 8 23:32:25 2014 +0300

    -Correct UG sections concerning Sewing.
    -Correct comments in the code referring to old location of sewing algorithm.

(0035176)
msv   
2014-12-08 23:35   
I have corrected the Sewing section of UG.
I have looked at other UGs only briefly.
(0035191)
ysn   
2014-12-09 11:03   
OK. Thank you for the input.
(0036647)
abv   
2015-01-26 14:28   
Reviewed, please integrate.

Actually many fragments merged from the site are quite outdated and require revision, but this can be made later
(0036888)
Timo   
2015-01-30 14:03   
Is the Target Version of this Mantis entry correct?
(0043559)
git   
2015-07-27 14:09   
Branch CR23640 has been deleted by kgv.

SHA-1: a9b85ac3c0d3e57c080d4d0b40e3316ce015d576