Part CheckGeometry: Difference between revisions

From FreeCAD Documentation
(clarify that BOP is additional)
(Fixed Docnav)
(19 intermediate revisions by 7 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:10-->
<!--T:10-->
{{Docnav
{{Docnav|[[Part RefineShape|Refine shape]]|[[Std Measure Menu|Measure]]|[[Part_Module|Part]]|IconL=Part RefineShape.png|IconC=Workbench_Part.svg|IconR=Part_Measure_Linear.svg}}
|[[Part_RefineShape|RefineShape]]
|[[Part_MakeFace|MakeFace]]
|[[Part_Module|Part]]
|IconL=Part_RefineShape.svg
|IconR=Part_MakeFace.svg
|IconC=Workbench_Part.svg
}}


<!--T:2-->
<!--T:2-->
{{GuiCommand
{{GuiCommand|Name=Part CheckGeometry‏‎|MenuLocation=Part → Check geometry|Workbenches=[[Part Workbench|Part]]|SeeAlso=}}
|Name=Part CheckGeometry‏‎
|MenuLocation=Part → Check geometry
|Workbenches=[[Part_Module|Part]]
|SeeAlso=
}}


==Introduction== <!--T:3-->
==Description== <!--T:3-->
The {{Button|[[Image:Part_CheckGeometry.svg|16px]] [[Part_CheckGeometry|Part CheckGeometry]]}} tool runs a verification and reports if geometry is a valid solid.
The check geometry tool allows you to verify if you have a valid solid


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


<!--T:5-->
<!--T:5-->
# Select a part (beware to select the whole part and not just a face to check for valid solid)
The tool is available in the Part workbench under Part menu or with the button in the Boolean toolbar.
# Invoke the tool by either:
Select a part (beware to select the whole part and not just a face to check for valid solid) then launch the tool.
#* Finding the {{Button|[[Image:Part_CheckGeometry.svg|16px]]}} button available in the Part workbench Boolean toolbar.
You will see results in the Task panel.
#* Using the {{MenuCommand|Part → [[Image:Part_CheckGeometry.svg|16px]] Check geometry}} entry from the top menu.

<!--T:72-->
Results will be reported in the [[Task_panel|Task panel]].


==Activate additional BOP check== <!--T:6-->
==Activate additional BOP check== <!--T:6-->
Line 23: Line 39:


<!--T:71-->
<!--T:71-->
To activate the BOP check follow these steps :
Beginning with version 0.19 there is a settings panel in the CheckGeometry results with a checkbox for toggling this on or off. For users of earlier versions, to activate the BOP check follow these steps :
# Use the menu {{menuCommand|Tools → Edit parameters... → Preferences → Mod → Part → CheckGeometry}}
# Use the menu {{menuCommand|Tools → Edit parameters... → Preferences → Mod → Part → CheckGeometry}}
# In the right pane double right-click on the ''RunBOPCheck'' parameter to change its value to '''true'''
# In the right pane double right-click on the ''RunBOPCheck'' parameter to change its value to '''true'''
Line 30: Line 47:


<!--T:8-->
<!--T:8-->
If the parameter or folder does not exist, you can create it by
If the parameter or folder does not exist, create it by:
# right-clicking on '''Part''' and choosing '''Add sub-group'''
# Right-clicking on '''Part''' and choosing {{KEY|Add sub-group}}
# naming the sub-group '''CheckGeometry'''
# Name the sub-group {{incode|CheckGeometry}}
# making sure the just created sub-group ''CheckGeometry'' is selected
# Make sure the feshly created sub-group {{incode|CheckGeometry}} is selected
# right-clicking in the right (empty) window and choosing '''New Boolean Item'''
# Right-clicking in the right (empty) window and choosing {{KEY|New Boolean Item}}
# naming the new Boolean item "RunBOPCheck" and make sure it is set to '''true'''
# Name the new Boolean item {{incode|RunBOPCheck}} and make sure it is set to ''True''
# clicking {{Button|Save to disk}}, close and restart.
# Press the {{Button|Save to disk}} button
# Close and restart.


</translate>
</translate>
Line 44: Line 62:
<translate>
<translate>


==Run Check and interpret results== <!--T:9-->
==Run check and interpret results== <!--T:9-->
*select in the tree view one or more objects you like to check
# Select within the [[Tree_view|tree view]] one or more objects to check
*click on [[Image:Part_CheckGeometry.png|32px]]
# Press the [[Image:Part_CheckGeometry.svg|24px]] [[Part_CheckGeometry|CheckGeometry]] button.
*you will get a report on the left side of the screen showing the result of the scan
#: Result: A report will display on the left side of the screen showing the result of the scan ({{VersionPlus|0.19}} any errors found are also logged in the [[Report_view|report view]] if logging is enabled in preferences)
*if your scan turned up errors you may click in the report window on a specific error message and the corresponding geometric object (edge/face ...) will be highlighted in the 3D view
# If the scan turned up errors: click in the report window on a specific error message and the corresponding geometric object (edge/face ...) will be highlighted in the [[3D_view|3D view]]
*at the moment FreeCAD has no automatic repair methods for solids, so you need to look at the steps used in FreeCAD to model this specific geometry and try to fix the error yourself
#: '''Note:''' At the moment FreeCAD has no automatic repair methods for solids, so you need to look at the steps used in FreeCAD to model this specific geometry and try to fix the error yourself




Line 57: Line 75:


<!--T:12-->
<!--T:12-->
{{Docnav
{{Docnav|[[Part RefineShape|Refine shape]]|[[Std Measure Menu|Measure]]|[[Part_Module|Part]]|IconL=Part RefineShape.png|IconC=Workbench_Part.svg|IconR=Part_Measure_Linear.svg}}
|[[Part_RefineShape|RefineShape]]

|[[Part_MakeFace|MakeFace]]
<!--T:13-->
|[[Part_Module|Part]]
{{Part Tools navi}}
|IconL=Part_RefineShape.svg

|IconR=Part_MakeFace.svg
<!--T:14-->
|IconC=Workbench_Part.svg
{{Userdocnavi}}
}}


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

Revision as of 15:26, 24 January 2021

Part CheckGeometry‏‎

Menu location
Part → Check geometry
Workbenches
Part
Default shortcut
None
Introduced in version
-
See also
None

Description

The Part CheckGeometry tool runs a verification and reports if geometry is a valid solid.

Usage

  1. Select a part (beware to select the whole part and not just a face to check for valid solid)
  2. Invoke the tool by either:
    • Finding the button available in the Part workbench Boolean toolbar.
    • Using the Part → Check geometry entry from the top menu.

Results will be reported in the Task panel.

Activate additional BOP check

The function CheckGeometry checks if the Boundary representation (BRep or B-rep) of the model is valid. Additionally to this BRep check, it is possible to have an additional BOP (BOP= Boolean OPerations) check.

Beginning with version 0.19 there is a settings panel in the CheckGeometry results with a checkbox for toggling this on or off. For users of earlier versions, to activate the BOP check follow these steps :

  1. Use the menu Tools → Edit parameters... → Preferences → Mod → Part → CheckGeometry
  2. In the right pane double right-click on the RunBOPCheck parameter to change its value to true
  3. Click Save to disk, close and restart.

See the screenshot below.

If the parameter or folder does not exist, create it by:

  1. Right-clicking on Part and choosing Add sub-group
  2. Name the sub-group CheckGeometry
  3. Make sure the feshly created sub-group CheckGeometry is selected
  4. Right-clicking in the right (empty) window and choosing New Boolean Item
  5. Name the new Boolean item RunBOPCheck and make sure it is set to True
  6. Press the Save to disk button
  7. Close and restart.


File:PartCheckGeometry.png


Run check and interpret results

  1. Select within the tree view one or more objects to check
  2. Press the CheckGeometry button.
    Result: A report will display on the left side of the screen showing the result of the scan (version 0.19 and above any errors found are also logged in the report view if logging is enabled in preferences)
  3. If the scan turned up errors: click in the report window on a specific error message and the corresponding geometric object (edge/face ...) will be highlighted in the 3D view
    Note: At the moment FreeCAD has no automatic repair methods for solids, so you need to look at the steps used in FreeCAD to model this specific geometry and try to fix the error yourself