CAM Profile: Difference between revisions

From FreeCAD Documentation
m (Use the correct naming convention for workbenches)
(Marked this version for translation)
(13 intermediate revisions by 4 users not shown)
Line 3: Line 3:


<!--T:40-->
<!--T:40-->
{{Docnav
{{Docnav|[[Path_Engrave|Engrave]]|[[Path_Helix|Helix]]|[[Path_Workbench|Path]]|IconL=Path-Engrave.png|IconC=Workbench_Path.svg|IconR=Path-Helix.png}}
|[[Path_Engrave|Engrave]]
|[[Path_Helix|Helix]]
|[[Path_Workbench|Path]]
|IconL=Path_Engrave.svg
|IconC=Workbench_Path.svg
|IconR=Path_Helix.svg
}}


<!--T:1-->
<!--T:44-->
{{GuiCommand
{{GuiCommand|Name=Path Profile|Workbenches=[[Path Workbench|Path]]|MenuLocation=Path → New Operation → Profile|Shortcut=P,P|SeeAlso=}}
|Name=Path Profile
|Workbenches=[[Path Workbench|Path]]
|MenuLocation=Path → Profile
|Shortcut=None
|Version=0.19
|SeeAlso=[[Path Contour|Path Contour]], [[Path ProfileFace|Path ProfileFace]], [[Path ProfileEdges|Path ProfileEdges]]
}}


==Description== <!--T:2-->
==Description== <!--T:45-->


<!--T:3-->
<!--T:46-->
The {{KEY|[[Image:Path Profile.png|16px]] [[Path Profile|Profile]]}} tool creates a contour operation based on selected features of the model.
The Contour tool creates a simple external contour cut of complex 3D [[Part Module|Part]]-based objects. The entire Job Model serves as the input for the Operation--regardless of whether any Body Geometry is selected when the Contour command is invoked. A Start point can be enabled from the Operation editor, using a location defined in the Property view->Start Points.


<!--T:4-->
<!--T:47-->
Although the {{KEY|[[Image:Path Profile.png|16px]] [[Path Profile|Profile]]}} tool is new in 0.19, it is simply a combination of the pre-existing {{KEY|[[Image:Path Contour.png|16px]] [[Path Contour|Contour]]}}, {{KEY|[[Image:Path Profile_Face.png|16px]] [[Path ProfileFace|Profile Face]]}}, and {{KEY|[[Image:Path Profile_Edges.png|16px]] [[Path ProfileEdges|Profile Edges]]}} operations that maintains their pre-existing capabilities. See their documentation for more details.

</translate>
[[Image:Path profile example.jpg|600px]]
[[Image:Path profile example.jpg|600px]]
<translate>
==Usage== <!--T:48-->


==Usage== <!--T:5-->


<!--T:6-->
<!--T:49-->
Initiate a Profile operation by doing the following:
# Select a face on a [[Part Module|Part]]-based object. Alternatively, also select a starting edge on that face.
# Invoke the command several ways:
# Press the {{KEY|[[Image:Path Profile.png|16px]] [[Path Profile|Profile]]}} button
#* Press the {{KEY|[[Image:Path Profile.png|16px]] [[Path Profile|Profile]]}} button
# Adjust the desired properties
#* Use the {{MenuCommand|Path → Profile}} entry in the Path menu
# Activate the Base Geometry section by clicking its tab, and select features from the Job model.
#*If no features are selected, the {{KEY|[[Image:Path Profile.png|16px]] [[Path Profile|Profile]]}} tool defaults to the previous {{KEY|[[Image:Path Contour.png|16px]] [[Path Contour|Contour]]}} operation behavior, contouring the entire model.
#*If faces are selected, then the previous {{KEY|[[Image:Path Profile_Face.png|16px]] [[Path ProfileFace|Profile Face]]}} behaviors are used.
#*If edges are selected, then the previous {{KEY|[[Image:Path Profile_Edges.png|16px]] [[Path ProfileEdges|Profile Edges]]}} behaviors are used.<BR />'''NOTE''': The profile edges portion of the {{KEY|[[Image:Path Profile.png|16px]] [[Path Profile|Profile]]}} operation has received improvements to allow functionality on some open-edge (non-loop) selections. See the '''Usage Notes''' section below for additional information on best practice for profiling open-edges.
# Activate the Operation section by clicking on its tab, and adjust the operation's settings as desired.
# (''Optional'') Click the '''Apply''' button to preview the operation with the current settings.
# Click the '''OK''' or '''Cancel''' buttons to create or cancel the operation.


==Options== <!--T:7-->
<!--T:50-->
A Start point can be enabled from the Operation tab in the Tasks Window editor, using a location defined in the {{MenuCommand|Property View → Data → Start Point}}.

<!--T:51-->
Make additional adjustments to the operation by modifying the operation's properties in the Data tab of the Property View. Advanced properties will be located here, if any.

==Usage Notes== <!--T:68-->
* To perform a {{KEY|[[Image:Path Profile.png|16px]] [[Path Profile|Profile]]}} operation on open-edges, it is best to select the top edges (highest edges) for the selection, and then manually set the Final Depth for the operation. Selection of bottom edges is unpredictable and will likely return undesirable paths in many situations.
* When profiling open-edges, the `Side` or `Cut Side` property is disabled internally even though it will likely be visible within the Task editor window and the Properties list within the Data tab.
* When profiling the entire model, a complete contour of the model, the `Side` or `Cut Side` property is hard coded to `Outside` even though it might be available for user input.


<!--T:8-->
* The Path Profile object is made to be part of a [[Path Job]]. To correctly configure the profiling, a tool table must be present in the project's machine object, and a [[Path ToolNumberToLoad|Tool Change]] command must be placed before the profile.


==Properties== <!--T:9-->
==Properties== <!--T:9-->
Line 33: Line 68:
''' ''Note'' ''': Not all of these Properties are available in the Task Window Editor. Some are only accessible in the Data tab of the Properties View panel for this Operation.
''' ''Note'' ''': Not all of these Properties are available in the Task Window Editor. Some are only accessible in the Data tab of the Properties View panel for this Operation.


====Base==== <!--T:22-->
====Base==== <!--T:52-->

<!--T:22-->
Note: It is suggested that you do not edit the Placement property of path operations. Rather, move or rotate the Path Job model as needed.
Note: It is suggested that you do not edit the Placement property of path operations. Rather, move or rotate the Path Job model as needed.


Line 49: Line 86:
* {{PropertyData|Label}}: User-provided name of the object (UTF-8)
* {{PropertyData|Label}}: User-provided name of the object (UTF-8)


====Depth==== <!--T:24-->
====Depth==== <!--T:53-->


<!--T:25-->
<!--T:54-->
* {{PropertyData|Clearance Height}}: The height needed to clear clamps and obstructions
* {{PropertyData|Clearance Height}}: The height needed to clear clamps and obstructions
* {{PropertyData|Final Depth}}: Final Depth of Tool- lowest value in Z
* {{PropertyData|Final Depth}}: Final Depth of Tool- lowest value in Z
* {{PropertyData|Finish Depth}}: Maximum material removed on final pass. The height (thickness) of the last cutting level - ''set for a better finish''.
* {{PropertyData|Safe Height}}: The above which Rapid motions are allowed.
* {{PropertyData|Start Depth}}: Starting Depth of Tool- first cut depth in Z
* {{PropertyData|Safe Height}}: The height above which Rapid motions are allowed. (Rapid safety height between locations)
* {{PropertyData|Step Down}}: Incremental Step Down of Tool
* {{PropertyData|Start Depth}}: Starting depth of Tool - ''first cut depth in Z''
* {{PropertyData|Step Down}}: Incremental step down of Tool during operation
</translate>
[[File:Path-DepthsAndHeights.gif|300px|center]]
<translate>
<!--T:55-->
{{Caption|Visual reference for Depth properties (settings)}}


====Path==== <!--T:26-->
====Path==== <!--T:56-->


<!--T:27-->
<!--T:57-->
* {{PropertyData|Active}}: make False, to prevent operation from generating code
* {{PropertyData|Active}}: make False, to prevent operation from generating code
* {{PropertyData|Base}}: The base geometry for this operation
* {{PropertyData|Comment}}: An optional comment for this Operation
* {{PropertyData|Comment}}: An optional comment for this Operation
* {{PropertyData|User Label}}: User assigned label
* {{PropertyData|Coolant Mode}}: The coolant mode for this operation.
* {{PropertyData|Cycle Time}}: The cycle time estimation for this operation.
* {{PropertyData|Tool Controller}}: Defines the Tool controller used in the Operation
* {{PropertyData|Tool Controller}}: Defines the Tool controller used in the Operation
* {{PropertyData|User Label}}: User assigned label


====Profile==== <!--T:19-->
====Profile==== <!--T:19-->


<!--T:20-->
<!--T:58-->
* {{PropertyData|Direction}}: The direction that the toolpath should go around the part: Clockwise[CW] or Counterclockwise[CCW]
* {{PropertyData|Direction}}: The direction that the tool path should go around the part: Clockwise[CW] or Counterclockwise[CCW]
* {{PropertyData|Join Type}}: Controls how tool moves around corners.
* {{PropertyData|Expand Profile}}: Extend the profile clearing beyond the Extra Offset.
* {{PropertyData|Expand Profile Step Over}}: Set the stepover percentage, based on the tool's diameter.
* {{PropertyData|Handle Multiple Features}}: Choose how to process multiple Base Geometry features.
* {{PropertyData|OffsetExtra}}: Extra value to stay away from final profile- good for roughing toolpath
* {{PropertyData|OffsetExtra}}: Extra value to stay away from final profile- good for roughing toolpath
* {{PropertyData|Side}}: (Cut Side) Side of edge that tool should cut. This only matters if `Use Compensation` is True(checked).
* {{PropertyData|Use Compensation}}: If checked, the Profile Operation is offset by the tool radius. The offset direction is determined by the Cut Side.
* {{PropertyData|Process Circles}}: Check if you want this Profile Operation to also be applied to cylindrical holes, ''which normally get drilled''.
* {{PropertyData|Process Circles}}: Check if you want this Profile Operation to also be applied to cylindrical holes, ''which normally get drilled''.
* {{PropertyData|Process Holes}}: Check if this Profile Operation should also process holes in the base geometry. '''Note''' that this does not include cylindrical holes.
* {{PropertyData|Process Holes}}: Check if this Profile Operation should also process holes in the base geometry. '''Note''' that this does not include cylindrical holes.
* {{PropertyData|Process Perimeter}}: Check if this Profile Operation should also process the outside perimeter of the base geometry shapes
* {{PropertyData|Process Perimeter}}: Check if this Profile Operation should also process the outside perimeter of the base geometry shapes
* {{PropertyData|Side}}: (Cut Side) Side of edge that tool should cut. This only matters if `Use Compensation` is True(checked).
* {{PropertyData|Use Compensation}}: If checked, the Profile Operation is offset by the tool radius. The offset direction is determined by the Cut Side.


====Rotation==== <!--T:28-->
====Rotation==== <!--T:28-->


<!--T:29-->
<!--T:59-->
* {{PropertyData|Attempt Inverse Angle}}: Automatically attempt Inverse Angle if initial rotation is incorrect.
* {{PropertyData|Attempt Inverse Angle}}: Automatically attempt Inverse Angle if initial rotation is incorrect.
* <s>{{PropertyData|B_Axis Error Override}}: Visually orient B(y) rotations to model (error in FreeCAD rendering).</s>
* {{PropertyData|Enable Rotation}}: Enable rotation to gain access to pockets or areas not normal to Z axis.
* {{PropertyData|Enable Rotation}}: Enable rotation to gain access to pockets or areas not normal to Z axis.
* {{PropertyData|Inverse Angle}}: Inverse the angle of the rotation. '' '''Example:''' change a rotation from -22.5 to 22.5 degrees.''
* {{PropertyData|Inverse Angle}}: Inverse the angle of the rotation. '' '''Example:''' change a rotation from -22.5 to 22.5 degrees.''
* {{PropertyData|Limit Depth To Face}}: Enforce the Z-depth of the selected face as the lowest value for final depth. Higher user values for final depth will be observed.
* {{PropertyData|Reverse Direction}}: Reverse orientation of Operation by 180 degrees.
* {{PropertyData|Reverse Direction}}: Reverse orientation of Operation by 180 degrees.


====Start Point==== <!--T:15-->
====Start Point==== <!--T:60-->


<!--T:16-->
<!--T:61-->
* {{PropertyData|Start Point}}: The start point of this path
* {{PropertyData|Start Point}}: The custom start point for the path of this operation.
** {{PropertyData|X}}: x distance value
* {{PropertyData|Use Start Point}}: make True, if manually specifying a Start Point, then enter Start Points in the property data Start Points field
* {{PropertyData|Extend At Start}}: extra length of tool path before start of part edge
** {{PropertyData|Y}}: y distance value
** {{PropertyData|Z}}: z distance value
* {{PropertyData|LeadIn Line Len}}: length of straight segment of toolpath that comes in at angle to first part edge
* {{PropertyData|Use Start Point}}: Make True, if manually specifying a Start Point. Set the start point in the property data Start Point field.


====End Point==== <!--T:17-->


<!--T:18-->
==Tasks Window Editor Layout== <!--T:62-->
* {{PropertyData|Use End Point}}: make True, if specifying an End Point
* {{PropertyData|Extend At End}}: extra length of tool path after end of part edge
* {{PropertyData|LeadOut LineLen}}: length of straight segment of toolpath that comes in at angle to last part edge
* {{PropertyData|End Point}}: The end point of this path


<!--T:31-->

===<span sytle="color:red;">Extras, Not-in-use, or Degraded</span>=== <!--T:30-->
* {{PropertyData|Use Placements}}: make True, if using the profile operation placement properties to transform toolpath in post processor
* {{PropertyData|SegLen}}: Tesselation value for tool paths made from beziers, bsplines, and ellipses

==Tasks Window Editor Layout== <!--T:31-->
''Descriptions for the settings are provided in the Properties list above.''
''Descriptions for the settings are provided in the Properties list above.''
This section is simply a layout map of the settings in the window editor for the Operation.
This section is simply a layout map of the settings in the window editor for the Operation.
Line 119: Line 158:
* '''Clear''': clear all items in the Base Geometry list
* '''Clear''': clear all items in the Base Geometry list


====Depth==== <!--T:34-->
====Depths==== <!--T:34-->


<!--T:35-->
<!--T:35-->
Line 126: Line 165:
* {{PropertyData|Step Down}}
* {{PropertyData|Step Down}}


====Height==== <!--T:36-->
====Heights==== <!--T:36-->


<!--T:37-->
<!--T:37-->
Line 134: Line 173:
====Operation==== <!--T:38-->
====Operation==== <!--T:38-->


<!--T:39-->
<!--T:63-->
* {{PropertyData|Tool Controller}}
* {{PropertyData|Tool Controller}}
* {{PropertyData|Cut Side}}
* {{PropertyData|Coolant Mode}}
* {{PropertyData|Cut Side **}}
* {{PropertyData|Direction}}
* {{PropertyData|Direction}}
* {{PropertyData|Extra Offset}}
* {{PropertyData|Extra Offset}}
* {{PropertyData|Enable Rotation}}
* {{PropertyData|Use Start Point}}
* {{PropertyData|Use Start Point}}
* {{PropertyData|Use Compensation}}
* {{PropertyData|Use Compensation}}
* {{PropertyData|Process Holes}}
* {{PropertyData|Process Holes **}}
* {{PropertyData|Process Circles}}
* {{PropertyData|Process Circles **}}
* {{PropertyData|Process Perimeter}}
* {{PropertyData|Process Perimeter **}}
'''<nowiki>**</nowiki>''' Availability changes based on selections in Base Geometry section.


<!--T:41-->
==Scripting== <!--T:64-->
{{Docnav|[[Path_Engrave|Engrave]]|[[Path_Helix|Helix]]|[[Path_Workbench|Path]]|IconL=Path-Engrave.png|IconC=Workbench_Path.svg|IconR=Path-Helix.png}}


<!--T:42-->
{{Path_Tools_navi}}


<!--T:43-->
<!--T:65-->
{{Emphasis|See also:}} [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
{{Userdocnavi}}

<!--T:66-->
Example:


<!--T:67-->
{{Code|code=#Place code example here.}}

<!--T:41-->
{{Docnav
|[[Path_Engrave|Engrave]]
|[[Path_Helix|Helix]]
|[[Path_Workbench|Path]]
|IconL=Path_Engrave.svg
|IconC=Workbench_Path.svg
|IconR=Path_Helix.svg
}}


</translate>
</translate>
{{Path_Tools_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}
{{clear}}

Revision as of 17:46, 15 September 2020

Other languages:

Path Profile

Menu location
Path → Profile
Workbenches
Path
Default shortcut
None
Introduced in version
0.19
See also
Path Contour, Path ProfileFace, Path ProfileEdges

Description

The Profile tool creates a contour operation based on selected features of the model.

Although the Profile tool is new in 0.19, it is simply a combination of the pre-existing File:Path Contour.png Contour, File:Path Profile Face.png Profile Face, and File:Path Profile Edges.png Profile Edges operations that maintains their pre-existing capabilities. See their documentation for more details.

Usage

Initiate a Profile operation by doing the following:

  1. Invoke the command several ways:
    • Press the Profile button
    • Use the Path → Profile entry in the Path menu
  2. Activate the Base Geometry section by clicking its tab, and select features from the Job model.
    • If no features are selected, the Profile tool defaults to the previous File:Path Contour.png Contour operation behavior, contouring the entire model.
    • If faces are selected, then the previous File:Path Profile Face.png Profile Face behaviors are used.
    • If edges are selected, then the previous File:Path Profile Edges.png Profile Edges behaviors are used.
      NOTE: The profile edges portion of the Profile operation has received improvements to allow functionality on some open-edge (non-loop) selections. See the Usage Notes section below for additional information on best practice for profiling open-edges.
  3. Activate the Operation section by clicking on its tab, and adjust the operation's settings as desired.
  4. (Optional) Click the Apply button to preview the operation with the current settings.
  5. Click the OK or Cancel buttons to create or cancel the operation.


A Start point can be enabled from the Operation tab in the Tasks Window editor, using a location defined in the Property View → Data → Start Point.


Make additional adjustments to the operation by modifying the operation's properties in the Data tab of the Property View. Advanced properties will be located here, if any.

Usage Notes

  • To perform a Profile operation on open-edges, it is best to select the top edges (highest edges) for the selection, and then manually set the Final Depth for the operation. Selection of bottom edges is unpredictable and will likely return undesirable paths in many situations.
  • When profiling open-edges, the `Side` or `Cut Side` property is disabled internally even though it will likely be visible within the Task editor window and the Properties list within the Data tab.
  • When profiling the entire model, a complete contour of the model, the `Side` or `Cut Side` property is hard coded to `Outside` even though it might be available for user input.


Properties

Note : Not all of these Properties are available in the Task Window Editor. Some are only accessible in the Data tab of the Properties View panel for this Operation.

Base

Note: It is suggested that you do not edit the Placement property of path operations. Rather, move or rotate the Path Job model as needed.

  • DataPlacement: Overall placement[position and rotation] of the object - with respect to the origin (or origin of parent object container)
    • DataAngle: Angle in degrees applied to rotation of the object around Axis property value
    • DataAxis: Axis(one or multiple) around which to rotate the object, set in sub-properties: x, y, z
      • DataX: x axis value
      • DataY: y axis value
      • DataZ: z axis value
    • DataPosition: Position of the object, set in sub-properties: x, y, z - with respect to the origin (or origin of parent object container)
      • DataX: x distance value
      • DataY: y distance value
      • DataZ: z distance value
  • DataLabel: User-provided name of the object (UTF-8)

Depth

  • DataClearance Height: The height needed to clear clamps and obstructions
  • DataFinal Depth: Final Depth of Tool- lowest value in Z
  • DataFinish Depth: Maximum material removed on final pass. The height (thickness) of the last cutting level - set for a better finish.
  • DataSafe Height: The height above which Rapid motions are allowed. (Rapid safety height between locations)
  • DataStart Depth: Starting depth of Tool - first cut depth in Z
  • DataStep Down: Incremental step down of Tool during operation

Visual reference for Depth properties (settings)

Path

  • DataActive: make False, to prevent operation from generating code
  • DataBase: The base geometry for this operation
  • DataComment: An optional comment for this Operation
  • DataCoolant Mode: The coolant mode for this operation.
  • DataCycle Time: The cycle time estimation for this operation.
  • DataTool Controller: Defines the Tool controller used in the Operation
  • DataUser Label: User assigned label

Profile

  • DataDirection: The direction that the tool path should go around the part: Clockwise[CW] or Counterclockwise[CCW]
  • DataExpand Profile: Extend the profile clearing beyond the Extra Offset.
  • DataExpand Profile Step Over: Set the stepover percentage, based on the tool's diameter.
  • DataHandle Multiple Features: Choose how to process multiple Base Geometry features.
  • DataOffsetExtra: Extra value to stay away from final profile- good for roughing toolpath
  • DataProcess Circles: Check if you want this Profile Operation to also be applied to cylindrical holes, which normally get drilled.
  • DataProcess Holes: Check if this Profile Operation should also process holes in the base geometry. Note that this does not include cylindrical holes.
  • DataProcess Perimeter: Check if this Profile Operation should also process the outside perimeter of the base geometry shapes
  • DataSide: (Cut Side) Side of edge that tool should cut. This only matters if `Use Compensation` is True(checked).
  • DataUse Compensation: If checked, the Profile Operation is offset by the tool radius. The offset direction is determined by the Cut Side.

Rotation

  • DataAttempt Inverse Angle: Automatically attempt Inverse Angle if initial rotation is incorrect.
  • DataEnable Rotation: Enable rotation to gain access to pockets or areas not normal to Z axis.
  • DataInverse Angle: Inverse the angle of the rotation. Example: change a rotation from -22.5 to 22.5 degrees.
  • DataLimit Depth To Face: Enforce the Z-depth of the selected face as the lowest value for final depth. Higher user values for final depth will be observed.
  • DataReverse Direction: Reverse orientation of Operation by 180 degrees.

Start Point

  • DataStart Point: The custom start point for the path of this operation.
    • DataX: x distance value
    • DataY: y distance value
    • DataZ: z distance value
  • DataUse Start Point: Make True, if manually specifying a Start Point. Set the start point in the property data Start Point field.


Tasks Window Editor Layout

Descriptions for the settings are provided in the Properties list above. This section is simply a layout map of the settings in the window editor for the Operation.

Base Geometry

  • Add: adds selected element(s) which should be the base(s) for the path(s)
  • Delete: delete the selected item(s) in the Base Geometry list
  • Clear: clear all items in the Base Geometry list

Depths

  • DataStart Depth
  • DataFinal Depth
  • DataStep Down

Heights

  • DataSafe Height
  • DataClearance Height

Operation

  • DataTool Controller
  • DataCoolant Mode
  • DataCut Side **
  • DataDirection
  • DataExtra Offset
  • DataEnable Rotation
  • DataUse Start Point
  • DataUse Compensation
  • DataProcess Holes **
  • DataProcess Circles **
  • DataProcess Perimeter **

** Availability changes based on selections in Base Geometry section.


Scripting

See also: FreeCAD Scripting Basics.

Example: 


#Place code example here.

Template:Path Tools navi

User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=CAM_Profile&oldid=760277"