Arch Equipment: Difference between revisions

Revision as of 01:22, 2 February 2017

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

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.

As of version 0.17, equipment objects also have a Mesh 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.

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

How to use

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

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

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

makeEquipment ( baseObject )

Creates an equipment object from a base object (Mesh or Part)
Returns the new equipment object, or None if the operation failed.

Example:

import Part, Arch
box = Part.makeBox(2,2,2)
base = FreeCAD.ActiveDocument.addObject("Part::Feature","Box")
base.Shape = box
Arch.makeEquipment(base)

Other languages:

@@ Line 2: / Line 2: @@
 <!--T:1-->
-{{GuiCommand|Name=Arch Equipment|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch → Equipment|Shortcut=E Q}}
+{{GuiCommand|Name=Arch Equipment|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch → Equipment|Shortcut=E Q|SeeAlso=[[Arch_3Views|3 views from mesh]]}}
 ==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>
+As of version 0.17, equipment objects also have a '''Mesh''' 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.
-<!--T:4-->
-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 → [[Arch_3Views|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>
+When using the Arch OBJ exporter, all equipments that are in Mesh display mode will be exported as their mesh instead of their shape.
 ==How to use== <!--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
@@ Line 31: / Line 32: @@
 * {{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-->