Arch Reference: Difference between revisions
m (Changed section to 'Usage') |
m (Typo) |
||
(9 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
<translate> |
<translate> |
||
<!--T:16--> |
<!--T:16--> |
||
{{Docnav |
|||
{{docnav|[[Arch_Site|Site]]|[[Arch_Window|Window]]|[[Arch_Module|Arch]]|IconL=Arch_Site.svg |IconC=Workbench_Arch.svg |IconR=Arch_Window.svg}} |
|||
|[[Arch_Floor|Floor]] |
|||
|[[Arch_Window|Window]] |
|||
|[[Arch_Workbench|Arch]] |
|||
|IconL=Arch_Floor.svg |
|||
|IconR=Arch_Window.svg |
|||
|IconC=Workbench_Arch.svg |
|||
}} |
|||
<!--T:1--> |
<!--T:1--> |
||
{{GuiCommand |
|||
{{GuiCommand|Name=Arch Reference|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch → Reference|Shortcut=|SeeAlso=[[Arch BuildingPart]]}} |
|||
|Name=Arch Reference |
|||
|MenuLocation=Arch → Reference |
|||
|Workbenches=[[Arch_Workbench|Arch]] |
|||
|SeeAlso=[[Arch_BuildingPart|Arch BuildingPart]] |
|||
}} |
|||
==Description== <!--T:2--> |
==Description== <!--T:2--> |
||
Line 13: | Line 26: | ||
<!--T:4--> |
<!--T:4--> |
||
The Reference tool allows you to place an object in the current document that copies its shape and colors from |
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--> |
==Usage== <!--T:5--> |
||
<!--T:6--> |
<!--T:6--> |
||
# Press the {{KEY|[[Image: |
# 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== <!--T:7--> |
==Options== <!--T:7--> |
||
<!--T:8--> |
<!--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. |
||
* By right-clicking a Reference object in the tree view, you have the options to reload the original object, or open the containing file |
* 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 |
* 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 |
* 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== <!--T:9--> |
==Properties== <!--T:9--> |
||
Line 42: | Line 55: | ||
<!--T:12--> |
<!--T:12--> |
||
The Reference 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 59: | Line 72: | ||
Arch.makeReference("/path/to/some/file.FSCtd","myPart") |
Arch.makeReference("/path/to/some/file.FSCtd","myPart") |
||
}} |
}} |
||
<translate> |
<translate> |
||
<!--T:17--> |
<!--T:17--> |
||
{{Docnav |
|||
{{docnav|[[Arch_Site|Site]]|[[Arch_Window|Window]]|[[Arch_Module|Arch]]|IconL=Arch_Site.svg |IconC=Workbench_Arch.svg |IconR=Arch_Window.svg}} |
|||
|[[Arch_Floor|Floor]] |
|||
|[[Arch_Window|Window]] |
|||
<!--T:18--> |
|||
|[[Arch_Workbench|Arch]] |
|||
⚫ | |||
|IconL=Arch_Floor.svg |
|||
|IconR=Arch_Window.svg |
|||
<!--T:19--> |
|||
|IconC=Workbench_Arch.svg |
|||
⚫ | |||
}} |
|||
<!--T:15--> |
|||
[[Category:Arch]] |
|||
</translate> |
</translate> |
||
⚫ | |||
⚫ |
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
- 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 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")
Arch
- Elements: Wall, Structure, Curtain Wall, Window, Roof, Space, Stairs, Equipment, Frame, Fence, Truss, Profile, Pipe, Pipe Connector
- Reinforcements: Straight Rebar, U-Shape Rebar, L-Shape Rebar, Stirrup, Bent-Shape Rebar, Helical Rebar, Column Reinforcement, Beam Reinforcement, Slab Reinforcement, Footing Reinforcement, Custom Rebar
- Panels: Panel, Panel Cut, Panel Sheet, Nest
- Materials: Material, Multi-Material
- Organization: Building Part, Project, Site, Building, Level, External reference, Section Plane, Schedule
- Axes: Axis, Axes system, Grid
- Modification: Cut with plane, Add component, Remove component, Survey
- Utilities: Component, Clone component, Split Mesh, Mesh to Shape, Select non-manifold meshes, Remove Shape from Arch, Close Holes, Merge Walls, Check, Toggle IFC Brep flag, 3 Views from mesh, Create IFC spreadsheet, Toggle Subcomponents
- Additional: Preferences, Import Export Preferences (IFC, DAE, OBJ, JSON, 3DS, SHP), IfcOpenShell, IfcPlusPlus, Arch API
User documentation
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Assembly, BIM, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Surface, TechDraw, Test Framework
- Hubs: User hub, Power users hub, Developer hub