Arch Check: Difference between revisions

From FreeCAD Documentation
m ([[ | ]](Vertical Docnav))
No edit summary
(3 intermediate revisions by 3 users not shown)
Line 3: Line 3:


<!--T:10-->
<!--T:10-->
{{docnav
{{Docnav
|[[Arch_MergeWalls|Merge Walls]]
|[[Arch_MergeWalls|Merge Walls]]
|[[Arch_IfcExplorer|Ifc Explorer]]
|[[Arch_IfcExplorer|Ifc Explorer]]
|[[Arch_Module|Arch]]|IconL=Arch_MergeWalls.svg
|[[Arch_Module|Arch]]
|IconL=Arch_MergeWalls.svg
|IconR=IFC.svg
|IconC=Workbench_Arch.svg
|IconC=Workbench_Arch.svg
|IconR=Arch_IfcExplorer.png
}}
}}


Line 14: Line 15:
{{GuiCommand
{{GuiCommand
|Name=Arch Check
|Name=Arch Check
|Workbenches=[[Arch Module|Arch]]
|MenuLocation=Arch → Utilities → Check
|MenuLocation=Arch → Utilities → Check
|SeeAlso=[[Arch CloseHoles|Arch CloseHoles]]
|Workbenches=[[Arch_Module|Arch]]
|SeeAlso=[[Arch_CloseHoles|Arch CloseHoles]]
}}
}}


Line 22: Line 23:


<!--T:3-->
<!--T:3-->
This tool checks the current document or the selected objects for non-solid {{KEY|[[Image: Workbench_Part.svg|16px]] [[Part Module|Part]]}} or {{KEY|[[Image: Workbench_Arch.svg|16px]] [[Arch Module|Arch]]}} objects, that might give problems, since most operations of the Arch module require solid objects.
This tool checks the current document or the selected objects for non-solid {{KEY|[[Image: Workbench_Part.svg|16px]] [[Part_Module|Part]]}} or {{KEY|[[Image: Workbench_Arch.svg|16px]] [[Arch_Module|Arch]]}} objects, that might give problems, since most operations of the Arch module require solid objects.


==Usage== <!--T:4-->
==Usage== <!--T:4-->
Line 71: Line 72:


<!--T:16-->
<!--T:16-->
{{docnav
{{Docnav
|[[Arch_MergeWalls|Merge Walls]]
|[[Arch_MergeWalls|Merge Walls]]
|[[Arch_IfcExplorer|Ifc Explorer]]
|[[Arch_IfcExplorer|Ifc Explorer]]
|[[Arch_Module|Arch]]|IconL=Arch_MergeWalls.svg
|[[Arch_Module|Arch]]
|IconL=Arch_MergeWalls.svg
|IconR=IFC.svg
|IconC=Workbench_Arch.svg
|IconC=Workbench_Arch.svg
|IconR=Arch_IfcExplorer.png
}}
}}


<!--T:17-->
{{Arch Tools navi}}

<!--T:18-->
{{Userdocnavi}}
</translate>
</translate>
{{Arch Tools navi{{#translation:}}}}

{{Userdocnavi{{#translation:}}}}

Revision as of 14:58, 29 November 2020

Arch Check

Menu location
Arch → Utilities → Check
Workbenches
Arch
Default shortcut
None
Introduced in version
-
See also
Arch CloseHoles

Description

This tool checks the current document or the selected objects for non-solid Part or Arch objects, that might give problems, since most operations of the Arch module require solid objects.

Usage

  1. Press the Check button, or ArchUtilities Check in the top menu.

Scripting

See also: Arch API and FreeCAD Scripting Basics.

This tool can be used in macros and from the Python console by using the following function:

list_bad = check(objectslist, includehidden=False)
  • Checks if the given objects in objectslist contain only solids.
  • If includehidden is True it will include all hidden objects, otherwise it will omit them from the search.
  • Returns list_bad, a list with the objects that are not derived from a Part::Feature, or components that are not closed, not valid, don't contain solids, or that contain faces that are not part of any solid. This is used to detect Arch or Draft wires and profiles that aren't solids.
    • Each element in list_bad is another list [object, message], where object is the detected non-solid, and message indicates the reason why it was included in this list.

Example:

import FreeCAD, Draft, Arch

p1 = FreeCAD.Vector(0, 0, 0)
p2 = FreeCAD.Vector(2000, 0, 0)
baseline = Draft.makeLine(p1, p2)
Wall1 = Arch.makeWall(baseline, length=None, width=150, height=2000)
FreeCAD.ActiveDocument.recompute()

Wall2 = Arch.makeWall(None, length=2000, width=200, height=1000)
FreeCAD.ActiveDocument.recompute()

Circle = Draft.makeCircle(450)
Wire = Draft.makeWire([FreeCAD.Vector(1000, 0, 0), FreeCAD.Vector(1500, 1000, 0), FreeCAD.Vector(2500, -1000, 0)])

list_bad = Arch.check([Wall1, Wall2, Circle, Wire], includehidden=True)
print(list_bad)