Part CheckGeometry: Difference between revisions

From FreeCAD Documentation
(Add to usage, add some options)
(Reorganize BOP check option)
Line 19: Line 19:


==Description== <!--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 {{Button|[[Image:Part_CheckGeometry.svg|16px]] [[Part_CheckGeometry|Part CheckGeometry]]}} tool runs a verification and reports if geometry is a valid solid. The tool checks if the [https://en.wikipedia.org/wiki/Boundary_representation Boundary representation] (BRep or [[Glossary#B|B-rep]]) of the model is valid.


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


===Run BOP check===
===Run BOP check===

<!--T:7-->
If ticked, additionally a Boolean OPerations (BOP) check is performed. {{Version|0.19}}


===Log errors===
===Log errors===


==Activate additional BOP check== <!--T:6-->
==Activate BOP check via Edit parameters...== <!--T:6-->


<!--T:7-->
The function CheckGeometry checks if the [https://en.wikipedia.org/wiki/Boundary_representation Boundary representation] (BRep or [[Glossary#B|B-rep]]) of the model is valid. Additionally to this BRep check, it is possible to have an additional BOP (BOP= Boolean OPerations) check.


<!--T:71-->
<!--T:71-->
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 :
{{VersionMinus|0.18}} 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}}

Revision as of 11:05, 12 August 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. The tool checks if the Boundary representation (BRep or B-rep) of the model is valid.

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:
    • Clicking on the CheckGeometry button available in the Part workbench toolbar.
    • Using the Part → Check geometry entry from the top menu.
  3. The Settings task panel opens, except Skip settings page is enabled. See Options for more information. Click Run check.

Results will be reported in the Task panel.

Options

Skip settings page

If ticked, subsequent invocations of the tool skip showing the Settings task panel.

Run BOP check

If ticked, additionally a Boolean OPerations (BOP) check is performed. introduced in version 0.19

Log errors

Activate BOP check via Edit parameters...

version 0.18 and below 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