Lattice2 Workbench

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

The FreeCAD Lattice2 External Workbench Icon

Introduction

Lattice2 is stable. New features may be added, but no breaking changes are supposed to happen.

The Lattice2 Workbench is a FreeCAD external workbench that serves the purpose of working with placements and arrays of placements. It is a sort of Assembly workbench, but with emphasis on arrays. There are no constraints and relations, there are just arrays of placements that can be generated, combined, transformed, superimposed, and populated with shapes.

Ever wondered how to create a protractor with FreeCAD? That's the aim of the workbench (including tick labeling). Also, exploded assemblies can be made with the workbench.

Additionally, the workbench features a few general-purpose tools, such as parametric downgrade, bounding boxes, shape info tool, and tools for working with collections of shapes (compounds).

One of the big design goals of the workbench is being as parametric as possible.

References

• Author: DeepSOIC
• Home page: https://github.com/DeepSOIC/Lattice2
• Source code on github: https://github.com/DeepSOIC/Lattice2

Tools

Detailed description on the Lattice2 Github wiki

Toolbar

Lattice2 Toolbar

Commands

• Placement
  • Single Placement: Custom
  • Single Placement: XY plane
  • Single Placement: XZ plane
  • Single Placement: YZ plane
  • Single Placement: along X
  • Single Placement: along Y
  • Single Placement: along Z
  • Single Placement: Euler angles
  • Placement of shape: Copy object.Placement
  • Placement of shape: Center of bounding box
  • Placement of shape: Center of mass
  • Placement of shape: Inertial axis system
• Attachable Placement
• Generate linear array
• Generate polar array
• Array from shape
  • Internal placements
  • Center of bounding box
  • Center of mass
  • Inertial axis system
• Invert lattice
• Join arrays
• Array filter
  • Selected items
  • Touching
  • Within distance window
  • Pointing at shape
• Explode array
• Project array
• Resample array
• Populate with copies
  • Populate with copies
  • Populate with copies: Build array
  • Moved object
• Populate with children
  • Populate with children
  • Populate with children: Build array
  • Moved children
• Parametric downgrade
  • Downgrade to
  • Downgrade to Leaves
  • Downgrade to CompSolids
  • Downgrade to Shells
  • Downgrade to OpenWires
  • Downgrade to Faces
  • Downgrade to Wires
  • Downgrade to Edges
  • Downgrade to Seam edges
  • Downgrade to Non-seam edges
  • Downgrade to Vertices
• Sub link
• Make compound
• Explode compound
• Fuse compound
• Bounding box
  • Whole
  • Children
• Shape string for array
• Para series
• Inspect
  • Inspect seletion
  • Shape info (feature)
• Substitute object
• Expose links to subelements

Other

• Recomputes
  • Make recompute locher object:
  • Lock recomputes:
  • Unlock recomputes:
  • Recompute feature:
  • Recompute document:
  • Force recompute:
  • Touch selected feature:
• Lattice2 Workbench icon

Installation

Prerequisites: Lattice2 Workbench requires FreeCAD >= v0.16.5155.

Automatic installation

As of v0.17 one can use the Addon Manager to install the Lattice2 Workbench. Use Tools → Addon Manager

Manual Install

• Scroll to the top of the page, and click 'download zip' button
• Unpack the contents into a "Lattice2" folder created in \Path\to\FreeCAD\Mod, and restart FreeCAD.
• 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).

After you install the workbench, it should appear at the bottom of list of workbench selector in FreeCAD.

Tutorials

• Tutorials: Gallery
• Basic Tutorial
• Lattice2 in PartDesign
• Making a Cogset
• Feature Patterns in Lattice2 Workbench by @sliptonic

Links to Lattice2 workbench

• Lattice2 Wiki: https://github.com/DeepSOIC/Lattice2/wiki
• FreeCAD Wiki: https://www.freecadweb.org/wiki/Lattice2_Workbench
• FreeCAD Forum: Lattice workbench - v2.0 is becoming stable
• Gallery: https://github.com/DeepSOIC/Lattice2/wiki/Gallery
• Report bugs: Please report bugs at https://github.com/DeepSOIC/Lattice2/issues

Other useful links

• Lattice aka Lattice1 Workbench (obsolete)
• External Workbenches: List of FreeCAD workbenches.
• Macros recipes
• FreeCAD Community Portal

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, Material, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Surface, TechDraw, Test Framework

---

• Addons: Addon Manager, External workbenches, Scripting and macros

---

• Hubs: User hub, Power users hub, Developer hub