PartDesign SubtractiveHelix: Difference between revisions

From FreeCAD Documentation
m (typo)
No edit summary
Line 20: Line 20:


==Description==
==Description==
The '''Pocket''' tool cuts out a solid by extruding a sketch (or a face of the solid) in a straight path and subtracting it from the solid.
The '''Helix''' tool creates a solid by sweeping a selected sketch or 2D object along a helix path.


</translate>
</translate>[[File:Helix overview.png|none]]<translate>

[[File:PartDesign Pocket example.svg|none]]
<!--T:11-->
<translate>
''The profile (B), is swept around axis (A) in order to produce the solid helix (C)''
<!--T:8-->
''Sketch profile (A) was mapped to the top face of base solid (B); result after pocketing through on the right. ''


==Usage==
==Usage==

# Select the sketch to be pocketed.
<!--T:13-->
#: The sketch must be mapped to the planar face of an existing solid or Part Design feature, or an error message will appear.
# Select the sketch to be swept into a helix. A face on the existing solid can alternatively be used.
# Press the {{KEY|[[Image:PartDesign_Pocket.svg|16px]] '''Pocket'''}} button.
# Press the {{KEY|[[Image:PartDesign_AdditiveHelix.svg|24px]] '''AdditiveHelix'''}} button.
# Set the Pocket parameters (see next section).
# Set the Helix parameters (see next section).
# Click OK.
# Inspect the Helix in the view window, to ensure that the parameters do not result in a self intersecting helix.
# Press {{KEY|OK}}.


==Options==
==Options==
When creating an Additive Helix, the '''Helix parameters''' dialogue offers several parameters specifying how the sketch should be swept.
[[Image:Pocket_options.png|left]]

{|
| [[File:Parameter dialog for AdditiveHelix tool.png|left]]
|
===Axis===
This option specifies the axis about which the sketch is to be swept.
* '''Vertical sketch axis''': selects the vertical sketch axis.
* '''Horizontal sketch axis''': selects the horizontal sketch axis.
* '''Construction line''': selects a construction line contained in the sketch used by the Helix. The drop down list will contain an entry for each construction line. The first construction line created in the sketch will be labelled ''Construction line 1''.
* '''Base (X/Y/Z) axis''': selects the X, Y or Z axis of the Body's Origin;
* '''Select reference...''': allows selection in the 3D view of an edge on the Body, or a [[PartDesign Line|datum line]].

===Mode===
This controls what parameters will be used to define the helix, Allowable choices are: Pitch-Height, Pitch-Turns and Height-Turns.
===Pitch===
The distance between turns in the helix.
===Height===
The height of the helix (center-center).
===Turns===
The number of turns in the helix. Define as Height/Pitch

===Left handed===
If checked, the turning direction of helix is reversed from default clockwise to counterclockwise.

===Reversed===
If checked, the axis direction of helix is reversed from default.

===Update view===
If checked, the helix will be shown in the view, and updated automatically on every change of the parameters.

|}
{{clear}}

==Properties ==


Below are properties which can be defined after creation of the feature.
When creating a pocket, the '''Pocket parameters''' dialogue offers five different ways of specifying the length (depth) to which the pocket will be extruded:
===Dimension===
Enter a numeric value for the depth of the pocket. The default direction for extrusion is into the support. Extrusions occur [http://en.wikipedia.org/wiki/Surface_normal normal] to the defining sketch plane. Negative dimensions are not possible. Use the '''Reversed''' option instead.
===To first===
The pocket will extrude up to the first face of the support in the extrusion direction. In other words, it will cut through all material until it reaches an empty space.
===Through all===
The pocket will cut through all material in the extrusion direction. With the option '''Symmetric to plane''' the pad will cut through all material in both directions.</br>'''Note:''' For technical reasons, ''Through All'' is actually a 10 meter deep pocket. If you need deeper pockets, use ''Dimension''.


* {{PropertyData|Pitch}}: The axial distance between two turns.
===Up to face===
* {{PropertyData|Height}}: The total length of the helix (not accounting for the extent of the profile)
The pocket will extrude up to a face in the support that can be chosen by clicking on it.
* {{PropertyData|Turns}}: The number of turns (do not need to be a whole number)
===Two dimensions===
* {{PropertyData|Left Handed}}:
This allows to enter a second length in which the pocket should extend in the opposite direction (into the support). Again can be changed by ticking the '''Reversed''' option. {{VersionPlus|0.17}}
* {{PropertyData|Reversed}}: true or false. See [[#Reversed|Reversed]].
* {{PropertyData|Angle}}: Not used.
* {{PropertyData|Reference axis}}: The the helix axis
* {{PropertyData|Mode}}: The helix input mode (pitch-height, pitch-turns, turns-height)
* {{PropertyData|Outside}}: Not used (Used in SubtractiveHelix)
* {{PropertyData|Has Been Edited}}: If false, the tool will propose an initial value for pitch based on the profile bounding box, so that self intersection is avoided.
* {{PropertyData|Refine}}: true or false. If set to true, cleans the solid from residual edges left by features. See [[Part RefineShape]] for more details.
* {{PropertyData|Profile}}: Either a sketch containing a closed contour, or a face.
* {{PropertyData|Midplane}}: Not used.
* {{PropertyData|Up to face}}: Not used.
* {{PropertyData|Allow multiple face}}: Not used.


==Limitations==
==Examples==
* Use the type '''Dimension''' or '''Through All''' wherever possible because the other types sometimes give trouble when they are being patterned
* Otherwise, the pocket feature has the same [[PartDesign_Pad#Limitations|limitations]] as the pad feature.


{{Docnav
{{Docnav

Revision as of 08:06, 6 February 2021

This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.

PartDesign SubtractiveHelix

Menu location
PartDesign → Create a subtractive feature → Subtractive helix
Workbenches
PartDesign
Default shortcut
None
Introduced in version
0.19
See also
None

Description

The Helix tool creates a solid by sweeping a selected sketch or 2D object along a helix path.

File:Helix overview.png

The profile (B), is swept around axis (A) in order to produce the solid helix (C)

Usage

  1. Select the sketch to be swept into a helix. A face on the existing solid can alternatively be used.
  2. Press the AdditiveHelix button.
  3. Set the Helix parameters (see next section).
  4. Inspect the Helix in the view window, to ensure that the parameters do not result in a self intersecting helix.
  5. Press OK.

Options

When creating an Additive Helix, the Helix parameters dialogue offers several parameters specifying how the sketch should be swept.

File:Parameter dialog for AdditiveHelix tool.png

Axis

This option specifies the axis about which the sketch is to be swept.

  • Vertical sketch axis: selects the vertical sketch axis.
  • Horizontal sketch axis: selects the horizontal sketch axis.
  • Construction line: selects a construction line contained in the sketch used by the Helix. The drop down list will contain an entry for each construction line. The first construction line created in the sketch will be labelled Construction line 1.
  • Base (X/Y/Z) axis: selects the X, Y or Z axis of the Body's Origin;
  • Select reference...: allows selection in the 3D view of an edge on the Body, or a datum line.

Mode

This controls what parameters will be used to define the helix, Allowable choices are: Pitch-Height, Pitch-Turns and Height-Turns.

Pitch

The distance between turns in the helix.

Height

The height of the helix (center-center).

Turns

The number of turns in the helix. Define as Height/Pitch

Left handed

If checked, the turning direction of helix is reversed from default clockwise to counterclockwise.

Reversed

If checked, the axis direction of helix is reversed from default.

Update view

If checked, the helix will be shown in the view, and updated automatically on every change of the parameters.

Properties

Below are properties which can be defined after creation of the feature.

  • DataPitch: The axial distance between two turns.
  • DataHeight: The total length of the helix (not accounting for the extent of the profile)
  • DataTurns: The number of turns (do not need to be a whole number)
  • DataLeft Handed:
  • DataReversed: true or false. See Reversed.
  • DataAngle: Not used.
  • DataReference axis: The the helix axis
  • DataMode: The helix input mode (pitch-height, pitch-turns, turns-height)
  • DataOutside: Not used (Used in SubtractiveHelix)
  • DataHas Been Edited: If false, the tool will propose an initial value for pitch based on the profile bounding box, so that self intersection is avoided.
  • DataRefine: true or false. If set to true, cleans the solid from residual edges left by features. See Part RefineShape for more details.
  • DataProfile: Either a sketch containing a closed contour, or a face.
  • DataMidplane: Not used.
  • DataUp to face: Not used.
  • DataAllow multiple face: Not used.

Examples