Struct TransparentVolumeMeshItem 

#[non_exhaustive]
pub struct TransparentVolumeMeshItem {
    pub id: ProjectedTetId,
    pub pick_id: u64,
    pub volume_mesh_data: Option<Arc<VolumeMeshData>>,
    pub density: f32,
    pub scalar_range: Option<(f32, f32)>,
    pub threshold_min: f32,
    pub threshold_max: f32,
    pub appearance: AppearanceSettings,
    pub selected: bool,
    pub boundary_mesh_id: Option<MeshId>,
}

A transparent unstructured volume mesh rendered via projected tetrahedra.

Created by uploading a VolumeMeshData with [ViewportGpuResources::upload_projected_tet_mesh] and submitting the returned ProjectedTetId each frame.

Picking

Set pick_id to a non-zero value and provide volume_mesh_data to enable cell-level picking via renderer.pick() and renderer.pick_rect(). volume_mesh_data must be the same data passed to upload_projected_tet_mesh for this item.

Selection highlight

Set selected = true to draw an object-level outline ring around this mesh. Also supply boundary_mesh_id with the MeshId returned by upload_volume_mesh_data for the same geometry; the outline pass uses that boundary surface to compute the silhouette. Without boundary_mesh_id the selected flag has no visual effect.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: ProjectedTetId

Handle to the uploaded projected-tet mesh.

pick_id: u64

Pick ID returned when a cell in this mesh is hit.

0 means this mesh is not pickable. Set to a non-zero value alongside volume_mesh_data to enable cell picking.

volume_mesh_data: Option<Arc<VolumeMeshData>>

CPU mesh data for cell picking.

Must match the data passed to upload_projected_tet_mesh for id. None disables cell-level picking regardless of pick_id.

density: f32

Beer-Lambert extinction coefficient (world-space units).

Higher values make the volume more opaque. Typical range: 0.1 to 5.0.

scalar_range: Option<(f32, f32)>

Override the auto-detected scalar range [min, max] used to normalize colourmap lookup.

None uses the range computed at upload time.

threshold_min: f32

Scalar threshold range. Tetrahedra whose scalar value falls outside [threshold_min, threshold_max] are discarded by the shader and not rendered.

Operates on raw (un-normalized) scalar values, the same units as the data passed to upload_projected_tet_mesh. Default: no clipping (all tets rendered).

threshold_max: f32

Upper scalar threshold. See threshold_min.

appearance: AppearanceSettings

Per-item appearance overrides (hidden, unlit, opacity, wireframe).

selected: bool

Draw a selection outline ring around this mesh when true.

Requires boundary_mesh_id to be set; see the type-level docs.

boundary_mesh_id: Option<MeshId>

Boundary surface mesh used for the selection outline mask pass.

Pass the MeshId returned by upload_volume_mesh_data for the same geometry. The mesh positions are assumed to be in world space (identity model matrix).

Implementations

impl TransparentVolumeMeshItem

pub fn new(id: ProjectedTetId) -> Self

Create a visible item with default density of 1.0 and auto scalar range.

Trait Implementations

impl Clone for TransparentVolumeMeshItem

fn clone(&self) -> TransparentVolumeMeshItem

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.