Arch Equipment: Difference between revisions

Revision as of 14:27, 29 November 2020

Other languages:

Fence

CompPipe

Arch

Menu location
Arch Equipment
Arch → Equipment
Workbenches
Arch
Default shortcut
E Q
Introduced in version
-
See also
Arch 3 views

Description

The Equipment tool offers you a simple and convenient way to insert non-structural, standalone elements such as pieces of furniture, hidro-sanitary equipments or electrical appliances to your projects. Equipments are based on Part shapes, which allow them to benefit from the solidity and possibilities of BRep geometry, and generate nice views when rendered to plan and section views.

Furniture objects enclosed in an Arch Equipment object. The flat projections can be obtained by the Draft Shape2DView tool

As of version 0.17, equipment objects also have a DataHiRes property where a Mesh object can be attached. Equipment objects can then be made to display that mesh in the 3D view instead of their shape, which allows to use any high-resolution mesh objects such as detailed pieces of furniture commonly found on websites.

Furniture objects enclosed in an Arch Equipment object, with a high resolution mesh attached

When using the Arch OBJ exporter, all equipment objects that are in mesh display mode will be exported as their mesh instead of their shape.

Usage

Select a Part shape, and optionally a Mesh object.
Press the Arch Equipment button, or press E then Q keys.

Options

Equipments share the common properties and behaviours of all Arch Components

Properties

DataModel: A description of the model of this equipment.
DataUrl: An URL of the product page where more information about this equipment can be found.
DataMesh: A Mesh representation to use for this equipment. When set, the Mesh display mode becomes available.

Scripting

See also: Arch API and FreeCAD Scripting Basics.

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

Equipment = makeEquipment(baseobj=None, placement=None, name="Equipment")

Creates an Equipment object from the given baseobj, which can be a Part or a Mesh.
If a placement is given, it is used.
It returns None if the operation fails.

Example:

import FreeCAD, Arch

Box = FreeCAD.ActiveDocument.addObject("Part::Box", "Box")
Box.Length = 500
Box.Width = 2000
Box.Height = 600

Equip = Arch.makeEquipment(Box)
FreeCAD.ActiveDocument.recompute()

Fence

CompPipe

Arch

Elements: Wall, Structure, Curtain Wall, Window, Roof, Space, Stairs, Equipment, Frame, Fence, Truss, Profile, Pipe, Pipe Connector
Reinforcements: Straight Rebar, U-Shape Rebar, L-Shape Rebar, Stirrup, Bent-Shape Rebar, Helical Rebar, Column Reinforcement, Beam Reinforcement, Slab Reinforcement, Footing Reinforcement, Custom Rebar
Panels: Panel, Panel Cut, Panel Sheet, Nest
Materials: Material, Multi-Material
Organization: Building Part, Project, Site, Building, Level, External reference, Section Plane, Schedule
Axes: Axis, Axes system, Grid

Modification: Cut with plane, Add component, Remove component, Survey

Utilities: Component, Clone component, Split Mesh, Mesh to Shape, Select non-manifold meshes, Remove Shape from Arch, Close Holes, Merge Walls, Check, Toggle IFC Brep flag, 3 Views from mesh, Create IFC spreadsheet, Toggle Subcomponents
Additional: Preferences, Import Export Preferences (IFC, DAE, OBJ, JSON, 3DS, SHP), IfcOpenShell, IfcPlusPlus, Arch API

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 1: / Line 1: @@
+<languages/>
 <translate>
 <!--T:1-->
+{{Docnav
-{{GuiCommand|Name=Arch Equipment|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch → Equipment|Shortcut=E Q}}
+|[[Arch_Fence|Fence]]
+|[[Arch_CompPipe|CompPipe]]
+|[[Arch_Module|Arch]]
+|IconL=Arch_Fence.svg
+|IconR=Arch_CompPipe.png
+|IconC=Workbench_Arch.svg
+}}
+<!--T:20-->
+{{GuiCommand
+|Name=Arch Equipment
+|MenuLocation=Arch → Equipment
+|Workbenches=[[Arch_Module|Arch]]
+|Shortcut={{KEY|E}} {{KEY|Q}}
+|SeeAlso=[[Arch_3Views|Arch 3 views]]
+}}
 ==Description== <!--T:2-->
 <!--T:3-->
-The Equipment tool offers you a simple and convenient way to insert non-structural, standalone elements such as pieces of furniture, hidro-sanitary equipments or electrical appliances to your projects. Equipments can be based on a shape or a mesh, allowing to use either precise solid models, or more easily available mesh models that you can find on the internet.
+The Equipment tool offers you a simple and convenient way to insert non-structural, standalone elements such as pieces of furniture, hidro-sanitary equipments or electrical appliances to your projects. Equipments are based on [[Part Module|Part shapes]], which allow them to benefit from the solidity and possibilities of BRep geometry, and generate nice views when rendered to plan and section views.
 </translate>
-[[Image:Arch equipment example.jpg|640px]]
+[[Image:Arch equipment example.jpg]]
 <translate>
+<!--T:18-->
+{{Caption|Furniture objects enclosed in an [[Arch Equipment|Arch Equipment]] object. The flat projections can be obtained by the [[Draft Shape2DView|Draft Shape2DView]] tool}}
-<!--T:4-->
+<!--T:13-->
+As of version 0.17, equipment objects also have a {{PropertyData|HiRes}} property where a [[Mesh Module|Mesh]] object can be attached. Equipment objects can then be made to display that mesh in the 3D view instead of their shape, which allows to use any high-resolution mesh objects such as detailed pieces of furniture commonly found on websites.
-The above image shows examples of equipment objects made from shapes. As a result, projecting them in 2D gives perfect results. For mesh objects, which don't offer the same possibilities, a helper tool has been added to menu Arch -> Utilities -> 3 views from mesh allows to generate 3 flat, filled, orthogonal projections (top, front and side), which can then be used in 2D projections.
 </translate>
-[[Image:Arch equipment example2.jpg|640px]]
+[[Image:Arch equipment mesh.jpg]]
 <translate>
+<!--T:19-->
+{{Caption|Furniture objects enclosed in an [[Arch Equipment|Arch Equipment]] object, with a high resolution mesh attached}}
-==How to use== <!--T:5-->
+<!--T:14-->
+When using the Arch OBJ exporter, all equipment objects that are in mesh display mode will be exported as their mesh instead of their shape.
+==Usage== <!--T:5-->
 <!--T:6-->
-# Select a [[Part Workbench|Part]] shape or [[Mesh Workbench|Mesh]] object
+# Select a [[Part Workbench|Part]] shape, and optionally a [[Mesh Workbench|Mesh]] object.
-# Press the {{KEY|[[Image:Arch Equipment.png|16px]] [[Arch Equipment]]}} button, or press {{KEY|E}} then {{KEY|Q}} keys
+# Press the {{Button|[[Image:Arch Equipment.svg|16px]] [[Arch Equipment|Arch Equipment]]}} button, or press {{KEY|E}} then {{KEY|Q}} keys.
+==Options== <!--T:15-->
+<!--T:16-->
+* Equipments share the common properties and behaviours of all [[Arch Component|Arch Components]]
 ==Properties== <!--T:7-->
@@ Line 31: / Line 60: @@
 * {{PropertyData|Model}}: A description of the model of this equipment.
 * {{PropertyData|Url}}: An URL of the product page where more information about this equipment can be found.
+* {{PropertyData|Mesh}}: A [[Mesh Workbench|Mesh]] representation to use for this equipment. When set, the '''Mesh''' display mode becomes available.
 ==Scripting== <!--T:9-->
+{{Emphasis|See also:}} [[Arch API|Arch API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
 <!--T:10-->
-The Equipment tool can by used in [[macros]] and from the python console by using the following function:
+The Equipment tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function:
 </translate>
 {{Code|code=
+Equipment = makeEquipment(baseobj=None, placement=None, name="Equipment")
-makeEquipment ( baseObject )
 }}
 <translate>
 <!--T:11-->
-* Creates an equipment object from a base object (Mesh or Part)
+* Creates an {{incode|Equipment}} object from the given {{incode|baseobj}}, which can be a {{incode|Part}} or a {{incode|Mesh}}.
+* If a {{incode|placement}} is given, it is used.
-* Returns the new equipment object, or None if the operation failed.
+* It returns {{incode|None}} if the operation fails.
 <!--T:12-->
 Example:
 </translate>
 {{Code|code=
-import Part, Arch
+import FreeCAD, Arch
-box = Part.makeBox(2,2,2)
-base = FreeCAD.ActiveDocument.addObject("Part::Feature","Box")
+Box = FreeCAD.ActiveDocument.addObject("Part::Box", "Box")
-base.Shape = box
+Box.Length = 500
+Box.Width = 2000
-Arch.makeEquipment(base)
+Box.Height = 600
+Equip = Arch.makeEquipment(Box)
+FreeCAD.ActiveDocument.recompute()
 }}
+<translate>
-<languages/>
+<!--T:17-->
+{{Docnav
+|[[Arch_Fence|Fence]]
+|[[Arch_CompPipe|CompPipe]]
+|[[Arch_Module|Arch]]
+|IconL=Arch_Fence.svg
+|IconR=Arch_CompPipe.png
+|IconC=Workbench_Arch.svg
+}}
+</translate>
+{{Arch Tools navi{{#translation:}}}}
+{{Userdocnavi{{#translation:}}}}