Struct SurfaceMeshHandle 

pub struct SurfaceMeshHandle { /* private fields */ }

Handle for a registered surface mesh.

This handle provides methods to add quantities and configure the appearance of a surface mesh. Methods return &Self to allow chaining.

Example

use polyscope_rs::*;

init().unwrap();
let vertices = vec![Vec3::ZERO, Vec3::X, Vec3::Y];
let faces = vec![[0u32, 1, 2]];
let mesh = register_surface_mesh("mesh", vertices, faces);
mesh.set_surface_color(Vec3::new(1.0, 0.5, 0.0))
    .set_show_edges(true)
    .add_vertex_scalar_quantity("height", vec![0.0, 1.0, 0.5]);

Implementations

impl SurfaceMeshHandle

pub fn name(&self) -> &str

Returns the name of this mesh.

pub fn set_surface_color(&self, color: Vec3) -> &Self

Sets the surface color.

pub fn set_edge_color(&self, color: Vec3) -> &Self

Sets the edge color.

pub fn set_edge_width(&self, width: f32) -> &Self

Sets the edge width.

pub fn set_show_edges(&self, show: bool) -> &Self

Sets whether edges are shown.

pub fn set_backface_color(&self, color: Vec3) -> &Self

Sets the backface color.

pub fn set_transparency(&self, transparency: f32) -> &Self

Sets the transparency (0.0 = opaque, 1.0 = fully transparent).

pub fn set_material(&self, material: &str) -> &Self

Sets the material.

pub fn add_vertex_scalar_quantity(&self, name: &str, values: Vec<f32>) -> &Self

Adds a vertex scalar quantity.

pub fn add_face_scalar_quantity(&self, name: &str, values: Vec<f32>) -> &Self

Adds a face scalar quantity.

pub fn add_vertex_color_quantity(&self, name: &str, colors: Vec<Vec3>) -> &Self

Adds a vertex color quantity (RGB, alpha defaults to 1.0).

pub fn add_vertex_color_quantity_with_alpha( &self, name: &str, colors: Vec<Vec4>, ) -> &Self

Adds a vertex color quantity with explicit per-vertex RGBA alpha values.

Use this to specify per-vertex transparency. Requires Pretty (depth peeling) transparency mode to render correctly (set via appearance settings).

pub fn add_face_color_quantity(&self, name: &str, colors: Vec<Vec3>) -> &Self

Adds a face color quantity (RGB, alpha defaults to 1.0).

pub fn add_face_color_quantity_with_alpha( &self, name: &str, colors: Vec<Vec4>, ) -> &Self

Adds a face color quantity with explicit per-face RGBA alpha values.

Use this to specify per-face transparency. Requires Pretty (depth peeling) transparency mode to render correctly (set via appearance settings).

pub fn add_vertex_vector_quantity( &self, name: &str, vectors: Vec<Vec3>, ) -> &Self

Adds a vertex vector quantity (auto-scaled).

pub fn add_face_vector_quantity(&self, name: &str, vectors: Vec<Vec3>) -> &Self

Adds a face vector quantity (auto-scaled).

pub fn add_vertex_parameterization_quantity( &self, name: &str, coords: Vec<Vec2>, ) -> &Self

Adds a vertex parameterization (UV) quantity.

pub fn add_corner_parameterization_quantity( &self, name: &str, coords: Vec<Vec2>, ) -> &Self

Adds a corner parameterization (UV) quantity.

pub fn add_vertex_intrinsic_vector_quantity( &self, name: &str, vectors: Vec<Vec2>, basis_x: Vec<Vec3>, basis_y: Vec<Vec3>, ) -> &Self

Adds a vertex intrinsic vector quantity with explicit tangent basis (auto-scaled).

pub fn add_vertex_intrinsic_vector_quantity_auto( &self, name: &str, vectors: Vec<Vec2>, ) -> &Self

Adds a vertex intrinsic vector quantity with auto-computed tangent basis.

pub fn add_face_intrinsic_vector_quantity( &self, name: &str, vectors: Vec<Vec2>, basis_x: Vec<Vec3>, basis_y: Vec<Vec3>, ) -> &Self

Adds a face intrinsic vector quantity with explicit tangent basis (auto-scaled).

pub fn add_face_intrinsic_vector_quantity_auto( &self, name: &str, vectors: Vec<Vec2>, ) -> &Self

Adds a face intrinsic vector quantity with auto-computed tangent basis.

pub fn add_one_form_quantity( &self, name: &str, values: Vec<f32>, orientations: Vec<bool>, ) -> &Self

Adds a one-form quantity (edge-based differential form, auto-scaled).

Trait Implementations

impl Clone for SurfaceMeshHandle

fn clone(&self) -> SurfaceMeshHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.