App Link: Difference between revisions
(Marked this version for translation) |
(Moved icon above) |
||
Line 3: | Line 3: | ||
== Introduction == <!--T:1--> |
== Introduction == <!--T:1--> |
||
⚫ | |||
⚫ | |||
⚫ | |||
<!--T:2--> |
<!--T:2--> |
||
Line 9: | Line 13: | ||
<!--T:3--> |
<!--T:3--> |
||
When a regular copy of an object is created (for example, with [[Part SimpleCopy|Part SimpleCopy]]), an entire new object with its topological shape is duplicated, which consumes a lot of memory. App Link is used to re-use existing data of an existing object, so an entire new object doesn't need to be created; this improves the handling of copies, particularly in the context of mechanical assembly where many duplicates may be needed, or where importing smaller assemblies into bigger assemblies is required. |
When a regular copy of an object is created (for example, with [[Part SimpleCopy|Part SimpleCopy]]), an entire new object with its topological shape is duplicated, which consumes a lot of memory. App Link is used to re-use existing data of an existing object, so an entire new object doesn't need to be created; this improves the handling of copies, particularly in the context of mechanical assembly where many duplicates may be needed, or where importing smaller assemblies into bigger assemblies is required. |
||
⚫ | |||
⚫ | |||
⚫ | |||
== How to use == <!--T:4--> |
== How to use == <!--T:4--> |
Revision as of 06:16, 5 December 2019
Introduction
An App Link, or formally an App::Link
, is an element that returns a reference to another object in the document or in an external document. This object was introduced in v0.19 in order to re-use previously created objects, which is very useful to create assemblies.
When a regular copy of an object is created (for example, with Part SimpleCopy), an entire new object with its topological shape is duplicated, which consumes a lot of memory. App Link is used to re-use existing data of an existing object, so an entire new object doesn't need to be created; this improves the handling of copies, particularly in the context of mechanical assembly where many duplicates may be needed, or where importing smaller assemblies into bigger assemblies is required.
How to use
- App Links can be created by pressing LinkMake.
An App Link is an internal object, so it is mostly intended to be used by developers when developing assembly workbenches. For example, the Assembly3 and Assembly4 workbenches make use of this object. See External workbenches.
Properties
See Property for all property types that scripted objects can have.
An App::Link
object is not derived from a Part Feature, however, if the Link has a reference to an external object, it will show the properties of the latter object.
These are the properties available in the property editor for an empty App::Link
.
Data
Link
- DataLinked Object:
- DataLink Transform:
- DataPlacement:
- DataShow Element:
- DataElement Count:
- DataScale:
Base
- DataLabel:
View
Link
- ViewDraw Style:
- ViewLine Width:
- ViewOverride Material:
- ViewPoint Size:
- ViewSelectable:
- ViewShape Material:
Base
- ViewOn Top When Selected:
- ViewSelection Style:
- ViewShow In Tree:
- ViewVisibility:
Scripting
See also: FreeCAD Scripting Basics, and scripted objects.
See Part Feature for the general information.
An App Link is created with the addObject()
method of the document.
import FreeCAD as App
doc = App.newDocument()
obj = App.ActiveDocument.addObject("App::Link", "Name")
obj.Label = "Custom label"
Further reading
The App Link object was introduced after 2 years of development and prototyping. This component was thought and developed almost single-handedly by user realthunder. The motivations and design implementations behind this project are described in his GitHub page, Link. In order to accomplish this feature, several core changes to FreeCAD were made; these were also extensively documented in Core-Changes.
The App Link project started after the redesign of the PartDesign Workbench was complete in v0.17. The history of App Link can be traced to some essential forum threads:
- Why an object can only be inside one App::Part? (March 2017)
- Introducing App::Link/XLink (March 2017)
- Links (May 2017)
- Realthunder Link implementation: Architecture discussion (June 2017)
- PR #876: Link, stage one, context aware selection (July 2017)
- Preview: Link, stage two, API groundwork (July 2017)
- Assembly3 preview (December 2017)
- Merging of my Link branch (June 2018)
Finally, the pull request and merge happened:
- App::Link: the big merge, old thread (July 2019), pull request #2350 (the BIG merge), LinkMerge branch.
- App::Link: the big merge, main thread (July 2019)
- A simple path description of Link, 019, Link stage, Asm3, merge? (August 2019)
- PR#2559: expose link and navigation actions, an introduction to the Link feature in 0.19 (September 2019).
- File: New, Open, Close, Close All, Save, Save As, Save a Copy, Save All, Revert, Import, Export,Merge project, Project information, Print, Print preview, Export PDF, Recent files, Exit
- Edit: Undo, Redo, Cut, Copy, Paste, Duplicate selection, Refresh, Box selection, Box element selection, Select All, Delete, Send to Python Console, Placement, Transform, Alignment, Toggle Edit mode, Edit mode, Preferences
- View:
- Miscellaneous: Create new view, Orthographic view, Perspective view, Fullscreen, Bounding box, Toggle axis cross, Clipping plane, Texture mapping, Toggle navigation/Edit mode, Appearance, Random color, Workbench, Status bar
- Standard views: Fit all, Fit selection, Isometric, Dimetric, Trimetric, Home, Front, Top, Right, Rear, Bottom, Left, Rotate Left, Rotate Right
- Freeze display: Save views, Load views, Freeze view, Clear views
- Draw style: As is, Points, Wireframe, Hidden line, No shading, Shaded, Flat lines
- Stereo: Stereo red/cyan, Stereo quad buffer, Stereo Interleaved Rows, Stereo Interleaved Columns, Stereo Off, Issue camera position
- Zoom: Zoom In, Zoom Out, Box zoom
- Document window: Docked, Undocked, Fullscreen
- Visibility: Toggle visibility, Show selection, Hide selection, Select visible objects, Toggle all objects, Show all objects, Hide all objects, Toggle selectability, Toggle measurement, Clear measurement
- Toolbars: File, Edit, Clipboard, Workbench, Macro, View, Structure, Help
- Panels: Tree view, Property view, Selection view, Tasks, Python console, DAG view, Model, Report view
- Link navigation: Go to linked object, Go to the deepest linked object, Select all links
- Tree view actions: Sync view, Sync selection, Sync placement, Pre-selection, Record selection, Single document, Multi document, Collapse/Expand, Initiate dragging, Go to selection, Selection Back, Selection Forward
- Tools: Edit parameters, Save image, Load image, Scene inspector, Dependency graph, Project utility, Measure distance, Add text document, View turntable, Units calculator, Customize, Addon manager
- Macro: Macro recording, Macros, Recent macros, Execute macro, Attach to remote debugger, Debug macro, Stop debugging, Step over, Step into, Toggle breakpoint
- Help: Help, FreeCAD Website, Donate, Users documentation, Python scripting documentation, Automatic Python modules documentation, FreeCAD Forum, FreeCAD FAQ, Report a bug, About FreeCAD, What's This
- 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, Arch, Assembly, 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