Arch Reference: Difference between revisions
(Created page with "<languages/> <translate> {{GuiCommand|Name=Arch Reference|Workbenches=Arch|MenuLocation=Arch → Reference|Shortcut=|SeeAlso=Arch BuildingPart}} ==Descri...") |
(Marked this version for translation) |
||
Line 2: | Line 2: | ||
<translate> |
<translate> |
||
<!--T:1--> |
|||
{{GuiCommand|Name=Arch Reference|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch → Reference|Shortcut=|SeeAlso=[[Arch BuildingPart]]}} |
{{GuiCommand|Name=Arch Reference|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch → Reference|Shortcut=|SeeAlso=[[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 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. |
||
==How to use== |
==How to use== <!--T:5--> |
||
<!--T:6--> |
|||
# Press the {{KEY|[[Image:Arch Reference.png|16px]] '''Arch Reference'''}} button |
# Press the {{KEY|[[Image:Arch Reference.png|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 |
||
Line 17: | Line 21: | ||
# 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 |
* 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 |
* If the original object gets moved in containing file, this movement will reflect in the reference object |
||
Line 25: | Line 30: | ||
* 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 son'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 BuildingPart tool can by used in [[macros]] and from the python console by using the following function: |
||
</translate> |
</translate> |
||
Line 40: | Line 47: | ||
<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> |
Revision as of 20:17, 20 November 2018
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 an Part-based object (including Arch BuildingPart) stored in another FreeCAD file. If that FreeCAD file changes, the reference object is marked to be reloaded.
How to use
- Press the Arch Reference button
- Press the "Choose file..." button and select an existing FreeCAD file
- Select one of the included Part-based objects from the drop-down list
- 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 object at once, place them inside an 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
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 BuildingPart 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")