Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asmaloney/meshio
CloudCompare plugin for loading COLLADA, glTF, and IFC-SPF 3D models
https://github.com/asmaloney/meshio
3d-mesh cloudcompare cloudcompare-plugin collada file-format gltf hacktoberfest ifc
Last synced: about 13 hours ago
JSON representation
CloudCompare plugin for loading COLLADA, glTF, and IFC-SPF 3D models
- Host: GitHub
- URL: https://github.com/asmaloney/meshio
- Owner: asmaloney
- License: bsd-3-clause
- Created: 2019-03-04T18:11:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-20T15:37:51.000Z (5 months ago)
- Last Synced: 2024-06-21T09:17:14.158Z (5 months ago)
- Topics: 3d-mesh, cloudcompare, cloudcompare-plugin, collada, file-format, gltf, hacktoberfest, ifc
- Language: C++
- Homepage:
- Size: 90.8 KB
- Stars: 28
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/CloudCompare/CloudCompare)
[](https://opensource.org/licenses/BSD-3-Clause)
# 
MeshIO
This is a plugin for [CloudCompare](https://github.com/CloudCompare/CloudCompare) for reading 3D model files (meshes). It uses the [Open Asset Import Library](https://github.com/assimp/assimp) (Assimp).
Currently MeshIO supports reading the following formats:
- [COLLADA](https://en.wikipedia.org/wiki/COLLADA) (\*.dae)
- [glTF](https://en.wikipedia.org/wiki/GlTF) (\*.gltf \*.glb)
- [IFC-SPF](https://en.wikipedia.org/wiki/ISO_10303-21) a.k.a STEP (\*.ifc \*.stp \*.step)
## Requirements
MeshIO has two requirements that are currently different from CloudCompare itself:
1. CMake >= 3.22
2. C++17 compiler
## Building
Unfortunately, because of the way CloudCompare is set up, you have to build all of CloudCompare before you can build a plugin for it. So the first thing to do is to get the [CloudCompare source](https://github.com/CloudCompare/CloudCompare) and [build CloudCompare](https://github.com/CloudCompare/CloudCompare/blob/master/BUILD.md).
Once you have it building properly:
- clone this repository into the `CloudCompare/plugins/private` directory:
cd CloudCompare/plugins/private
git clone --recursive https://github.com/asmaloney/MeshIO.git
- re-run CloudCompare's cmake
- turn on `PLUGIN-3rdParty_MESH_IO` in the CloudCompare cmake options
- build CloudCompare
Note: If you are building for _CloudCompare 2.11.x_, use the tagged version of MeshIO at `cloudcompare-2.11.x`
## Adding Another Format
As long as it is a format supported by Assimp, getting the basics implemented is fairly straightforward (a bunch of copy-paste).
For example, to add a new format "Foo":
- copy and rename the header & source file of an existing importer (e.g. glTF)
- add the header & source files to the appropriate `CMakeLists.txt` files
- change the `FilterInfo` info in the constructor for the new format (details of the struct are found in CloudCompare's FileIOFilter.h) - the `id` should start with `MeshIO`
```cpp
FooFilter::FooFilter() :
// clang-format off
mioAbstractLoader( {
"MeshIO Foo Filter",
FileIOFilter::DEFAULT_PRIORITY,
QStringList{ "foo", "bar" },
"foo",
QStringList{ "MeshIO - Foo file (*.foo *.bar)" },
QStringList(),
Import
} )
{
}
```
- add the new importer to MeshIO::getFilters() in MeshIO.cpp:
```cpp
ccIOPluginInterface::FilterList MeshIO::getFilters()
{
// clang-format off
return {
FileIOFilter::Shared( new COLLADAFilter ),
FileIOFilter::Shared( new glTFFilter ),
FileIOFilter::Shared( new IFCFilter ),
FileIOFilter::Shared( new FooFilter ), // <--
};
}
```
- set the CMake variable in `CMakeLists.txt` so that Assimp builds the format:
```cmake
set( ASSIMP_BUILD_FOO_IMPORTER TRUE CACHE INTERNAL "override ASSIMP flags" FORCE )
```
This should result in the basic geometry and materials being loaded.
### Next Steps
You may need to massage the data a bit to make it suitable for working with in CloudCompare. For example the IFC importer cleans up some naming, and you might need to clean up object hierarchies. This can be done by overriding `mioAbstractLoader::_postProcess()`.
Once you have it working, please consider contributing it using a [pull request](https://github.com/asmaloney/MeshIO/pulls).
## Caveat
This plugin is using [another library](https://github.com/assimp/assimp) to read these file formats. There will be problems with some files (e.g. [IFC-SPF](https://en.wikipedia.org/wiki/ISO_10303-21) is not 100% implemented). It also means that some mesh names might be lost when importing some formats.
Because this plugin is basically translating the [Assimp](https://github.com/assimp/assimp) data into something [CloudCompare](https://github.com/CloudCompare/CloudCompare) understands, it can be tricky to figure out where the problem lies since it could involve any or all of the three components.
If you find files that do not work as expected, please add an [issue here](https://github.com/asmaloney/MeshIO/issues) and attach the smallest example you have that isn't working. I will try to assess where the problem lies and either report it to the [Assimp](https://github.com/assimp/assimp) project or [CloudCompare](https://github.com/CloudCompare/CloudCompare) project as necessary.
## Icon
The icon is by [qubodup](https://openclipart.org/detail/168258/3d-cube-icon) (Public Domain).
## License
This project is licensed under the BSD 3-Clause license - see [LICENSE](https://github.com/asmaloney/MeshIO/blob/master/LICENSE) file for details.
Individual source files contain the following tag instead of the full license text:
SPDX-License-Identifier: BSD-3-Clause
This enables machine processing of license information based on [SPDX
License Identifiers](https://spdx.org/ids).