Arch Reference: Difference between revisions

From FreeCAD Documentation
(Created page with "<languages/> <translate> {{GuiCommand|Name=Arch Reference|Workbenches=Arch|MenuLocation=Arch → Reference|Shortcut=|SeeAlso=Arch BuildingPart}} ==Descri...")
 
m (Typo)
 
(16 intermediate revisions by 7 users not shown)
Line 2: Line 2:
<translate>
<translate>


<!--T:16-->
{{GuiCommand|Name=Arch Reference|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch → Reference|Shortcut=|SeeAlso=[[Arch BuildingPart]]}}
{{Docnav
|[[Arch_Floor|Floor]]
|[[Arch_Window|Window]]
|[[Arch_Workbench|Arch]]
|IconL=Arch_Floor.svg
|IconR=Arch_Window.svg
|IconC=Workbench_Arch.svg
}}

<!--T:1-->
{{GuiCommand
|Name=Arch Reference
|MenuLocation=Arch → Reference
|Workbenches=[[Arch_Workbench|Arch]]
|SeeAlso=[[Arch_BuildingPart|Arch BuildingPart]]
}}


==Description==
==Description== <!--T:2-->


<!--T:3-->
[[Image:Arch reference screenshot.png|800px]]
[[Image:Arch reference screenshot.png|800px]]


<!--T:4-->
The Reference tool allows you to place an object in the current document that copies its shape and colors from an [[Part Workbench|Part]]-based object (including [[Arch BuildingPart]]) stored in another FreeCAD file. If that FreeCAD file changes, the reference object is marked to be reloaded.
The Reference tool allows you to place an object in the current document that copies its shape and colors from a [[Part Workbench|Part]]-based object (including [[Arch_BuildingPart|Arch BuildingPart]]) stored in another FreeCAD file. If that FreeCAD file changes, the reference object is marked to be reloaded.


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


<!--T:6-->
# Press the {{KEY|[[Image:Arch Reference.png|16px]] '''Arch Reference'''}} button
# Press the {{KEY|[[Image:Arch_Reference.svg|16px]] '''Arch Reference'''}} button,
# Press the "Choose file..." button and select an existing FreeCAD file
# Press the "Choose file..." button and select an existing FreeCAD file,
# Select one of the included Part-based objects from the drop-down list
# Select one of the included Part-based objects from the drop-down list,
# Press '''OK'''
# Press '''OK'''.


==Options==
==Options== <!--T:7-->


<!--T:8-->
* The reference object can be moved and rotated, the current position will be retained after reloading the object
* If the original object gets moved in containing file, this movement will reflect in the reference object
* The reference object can be moved and rotated, the current position will be retained after reloading the object.
* By right-clicking a Reference object in the tree view, you have the options to reload the original object, or open the containing file
* If the original object gets moved in containing file, this movement will reflect in the reference object.
* By right-clicking a Reference object in the tree view, you have the options to reload the original object, or open the containing file.
* To reference several object at once, place them inside an [[Arch BuildingPart]]
* To reference several objects at once, place them inside an [[Arch_BuildingPart|Arch BuildingPart]].
* When turning off the '''Update Colors''' view property of the Reference, it son't reload the original colors anymore, so you can safely change them
* When turning off the '''Update Colors''' view property of the Reference, it won't reload the original colors anymore, so you can safely change them.


==Properties==
==Properties== <!--T:9-->


<!--T:10-->
* {{PropertyData|File}}: The base file this component is built upon
* {{PropertyData|File}}: The base file this component is built upon
* {{PropertyData|Part}}: The part to use from the base file
* {{PropertyData|Part}}: The part to use from the base file
* {{PropertyView|Update Colors}}: If true, the colors from the linked file will be kept updated
* {{PropertyView|Update Colors}}: If true, the colors from the linked file will be kept updated


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


<!--T:12-->
The BuildingPart tool can by used in [[macros]] and from the python console by using the following function:
The Reference tool can by used in [[macros|macros]] and from the python console by using the following function:
</translate>
</translate>
{{Code|code=
{{Code|code=
Line 40: Line 62:
<translate>
<translate>


<!--T:13-->
creates a Reference object from the given object in the given file.
creates a Reference object from the given object in the given file.


<!--T:14-->
Example:
Example:
</translate>
</translate>
Line 48: Line 72:
Arch.makeReference("/path/to/some/file.FSCtd","myPart")
Arch.makeReference("/path/to/some/file.FSCtd","myPart")
}}
}}
<translate>


<!--T:17-->
{{Docnav
|[[Arch_Floor|Floor]]
|[[Arch_Window|Window]]
|[[Arch_Workbench|Arch]]
|IconL=Arch_Floor.svg
|IconR=Arch_Window.svg
|IconC=Workbench_Arch.svg
}}

</translate>
{{Arch Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 11:14, 16 March 2022

Arch Reference

Menu location
Arch → Reference
Workbenches
Arch
Default shortcut
None
Introduced in version
-
See also
Arch BuildingPart

Description

The Reference tool allows you to place an object in the current document that copies its shape and colors from a Part-based object (including Arch BuildingPart) stored in another FreeCAD file. If that FreeCAD file changes, the reference object is marked to be reloaded.

Usage

  1. Press the Arch Reference button,
  2. Press the "Choose file..." button and select an existing FreeCAD file,
  3. Select one of the included Part-based objects from the drop-down list,
  4. Press OK.

Options

  • The reference object can be moved and rotated, the current position will be retained after reloading the object.
  • If the original object gets moved in containing file, this movement will reflect in the reference object.
  • By right-clicking a Reference object in the tree view, you have the options to reload the original object, or open the containing file.
  • To reference several objects at once, place them inside an Arch BuildingPart.
  • When turning off the Update Colors view property of the Reference, it won't reload the original colors anymore, so you can safely change them.

Properties

  • DataFile: The base file this component is built upon
  • DataPart: The part to use from the base file
  • ViewUpdate Colors: If true, the colors from the linked file will be kept updated

Scripting

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

makeReference ([file_path,object_name])

creates a Reference object from the given object in the given file.

Example:

import Arch
Arch.makeReference("/path/to/some/file.FSCtd","myPart")