Crate modelio 

modelio-rs

Safe Rust bindings for Apple’s ModelIO framework on macOS. The published Cargo package is modelio-rs; the Rust library target is modelio.

Status: v0.2.1 adds transform authoring, transform stacks, mesh-buffer allocators, asset resolvers, procedural texture subclasses, and light-probe baking helpers on top of the v0.2.0 scene and animation surface.

Highlights

• Asset for loading, exporting, and walking ModelIO assets
• Mesh for procedural primitives, vertex buffer reads, submesh inspection, and vertex descriptor access
• Material and MaterialProperty for physically plausible materials and property mutation
• Light, PhysicallyPlausibleLight, and Camera for scene-lighting and camera control surfaces
• Object for hierarchy creation, child traversal, path lookup, and transform-component attachment
• Transform, TransformStack, and typed transform ops for explicit transform authoring
• MeshBufferData, MeshBufferDataAllocator, and related wrappers for buffer-authoring workflows
• AssetResolver plus path, bundle, and relative resolvers for asset lookup control
• VoxelArray for sparse voxel grids, boolean ops, and coarse mesh generation
• Texture for URL-backed textures, checkerboards, procedural gradients/noise/sky cubes, metadata, writes, and texel extraction
• LightProbe and LightProbeIrradianceDataSource for probe generation and placement helpers
• Skeleton, PackedJointAnimation, AnimationBindComponent, and animated value wrappers for basic rigging and animation workflows
• VertexDescriptor and VertexAttribute wrappers for vertex layout inspection and authoring

Quick start

use modelio::prelude::*;

fn main() -> modelio::Result<()> {
    let mesh = Mesh::new_box([1.0, 1.0, 1.0], [1, 1, 1], false, GeometryType::Triangles)?;
    let bbox = mesh.bounding_box();

    println!("vertices={}", mesh.vertex_count());
    println!("submeshes={}", mesh.submesh_count());
    println!("bounds min={:?} max={:?}", bbox.min, bbox.max);
    Ok(())
}

Surface overview

Assets + objects

• Asset::new, from_url, export_to_url, place_light_probes
• Asset::count, object_at, object_at_path, mesh_at, meshes
• Asset::frame_interval, start_time, end_time, up_axis
• Object::new, name, path, hidden, add_child, child_at, at_path, transform_component
• PathAssetResolver, BundleAssetResolver, RelativeAssetResolver, and AssetResolver::resolve_asset_named

Meshes + submeshes + vertex data

• Mesh::new_box, new_plane, new_ellipsoid, new_sphere, new_cylinder, new_icosahedron
• Mesh::vertex_count, vertex_buffers, submeshes, bounding_box, vertex_descriptor
• MeshBuffer::map, fill_data, allocator, zone, as_data_buffer
• MeshBufferData, MeshBufferDataAllocator, MeshBufferZoneDefault, and MeshBufferMap
• VertexAttributeData::info, bytes
• Submesh::index_count, index_type, geometry_type, index_buffer, material, set_material
• VertexDescriptor::info, attributes, attribute_named, copy
• VertexAttribute::new, info, set_initialization_value

Materials + textures

• Material::new, info, material_face, property_with_semantic
• MaterialProperty::info, set_float, set_color, set_string, set_url, texture
• Texture::from_url, new_checkerboard, new_color_temperature_gradient, new_color_gradient, new_vector_noise, new_scalar_noise, new_cellular_noise, new_normal_map, new_sky_cube
• Texture::info, write_to_url, update_sky_cube, texel_data_top_left, texel_data_bottom_left

Lights + cameras

• Light::new, info, set_light_type, set_color_space, irradiance_at_point
• LightProbe::new, reflective_texture, irradiance_texture, generate_spherical_harmonics_from_irradiance
• LightProbeIrradianceDataSource::new, bounding_box, spherical_harmonics_level
• PhysicallyPlausibleLight::new, info, set_color_temperature, set_lumens, cone-angle and attenuation setters
• Camera::new, info, set_projection, set_field_of_view, look_at, look_at_from, ray_to, frame_bounding_box

Transforms + animation

• Transform::new, from_component, from_matrix, translation, rotation, scale, and timed setters
• TransformComponent::matrix, key_times, local_transform_at_time, global_transform_with_object
• TransformStack::add_translate_op, add_rotate_*_op, add_scale_op, add_matrix_op, add_orient_op, transform_ops
• TransformOp plus typed op wrappers with animated-value accessors

Voxels + animation

• VoxelArray::new, info, set_voxel, voxel_exists, voxel_indices, voxels_within_extent
• VoxelArray::union_with, intersect_with, difference_with, coarse_mesh, mesh
• Skeleton::new, info, joint_bind_transforms, joint_rest_transforms
• PackedJointAnimation::new, info, translations, rotations, scales
• AnimationBindComponent::new, info, set_skeleton, set_packed_joint_animation, set_joint_paths
• AnimatedScalar, AnimatedVector2/3/4, AnimatedQuaternion, AnimatedMatrix4x4
• AnimatedScalarArray, AnimatedVector3Array, AnimatedQuaternionArray

Examples

The crate ships numbered examples covering every logical area:

• 01_primitive_smoke
• 02_asset_basics
• 03_material_properties
• 04_light_defaults
• 05_physically_plausible_light
• 06_camera_controls
• 07_object_hierarchy
• 08_voxel_array_boolean
• 09_texture_checkerboard
• 10_animation_bind_component
• 11_animated_value_types
• 12_submesh_material
• 13_vertex_attribute_descriptor
• 14_skeleton_basics
• 15_transform_stack_basics
• 16_mesh_buffer_allocator
• 17_asset_resolver_light_probe

Run one with:

cargo run --example 09_texture_checkerboard

Run them all with:

for ex in examples/*.rs; do cargo run --example "$(basename "$ex" .rs)"; done

Tests

Integration smoke tests live under tests/ with one file per logical area plus tests/api_coverage.rs, which validates the Swift bridge against the active macOS SDK headers.

License

Licensed under either of Apache-2.0 or MIT at your option.

Modules

prelude

vertex_format

Structs

AnimatedMatrix4x4

AnimatedQuaternion

AnimatedQuaternionArray

AnimatedScalar

AnimatedScalarArray

AnimatedValue

AnimatedValueInfo

AnimatedVector2

AnimatedVector3

AnimatedVector4

AnimatedVector3Array

AnimationBindComponent

Asset

AssetInfo

AssetResolver

BoundingBox

BundleAssetResolver

Camera

CameraInfo

Light

LightInfo

LightProbe

LightProbeIrradianceDataSource

Material

MaterialInfo

MaterialProperty

MaterialPropertyInfo

Mesh

MeshBuffer

MeshBufferAllocator

MeshBufferData

MeshBufferDataAllocator

MeshBufferInfo

MeshBufferMap

MeshBufferZone

MeshBufferZoneDefault

ModelIoError

Object

ObjectInfo

PackedJointAnimation

PackedJointAnimationInfo

PathAssetResolver

PhysicallyPlausibleLight

PhysicallyPlausibleLightInfo

RelativeAssetResolver

Skeleton

SkeletonInfo

Submesh

Texture

TextureInfo

Transform

TransformComponent

TransformMatrixOp

TransformOp

TransformOrientOp

TransformRotateOp

TransformRotateXOp

TransformRotateYOp

TransformRotateZOp

TransformScaleOp

TransformStack

TransformTranslateOp

VertexAttribute

VertexAttributeData

VertexAttributeDescriptorInfo

VertexAttributeInfo

VertexDescriptor

VertexDescriptorInfo

VoxelArray

VoxelArrayInfo

VoxelIndexExtent

Enums

AnimatedValueInterpolation

CameraProjection

DataPrecision

GeometryType

IndexBitDepth

LightType

MaterialFace

MaterialPropertyType

MaterialSemantic

MeshBufferType

ObjectKind

ProbePlacement

TextureChannelEncoding

TransformOpRotationOrder

Type Aliases

Result