suzanne.soy/Lattice2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme.md

Browse Source
This commit is contained in:
DeepSOIC 2019-08-28 04:13:04 +03:00 committed by GitHub
parent 4f7a6218df
commit 1a3a6fd3b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
readme.md
View File

@ -24,6 +24,8 @@ Let's have a glance over the most important capabilities that the workbench adds
* Re-use arrays as many times as you need. Unlike Draft array, which directly generates the array of shapes, lattice array tools generate arrays of placements. These can later be populated with shapes, as many times as necessary, without having to set up another array.
* Extends PartDesign workflow, offering a way to reuse a sequence of features in arbitrary bodies and places.
* Elements of array can be different. Unlike Draft Arrays, which always generate a set of equal shapes, Lattice arrays can be used to arrange a set of different shapes. Pack the shapes to be arranged into a Compound, and use Lattice [Populate with children](https://github.com/DeepSOIC/Lattice2/wiki/Feature-PopulateChildren) feature to arrange them.
* Arrays of placements can be combined, inverted, generated from existing shape arrangements, made from individual placements, projected onto shapes, filtered, etc. This allows to produce complex arrangements without scripting.
@ -32,49 +34,46 @@ Let's have a glance over the most important capabilities that the workbench adds
* linear arrays and polar arrays can have their axes linked to edges of shapes
* parametric explode commands allow extraction of specific elements of arrays, without losing parametric relation to the original.
* [ParaSeries](https://github.com/DeepSOIC/Lattice2/wiki/Feature-ParaSeries) feature allows to generate a series of parts with some parameter varied over a list of values.
# Why Lattice2, not just Lattice?
Lattice2 was created at the moment when breaking changes needed to be made, but there were a few things made with Lattice. So, it was decided to keep the workbench in that time's state indefinitely as version 1.0, and start development of a new version.
Lattice2 was created at the moment when breaking changes needed to be made to Lattice, but there were a few things made with Lattice. So, it was decided to keep the workbench in that time's state indefinitely as version 1.0, and start development of a new version.
The goal was to be able to have both Lattice v1 and v2 in a single FreeCAD installation. So a new repository was started, and all the files were renamed to start with 'lattice2' or otherwise differ from those of Lattice v1.
The goal was to allow editing old projects made with Lattice v1, by having both versions installed at the same time. So a new repository was started, and all the files were renamed to start with 'lattice2' or otherwise differ from those of Lattice v1.
# What's changed in Lattice2
* Population tools now have 'move' mode: a placement/set of placements can be supplied to treat as origins of the objects being populated
* Experimental recompute controlling tools were added
* Most icons were redesigned to follow a concept
* Lattice workbench can now be imported from Py console all at once, like that: `import Lattice2`
* ParaSeries feature was added, which can create a series of parts by changing some parameter of the model.
Lattice3 (if ever) will be a standalone repository, for the same reasons.
# Download/install
repository: https://github.com/DeepSOIC/Lattice2
Lattice2 WB requires FreeCAD no less than v0.16.5155.
Lattice2 WB requires FreeCAD no less than v0.16.5155. PartDesign tools require v0.17+. Both Py2/Qt4 and Py3/Qt5 builds are supported.
The workbench is OS independent, it should work on any system FreeCAD can be run on. If you find that it doesn't - that is a bug. Please make an issue.
Lattice2 is written in FreeCAD's Python, and must be run from within FreeCAD. It requires no compilation, and can be installed by copying the repository to a special location.
# Automated installation:
* The recommended way of installing the workbench is to use FreeCAD's built-in addon manager (Tools->Addon manager).
* Lattice2 workbench is packaged to Launchpad in the Ubuntu FreeCAD Community PPA (thanks to @abdullahtahiriyo).
* Lattice2 can be installed via @microelly's [Plugin Loader](https://github.com/microelly2/freecad-pluginloader)
# Manual install:
1. Scroll to the top of the page, and click 'download zip' button
1. Scroll to the top of the page, and click 'clone or download' -> 'download zip' button.
2. Unpack the contents into a "Lattice2" folder created in \Path\to\FreeCAD\Mod, and restart FreeCAD. <br>
Note that InitGui.py (and the rest of .py files) should end up directly under Mod\Lattice2 (not under nested directory like Mod\Lattice2\Lattice2).
On windows:<br>
`%AppData%\FreeCAD\Mod`, for all installs of FreeCAD<br>
`C:\Program Files\FreeCAD\Mod` (typ), for individual install of FreeCAD<br>
On Linux:<br>
`/home/userxyz/.FreeCAD/Mod/`<br>
MacOS:<br>
???
After you install the workbench, it should appear at the bottom of list of workbench selector in FreeCAD.
# Automated installation:
* Lattice2 workbench is packaged to Launchpad in the Ubuntu FreeCAD Community PPA (thanks to @abdullahtahiriyo).
* Lattice2 can be installed via [FreeCAD addons installer macro](https://github.com/FreeCAD/FreeCAD-addons)
* Lattice2 can be installed via @microelly's [Plugin Loader](https://github.com/microelly2/freecad-pluginloader)
If you want to install the workbench for development, git clone the repository wherever you like, and make a symlink in where FreeCAD can pick up add-ons
# License
Lattice workbench is licenced under LGPL V2, just like FreeCAD. For more info, see copying.lib file in the repository.
@ -83,12 +82,13 @@ Lattice workbench is licenced under LGPL V2, just like FreeCAD. For more info, s
Documentation: see [Lattice2 wiki](https://github.com/DeepSOIC/Lattice2/wiki) on Github. As the word "wiki" suggests, you can help by editing the documentation.
If you need help on something specific, you can ask a question on [FreeCAD forum](http://forum.freecadweb.org/index.php) (there is no Lattice forum yet...). You can also ask me directly.
If you need help on something specific, you can ask a question on [FreeCAD forum](http://forum.freecadweb.org/index.php) (there is no Lattice forum yet...). You can also ask me directly. If you post to the forum, please add this to your post so that I get a notification: `[quote=DeepSOIC user_id=3888]Ding![/quote]`
If you have found a bug, report it [here, in Github's issue tracker for Lattice2](https://github.com/DeepSOIC/Lattice2/issues). You can also post ideas for new features there, as well as plain questions.
If you have fixed a bug, or implemented a new feature you think suits the workbench, or whatever - feel free to make a pull-request here on github.
# Status
This version can be considered a release candidate. I will take care to not make breaking changes, but new functionality may keep coming.
The workbench is stable. I will take care to not make breaking changes, and some new functionality may keep coming.
If you make your FreeCAD project using Lattice2, all further changes to the project must be done with Lattice2 installed, even if you don't touch the relevant features. Otherwise, the parametric features in the project will lose their bound functionality, and will not recompute, even if you install Lattice2 later. This is the case for all add-ons in FreeCAD, not just Lattice2.