Arch Component: Difference between revisions

From FreeCAD Documentation
mNo edit summary
(Marked this version for translation)
 
(31 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:21-->
<!--T:21-->
{{Docnav
{{docnav|[[Arch_Survey|Survey]]|[[Arch_CloneComponent|Clone component]]|[[Arch_Module|Arch]]|IconL=Arch_Survey.svg |IconC=Workbench_Arch.svg |IconR=Arch_Component_Clone.svg}}
|[[Arch_Survey|Survey]]
|[[Arch_CloneComponent|Clonecomponent]]
|[[Arch_Workbench|Arch]]
|IconL=Arch_Survey.svg
|IconR=Arch_CloneComponent.svg
|IconC=Workbench_Arch.svg
}}


<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=Arch Component
|Name=Arch Component
|MenuLocation=Arch → Utilities → Component‎‏‎
|MenuLocation=Arch → Utilities → Component‎‏‎
|Workbenches=[[Arch Module|Arch]]
|Workbenches=[[Arch_Workbench|Arch]]
|Shortcut=C M
|Shortcut={{KEY|C}} {{KEY|M}}
|Icon=Arch Component.svg‏‎
}}
}}


Line 16: Line 23:


<!--T:3-->
<!--T:3-->
Creates a non-parametric [[Arch Module|Arch]] component from any [[Part Module|Part]]-based object. This gives the Part-based object the same attributes and properties as other Arch objects, and allows to specify how it should be exported to IFC by setting its '''Role''' property.
Creates a non-parametric [[Arch_Workbench|Arch]] component from any [[Part_Workbench|Part]]-based object. This gives the Part-based object the same attributes and properties as other Arch objects, and allows to specify how it should be exported to IFC by setting its {{PropertyData|Ifc Type}} property.


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


<!--T:5-->
<!--T:5-->
# Select a [[Part Module|Part]]-based object.
# Select a [[Part_Workbench|Part]]-based object.
# There are several ways to invoke the command:
# Select menu {{MenuCommand|Arch → Utilities → [[Image:Arch Component.svg|16px]] [[Arch Component|Component]]}}.
#* Press the {{Button|[[Image:Arch_Component.svg|16px]] [[Arch_Component|Component]]}} button.
#* Select the {{MenuCommand|Arch → Utilities → [[Image:Arch_Component.svg|16px]] Component}} option from the menu.
#* Use the keyboard shortcut: {{KEY|C}} then {{KEY|M}}.


==Common Arch component properties== <!--T:6-->
==Properties== <!--T:25-->


<!--T:7-->
<!--T:7-->
The Arch component object is also a base shared by all other Arch objects ({{KEY|[[Image:Arch_Wall.svg|16px]] [[Arch Wall|Arch Wall]]}}, {{KEY|[[Image:Arch_Structure.svg|16px]] [[Arch Structure|Arch Structure]]}}, etc). Therefore some of its properties and behaviours are common to all Arch objects (except tools that don't produce solid objects, like {{Button|[[Image:Arch SectionPlane.svg|16px]] [[Arch SectionPlane|Arch Section Plane]]}} or {{Button|[[Image:Arch Axis.svg|16px]] [[Arch Axis|Arch Axis]]}}):
The Arch component object is also a base shared by all other Arch objects ([[Arch_Wall|Arch Wall]], [[Arch_Structure|Arch Structure]], etc). Therefore some of its properties and behaviours are common to all Arch objects (except tools that don't produce solid objects, like [[Arch_SectionPlane|Arch Section Plane]] or [[Arch_Axis|Arch Axis]]).


<!--T:8-->
===Data=== <!--T:26-->

* '''Base shape''': Arch Components are always based on a [[Part Module|Shape]]-based base object. Some types of Arch objects will just use the Base shape as is, others (for example ({{KEY|[[Image:Arch_Wall.svg|16px]] [[Arch Wall|Arch Wall]]}}) will do some additional operations on it, such as an extrusion. For some types, having a base object is not mandatory ([[Arch Structure|Structure]])
<!--T:27-->
{{TitleProperty|Component}}


<!--T:9-->
<!--T:9-->
* '''Additions''': Arch Components have an addition property, that can hold reference to any number of other [[Part Module|Shape]]-based objects. The shape of these additions will be united with the base shape of the component, to produce the final shape.
* {{PropertyData|Additions|LinkList}}: Arch Components have an addition property, that can hold reference to any number of other [[Part_Workbench|Shape]]-based objects. The shape of these additions will be united with the base shape of the component, to produce the final shape. See [[#Notes|Notes]].

<!--T:28-->
* {{PropertyData|Axis|Link}}: An optional axis or axis system on which this object should be duplicated.

<!--T:8-->
* {{PropertyData|Base|Link}}: Arch Components are always based on a [[Part_Workbench|Shape]]-based base object. Some types of Arch objects will just use the Base shape as is, others (for example [[Arch_Wall|Arch Wall]]) will do some additional operations on it, such as an extrusion. For some types, having a base object is not mandatory ([[Arch_Structure|Arch Structure]]).

<!--T:14-->
* {{PropertyData|Clone Of|Link}}: Any Arch Component can be a clone of another Arch Component of the same type (a Wall can only be a clone of another Wall, etc.). The only exception is the generic Arch Component (as produced by this command), that can be clone of any other type (Wall, structure, window, etc). This allows to use a generic Arch Component to override the type of another one.

<!--T:19-->
* {{PropertyData|Hi Res|Link}}: Arch Components can use the shape of another object as a higher-resolution version of themselves. For this, both the Hi Res property and the Hi Res display mode must be set. This allows, for example, to make a simple wall, and then model every brick that composes the wall, for example with [[Part_Box|Part Box]]. Then, use a compound of those bricks as a high-resolution version of the wall. The shape of the wall is not modified by adding a Hi-Res object. Only its representation in the [[3D_view|3D view]] will change by adopting the representation of the high-resolution version instead of its own.

<!--T:29-->
* {{PropertyData|Horizontal Area|Area}}: The area of the projection of this object onto the XY plane (read-only).

<!--T:17-->
* {{PropertyData|Material|Link}}: All Arch Components have a Material slot, that can contain either a [[Arch SetMaterial|Material]] or a [[Arch_MultiMaterial|MultiMaterial]] (not all Arch object type support the use of [[Arch_MultiMaterial|MultiMaterials]]). The DiffuseColor and Transparency properties of the attached material will define the Shape color and transparency of the Arch component. The material will be imported and exported to [[Arch_IFC|IFC]], [[Arch_OBJ|OBJ]] and [[Arch_DAE|DAE]].

<!--T:30-->
* {{PropertyData|Move Base|Bool}}: Specifies if moving this object moves its base instead.

<!--T:18-->
* {{PropertyData|Move With Host|Bool}}: When a component is embedded inside another (for example a window inside a wall), setting this property to True will make the object move and rotate together when its host object is moved or rotated using [[Draft_Move|Draft Move]] or [[Draft_Rotate|Draft Rotate]].

<!--T:31-->
* {{PropertyData|Perimeter Length|Length}}: The perimeter length of the horizontal area (read-only).

<!--T:32-->
* {{PropertyData|Standard Code|String}}: An optional standard (OmniClass, etc...) code for this component.


<!--T:10-->
<!--T:10-->
* '''Subtractions''': Arch Components have an subtraction property, that can hold reference to any number of other [[Part Module|Shape]]-based objects. The shape of these objects will be subtracted from the base shape of the component, to produce the final shape.
* {{PropertyData|Subtractions|LinkList}}: Arch Components have an subtraction property, that can hold reference to any number of other [[Part_Workbench|Shape]]-based objects. The shape of these objects will be subtracted from the base shape of the component, to produce the final shape. See [[#Notes|Notes]].


<!--T:11-->
<!--T:33-->
* {{PropertyData|Vertical Area|Area}}: The area of all vertical faces of this object (read-only).
* The Placement of the Arch Component is applied after the additions and subtractions are done, so these are performed against the base object at its base location. Then the result is moved to the location of the Placement.


<!--T:12-->
<!--T:34-->
{{TitleProperty|IFC}}
* Objects can be added or removed to/from a Component's Additions and Subtractions lists by selecting both the object and the component, and using the [[Arch Add|Arch Add]] or [[Arch Remove|Arch Remove]] commands, or from the task panel by double-clicking the Component in the Tree view. The task panel also allows to check which object is currently part of these lists.

<!--T:35-->
* {{PropertyData|Ifc Data|Map|Hidden}}:

<!--T:36-->
* {{PropertyData|Ifc Properties|Map|Hidden}}:


<!--T:13-->
<!--T:13-->
* '''Role''': Each Arch Component, besides the function defined by its type (wall, window, etc), also has a Role property, that can define further which kind of function it performs. For example, a [[Arch Structure|Structure]] can have a beam or column role. Generic Arch Components (as produced by this command) can have any role available in the whole Arch workbench. The role is what is used to define the type of IFC object to export to when [[Arch IFC|exporting to IFC]].
* {{PropertyData|Ifc Type|Enumeration}}: Each Arch Component, besides the function defined by its type (wall, window, etc), also has a Role property, that can define further which kind of function it performs. For example, an [[Arch_Structure|Arch Structure]] can have a beam or column role. Generic Arch Components (as produced by this command) can have any role available in the whole Arch workbench. The role is what is used to define the type of IFC object to export to when [[Arch_IFC|exporting to IFC]].


<!--T:14-->
<!--T:37-->
{{TitleProperty|IFC Attributes}}
* '''Clone Of''': Any Arch Component can be a clone of another Arch Component of the same type (a Wall can only be a clone of another Wall, etc.). The only exception is the generic Arch Component (as produced by this command), that can be clone of any other type (Wall, structure, window, etc). This allows to use a generic Arch Component to override the type of another one.


<!--T:15-->
<!--T:15-->
* '''Description''': All Arch Components have a Description field, that can contain any text. This is used when [[Arch IFC|exporting to IFC]].
* {{PropertyData|Description|String}}: All Arch Components have a Description field, that can contain any text. This is used when [[Arch_IFC|exporting to IFC]].

<!--T:38-->
* {{PropertyData|Global Id|String}}:

<!--T:39-->
* {{PropertyData|Object Type|String}}:

<!--T:40-->
* {{PropertyData|Predefined Type|Enumeration}}:


<!--T:16-->
<!--T:16-->
* '''Tag''': The Tag property is another text field, which can be used to give an additional custom identity to objects.
* {{PropertyData|Tag|Enumeration}}: The Tag property is another text field, which can be used to give an additional custom identity to objects.


<!--T:17-->
==Notes== <!--T:41-->
* '''Material''': All Arch Components have a Material slot, that can contain either a [[Arch SetMaterial|Material]] or a [[Arch MultiMaterial|MultiMaterial]] (not all Arch object type support the use of MultiMaterials). The DiffuseColor and Transparency properties of the attached material will define the Shape color and transparency of the Arch component. The material will be imported and exported to [[Arch IFC|IFC]], [[Arch OBJ|OBJ]] and [[Arch DAE|DAE]].


<!--T:18-->
<!--T:11-->
* The Placement of the Arch Component is applied after the additions and subtractions are done, so these are performed against the base object at its base location. Then the result is moved to the location of the Placement.
* '''Move with Host''': When a component is embedded inside another (for example a window inside a wall), setting this property to True will make the object move and rotate together when its host object is moved or rotated using [[Draft Move|Draft Move]] or [[Draft Rotate|Draft Rotate]].


<!--T:19-->
<!--T:12-->
* Objects can be added or removed to/from a Component's Additions and Subtractions lists by selecting both the object and the component, and using the [[Arch_Add|Arch Add]] or [[Arch_Remove|Arch Remove]] commands, or from the task panel by double-clicking the Component in the [[Tree_view|Tree view]]. The task panel also allows to check which object is currently part of these lists.
* '''Hi Res''': Arch Components can use the shape of another object as a higher-resolution version of themselves. For this, both the Hi Res property and the Hi Res display mode must be set. This allows, for example, to make a simple wall, and then model every brick that composes the wall, for example with [[Part Box|Part Box]]. Then, use a compound of those bricks as a high-resolution version of the wall. The shape of the wall is not modified by adding a Hi-Res object. Only its representation in the 3D view will change by adopting the representation of the high-resolution version instead of its own.


<!--T:22-->
{{docnav|[[Arch_Survey|Survey]]|[[Arch_CloneComponent|Clone component]]|[[Arch_Module|Arch]]|IconL=Arch_Survey.svg |IconC=Workbench_Arch.svg |IconR=Arch_Component_Clone.svg}}


<!--T:23-->
<!--T:22-->
{{Docnav
{{Arch Tools navi}}
|[[Arch_Survey|Survey]]
|[[Arch_CloneComponent|Clonecomponent]]
|[[Arch_Workbench|Arch]]
|IconL=Arch_Survey.svg
|IconR=Arch_CloneComponent.svg
|IconC=Workbench_Arch.svg
}}


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

Latest revision as of 16:34, 9 May 2024

Arch Component

Menu location
Arch → Utilities → Component‎‏‎
Workbenches
Arch
Default shortcut
C M
Introduced in version
-
See also
None

Description

Creates a non-parametric Arch component from any Part-based object. This gives the Part-based object the same attributes and properties as other Arch objects, and allows to specify how it should be exported to IFC by setting its DataIfc Type property.

Usage

  1. Select a Part-based object.
  2. There are several ways to invoke the command:
    • Press the Component button.
    • Select the Arch → Utilities → Component option from the menu.
    • Use the keyboard shortcut: C then M.

Properties

The Arch component object is also a base shared by all other Arch objects (Arch Wall, Arch Structure, etc). Therefore some of its properties and behaviours are common to all Arch objects (except tools that don't produce solid objects, like Arch Section Plane or Arch Axis).

Data

Component

  • DataAdditions (LinkList): Arch Components have an addition property, that can hold reference to any number of other Shape-based objects. The shape of these additions will be united with the base shape of the component, to produce the final shape. See Notes.
  • DataAxis (Link): An optional axis or axis system on which this object should be duplicated.
  • DataBase (Link): Arch Components are always based on a Shape-based base object. Some types of Arch objects will just use the Base shape as is, others (for example Arch Wall) will do some additional operations on it, such as an extrusion. For some types, having a base object is not mandatory (Arch Structure).
  • DataClone Of (Link): Any Arch Component can be a clone of another Arch Component of the same type (a Wall can only be a clone of another Wall, etc.). The only exception is the generic Arch Component (as produced by this command), that can be clone of any other type (Wall, structure, window, etc). This allows to use a generic Arch Component to override the type of another one.
  • DataHi Res (Link): Arch Components can use the shape of another object as a higher-resolution version of themselves. For this, both the Hi Res property and the Hi Res display mode must be set. This allows, for example, to make a simple wall, and then model every brick that composes the wall, for example with Part Box. Then, use a compound of those bricks as a high-resolution version of the wall. The shape of the wall is not modified by adding a Hi-Res object. Only its representation in the 3D view will change by adopting the representation of the high-resolution version instead of its own.
  • DataHorizontal Area (Area): The area of the projection of this object onto the XY plane (read-only).
  • DataMaterial (Link): All Arch Components have a Material slot, that can contain either a Material or a MultiMaterial (not all Arch object type support the use of MultiMaterials). The DiffuseColor and Transparency properties of the attached material will define the Shape color and transparency of the Arch component. The material will be imported and exported to IFC, OBJ and DAE.
  • DataMove Base (Bool): Specifies if moving this object moves its base instead.
  • DataMove With Host (Bool): When a component is embedded inside another (for example a window inside a wall), setting this property to True will make the object move and rotate together when its host object is moved or rotated using Draft Move or Draft Rotate.
  • DataPerimeter Length (Length): The perimeter length of the horizontal area (read-only).
  • DataStandard Code (String): An optional standard (OmniClass, etc...) code for this component.
  • DataSubtractions (LinkList): Arch Components have an subtraction property, that can hold reference to any number of other Shape-based objects. The shape of these objects will be subtracted from the base shape of the component, to produce the final shape. See Notes.
  • DataVertical Area (Area): The area of all vertical faces of this object (read-only).

IFC

  • Data (Hidden)Ifc Data (Map):
  • Data (Hidden)Ifc Properties (Map):
  • DataIfc Type (Enumeration): Each Arch Component, besides the function defined by its type (wall, window, etc), also has a Role property, that can define further which kind of function it performs. For example, an Arch Structure can have a beam or column role. Generic Arch Components (as produced by this command) can have any role available in the whole Arch workbench. The role is what is used to define the type of IFC object to export to when exporting to IFC.

IFC Attributes

  • DataDescription (String): All Arch Components have a Description field, that can contain any text. This is used when exporting to IFC.
  • DataGlobal Id (String):
  • DataObject Type (String):
  • DataPredefined Type (Enumeration):
  • DataTag (Enumeration): The Tag property is another text field, which can be used to give an additional custom identity to objects.

Notes

  • The Placement of the Arch Component is applied after the additions and subtractions are done, so these are performed against the base object at its base location. Then the result is moved to the location of the Placement.
  • Objects can be added or removed to/from a Component's Additions and Subtractions lists by selecting both the object and the component, and using the Arch Add or Arch Remove commands, or from the task panel by double-clicking the Component in the Tree view. The task panel also allows to check which object is currently part of these lists.