libs: model3d moves to github.com/hexops/mach-model3d

Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst 2023-07-01 22:34:14 -07:00
parent 4a56244912
commit aa117760c7
14 changed files with 0 additions and 7167 deletions

View file

@ -1,2 +0,0 @@
* text=auto eol=lf
upstream/** linguist-vendored

View file

@ -1 +0,0 @@
github: slimsag

View file

@ -1,5 +0,0 @@
Please send your change to [the main repository](https://github.com/hexops/mach/tree/main/libs/model3d) instead, sorry for the trouble!
This helps us avoid some complex merge conflicts we run into when changes are made to both repositories and history needs to be reconciled. Keeping PRs in just that repository enables us to use `git subtree` to trivially keep the two repositories in sync.
Once your PR is merged over there, it'll automatically sync to this repository.

View file

@ -1,51 +0,0 @@
name: CI
on:
- push
- pull_request
jobs:
x86_64-linux:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup Zig
run: |
sudo apt install xz-utils
sudo sh -c 'wget -c https://ziglang.org/builds/zig-linux-x86_64-0.11.0-dev.3883+7166407d8.tar.xz -O - | tar -xJ --strip-components=1 -C /usr/local/bin'
- name: build
run: zig build
- name: test
run: zig build test
x86_64-windows:
runs-on: windows-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup Zig
run: |
$ProgressPreference = 'SilentlyContinue'
Invoke-WebRequest -Uri "https://ziglang.org/builds/zig-windows-x86_64-0.11.0-dev.3883+7166407d8.zip" -OutFile "C:\zig.zip"
cd C:\
7z x zig.zip
Add-Content $env:GITHUB_PATH "C:\zig-windows-x86_64-0.11.0-dev.3883+7166407d8\"
- name: build
run: zig build
- name: test
run: zig build test
x86_64-macos:
runs-on: macos-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup Zig
run: |
brew install xz
sudo sh -c 'wget -c https://ziglang.org/builds/zig-macos-x86_64-0.11.0-dev.3883+7166407d8.tar.xz -O - | tar -xJ --strip-components=1 -C /usr/local/bin'
- name: build
run: zig build
env:
AGREE: true
- name: test
run: zig build test
env:
AGREE: true

View file

@ -1,18 +0,0 @@
# This file is for zig-specific build artifacts.
# If you have OS-specific or editor-specific files to ignore,
# such as *.swp or .DS_Store, put those in your global
# ~/.gitignore and put this in your ~/.gitconfig:
#
# [core]
# excludesfile = ~/.gitignore
#
# Cheers!
# -andrewrk
zig-cache/
zig-out/
/release/
/debug/
/build/
/build-*/
/docgen_tmp/

View file

@ -1,13 +0,0 @@
Copyright 2021, Hexops Contributors (given via the Git commit history).
All documentation, image, sound, font, and 2D/3D model files are CC-BY-4.0 licensed unless
otherwise noted. You may get a copy of this license at https://creativecommons.org/licenses/by/4.0
Files in a directory with a separate LICENSE file may contain files under different license terms,
described within that LICENSE file.
All other files are licensed under the Apache License, Version 2.0 (see LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
or the MIT license (see LICENSE-MIT or http://opensource.org/licenses/MIT), at your option.
All files in the project without exclusions may not be copied, modified, or distributed except
according to the terms above.

View file

@ -1,202 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View file

@ -1,25 +0,0 @@
Copyright (c) 2021 Hexops Contributors (given via the Git commit history).
Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

View file

@ -1,27 +0,0 @@
# mach/model3d - compact, featureful model format & alternative to glTF
[Model3D](https://gitlab.com/bztsrc/model3d/) is an up-and-coming compact, featureful, universal model format that tries to address the shortcomings of existing formats (yes, including glTF - see [their rationale](https://gitlab.com/bztsrc/model3d/#rationale).)
This repository provides Zig bindings, with the aim of a pure-Zig implementation eventually.
This repository is a separate copy of the same library in the [main Mach repository](https://github.com/hexops/mach), and is automatically kept in sync, so that anyone can use this library in their own project if they like!
## Experimental
This is an _experimental_ Mach library, according to our [stability guarantees](https://machengine.org/next/docs/libs/):
> Experimental libraries may have their APIs change without much notice, and you may have to look at recent changes in order to update your code.
[Why this library is not declared stable yet](https://machengine.org/next/docs/libs/experimental/#model3d)
## Join the community
Join the Mach community [on Discord](https://discord.gg/XNG3NZgCqp) to discuss this project, ask questions, get help, etc.
## Issues
Issues are tracked in the [main Mach repository](https://github.com/hexops/mach/issues?q=is%3Aissue+is%3Aopen+label%3Amodel3d).
## Contributing
Contributions are very welcome. Pull requests must be sent to [the main repository](https://github.com/hexops/mach/tree/main/libs/model3d) to avoid some complex merge conflicts we'd get by accepting contributions in both repositories. Once the changes are merged there, they'll get sync'd to this repository automatically.

Binary file not shown.

View file

@ -1,52 +0,0 @@
const std = @import("std");
var _module: ?*std.build.Module = null;
pub fn module(b: *std.Build) *std.build.Module {
if (_module) |m| return m;
_module = b.createModule(.{
.source_file = .{ .path = sdkPath("/src/main.zig") },
});
return _module.?;
}
pub fn build(b: *std.Build) void {
const optimize = b.standardOptimizeOption(.{});
const target = b.standardTargetOptions(.{});
const test_step = b.step("test", "Run library tests");
test_step.dependOn(&testStep(b, optimize, target).step);
}
pub fn testStep(b: *std.Build, optimize: std.builtin.OptimizeMode, target: std.zig.CrossTarget) *std.build.RunStep {
const main_tests = b.addTest(.{
.name = "model3d-tests",
.root_source_file = .{ .path = sdkPath("/src/main.zig") },
.target = target,
.optimize = optimize,
});
link(b, main_tests, target);
b.installArtifact(main_tests);
return b.addRunArtifact(main_tests);
}
pub fn link(b: *std.Build, step: *std.build.CompileStep, target: std.zig.CrossTarget) void {
const lib = b.addStaticLibrary(.{
.name = "model3d",
.target = target,
.optimize = step.optimize,
});
// Note: model3d needs unaligned accesses, which are safe on all modern architectures.
// See https://gitlab.com/bztsrc/model3d/-/issues/19
lib.addCSourceFile(sdkPath("/src/c/m3d.c"), &.{ "-std=c89", "-fno-sanitize=alignment" });
lib.linkLibC();
step.addIncludePath(sdkPath("/src/c/"));
step.linkLibrary(lib);
}
fn sdkPath(comptime suffix: []const u8) []const u8 {
if (suffix[0] != '/') @compileError("suffix must be an absolute path");
return comptime blk: {
const root_dir = std.fs.path.dirname(@src().file) orelse ".";
break :blk root_dir ++ suffix;
};
}

View file

@ -1,3 +0,0 @@
#define M3D_IMPLEMENTATION
#define M3D_EXPORTER
#include "m3d.h"

File diff suppressed because it is too large Load diff

View file

@ -1,239 +0,0 @@
const std = @import("std");
const c = @cImport(@cInclude("m3d.h"));
const testing = std.testing;
pub const Error = error{
/// memory allocation error
OutOfMemory,
/// malformed text file (ASCII import only)
BadFile,
/// unimplemented interpreter (procedural surface)
Unimplemented,
/// unknown material property record
Unknown,
/// unknown mesh record (only triangles supported)
UnknownMeshRecord,
/// unknown image format (PNG only)
UnknownImageFormat,
/// unknown action or frame or missing bones
UnknownActionFrame,
/// unknown shape command record
UnknownCommand,
/// no voxel dimension or voxel size defined
UnknownVoxel,
/// either the precision or number of bones truncated
Truncated,
/// too many or no chunk of color map
UnexpectedColorMapCount,
/// too many or no chunk of texture map
UnexpectedTextureMapCount,
/// too many or no chunk of vertices
UnexpectedVerticeCount,
/// too many or no chunk of bones
UnexpectedBoneCount,
/// too many or no chunk of material
UnexpectedMaterialCount,
/// too many or no chunk of shape
UnexpectedShapeCount,
/// too many or no chunk of voxel
UnexpectedVoxelCount,
};
const M3d = @This();
handle: *c.m3d_t,
pub fn load(data: [:0]u8, readfile_fn: ?ReadFn, free_fn: ?FreeFn, mtllib: ?M3d) ?M3d {
return .{
.handle = c.m3d_load(
data.ptr,
readfile_fn,
free_fn,
if (mtllib) |m| m.handle else null,
) orelse return null,
};
}
pub fn deinit(self: M3d) void {
c.m3d_free(self.handle);
}
/// return value must be freed with std.c.free
pub fn save(self: M3d, quality: Quality, flags: Flags) Error![]u8 {
var size: u32 = 0;
return if (c.m3d_save(
self.handle,
@intFromEnum(quality),
@as(c_int, @bitCast(flags)),
&size,
)) |res|
res[0..size]
else
return intToError(self.errCode());
}
pub fn frame(self: M3d, action_id: u32, frame_id: u32, skeleton: []Transform) Error![]Transform {
return if (c.m3d_frame(self.handle, action_id, frame_id, skeleton.ptr)) |res|
res[0..self.handle.numbone]
else
intToError(self.errCode());
}
pub fn pose(self: M3d, action_id: u32, msec: u32) Error![]Bone {
return if (c.m3d_pose(self.handle, action_id, msec)) |res|
res[0..self.handle.numbone]
else
intToError(self.errCode());
}
pub fn name(self: M3d) [:0]const u8 {
return std.mem.span(self.handle.name);
}
pub fn license(self: M3d) [:0]const u8 {
return std.mem.span(self.handle.license);
}
pub fn author(self: M3d) [:0]const u8 {
return std.mem.span(self.handle.author);
}
pub fn description(self: M3d) [:0]const u8 {
return std.mem.span(self.handle.desc);
}
pub fn scale(self: M3d) f32 {
return self.handle.scale;
}
pub fn preview(self: M3d) InlineAsset {
return self.handle.preview;
}
pub fn textures(self: M3d) []TextureData {
return self.handle.texture[0..self.handle.numtexture];
}
pub fn materials(self: M3d) []Material {
return self.handle.material[0..self.handle.nummaterial];
}
pub fn errCode(self: M3d) c_int {
return self.handle.errcode;
}
pub const TextureIndex = c.m3d_texturedata_t;
pub const TextureData = c.m3d_texturedata_t;
pub const Weight = c.m3d_weight_t;
pub const Skin = c.m3d_skin_t;
pub const Bone = c.m3d_bone_t;
pub const Vertex = c.m3d_vertex_t;
pub const Material = c.m3d_material_t;
pub const Face = c.m3d_face_t;
pub const VoxelItem = c.m3d_voxelitem_t;
pub const VoxelType = c.m3d_voxeltype_t;
pub const Voxel = c.m3d_voxel_t;
pub const ShapeCommand = c.m3d_shapecommand_t;
pub const Shape = c.m3d_shape_t;
pub const Label = c.m3d_label_t;
pub const Transform = c.m3d_transform_t;
pub const Frame = c.m3d_frame_t;
pub const Action = c.m3d_action_t;
pub const InlineAsset = c.m3d_inlinedasset_t;
pub const ReadFn = *const fn (filename: [*c]u8, size: [*c]c_uint) callconv(.C) [*c]u8;
pub const FreeFn = *const fn (ptr: ?*anyopaque) callconv(.C) void;
pub const Quality = enum(u2) {
// export with -128 to 127 coordinate precision
int8 = c.M3D_EXP_INT8,
// export with -32768 to 32767 precision
int16 = c.M3D_EXP_INT16,
// export with 32 bit floating point precision
float = c.M3D_EXP_FLOAT,
// export with 64 bit floatint point precision
double = c.M3D_EXP_DOUBLE,
};
pub const Flags = packed struct(u32) {
// don't export color map
nocmap: bool = false,
// don't export materials
nomaterial: bool = false,
// don't export model face
noface: bool = false,
// don't export normal vectors
nonormal: bool = false,
// don't export texture UV
notxtcrd: bool = false,
// flip V in texture UVs
fliptxtcrd: bool = false,
// don't recalculate coordinates
norecalc: bool = false,
// the input is left-handed
idosuck: bool = false,
// don't export skeleton
nobone: bool = false,
// no animation nor skeleton saved
noaction: bool = false,
// inline assets into the model
inline_assets: bool = false,
// export unknown chunks too
extra: bool = false,
// export into uncompressed binary
nozlib: bool = false,
// export into ASCII format
ascii: bool = false,
// don't export maximum vertex
novrtmax: bool = false,
_padding: u17 = 0,
};
fn intToError(int: c_int) Error {
return switch (int) {
c.M3D_SUCCESS => unreachable,
c.M3D_ERR_ALLOC => error.OutOfMemory,
c.M3D_ERR_BADFILE => error.BadFile,
c.M3D_ERR_UNIMPL => error.Unimplemented,
c.M3D_ERR_UNKPROP => error.Unknown,
c.M3D_ERR_UNKMESH => error.UnknownMeshRecord,
c.M3D_ERR_UNKIMG => error.UnknownImageFormat,
c.M3D_ERR_UNKFRAME => error.UnknownActionFrame,
c.M3D_ERR_UNKCMD => error.UnknownCommand,
c.M3D_ERR_UNKVOX => error.UnknownVoxel,
c.M3D_ERR_TRUNC => error.Truncated,
c.M3D_ERR_CMAP => error.UnexpectedColorMapCount,
c.M3D_ERR_TMAP => error.UnexpectedTextureMapCount,
c.M3D_ERR_VRTS => error.UnexpectedVerticeCount,
c.M3D_ERR_BONE => error.UnexpectedBoneCount,
c.M3D_ERR_MTRL => error.UnexpectedMaterialCount,
c.M3D_ERR_SHPE => error.UnexpectedShapeCount,
c.M3D_ERR_VOXT => error.UnexpectedVoxelCount,
else => unreachable,
};
}
test {
testing.refAllDeclsRecursive(@This());
var model_file = try std.fs.cwd().openFile(thisDir("/../assets/cube.m3d"), .{});
defer model_file.close();
var model_data = try model_file.readToEndAllocOptions(testing.allocator, 1024, 119, @alignOf(u8), 0);
defer testing.allocator.free(model_data);
const model = M3d.load(model_data, null, null, null) orelse return error.Fail;
defer model.deinit();
try testing.expectEqualStrings(model.name(), "cube.obj");
var out = try model.save(.float, .{});
defer std.c.free(out.ptr);
try testing.expect(out.len >= 119);
}
fn thisDir(comptime suffix: []const u8) []const u8 {
if (suffix[0] != '/') @compileError("suffix must be an absolute path");
return comptime blk: {
const root_dir = std.fs.path.dirname(@src().file) orelse ".";
break :blk root_dir ++ suffix;
};
}