GuiCommand: Name: Arch Reference MenuLocation: 3D/BIM , Generic 3D tools , External reference Workbenches: BIM_Workbench SeeAlso:
Arch Reference
Description
The Arch 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
- Press the
External 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 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
-
File: The base file this component is built upon
-
Part: The part to use from the base file
-
Update 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:
reference = makeReference([filepath], [partname], [name])Creates a reference object named name from the object partname in the file filepath. All arguments are optional.
Example:
import Arch
Arch.makeReference("/path/to/some/file.FSCtd", "myPart")⏵ documentation index > BIM > Arch Reference
This page is retrieved from https://github.com/FreeCAD/FreeCAD-documentation/blob/main/wiki/Arch_Reference.md