Arch Add: Difference between revisions

From FreeCAD Documentation
No edit summary
(Marked this version for translation)
Line 1: Line 1:
{{GuiCommand|Name=Arch Add|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch -> Add|SeeAlso=[[Arch Remove]]}}
{{GuiCommand|Name=Arch Add|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch -> Add|SeeAlso=[[Arch Remove]]}}
<translate>
<translate>
==Description==
==Description== <!--T:1-->


<!--T:2-->
The Add tool allows you to do 4 kinds of operations:
The Add tool allows you to do 4 kinds of operations:
* Add [[Part Module|shape]]-based objects to an Arch component, such as a [[Arch Wall|wall]] or [[Arch Structure|structure]]. These objects make then part of the Arch component, and allow you to modify its shape but keeping its base properties such as width and height
* Add [[Part Module|shape]]-based objects to an Arch component, such as a [[Arch Wall|wall]] or [[Arch Structure|structure]]. These objects make then part of the Arch component, and allow you to modify its shape but keeping its base properties such as width and height
Line 13: Line 14:
<translate>
<translate>


<!--T:3-->
In the above image, a box is being added to a wall.
In the above image, a box is being added to a wall.


==How to use==
==How to use== <!--T:4-->


<!--T:5-->
# Select the object(s) to be added, then the "host" object (the host object must be the last one you selected)
# Select the object(s) to be added, then the "host" object (the host object must be the last one you selected)
# Press the {{KEY|[[Image:Arch Add.png|16px]] '''Add'''}} button
# Press the {{KEY|[[Image:Arch Add.png|16px]] '''Add'''}} button


==Scripting==
==Scripting== <!--T:6-->


<!--T:7-->
The Add tool can by used in [[macros]] and from the python console by using the following function:
The Add tool can by used in [[macros]] and from the python console by using the following function:
</translate>
</translate>
'''addComponents (objectsList,hostObject)''':
'''addComponents (objectsList,hostObject)''':
<translate>
<translate>
<!--T:8-->
* Adds the given object or the objects from the given list as components to the given host Object. Use this for example to add windows to a wall, or to add walls to a floor.
* Adds the given object or the objects from the given list as components to the given host Object. Use this for example to add windows to a wall, or to add walls to a floor.
* Returns nothing.
* Returns nothing.


<!--T:9-->
Example:
Example:
</translate>
</translate>

Revision as of 00:07, 29 November 2013

Arch Add

Menu location
Arch -> Add
Workbenches
Arch
Default shortcut
None
Introduced in version
-
See also
Arch Remove

Description

The Add tool allows you to do 4 kinds of operations:

In the above image, a box is being added to a wall.

How to use

  1. Select the object(s) to be added, then the "host" object (the host object must be the last one you selected)
  2. Press the Add button

Scripting

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

addComponents (objectsList,hostObject): 
  • Adds the given object or the objects from the given list as components to the given host Object. Use this for example to add windows to a wall, or to add walls to a floor.
  • Returns nothing.

Example:

import FreeCAD, Arch, Draft, Part
line = Draft.makeWire([FreeCAD.Vector(0,0,0),FreeCAD.Vector(2,2,0)])
wall = Arch.makeWall(line)
box = Part.makeBox(1,1,1)
Arch.addComponents(box,wall)