kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Draft: improve the README files with links

Browse Source
This commit is contained in:
vocx-fc
2020-02-06 00:52:40 -06:00
committed by Yorik van Havre
parent 054ce9a540
commit 9eeceb4f28
8 changed files with 129 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/Mod/Draft/draftviewproviders/README.md
View File

@@ -1,7 +1,25 @@
2020 February
At the moment these view providers aren't used at all.
These files define the view provider classes of the "scripted objects"
defined by the workbench. These scripted objects are originally
defined in the big `Draft.py` file.
When the Draft tools are eventually split into individual modules,
the code of the view providers should be placed here.
Each scripted object has a creation command like `make_arc`,
a proxy class like `Arc`, and a view provider like `ViewProviderArc`.
The view providers define the code that indicates how they are displayed
in the tree view and in the 3D view, and visual properties
such as line thickness, line color, face color, and transparency.
These properties are only available when the graphical interface exists,
otherwise they are ignored.
Each scripted object in `draftobjects/` should import its corresponding
view provider from this directory as long the graphical interface
is available.
These modules should be split from the big `Draft.py` module.
At the moment the files in this directory aren't really used,
but are used as placeholders for when the migration of classes happens.
For more information see the thread:
[[Discussion] Splitting Draft tools into their own modules](https://forum.freecadweb.org/viewtopic.php?f=23&t=38593&start=10#p341298)