Crate fast_mesh_scene 

Scenes of several editable meshes, built on fast_mesh_store, fast_mesh_bvh and fast_mesh_query.

A Scene owns meshes, each with a BVH, an UpdateMode and a Placement (a rotation, a per-axis scale and a translation into the world). Meshes are addressed by generational MeshIds: once a mesh is removed, its id is rejected with SceneError::UnknownMesh for good.

• Registry: Scene::add_mesh, Scene::remove_mesh, Scene::mesh and Scene::ids (in index order).
• Placements: Scene::placement and Scene::set_placement. A placement is validated (a proper rotation, a finite positive scale) and stored exactly as given. World queries, fields and sections all follow the scale; pair queries run on copies baked into one mesh’s local space (or into the world) when a scale is involved.
• Editing: Scene::edit runs a store transaction on one mesh and records its patch. All-or-nothing: a failed edit changes nothing. The closure may fail with any error that converts into SceneError, so repair operations from ops (the re-exported fast-mesh-ops) run directly: scene.edit(id, |tx| ops::fill_holes(tx, &options)).
• Joining: Scene::join appends one mesh’s geometry into another and bridges a loop on each, as one undo step, then removes the source mesh.
• Cutting: Scene::cut_by_plane splits a mesh with a world plane, capping both openings flat by default, and adds the removed side as a new mesh with the same placement, as one undo step.
• Booleans: Scene::boolean unions, subtracts or intersects mesh B into mesh A in the world; the result replaces A with A’s placement, as one undo step.
• Registration: Scene::register rigidly aligns one mesh to another by trimmed point-to-plane ICP from their current placements, and sets the moving mesh’s placement as one undo step when the result is good.
• History: one undo history across all meshes, in steps. Scene::begin_step / Scene::end_step group edits and placement changes (otherwise each is its own step); Scene::undo, Scene::redo and Scene::cancel_step are all-or-nothing per step. SceneOptions::history_budget evicts the oldest steps.
• BVH state: each mesh’s UpdateMode says when its BVH follows the mesh; Scene::set_mode, Scene::update, Scene::flush and Scene::is_current.
• Change reports: Scene::take_changes drains one MeshChanges per affected mesh. Further consumers each get their own copy of every report: Scene::subscribe, Scene::take_changes_for and Scene::unsubscribe.
• UVs: a mesh added with Mesh::add_uvs keeps them through edits, undo and redo. Every operation preserves or undoably drops them; see docs/uv-channel.md.
• Maintenance: Scene::add_channel, Scene::remove_channel, Scene::derived_channel_mut (all three reported, and the field: prefix reserved) and Scene::compact.
• Local space: Scene::bvh (current BVHs only), Scene::relative_transform, Scene::world_to_local and Scene::local_to_world.
• World queries, in world f64 coordinates: Scene::raycast, Scene::closest_point and Scene::closest_point_on, and between two meshes Scene::intersects, Scene::mesh_distance and Scene::triangles_near. Each maps into mesh-local space, runs the Phase 3 query and maps the result back; bounds are rounded outward to f32 and results filtered against the exact bound. Queries over all meshes update every Lazy BVH and fail with SceneError::StaleBvh on a stale Manual one; queries naming meshes touch only those.
• Contacts: Scene::find_contacts finds the mesh pairs within a margin (broadphase over world boxes, then Phase 3b per pair), optionally restricted by a ContactFilter.
• Distance fields: Scene::add_distance_field registers a signed distance field (DistanceField) from one mesh’s vertices to another mesh, stored in a derived channel field:<name> and kept up to date incrementally under the UpdateMode of the mesh it is on (Scene::update_fields, Scene::flush). Read with Scene::field_values and Scene::field_status; list a mesh’s with Scene::fields_on; change max_distance or the sign mode with Scene::reconfigure_field; remove with Scene::remove_field (or with either mesh).
• Colours: Scene::set_coloring colours a mesh from one of its fields with a ColorRule; Scene::coloring returns the colouring, Scene::colors one RGBA8 per vertex slot, and recoloured vertices are reported in MeshChanges::colors_dirty.
• Normals: Scene::set_normals turns a mesh’s smooth vertex normals on; Scene::normals returns one mesh-local normal per vertex slot, kept up to date incrementally under the mesh’s UpdateMode, and recomputed vertices are reported in MeshChanges::normals_dirty.
• Sections: Scene::add_section cuts meshes with a world Plane (SectionDesc) into contours in world and plane (u, v) coordinates, with length, signed area and an optional fill (SectionResult), kept up to date under each mesh’s UpdateMode (Scene::update_sections, Scene::flush). Read with Scene::section, Scene::section_status and Scene::section_gap; changes are reported in MeshChanges::sections_changed.

Re-exports

pub use fast_mesh_ops as ops;

Structs

BooleanReport

What Scene::boolean did.

ColorRule

How a scalar field is turned into colours.

Coloring

How a mesh is coloured from one of its fields, for Scene::set_coloring.

Contact

Two meshes within the margin of Scene::find_contacts.

ContactFilter

Which mesh pairs Scene::find_contacts looks at.

CurvatureField

A per-vertex curvature field to register with Scene::add_curvature_field.

CutOptions

What to cut: a world plane and whether to cap.

CutReport

What Scene::cut_by_plane did.

DistanceField

A signed distance field to register with Scene::add_distance_field.

FieldId

A field registered on a mesh of the scene.

FieldStatus

The state of a field, from Scene::field_status.

Fill

The filled cross-section made by fill: triangles over (u, v) points.

Gap

The closest pair between two meshes’ contours in a section, from Scene::section_gap.

JoinOptions

What to join: a loop on the target and a loop on the source.

JoinReport

What Scene::join did.

MeshBuild

A mesh being prepared for Scene::add_mesh_built outside any scene: its BVH, and its vertex normals when asked for (MeshBuild::set_normals), are built in steps (MeshBuild::step), so that a caller can yield between them (the Worker engine adds large meshes this way). Nothing of it is in a scene until it is added.

MeshChanges

What happened to one mesh since the subscriber’s last Scene::take_changes_for (or Scene::take_changes for the default subscriber).

MeshId

A handle to a mesh in a Scene.

MeshOptions

Options for adding a mesh to a Scene.

Placement

A transform from a mesh’s points to the world: world = rotation * (scale * p) + translation, where p is the mesh’s own point (its origin plus a local position), all in f64.

Plane

A plane in mesh-local coordinates, with an orthonormal 2D frame (u, v) in it. The frame is right-handed: normal = u × v.

RegisterOptions

Options for Scene::register.

RegisterReport

What Scene::register found.

Scene

Several meshes, each with a BVH and a placement in the world.

SceneClosestHit

The point of the scene nearest to a world point.

SceneClosestOptions

Options for Scene::closest_point and Scene::closest_point_on, in world units.

SceneMeshDistance

The closest pair of points between two meshes, in the world.

SceneOptions

Options for a Scene.

SceneRayHit

Where a world ray hit a mesh of the scene.

SceneRayOptions

Options for Scene::raycast, in world units.

SectionContour

One chain of a section: a closed loop or an open polyline.

SectionDesc

A plane section to register with Scene::add_section.

SectionId

A plane section of the scene, from Scene::add_section.

SectionResult

A section’s result for one mesh, from Scene::section.

SignStatus

What SignData::build found out about a mesh, so that an application can warn when signs are doubtful.

SubscriberId

A consumer of change reports, from Scene::subscribe.

ThicknessField

A per-vertex wall-thickness field to register with Scene::add_thickness_field.

Enums

BooleanOp

Which boolean to compute.

Colormap

A colormap from t in [0, 1] to RGBA8.

FieldBudget

How much one Scene::field_step computes.

FieldsError

Why a field kernel could not run.

NotApplied

Why a result was not applied.

OutOfRange

What to show for a value outside the colour range.

SceneError

Why a scene operation could not run. A failed operation leaves the scene unchanged.

SectionStatus

Whether a section’s result for a mesh matches the scene as it is now, from Scene::section_status.

SignMode

How the sign of a distance is decided.

StepState

Where the field step unit stands after Scene::field_step.

UpdateMode

When a mesh’s BVH is brought up to date after the mesh changes.

Constants

DEFAULT_MAX_RMSE_FRACTION

The default RegisterOptions::max_rmse, as a fraction of the moving points’ extent. A wrong local minimum measured about 3%, and the same mesh with noise of 1% of its size correctly aligned at about 0.4% (icp_survey in fast-mesh-ops). Scans noisier than this need their own limit.

Functions

color_of

The colour of value v under rule.

Type Aliases

Result

Result with SceneError as the error type.