Part Slice: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
No edit summary
(46 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<translate>
<!--T:25-->
{{Docnav
|[[Part_SliceApart|SliceApart]]
|[[Part_XOR|XOR]]
|[[Part_Module|Part]]
|IconL=Part_SliceApart.svg
|IconR=Part_XOR.svg
|IconC=Workbench_Part.svg
}}


<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand|Name=Part Slice|MenuLocation=Part → Split → Slice|Workbenches=[[Part Module|Part]]|SeeAlso=[[Part_BooleanFragments|Part Boolean Fragments]], [[Part_XOR|Part XOR]], [[Part_CompJoinFeatures|Join features]], [[Part Booleans|Part Booleans]]}}
|Name=Part Slice
|MenuLocation=Part → Split → Slice
|Workbenches=[[Part_Module|Part]]
|Version=0.17
|SeeAlso=[[Part_BooleanFragments|Part Boolean Fragments]], [[Part_XOR|Part XOR]], [[Part_CompJoinFeatures|Part Join features]], [[Part_Boolean|Part Boolean]]
}}

==Description== <!--T:36-->


==Description== <!--T:2-->
<!--T:2-->
Tool to split shapes by intersection with other shapes. For example, for a box and a plane, a compound of two solids is created.
The [[Image:Part_Slice.svg|24px]] [[Part_Slice|Part Slice]] also known as '''Slice to compound''' tool is used to split shapes by intersection with other shapes. For example, for a box and a plane, a compound of two solids is created.


<!--T:3-->
<!--T:3-->
Line 11: Line 29:


<!--T:4-->
<!--T:4-->
(on the picture above, the pieces were moved apart manually afterwards, to reveal the slicing)
{{Caption|Above: the pieces were moved apart manually afterwards, to reveal the slicing}}

<!--T:23-->
There are two commands to slice a shape: [[Image:Part_SliceApart.svg|24px]] [[Part SliceApart|Slice apart]] and [[Image:Part_Slice.svg|24px]] [[Part Slice|Slice to compound]]. They both create a 'Slice' parametric feature, that puts the sliced pieces into a compound. However, [[Image:Part_SliceApart.svg|24px]] [[Part SliceApart|Slice Apart]] explodes the resulting compound into separate objects. "Slice to compound" is fully-parametric, and causes no trouble as the number of pieces changes. "Slice apart" will not update the number of objects as the number of pieces changes.


<!--T:5-->
<!--T:5-->
The output shape occupies the same space as the original. But it is split where it intersects with other shapes. The split pieces are put into a compound (or compsolid), so the object appears to remain in one piece. You need to explode the compound to get the individual pieces. Use, for example, [[Draft Downgrade]] for the purpose.
The output shape occupies the same space as the original. But it is split where it intersects with other shapes. The split pieces are put into a compound (or compsolid), so the object appears to remain in one piece. You need to explode the compound to get the individual pieces. If you want to access the individual pieces in a parametric way you can use [[Image:Part_CompoundFilter.svg|24px]] [[Part CompoundFilter]] for this purpose. For quick non-parametric access use [[Image:Draft_Downgrade.svg|24px]] [[Draft Downgrade]].


<!--T:6-->
<!--T:6-->
The tool has three modes: "Standard", "Split", and "CompSolid".
The tool has three modes: "Standard", "Split", and "CompSolid". There is no selection form, they are predefined but can be accessed after the operation on the resulting slices level.


<!--T:7-->
<!--T:7-->
Line 29: Line 50:


<!--T:10-->
<!--T:10-->
The overall action of the tool is very similar to [[Part BooleanFragments|Boolean Fragments]], except only the pieces from the first shape are in the result.
The overall action of the tool is very similar to [[Image:Part_BooleanFragments.svg|24px]] [[Part BooleanFragments|Boolean Fragments]], except only the pieces from the first shape are in the result.


==How to use== <!--T:11-->
==Usage== <!--T:37-->

# Select the object to be sliced, first, and then some objects to slice with. <br /> The order of selection is important. Compounds with self-intersections are not allowed (self-intersections sometimes can be accounted for by passing the compound through [[Part_BooleanFragments|BooleanFragments]])
<!--T:11-->
# Invoke the Part Slice command.
# Select the object to be sliced, first, and then some objects to slice with. <br /> The order of selection is important. Compounds with self-intersections are not allowed (self-intersections sometimes can be accounted for by passing the compound through [[Image:Part_BooleanFragments.svg|24px]] [[Part_BooleanFragments|BooleanFragments]])
# Invoke the Part Slice command several ways:
#* Press the [[Image:Part_Slice.svg|24px]] [[Part Slice]] button in the Part toolbar
#* Use the {{MenuCommand|Part → Split → Slice}} entry in the Part menu

<!--T:29-->
# Noteː The Objects to slice with must completely separate the object to be sliced. Thus a cube cannot be sliced by a wire, but by a plane derived from an extruded wire for instance.


<!--T:12-->
<!--T:12-->
A Slice parametric object is created. Original objects are hidden, and the result of intersection is shown in 3D view.
A Slice parametric object is created. Original objects are hidden, and the result of intersection is shown in [[3D view]].

===Tree structure of Slice === <!--T:30-->
The Slice command creates a sliced object. In the following example a cube is sliced by a face.

<!--T:31-->
The slice is created and each piece of it is united in a Compound.

<!--T:32-->
[[Image:Part_SliceTree.png]]

==Properties== <!--T:38-->


==Properties== <!--T:13-->
<!--T:13-->
{{TitleProperty|Slice}}
{{TitleProperty|Slice}}
* {{PropertyData|Base}}: Object to be sliced.
* {{PropertyData|Base}}: Object to be sliced.
Line 45: Line 84:
* {{PropertyData|Tolerance}}: "fuzziness" value. This is an extra tolerance to apply when searching for intersections, in addition to tolerances stored in the input shapes.
* {{PropertyData|Tolerance}}: "fuzziness" value. This is an extra tolerance to apply when searching for intersections, in addition to tolerances stored in the input shapes.


==Example: making puzzle== <!--T:14-->
<!--T:33-->
̈Noteː Properties are accessible on the slices inner object, not on the result level.
# Switch to [[Sketcher Workbench]], create an new sketch. Draw a rectangle that will outline the overall shape of the puzzle. Close the sketch.<br />[[image:slice_example_step1.png|320px]]

# Switch to [[Part Module|Part workbench]]. Select the sketch, and pick Part->Create face from sketch (in menu).<br />[[image:slice_example_step2.png|320px]]
==Example== <!--T:14-->
# Switch to Sketcher workbench, and create another sketch on the same plane. Using polyline tool, draw the lines that will split the puzzle into pieces.<br />[[image:slice_example_step3.png|320px]]

# Switch to Part workbench. Select the splitter sketch, and apply [[Part BooleanFragments|Part Boolean Fragments]]. This will insert vertices where lines of splitter sketch intersect. Having them is essential for the next step to work.<br />[[image:slice_example_step4.png|320px]]
===Creating a Puzzle=== <!--T:34-->
# Select the rectangular face, and the BooleanFragments of splitter sketch, and apply Part Split.<br />[[image:slice_example_step5.png|320px]]

# Switch to Draft workbench, and apply Draft Downgrade to the result. You should get all the pieces as "Face00X" in document tree, that can be moved independently. Done!<br />[[image:slice_example_step6.png|320px]]
<!--T:35-->
# Switch to [[Image:Workbench_Sketcher.svg|24px]] [[Sketcher Workbench]]
#* Create a new sketch.
#* Draw a rectangle that will outline the overall shape of the puzzle.
#* Close the sketch.<br />[[image:slice_example_step1.png|320px]]
# Switch to [[Image:Workbench_Part.svg|24px]] [[Part Module|Part workbench]].
#* Select the sketch, and pick {{MenuCommand|Part → Create face from sketch}} .<br />[[image:slice_example_step2.png|320px]]
# Switch back to [[Image:Workbench_Sketcher.svg|24px]] [[Sketcher Workbench]]
#* Create another sketch on the same plane.
#* Using polyline tool, draw the lines that will split the puzzle into pieces.<br />[[image:slice_example_step3.png|320px]]
# Switch back to [[Image:Workbench_Part.svg|24px]] [[Part Module|Part Workbench]].
#* Select the splitter sketch, and apply [[Image:Part_BooleanFragments.svg|24px]] [[Part BooleanFragments|Part Boolean Fragments]]. This will insert vertices where lines of splitter sketch intersect. Having them is essential for the next step to work.<br />[[image:slice_example_step4.png|320px]]
# Select the rectangular face, and the BooleanFragments of splitter sketch, and apply [[Image:Part_Slice.svg|24px]] Part Slice.<br />[[image:slice_example_step5.png|320px]]
# Use [[Image:Part_ExplodeCompound.svg|24px]] [[Part ExplodeCompound]] on the sliced face, to break apart the compound made by Part Slice into individual pieces.

<!--T:24-->
'''Note:''' Steps 5 and 6 can be done in single click using [[Image:Part_SliceApart.svg|24px]] [[Part SliceApart]]

==Notes== <!--T:39-->

<!--T:22-->
* The tool was introduced in FreeCAD v0.17.8053. FreeCAD needs to be compiled with OCC 6.9.0 or later; otherwise, the tool is unavailable.
* ̈Properties are accessible on the slices inner object, not on the result level.
* The Objects to slice with must completely separate the object to be sliced. Thus a cube cannot be sliced by a wire, but by a plane derived from an extruded wire for instance.
* Slicing object must pass BOP check. See [[Image:Part_CheckGeometry.svg|24px]] [[Part CheckGeometry]].


==Scripting== <!--T:15-->
==Scripting== <!--T:15-->
Line 58: Line 122:
The tool can by used in [[macros]] and from the python console by using the following function:
The tool can by used in [[macros]] and from the python console by using the following function:
</translate>
</translate>
'''BOPTools.SplitFeatures.makeSlice(name)'''
{{Code|code=BOPTools.SplitFeatures.makeSlice(name)}}
<translate>
<translate>


Line 68: Line 132:
Slice can also be applied to plain shapes, without the need to have a document object, via:
Slice can also be applied to plain shapes, without the need to have a document object, via:
</translate>
</translate>
'''Part.BOPTools.SplitAPI.slice(base_shape, tool_shapes, mode, tolerance = 0.0)'''
{{Code|code=BOPTools.SplitAPI.slice(base_shape, tool_shapes, mode, tolerance = 0.0)}}
<translate>
<translate>
<!--T:19-->
<!--T:19-->
Line 78: Line 142:
</translate>
</translate>
{{code|code=
{{code|code=
import Part
import BOPTools.SplitFeatures
j = Part.BOPTools.SplitFeatures.makeSlice(name= 'Slice')
j = BOPTools.SplitFeatures.makeSlice(name= 'Slice')
j.Base = FreeCADGui.Selection.getSelection()[0]
j.Base = FreeCADGui.Selection.getSelection()[0]
j.Tools = FreeCADGui.Selection.getSelection()[1:]
j.Tools = FreeCADGui.Selection.getSelection()[1:]
Line 86: Line 150:


<!--T:21-->
<!--T:21-->
The tool itself is implemented in Python, see /Mod/Part/BOPTools/SplitFeatures.py under where FreeCAD is installed.
The tool itself is implemented in Python, see {{FileName|/Mod/Part/BOPTools/SplitFeatures.py}} ([https://github.com/FreeCAD/FreeCAD/blob/master/src/Mod/Part/BOPTools/SplitFeatures.py GitHub link]) within the FreeCAD installation directory.



==Version== <!--T:22-->
==Tutorials== <!--T:40-->
The tool was introduced in FreeCAD v0.17.8053. FreeCAD needs to be compiled with OCC 6.9.0 or later; otherwise, the tool is unavailable.

<!--T:42-->
* [https://www.youtube.com/watch?v=tzHkQaHgrfQ FreeCad 0.18 Part WB using Slice and Slice Apart] (English language), author: Ha Gei

<!--T:43-->
* [https://www.youtube.com/watch?v=JJAL5JmqqKQ FreeCAD Slice und Slice Apart und andere Tricks] (German language), author: Ha Gei


<!--T:26-->
{{Docnav
|[[Part_SliceApart|SliceApart]]
|[[Part_XOR|XOR]]
|[[Part_Module|Part]]
|IconL=Part_SliceApart.svg
|IconR=Part_XOR.svg
|IconC=Workbench_Part.svg
}}


</translate>
</translate>
{{Part Tools navi{{#translation:}}}}
{{clear}}
{{Userdocnavi{{#translation:}}}}
<languages/>

Revision as of 18:42, 27 November 2020

Part Slice

Menu location
Part → Split → Slice
Workbenches
Part
Default shortcut
None
Introduced in version
0.17
See also
Part Boolean Fragments, Part XOR, Part Join features, Part Boolean

Description

The Part Slice also known as Slice to compound tool is used to split shapes by intersection with other shapes. For example, for a box and a plane, a compound of two solids is created.

Above: the pieces were moved apart manually afterwards, to reveal the slicing

There are two commands to slice a shape: Slice apart and Slice to compound. They both create a 'Slice' parametric feature, that puts the sliced pieces into a compound. However, Slice Apart explodes the resulting compound into separate objects. "Slice to compound" is fully-parametric, and causes no trouble as the number of pieces changes. "Slice apart" will not update the number of objects as the number of pieces changes.

The output shape occupies the same space as the original. But it is split where it intersects with other shapes. The split pieces are put into a compound (or compsolid), so the object appears to remain in one piece. You need to explode the compound to get the individual pieces. If you want to access the individual pieces in a parametric way you can use Part CompoundFilter for this purpose. For quick non-parametric access use Draft Downgrade.

The tool has three modes: "Standard", "Split", and "CompSolid". There is no selection form, they are predefined but can be accessed after the operation on the resulting slices level.

"Standard" and "Split" differ by the action of the tool on wires, shells and compsolids: if "Split", those are separated; if "Standard", they are kept together (get extra segments).

Compounding structure in "Standard" and "Split" modes follows the compounding structure of shape being sliced.

In "CompSolid" mode, the output is a compsolid (or a compound of compsolids, if the resulting solids form more than one island of connectedness). Compsolid is a set of solids connected by faces; they are related to solids like wires are related to edges, and shells are related to faces; the name is probably a shortened phrase "composite solid".

The overall action of the tool is very similar to Boolean Fragments, except only the pieces from the first shape are in the result.

Usage

  1. Select the object to be sliced, first, and then some objects to slice with.
    The order of selection is important. Compounds with self-intersections are not allowed (self-intersections sometimes can be accounted for by passing the compound through BooleanFragments)
  2. Invoke the Part Slice command several ways:
    • Press the Part Slice button in the Part toolbar
    • Use the Part → Split → Slice entry in the Part menu
  1. Noteː The Objects to slice with must completely separate the object to be sliced. Thus a cube cannot be sliced by a wire, but by a plane derived from an extruded wire for instance.

A Slice parametric object is created. Original objects are hidden, and the result of intersection is shown in 3D view.

Tree structure of Slice

The Slice command creates a sliced object. In the following example a cube is sliced by a face.

The slice is created and each piece of it is united in a Compound.

Properties

Slice

  • DataBase: Object to be sliced.
  • DataTools: List of objects to slice with. (as of FreeCAD v0.17.8053, this property is not displayed in property editor, and can only be accessed via Python).
  • DataMode: "Standard", "Split", or "CompSolid". "Split" is default. Standard and Split differ by the action of the tool on aggregation type shapes: if Split, those are separated; otherwise they are kept together (get extra segments).
  • DataTolerance: "fuzziness" value. This is an extra tolerance to apply when searching for intersections, in addition to tolerances stored in the input shapes.

̈Noteː Properties are accessible on the slices inner object, not on the result level.

Example

Creating a Puzzle

  1. Switch to Sketcher Workbench
    • Create a new sketch.
    • Draw a rectangle that will outline the overall shape of the puzzle.
    • Close the sketch.
  2. Switch to Part workbench.
    • Select the sketch, and pick Part → Create face from sketch .
  3. Switch back to Sketcher Workbench
    • Create another sketch on the same plane.
    • Using polyline tool, draw the lines that will split the puzzle into pieces.
  4. Switch back to Part Workbench.
    • Select the splitter sketch, and apply Part Boolean Fragments. This will insert vertices where lines of splitter sketch intersect. Having them is essential for the next step to work.
  5. Select the rectangular face, and the BooleanFragments of splitter sketch, and apply Part Slice.
  6. Use Part ExplodeCompound on the sliced face, to break apart the compound made by Part Slice into individual pieces.

Note: Steps 5 and 6 can be done in single click using Part SliceApart

Notes

  • The tool was introduced in FreeCAD v0.17.8053. FreeCAD needs to be compiled with OCC 6.9.0 or later; otherwise, the tool is unavailable.
  • ̈Properties are accessible on the slices inner object, not on the result level.
  • The Objects to slice with must completely separate the object to be sliced. Thus a cube cannot be sliced by a wire, but by a plane derived from an extruded wire for instance.
  • Slicing object must pass BOP check. See Part CheckGeometry.

Scripting

The tool can by used in macros and from the python console by using the following function:

BOPTools.SplitFeatures.makeSlice(name)
  • Creates an empty Slice feature. The 'Base' and 'Tools' properties must be assigned explicitly, afterwards.
  • Returns the newly created object.

Slice can also be applied to plain shapes, without the need to have a document object, via:

BOPTools.SplitAPI.slice(base_shape, tool_shapes, mode, tolerance = 0.0)

This can be useful for making custom Python scripted features.


Example:

import BOPTools.SplitFeatures
j = BOPTools.SplitFeatures.makeSlice(name= 'Slice')
j.Base = FreeCADGui.Selection.getSelection()[0]
j.Tools = FreeCADGui.Selection.getSelection()[1:]

The tool itself is implemented in Python, see /Mod/Part/BOPTools/SplitFeatures.py (GitHub link) within the FreeCAD installation directory.


Tutorials