|
1 | | -<p align="center"> |
2 | | - <img src="images/appicon_256.png" width="200px" align="center" /> |
3 | | -</p> |
4 | | - |
| 1 | +<div align="center"> |
| 2 | + |
| 3 | +[](https://github.com/fougue/mayo/actions/workflows/ci.yml) |
5 | 4 | [](https://ci.appveyor.com/project/HuguesDelorme/mayo) |
6 | | -[](https://app.travis-ci.com/fougue/mayo) |
| 5 | +[](https://www.codacy.com/gh/fougue/mayo/dashboard?utm_source=github.com&utm_medium=referral&utm_content=fougue/mayo&utm_campaign=Badge_Grade) |
| 6 | +[](https://github.com/fougue/mayo/releases) |
7 | 7 | [](https://github.com/fougue/mayo/blob/develop/LICENSE.txt) |
| 8 | +[](https://github.com/fougue/mayo/releases) |
| 9 | + |
| 10 | +</div> |
8 | 11 |
|
9 | | -# What is Mayo |
10 | | -Mayo is an opensource 3D CAD viewer and converter |
11 | | - |
12 | | -# Overview |
13 | | -* View and convert 3D files in different formats |
14 | | -* Explore assembly trees(product structure) and view properties |
15 | | -* Cross platform: runs on Windows, Linux and macOS |
16 | | -* Underlying toolkits: OpenCascade and Qt |
17 | | - |
18 | | -# Current features |
19 | | -* 3D exploding of the model tree, allowing better exploration of complex designs |
20 | | -* 3D clip planes with configurable capping |
21 | | -* 3D view cube providing intuitive camera manipulation |
22 | | -* Save image(snapshot) of the current 3D view |
23 | | -* Quick access to the CAD files recently open thanks to thumbnails in the Home page |
24 | | -* Toggle visibility of any item from the Model tree(use checkbox) |
25 | | -* Customizable precision of the meshes computed from BRep shapes, affecting visualization quality and conversion into mesh formats |
26 | | -* Convert files to multiple CAD formats from command-line interface(CLI) |
27 | | - |
28 | | -3D viewer operations : |
29 | | -* Rotate : mouse left + move |
30 | | -* Pan : mouse right + move |
31 | | -* Zoom : mouse wheel(scroll) |
32 | | -* Window zoom : mouse wheel + move |
33 | | -* Instant zoom : space bar |
34 | | -* Select Object: mouse left click |
35 | | -* Select Objects: SHIFT + mouse left clicks |
36 | | - |
37 | | -# Supported formats |
38 | | - Formats | Import | Export | Notes |
39 | | ---------------------------|-----------|----------|------------------------------ |
40 | | -STEP | ✔ | ✔ | AP203, 214, 242(some parts) |
41 | | -IGES | ✔ | ✔ | v5.3 |
42 | | -OpenCascade BREP | ✔ | ✔ | |
43 | | -DXF | ✔ | ❌ | |
44 | | -OBJ | ✔ | ✔ | Import requires OpenCascade ≥ v7.4.0<br>Export requires OpenCascade ≥ v7.6.0 |
45 | | -glTF | ✔ | ✔ | Import requires OpenCascade ≥ v7.4.0<br>Export requires OpenCascade ≥ v7.5.0<br>Supports 1.0, 2.0 and GLB |
46 | | -VRML | ❌ | ✔ | v2.0 UTF8 |
47 | | -STL | ✔ | ✔ | ASCII/binary |
48 | | -AMF | ❌ | ✔ | v1.2 Text/ZIP<br>Requires [gmio](https://github.com/fougue/gmio) ≥ v0.4.0 |
49 | | - |
50 | | -Mayo provides precise control over [import](https://github.com/fougue/mayo/wiki/Import-parameters-by-CAD-format) and [export](https://github.com/fougue/mayo/wiki/Export-parameters-by-CAD-format) with many parameters per format. |
51 | | - |
52 | | -# Gallery |
53 | | - |
54 | | -<img src="doc/screencast_1.gif"/> |
| 12 | +<div align="center"> |
| 13 | + <img src="images/appicon_256.png" alt="Logo" width="128px" align="center" /> |
| 14 | + <p></p> |
| 15 | + <p align="center"><strong>Mayo</strong> the opensource 3D CAD viewer and converter</9> |
| 16 | + <p></p> |
| 17 | + <img src="doc/screencast_1.gif"/> |
| 18 | +</div> |
55 | 19 |
|
56 | | -<img src="doc/screencast_cli.gif"/> |
| 20 | +## :eyeglasses: Overview |
| 21 | +- **Convert 3D files** <br/> |
| 22 | +Mayo can read/write 3D files from/to STEP, IGES, STL and many other [CAD formats](https://github.com/fougue/mayo/wiki/Supported-formats) |
| 23 | + |
| 24 | +- **Visualize 3D files** <br/> |
| 25 | +Mayo 3D viewer supports clip planes, exploding of assemblies, measurement of shapes, show/hide parts, ... |
| 26 | + |
| 27 | +- **Cross platform** <br/> |
| 28 | +Mayo runs on Windows, Linux and macOS |
| 29 | + |
| 30 | +- **Solid foundations** <br/> |
| 31 | +Mayo is developed in modern C++ with [Qt](https://www.qt.io) and [OpenCascade](https://dev.opencascade.org) |
| 32 | + |
| 33 | +## :zap: Features |
| 34 | +- **3D clip planes** with configurable capping |
| 35 | + |
| 36 | +- **3D exploding of the model tree** allowing better exploration of complex designs |
| 37 | + |
| 38 | +- **3D measure tools** for circles, angles, lengths, areas, ... |
| 39 | + |
| 40 | +- **3D view cube** providing intuitive camera manipulation |
| 41 | + |
| 42 | +- **Quick access to CAD files** recently open thanks to thumbnails in the [Home page](https://github.com/fougue/mayo/blob/develop/doc/screenshot_5.png) |
| 43 | + |
| 44 | +- **Toggle item visibility** within the Model tree(use checkbox) |
| 45 | + |
| 46 | +- **Customizable mesh precision** for BREP shapes, affecting visualization quality and conversion into mesh formats |
57 | 47 |
|
| 48 | +- **Convert files** to multiple CAD formats from [command-line interface](https://github.com/fougue/mayo/blob/develop/doc/screencast_cli.gif):computer: |
| 49 | + |
| 50 | +## :floppy_disk: Supported formats |
| 51 | + Format | Import | Export | Notes |
| 52 | +----------|--------------------|--------------------|------------------ |
| 53 | +STEP | :white_check_mark: | :white_check_mark: | AP203, 214, 242 |
| 54 | +IGES | :white_check_mark: | :white_check_mark: | v5.3 |
| 55 | +BREP | :white_check_mark: | :white_check_mark: | OpenCascade format |
| 56 | +DXF | :white_check_mark: | :x: | |
| 57 | +OBJ | :white_check_mark: | :white_check_mark: | |
| 58 | +glTF | :white_check_mark: | :white_check_mark: | 1.0, 2.0 and GLB |
| 59 | +VRML | :x: | :white_check_mark: | v2.0 UTF8 |
| 60 | +STL | :white_check_mark: | :white_check_mark: | ASCII/binary |
| 61 | +AMF | :x: | :white_check_mark: | v1.2 Text/ZIP |
| 62 | +PLY | :white_check_mark: | :white_check_mark: | ASCII/binary |
| 63 | +Image | :x: | :white_check_mark: | PNG, JPEG, ... |
| 64 | + |
| 65 | +See also this dedicated [wikipage](https://github.com/fougue/mayo/wiki/Supported-formats) for more details |
| 66 | + |
| 67 | +## :mag: 3D viewer operations |
| 68 | + |
| 69 | + Operation | Mouse/Keyboard controls |
| 70 | +---------------|-------------------------- |
| 71 | +Rotate | mouseLeft + move |
| 72 | +Pan | mouseRight + move |
| 73 | +Zoom | mouseLeft + mouseRight + move |
| 74 | +Zoom +/- | mouseWheel(scroll) |
| 75 | +Window zoom | CTRL + mouseLeft + move |
| 76 | +Instant zoom | spaceBar |
| 77 | +Select Object | mouseLeft click |
| 78 | +Select Objects | SHIFT + mouseLeft clicks |
| 79 | + |
| 80 | +Mayo supports also multiple 3D viewer navigation styles to mimic common CAD applications(CATIA, SOLIDWORKS, ...) |
| 81 | + |
| 82 | +## :hammer: How to build Mayo |
| 83 | +[Instructions for Windows MSVC](https://github.com/fougue/mayo/wiki/Build-instructions-for-Windows-MSVC) |
| 84 | +[Instructions for Debian](https://github.com/fougue/mayo/wiki/Build-instructions-for-Debian) |
| 85 | +[Instructions for macOS](https://github.com/fougue/mayo/wiki/Build-instructions-for-macOS) |
| 86 | + |
| 87 | +## :clapper: Gallery |
| 88 | + |
| 89 | +<img src="doc/screencast_cli.gif"/> |
| 90 | + |
58 | 91 | <img src="doc/screenshot_2.png"/> |
59 | 92 |
|
60 | 93 | <img src="doc/screenshot_3.png"/> |
61 | 94 |
|
62 | 95 | <img src="doc/screenshot_4.png"/> |
63 | 96 |
|
64 | 97 | <img src="doc/screenshot_5.png"/> |
65 | | - |
66 | | -# How to build Mayo |
67 | | -[Instructions for Windows MSVC](https://github.com/fougue/mayo/wiki/Build-instructions-for-Windows-MSVC) |
68 | | -[Instructions for Debian](https://github.com/fougue/mayo/wiki/Build-instructions-for-Debian) |
|
0 commit comments