Struct Context 

pub struct Context {

    pub initialized: bool,
    pub registry: Registry,
    pub groups: HashMap<String, Group>,
    pub slice_planes: HashMap<String, SlicePlane>,
    pub gizmo_config: GizmoConfig,
    pub selected_structure: Option<(String, String)>,
    pub selected_slice_plane: Option<String>,
    pub options: Options,
    pub length_scale: f32,
    pub bounding_box: (Vec3, Vec3),
    pub floating_quantities: Vec<Box<dyn Quantity>>,
    pub file_drop_callback: Option<FileDropCallback>,
    pub material_load_queue: Vec<MaterialLoadRequest>,
}

The global context containing all polyscope state.

Fields

initialized: bool

Whether polyscope has been initialized.

registry: Registry

The structure registry.

groups: HashMap<String, Group>

Groups for organizing structures.

slice_planes: HashMap<String, SlicePlane>

Slice planes for cutting through geometry.

gizmo_config: GizmoConfig

Gizmo configuration for transformation controls.

selected_structure: Option<(String, String)>

Currently selected structure (type_name, name) for gizmo operations.

selected_slice_plane: Option<String>

Currently selected slice plane for gizmo operations.

options: Options

Global options.

length_scale: f32

Representative length scale for all registered structures.

bounding_box: (Vec3, Vec3)

Axis-aligned bounding box for all registered structures.

floating_quantities: Vec<Box<dyn Quantity>>

Floating quantities (not attached to any structure).

file_drop_callback: Option<FileDropCallback>

Callback invoked when files are dropped onto the window.

material_load_queue: Vec<MaterialLoadRequest>

Deferred material load requests (processed by App each frame).

Implementations

impl Context

pub fn center(&self) -> Vec3

Computes the center of the bounding box.

pub fn update_extents(&mut self)

Updates the global bounding box and length scale from all structures.

Respects the auto_compute_scene_extents option: when disabled, this is a no-op and the user controls extents manually. Matches C++ Polyscope’s updateStructureExtents() guard behavior.

pub fn recompute_extents(&mut self)

Unconditionally recomputes extents from all registered structures.

Called by update_extents() when auto-compute is enabled, and also called directly when the user re-enables auto-compute.

pub fn create_group(&mut self, name: &str) -> &mut Group

Creates a new group.

pub fn get_group(&self, name: &str) -> Option<&Group>

Gets a group by name.

pub fn get_group_mut(&mut self, name: &str) -> Option<&mut Group>

Gets a mutable group by name.

pub fn remove_group(&mut self, name: &str) -> Option<Group>

Removes a group by name.

pub fn has_group(&self, name: &str) -> bool

Returns true if a group with the given name exists.

pub fn group_names(&self) -> Vec<&str>

Returns all group names.

pub fn is_structure_visible(&self, structure: &dyn Structure) -> bool

Checks if a structure should be visible, combining its own enabled state with group visibility.

A structure is visible if:

• Its own is_enabled() returns true, AND
• It’s not in any disabled group (checked via is_structure_visible_in_groups)

pub fn is_structure_visible_in_groups( &self, type_name: &str, name: &str, ) -> bool

Checks if a structure should be visible based on its group membership.

A structure is visible if:

• It’s not in any group, or
• All of its ancestor groups are enabled

pub fn add_slice_plane(&mut self, name: &str) -> &mut SlicePlane

Adds a new slice plane.

pub fn get_slice_plane(&self, name: &str) -> Option<&SlicePlane>

Gets a slice plane by name.

pub fn get_slice_plane_mut(&mut self, name: &str) -> Option<&mut SlicePlane>

Gets a mutable slice plane by name.

pub fn remove_slice_plane(&mut self, name: &str) -> Option<SlicePlane>

Removes a slice plane by name.

pub fn has_slice_plane(&self, name: &str) -> bool

Returns true if a slice plane with the given name exists.

pub fn slice_plane_names(&self) -> Vec<&str>

Returns all slice plane names.

pub fn num_slice_planes(&self) -> usize

Returns the number of slice planes.

pub fn slice_planes(&self) -> impl Iterator<Item = &SlicePlane>

Returns an iterator over all slice planes.

pub fn enabled_slice_planes(&self) -> impl Iterator<Item = &SlicePlane>

Returns an iterator over all enabled slice planes.

pub fn select_structure(&mut self, type_name: &str, name: &str)

Selects a structure for gizmo manipulation. This deselects any selected slice plane (mutual exclusion).

pub fn deselect_structure(&mut self)

Deselects the current structure.

pub fn selected_structure(&self) -> Option<(&str, &str)>

Returns the currently selected structure, if any.

pub fn has_selection(&self) -> bool

Returns whether a structure is selected.

pub fn select_slice_plane(&mut self, name: &str)

Selects a slice plane for gizmo manipulation. This deselects any selected structure (mutual exclusion).

pub fn deselect_slice_plane(&mut self)

Deselects the current slice plane.

pub fn selected_slice_plane(&self) -> Option<&str>

Returns the currently selected slice plane name, if any.

pub fn has_slice_plane_selection(&self) -> bool

Returns whether a slice plane is selected.

pub fn gizmo(&self) -> &GizmoConfig

Returns the gizmo configuration.

pub fn gizmo_mut(&mut self) -> &mut GizmoConfig

Returns the mutable gizmo configuration.

Trait Implementations

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.