smfj
The smfj package provides a minimalist format for storing mesh data.
Features
- Strongly-typed generic non-interleaved storage format.
- Carefully designed binary format that allows for mapping sections of files into memory for direct upload to the GPU. All data is strictly aligned for performance.
- Rich integer types: Store named arrays of 1-4 component 8/16/32/64-bit signed and unsigned integer vectors.
- Rich floating point types: Store named arrays of 1-4 component 16/32/64-bit floating-point vectors.
- Text and binary encodings.
- Blender plugin to export directly to the text format.
- Event-based parsers for near zero-allocation parsing.
- Extensible filter system for processing and transforming mesh data.
- High coverage test suite.
- OSGi-ready
- JPMS-ready
- ISC license.
Specification
See the specification.
Releases & Development Snapshots
Releases
You can subscribe to the atom feed to be notified of project releases.
The most recently released version of the package is 1.0.0.
1.0.0 Release (2024-05-05Z)
The compiled artifacts for the release (and all previous releases) are available on Maven Central.
Maven Modules
<dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.blender</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.cmdline</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.core</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.format.binary2</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.format.obj</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.format.support</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.format.text</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.format.xml</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.frontend</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.parser.api</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.probe.api</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.processing.api</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.processing.main</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.serializer.api</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.specification</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.tests</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.validation.api</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.smfj</group> <artifactId>com.io7m.smfj.validation.main</artifactId> <version>1.0.0</version> </dependency>
Previous Releases
The changelogs for the most recent previous releases are as follows:
0.15.0 Release (2020-04-04Z)
- Full JPMS modularization and OSGi bundle baselining (Backwards incompatible)
0.14.0 Release (2017-06-21Z)
- Correctly handle a lack of triangles and vertex data in the byte buffer packer. (Tickets: 51)
- Require parsers to fail on missing triangles and vertices. (Backwards incompatible)
0.13.0 Release (2017-06-18Z)
- Replace the attribute_offset field. (Backwards incompatible) (Tickets: 49)
0.12.0 Release (2017-06-18Z)
- Add a "resample" filter command to provide lossy resampling of vertex data.
- Add application information. Export application metadata in the Blender plugin, and add a filter command to generate application info as metadata.
Development Snapshots
At the time of writing, the current unstable development version of the package is 0.16.0-SNAPSHOT.
Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.
Manual
Specification
Sources
This project uses Git to manage source code.
Repository: https://www.github.com/io7m-com/smfj
$ git clone --recursive https://www.github.com/io7m-com/smfj
Issues
This project uses GitHub Issues to track issues.
License
Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.