CAM Profile: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
(Marked this version for translation)
(48 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<translate>
<!--T:1-->
{{GuiCommand|Name=Path Profile|Workbenches=[[Path Workbench|Path]]|MenuLocation=Path → New Operation → Profile|Shortcut=P,P|SeeAlso=}}


==Description== <!--T:2-->
<!--T:40-->
{{Docnav
|[[Path_ToolBitDock|ToolBitDock]]
|[[Path_Pocket_Shape|Pocket Shape]]
|[[Path_Workbench|Path]]
|IconL=Path_ToolBitDock.svg
|IconR=Path_Pocket_Shape.svg
|IconC=Workbench_Path.svg
}}


<!--T:3-->
<!--T:44-->
{{GuiCommand
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.
|Name=Path Profile
|MenuLocation=Path → Profile
|Workbenches=[[Path_Workbench|Path]]
|Version=0.19
}}


<!--T:4-->
==Description== <!--T:45-->
[[Image:Path profile example.jpg]]


==Usage== <!--T:5-->
<!--T:46-->
The {{KEY|[[Image:Path_Profile.svg|16px]] [[Path_Profile|Profile]]}} tool creates a contour operation based on selected features of the model. The tool was introduced in version 0.19. It offers three operations that were handled by separate tools in previous versions.


<!--T:6-->
<!--T:69-->
All operations create objects that are made to be part of a {{KEY|[[Image:Path_Job.svg|24px]] [[Path_Job|Path Job]]}}.
# Select a face on a [[Part Module|Part]]-based object. Alternatively, also select a starting edge on that face.
# Press the {{KEY|[[Image:Path Profile.png|16px]] [[Path Profile|Profile]]}} button
# Adjust the desired properties


==Options== <!--T:7-->
<!--T:70-->
These are the available operations:


<!--T:8-->
===Contour operation=== <!--T:71-->

* The Path Profile object is made to be part of a [[Path Project]]. 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.
<!--T:72-->
A {{KEY|Contour}} operation is the default. It creates a simple external contour cut of complex 3D [[Image:Workbench_Part.svg|24px]] [[Part_Workbench|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.

===Profile Face operation=== <!--T:73-->

<!--T:74-->
A {{KEY|Profile Face}} operation creates a simple contour path from one ore more selected faces of an object.

===Profile Edges operation=== <!--T:75-->

<!--T:76-->
A {{KEY|Profile Edges}} operation creates a simple contour path from selected edges.

</translate>
[[Image:Path_profile_example.jpg|600px]]
<translate>

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

<!--T:49-->
# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Path_Profile.svg|16px]] [[Path_Profile|Path Profile]]}} button.
#* Select the {{MenuCommand|Path → [[Image:Path_Profile.svg|16px]] Profile}} option from the menu.
# Activate the Base Geometry section by clicking its tab, and select features from the Job model.
#* If no features are selected, the command defaults to a {{MenuCommand|Contour}} operation, contouring the entire model.
#* If faces are selected, then the result is a {{MenuCommand|Profile Face}} operation.
#* If edges are selected, then the result is a {{MenuCommand|Profile Edges}} operation.<br>'''NOTE''': This 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.
# Optionally press the {{Button|Apply}} button to preview the operation with the current settings.
# Click the {{Button|OK}} button or the {{Button|Cancel}} button to create or cancel the operation.

<!--T:77-->
'''Important Note: Path Profile doesn't take care of other details of the object. You have to adjust the properties, especially the final depth, carefully, a mistake might destroy your work piece'''

<!--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:78-->

<!--T:68-->
* The {{KEY|[[Image:Path_Profile.svg|16px]] [[Path_Profile|Profile]]}} operation is capable of profiling '''open-edges''' (one or more continuous edges that do not form a loop as seen from the ''Top View'')
** It is best to select the top edges (highest edges) for the selection. After doing so, you will need to manually set the Final Depth for the operation. Selection of bottom edges only is unpredictable and will likely return undesirable paths in many situations; however, it will return correct paths in some situations.
** Selected edges must form a continual edge ''as viewed from the Top View''. Selected top edges may have differing heights, so long as they connect at a common (X, Y) coordinate - differing Z-heights are acceptable in ''some'''**''''' cases. <BR />'''**'''In certain cases, the user will need to include in their selection the straight vertical connecting edge between two adjacent edges of different heights that share a common (X, Y) coordinate.
**Because top edges are selected, the Final Depth for the operation will need to be set manually.
** 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== <!--T:9-->
==Properties== <!--T:9-->


<!--T:10-->
<!--T:21-->
''' ''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.
* {{PropertyData|Active}}: Make False, to prevent operation from generating code
* {{PropertyData|Use Placements}}: make True, if using the profile operation placement properties to transform toolpath in post processor
* {{PropertyData|Tool Controller}}: The Tool controller specifies the index of the Tool to use


===Depth Properties=== <!--T:11-->
<!--T:52-->
{{TitleProperty|Base}}
* {{PropertyData|Start Depth}}: Starting Depth of Tool- first cut depth in Z
* {{PropertyData|Final Depth}}: Final Depth of Tool- lowest value in Z
* {{PropertyData|Step Down}}: Incremental Step Down of Tool


<!--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.


===Height Properties=== <!--T:12-->
<!--T:23-->
* {{PropertyData|Placement}}: Overall placement[position and rotation] of the object - with respect to the origin (or origin of parent object container)
* {{PropertyData|Safe Height}}: The above which Rapid motions are allowed.
* {{PropertyData|Clearance Height}}: The height needed to clear clamps and obstructions
** {{PropertyData|Angle}}: Angle in degrees applied to rotation of the object around Axis property value
** {{PropertyData|Axis}}: Axis(one or multiple) around which to rotate the object, set in sub-properties: x, y, z
*** {{PropertyData|X}}: x axis value
*** {{PropertyData|Y}}: y axis value
*** {{PropertyData|Z}}: z axis value
** {{PropertyData|Position}}: Position of the object, set in sub-properties: x, y, z - with respect to the origin (or origin of parent object container)
*** {{PropertyData|X}}: x distance value
*** {{PropertyData|Y}}: y distance value
*** {{PropertyData|Z}}: z distance value
* {{PropertyData|Label}}: User-provided name of the object (UTF-8)


<!--T:53-->
{{TitleProperty|Depth}}


<!--T:54-->
* {{PropertyData|Clearance Height}}: The height needed to clear clamps and obstructions
* {{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 height above which Rapid motions are allowed. (Rapid safety height between locations)
* {{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)}}


===Operation Properties=== <!--T:13-->
<!--T:56-->
{{TitleProperty|Path}}

<!--T:57-->
* {{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|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|Direction}}: Specifies a CW or CCW path for the External contour cut
* {{PropertyData|User Label}}: User assigned label
* {{PropertyData|Use Start Point}}: make True, if manually specifying a Start Point, then enter Start Points in the Property data Start Points field


===Start Point Properties=== <!--T:15-->
<!--T:19-->
{{TitleProperty|Profile}}


<!--T:16-->
<!--T:58-->
* {{PropertyData|Start Point}}: The start point of this path
* {{PropertyData|Direction}}: The direction that the tool path should go around the part: Clockwise[CW] or Counterclockwise[CCW]
* {{PropertyData|Use Start Point}}: make True, if specifying a Start Point
* {{PropertyData|Expand Profile}}: Extend the profile clearing beyond the Extra Offset.
* {{PropertyData|Extend At Start}}: extra length of tool path before start of part edge
* {{PropertyData|Expand Profile Step Over}}: Set the stepover percentage, based on the tool's diameter.
* {{PropertyData|LeadIn Line Len}}: length of straight segment of toolpath that comes in at angle to first part edge
* {{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|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 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.


===End Point Properties=== <!--T:17-->
<!--T:28-->
{{TitleProperty|Rotation}}


<!--T:18-->
<!--T:59-->
* {{PropertyData|Use End Point}}: make True, if specifying an End Point
* {{PropertyData|Attempt Inverse Angle}}: Automatically attempt Inverse Angle if initial rotation is incorrect.
* {{PropertyData|Extend At End}}: extra length of tool path after end of part edge
* {{PropertyData|Enable Rotation}}: Enable rotation to gain access to pockets or areas not normal to Z axis.
* {{PropertyData|LeadOut LineLen}}: length of straight segment of toolpath that comes in at angle to last part edge
* {{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|End Point}}: The end point of this path
* {{PropertyData|Reverse Direction}}: Reverse orientation of Operation by 180 degrees.


===Profile Properties=== <!--T:19-->
<!--T:60-->
{{TitleProperty|Start Point}}


<!--T:20-->
<!--T:61-->
* {{PropertyData|Side}}: Side of edge that tool should cut
* {{PropertyData|Start Point}}: The custom start point for the path of this operation.
** {{PropertyData|X}}: x distance value
* {{PropertyData|Direction}}: The direction that the toolpath should go around the part ClockWise CW or CounterClockWise CCW
* {{PropertyData|OffsetExtra}}: Extra value to stay away from final profile- good for roughing toolpath
** {{PropertyData|Y}}: y distance value
* {{PropertyData|SegLen}}: Tesselation value for tool paths made from beziers, bsplines, and ellipses
** {{PropertyData|Z}}: z distance value
* {{PropertyData|Use 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== <!--T:62-->

<!--T:31-->
''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=== <!--T:32-->

<!--T:33-->
* '''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=== <!--T:34-->

<!--T:35-->
* {{PropertyData|Start Depth}}
* {{PropertyData|Final Depth}}
* {{PropertyData|Step Down}}

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

<!--T:37-->
* {{PropertyData|Safe Height}}
* {{PropertyData|Clearance Height}}

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

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

==Scripting== <!--T:64-->

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

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


</translate>
</translate>
{{Code|code=
{{clear}}
#Place code example here.
<languages/>
}}
<translate>


<!--T:41-->
{{Docnav
|[[Path_ToolBitDock|ToolBitDock]]
|[[Path_Pocket_Shape|Pocket Shape]]
|[[Path_Workbench|Path]]
|IconL=Path_ToolBitDock.svg
|IconR=Path_Pocket_Shape.svg
|IconC=Workbench_Path.svg
}}

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

Revision as of 20:43, 26 February 2022

Other languages:

Path Profile

Menu location
Path → Profile
Workbenches
Path
Default shortcut
None
Introduced in version
0.19
See also
None

Description

The Profile tool creates a contour operation based on selected features of the model. The tool was introduced in version 0.19. It offers three operations that were handled by separate tools in previous versions.

All operations create objects that are made to be part of a Path Job.

These are the available operations:

Contour operation

A Contour operation is the default. It creates a simple external contour cut of complex 3D 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.

Profile Face operation

A Profile Face operation creates a simple contour path from one ore more selected faces of an object.

Profile Edges operation

A Profile Edges operation creates a simple contour path from selected edges.

Usage

  1. There are several ways to invoke the command:
    • Press the Path Profile button.
    • Select the Path → Profile option from the menu.
  2. Activate the Base Geometry section by clicking its tab, and select features from the Job model.
    • If no features are selected, the command defaults to a Contour operation, contouring the entire model.
    • If faces are selected, then the result is a Profile Face operation.
    • If edges are selected, then the result is a Profile Edges operation.
      NOTE: This 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. Optionally press the Apply button to preview the operation with the current settings.
  5. Click the OK button or the Cancel button to create or cancel the operation.

Important Note: Path Profile doesn't take care of other details of the object. You have to adjust the properties, especially the final depth, carefully, a mistake might destroy your work piece

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

  • The Profile operation is capable of profiling open-edges (one or more continuous edges that do not form a loop as seen from the Top View)
    • It is best to select the top edges (highest edges) for the selection. After doing so, you will need to manually set the Final Depth for the operation. Selection of bottom edges only is unpredictable and will likely return undesirable paths in many situations; however, it will return correct paths in some situations.
    • Selected edges must form a continual edge as viewed from the Top View. Selected top edges may have differing heights, so long as they connect at a common (X, Y) coordinate - differing Z-heights are acceptable in some** cases.
      **In certain cases, the user will need to include in their selection the straight vertical connecting edge between two adjacent edges of different heights that share a common (X, Y) coordinate.
    • Because top edges are selected, the Final Depth for the operation will need to be set manually.
    • 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=1104742"