Salome HOME
Fix compilation error (conflict of OK name between OCCT Plate_Plate.hxx and GEOM...
[modules/geom.git] / doc / salome / gui / GEOM / input / shapesonshape.doc
1 /*!
2
3 \page shapesonshape_page Get Shapes on Shape
4
5 This operation is a special case of <b>Explode</b> operation. It
6 produces a group of sub-shapes of the exploded shape, which are
7 located in a definite way relatively another reference shape. The
8 reference shape should be a solid.
9
10 To use this operation, select in the Main Menu <b>Operations -> Get Shapes on Shape.</b> The following dialog box will appear. 
11
12 \image html shapesonshape.png
13
14 <ul>
15 <li> <b>Name</b> is the name of the resulting group of shapes; </li>
16 <li> <b>Shape for exploding</b> is the shape that will be exploded; </li>
17 <li> <b>Solid for checking</b> is the reference shape, which should be
18 a solid; </li>
19 <li> <b>Reconstruction Limit</b> is the type of created sub-shapes:
20                        solid, shell, face, wire, edge, vertex; </li>
21 <li> <b>State</b> is the position of the created sub-shapes relatively the reference shapes:
22         <ul>
23         <li> IN - the created sub-shapes are located inside the reference shape; </li>
24         <li> OUT - the created sub-shapes are located outside the reference shape; </li>
25         <li> ON - the created sub-shapes lie on the reference shape; </li>
26         <li> ONIN - the created sub-shapes lie on the reference shape or are located inside it; </li>
27         <li> ONOUT - the created sub-shapes lie on the reference shape or are located outside it; </li>
28         </ul> </li>
29 </ul>
30
31 \n <b>Advanced options</b> \ref preview_anchor "Preview"
32
33 Example: 
34
35 In the images below the box is the exploded shape and the cylinder is the reference shape. In the first image the edge IN the reference cylinder is highlighted in red, in the second the edges OUT of the reference cylinder are highlighted.
36
37 \image html shonshex1.png
38 \image html shonshex2.png
39
40  
41 */