OpenRCT2-ObjectCommon 0.1.3__tar.gz → 0.2.0__tar.gz

{openrct2_objectcommon-0.1.3 → openrct2_objectcommon-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OpenRCT2-ObjectCommon
-Version: 0.1.3
+Version: 0.2.0
 Summary: Shared config, CLI, .parkobj, and object.json scaffolding for OpenRCT2 object generators.
 Project-URL: Homepage, https://github.com/alex-parisi/OpenRCT2-ObjectCommon
 Project-URL: Repository, https://github.com/alex-parisi/OpenRCT2-ObjectCommon
@@ -9,7 +9,7 @@ License-Expression: GPL-3.0-or-later
 License-File: LICENSE
 Requires-Python: >=3.11
 Requires-Dist: numpy>=1.26
-Requires-Dist: openrct2-x7-renderer>=0.3.1
+Requires-Dist: openrct2-x7-renderer>=0.3.4
 Requires-Dist: pillow>=10.0
 Requires-Dist: pyyaml>=6.0
 Provides-Extra: blender
@@ -109,8 +109,9 @@ def export_to(obj, context, parkobj_path, work_dir, skip_render=False):
 
 ### Blender helpers
 
-The `blender` subpackage imports `bpy` (only `blender.modal` — `blender.lights`
-does not), so install the extra when working with it outside Blender:
+The `blender` subpackage imports `bpy` (`blender.modal`, `blender.props`, and
+`blender.mesh_extract` — `blender.lights` does not), so install the extra when
+working with it outside Blender:
 
 ```bash
 pip install "OpenRCT2-ObjectCommon[blender]"

{openrct2_objectcommon-0.1.3 → openrct2_objectcommon-0.2.0}/README.md

@@ -91,8 +91,9 @@ def export_to(obj, context, parkobj_path, work_dir, skip_render=False):
 
 ### Blender helpers
 
-The `blender` subpackage imports `bpy` (only `blender.modal` — `blender.lights`
-does not), so install the extra when working with it outside Blender:
+The `blender` subpackage imports `bpy` (`blender.modal`, `blender.props`, and
+`blender.mesh_extract` — `blender.lights` does not), so install the extra when
+working with it outside Blender:
 
 ```bash
 pip install "OpenRCT2-ObjectCommon[blender]"

{openrct2_objectcommon-0.1.3 → openrct2_objectcommon-0.2.0}/openrct2_object_common/blender/lights.py

@@ -43,7 +43,7 @@ def lights_from_items(items: Iterable[_LightItem]) -> list[Light]:
     rig = [
         Light(
             type=LIGHT_TYPE_MAP[item.type],
-            shadow=int(item.shadow),
+            shadow=bool(item.shadow),
             direction=normalize_direction(list(item.direction)),
             intensity=item.strength,
         )

{openrct2_objectcommon-0.1.3 → openrct2_objectcommon-0.2.0}/openrct2_object_common/blender/mesh_extract.py

@@ -16,6 +16,7 @@ from collections.abc import Callable
 import bpy
 import numpy as np
 from mathutils import Matrix, Vector
+from openrct2_x7_renderer.constants import MaterialFlag
 from openrct2_x7_renderer.image import quantize_to_indexed, read_png
 from openrct2_x7_renderer.mesh import Material, Mesh
 from openrct2_x7_renderer.types import IndexedImage
@@ -65,8 +66,6 @@ def material_base(
     *prop_attr*: attribute name on the bpy material (e.g. ``"vg_material"``).
     *region_map*: maps region enum string → ``(flag_bits, region_id)``.
     """
-    from openrct2_x7_renderer.constants import MaterialFlag
-
     m = Material()
     if bmat is None:
         return m, None

{openrct2_objectcommon-0.1.3 → openrct2_objectcommon-0.2.0}/openrct2_object_common/parkobj.py

@@ -73,6 +73,8 @@ def write_images_dat_lgx(
     ``note`` is appended to the log line (e.g. ``" for 4 tiles"``). Returns the
     single-element ``["$LGX:images.dat[0..N-1]"]`` list OpenRCT2 expects.
     """
+    if not images:
+        raise ValueError("Cannot write images.dat with no sprites")
     out_path = work_dir / "images.dat"
     write_images_dat(images, out_path)
     log.info(
@@ -123,6 +125,11 @@ def assemble_parkobj(
     parkobj_path.parent.mkdir(parents=True, exist_ok=True)
     tmp_fd, tmp_path = tempfile.mkstemp(suffix=".parkobj", dir=parkobj_path.parent)
     os.close(tmp_fd)
+    # mkstemp creates the file 0o600; widen to the umask default so the
+    # delivered .parkobj has normal file permissions after os.replace.
+    umask = os.umask(0)
+    os.umask(umask)
+    os.chmod(tmp_path, 0o666 & ~umask)
     try:
         with zipfile.ZipFile(tmp_path, "w", compression=zipfile.ZIP_DEFLATED) as zf:
             zf.write(work_dir / "object.json", "object.json")

{openrct2_objectcommon-0.1.3 → openrct2_objectcommon-0.2.0}/openrct2_object_common/placement.py

@@ -13,7 +13,7 @@ import math
 
 import numpy as np
 from numpy.typing import NDArray
-from openrct2_x7_renderer.geometry import rotate_x, rotate_y, rotate_z
+from openrct2_x7_renderer.geometry import rotate_x, rotate_y, rotate_z, split_mesh_by_ghost
 from openrct2_x7_renderer.mesh import Mesh
 from openrct2_x7_renderer.ray_trace import SceneBuilder
 from openrct2_x7_renderer.types import Model
@@ -24,8 +24,8 @@ __all__ = ["add_model_to_scene", "orientation_to_matrix"]
 def orientation_to_matrix(orientation_deg: NDArray[np.float64]) -> NDArray[np.float64]:
     """A MeshFrame orientation ``(angle_y, angle_z, angle_x)`` in degrees as a
     ``(3, 3)`` rotation matrix, applied as ``rotate_y @ rotate_z @ rotate_x``."""
-    rx, ry, rz = orientation_deg * (math.pi / 180.0)
-    return rotate_y(rx) @ rotate_z(ry) @ rotate_x(rz)
+    ry, rz, rx = orientation_deg * (math.pi / 180.0)
+    return rotate_y(ry) @ rotate_z(rz) @ rotate_x(rx)
 
 
 def add_model_to_scene(
@@ -42,17 +42,16 @@ def add_model_to_scene(
     Placements whose ``mesh_index`` is ``-1`` (an empty slot) are skipped. With
     ``clamp_frame=True`` a placement with fewer frames falls back to its last
     frame (scenery's animated poses); with ``False`` the frame is indexed exactly
-    (vehicle frames are uniform across placements). ``mask`` is the per-model
-    ``MeshFlag`` bitmask (e.g. ghost / mask geometry).
+    (vehicle frames are uniform across placements). ``mask`` is the base per-model
+    ``MeshFlag`` bitmask (e.g. ghost / mask geometry); faces whose material is a
+    ghost are additionally split into their own ``MeshFlag.GHOST`` model.
     """
     for mesh_frames in model.meshes:
         idx = min(frame, len(mesh_frames) - 1) if clamp_frame else frame
         mf = mesh_frames[idx]
         if mf.mesh_index == -1:
             continue
-        builder.add_model(
-            meshes[mf.mesh_index],
-            orientation_to_matrix(mf.orientation),
-            mf.position.astype(np.float64),
-            mask,
-        )
+        matrix = orientation_to_matrix(mf.orientation)
+        position = mf.position.astype(np.float64)
+        for sub_mesh, sub_mask in split_mesh_by_ghost(meshes[mf.mesh_index], mask):
+            builder.add_model(sub_mesh, matrix, position, sub_mask)

{openrct2_objectcommon-0.1.3 → openrct2_objectcommon-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "OpenRCT2-ObjectCommon"
-version = "0.1.3"
+version = "0.2.0"
 description = "Shared config, CLI, .parkobj, and object.json scaffolding for OpenRCT2 object generators."
 readme = "README.md"
 requires-python = ">=3.11"
@@ -9,7 +9,7 @@ authors = [
     { name = "Alex Parisi", email = "alex@atparisi.com" }
 ]
 dependencies = [
-    "openrct2-x7-renderer>=0.3.1",
+    "openrct2-x7-renderer>=0.3.4",
     "numpy>=1.26",
     "pillow>=10.0",
     "pyyaml>=6.0",
@@ -19,8 +19,8 @@ dependencies = [
 Homepage = "https://github.com/alex-parisi/OpenRCT2-ObjectCommon"
 Repository = "https://github.com/alex-parisi/OpenRCT2-ObjectCommon"
 
-# The Blender helpers (openrct2_object_common.blender.modal) import bpy; the rest
-# of the package does not. Only the add-ons need this extra.
+# The Blender helpers (openrct2_object_common.blender, except .lights) import
+# bpy; the rest of the package does not. Only the add-ons need this extra.
 [project.optional-dependencies]
 blender = ["bpy>=4.0"]
 

{openrct2_objectcommon-0.1.3 → openrct2_objectcommon-0.2.0}/tests/test_parkobj.py

@@ -1,6 +1,7 @@
 """Tests for .parkobj assembly and the images.dat helper."""
 
 import json
+import os
 import zipfile
 
 import numpy as np
@@ -26,6 +27,13 @@ def test_write_images_dat_lgx_writes_blob_and_ref(tmp_path):
     assert (tmp_path / "images.dat").exists()
 
 
+def test_write_images_dat_lgx_rejects_empty_list(tmp_path):
+    # An empty list would otherwise emit a malformed "$LGX:images.dat[0..-1]".
+    with pytest.raises(ValueError, match="no sprites"):
+        write_images_dat_lgx([], tmp_path)
+    assert not (tmp_path / "images.dat").exists()
+
+
 def test_assemble_renders_and_zips(tmp_path):
     work = tmp_path / "object"
     parkobj = tmp_path / "out" / "thing.parkobj"
@@ -58,6 +66,19 @@ def test_assemble_cleans_up_temp_on_zip_failure(tmp_path):
     assert list(out.glob("*.parkobj")) == []
 
 
+def test_assemble_parkobj_respects_umask(tmp_path):
+    # The temp file behind the atomic replace is mkstemp'd (0o600); the final
+    # .parkobj must carry normal umask-derived permissions instead.
+    work = tmp_path / "object"
+    parkobj = tmp_path / "thing.parkobj"
+    old_umask = os.umask(0o022)
+    try:
+        assemble_parkobj({"id": "rct2.thing"}, parkobj, work, _render_two_pixels)
+    finally:
+        os.umask(old_umask)
+    assert parkobj.stat().st_mode & 0o777 == 0o644
+
+
 def test_skip_render_reuses_previous_images(tmp_path):
     work = tmp_path / "object"
     work.mkdir()

{openrct2_objectcommon-0.1.3 → openrct2_objectcommon-0.2.0}/tests/test_placement.py

@@ -7,6 +7,8 @@ scene is needed.
 
 import numpy as np
 from openrct2_object_common.placement import add_model_to_scene, orientation_to_matrix
+from openrct2_x7_renderer.constants import MeshFlag
+from openrct2_x7_renderer.mesh import Material, Mesh
 from openrct2_x7_renderer.types import MeshFrame, Model
 
 
@@ -20,6 +22,18 @@ class _StubBuilder:
         self.calls.append((mesh, matrix, translation, mask))
 
 
+def _mesh(*, is_ghost: bool = False) -> Mesh:
+    """A one-triangle mesh with a single (optionally ghost) material."""
+    return Mesh(
+        vertices=np.zeros((3, 3), dtype=np.float32),
+        normals=np.zeros((3, 3), dtype=np.float32),
+        uvs=np.zeros((3, 2), dtype=np.float32),
+        faces=np.array([[0, 1, 2]], dtype=np.uint32),
+        face_materials=np.array([0], dtype=np.uint32),
+        materials=[Material(is_ghost=is_ghost)],
+    )
+
+
 def test_orientation_to_matrix_zero_is_identity():
     m = orientation_to_matrix(np.zeros(3, dtype=np.float64))
     assert m.shape == (3, 3)
@@ -33,7 +47,7 @@ def test_orientation_to_matrix_is_orthonormal():
 
 
 def test_add_model_places_each_referenced_mesh():
-    meshes = ["mesh0", "mesh1"]
+    meshes = [_mesh(), _mesh()]
     model = Model(meshes=[
         [MeshFrame(mesh_index=0, position=np.array([1.0, 2.0, 3.0]))],
         [MeshFrame(mesh_index=1)],
@@ -41,21 +55,33 @@ def test_add_model_places_each_referenced_mesh():
     builder = _StubBuilder()
     add_model_to_scene(builder, meshes, model, mask=7)
 
-    assert [c[0] for c in builder.calls] == ["mesh0", "mesh1"]
+    assert [c[0] for c in builder.calls] == meshes
     np.testing.assert_allclose(builder.calls[0][2], [1.0, 2.0, 3.0])
     assert all(c[3] == 7 for c in builder.calls)
 
 
 def test_add_model_skips_empty_slots():
+    only = _mesh()
     model = Model(meshes=[[MeshFrame(mesh_index=-1)], [MeshFrame(mesh_index=0)]])
     builder = _StubBuilder()
-    add_model_to_scene(builder, ["only"], model)
-    assert [c[0] for c in builder.calls] == ["only"]
+    add_model_to_scene(builder, [only], model)
+    assert [c[0] for c in builder.calls] == [only]
 
 
 def test_clamp_frame_falls_back_to_last_pose():
     # Placement has 2 frames; requesting frame 5 with clamp uses the last (idx 1).
+    a, b = _mesh(), _mesh()
     model = Model(meshes=[[MeshFrame(mesh_index=0), MeshFrame(mesh_index=1)]])
     builder = _StubBuilder()
-    add_model_to_scene(builder, ["a", "b"], model, frame=5, clamp_frame=True)
-    assert [c[0] for c in builder.calls] == ["b"]
+    add_model_to_scene(builder, [a, b], model, frame=5, clamp_frame=True)
+    assert [c[0] for c in builder.calls] == [b]
+
+
+def test_add_model_marks_ghost_material_geometry():
+    # A wholly ghost placement is added once, carrying the base mask OR'd with
+    # MeshFlag.GHOST so the renderer traces through it.
+    model = Model(meshes=[[MeshFrame(mesh_index=0)]])
+    builder = _StubBuilder()
+    add_model_to_scene(builder, [_mesh(is_ghost=True)], model, mask=2)
+    assert len(builder.calls) == 1
+    assert builder.calls[0][3] == 2 | int(MeshFlag.GHOST)