Struct DefaultActions

Source

pub struct DefaultActions<Id>where
    Id: Hash + Eq + Clone + Debug,
{ /* private fields */ }

Expand description

Default implementation of outliner actions with state tracking.

This struct provides a complete, ready-to-use implementation of the OutlinerActions trait. It tracks:

Selection state: Which nodes are currently selected
Visibility state: Which nodes are visible/hidden
Lock state: Which nodes are locked
Event log: Optional logging of all interactions

§Type Parameters

Id - The type used to identify nodes. Must implement Hash, Eq, and Clone.

§Examples

§Basic Usage

use egui_arbor::default_actions::DefaultActions;
use egui_arbor::OutlinerActions;

let mut actions = DefaultActions::<u64>::new();

// All nodes start unselected, visible, and unlocked
assert!(!OutlinerActions::<TestNode>::is_selected(&actions, &1));
assert!(!OutlinerActions::<TestNode>::is_visible(&actions, &1));
assert!(!OutlinerActions::<TestNode>::is_locked(&actions, &1));

§With Event Logging

use egui_arbor::default_actions::DefaultActions;
use egui_arbor::OutlinerActions;

let mut actions = DefaultActions::<u64>::with_logging(50);

// Events are automatically logged
OutlinerActions::<TestNode>::on_select(&mut actions, &1, true);
assert_eq!(actions.event_log().unwrap().len(), 1);

§Pre-populate State

use egui_arbor::default_actions::DefaultActions;
use egui_arbor::OutlinerActions;
use std::collections::HashSet;

let mut actions = DefaultActions::<u64>::new();

// Make all nodes visible by default
let visible_ids: HashSet<_> = (0..10).collect();
actions.set_all_visible(visible_ids);

assert!(OutlinerActions::<TestNode>::is_visible(&actions, &5));

Implementations§

Source §

impl<Id> DefaultActions<Id>
where Id: Hash + Eq + Clone + Debug,

Source

pub fn new() -> Self

Creates a new actions handler with no event logging.

All nodes start unselected, invisible, and unlocked.

§Examples

use egui_arbor::default_actions::DefaultActions;

let actions = DefaultActions::<u64>::new();

Source

pub fn with_logging(max_log_entries: usize) -> Self

Creates a new actions handler with event logging enabled.

§Arguments

max_log_entries - Maximum number of log entries to keep

§Examples

use egui_arbor::default_actions::DefaultActions;

let actions = DefaultActions::<u64>::with_logging(100);

Source

pub fn event_log(&self) -> Option<&EventLog<Id>>

Returns a reference to the event log, if logging is enabled.

§Examples

use egui_arbor::default_actions::DefaultActions;

let actions = DefaultActions::<u64>::with_logging(10);
assert!(actions.event_log().is_some());

let actions = DefaultActions::<u64>::new();
assert!(actions.event_log().is_none());

Source

pub fn event_log_mut(&mut self) -> Option<&mut EventLog<Id>>

Returns a mutable reference to the event log, if logging is enabled.

§Examples

use egui_arbor::default_actions::DefaultActions;

let mut actions = DefaultActions::<u64>::with_logging(10);
if let Some(log) = actions.event_log_mut() {
    log.clear();
}

Source

pub fn selected_count(&self) -> usize

Returns the number of selected nodes.

§Examples

use egui_arbor::default_actions::DefaultActions;
use egui_arbor::OutlinerActions;

let mut actions = DefaultActions::<u64>::new();
OutlinerActions::<TestNode>::on_select(&mut actions, &1, true);
OutlinerActions::<TestNode>::on_select(&mut actions, &2, true);
assert_eq!(actions.selected_count(), 2);

Source

pub fn visible_count(&self) -> usize

Returns the number of visible nodes.

§Examples

use egui_arbor::default_actions::DefaultActions;
use egui_arbor::OutlinerActions;

let mut actions = DefaultActions::<u64>::new();
OutlinerActions::<TestNode>::on_visibility_toggle(&mut actions, &1);
assert_eq!(actions.visible_count(), 1);

Source

pub fn locked_count(&self) -> usize

Returns the number of locked nodes.

§Examples

use egui_arbor::default_actions::DefaultActions;
use egui_arbor::OutlinerActions;

let mut actions = DefaultActions::<u64>::new();
OutlinerActions::<TestNode>::on_lock_toggle(&mut actions, &1);
assert_eq!(actions.locked_count(), 1);

Source

pub fn selected(&self) -> &HashSet<Id>

Returns a reference to the set of selected node IDs.

§Examples

use egui_arbor::default_actions::DefaultActions;
use egui_arbor::OutlinerActions;

let mut actions = DefaultActions::<u64>::new();
OutlinerActions::<TestNode>::on_select(&mut actions, &1, true);
OutlinerActions::<TestNode>::on_select(&mut actions, &2, true);

assert!(actions.selected().contains(&1));
assert!(actions.selected().contains(&2));

Source

pub fn visible(&self) -> &HashSet<Id>

Returns a reference to the set of visible node IDs.

Source

pub fn locked(&self) -> &HashSet<Id>

Returns a reference to the set of locked node IDs.

Source

pub fn set_all_visible(&mut self, ids: HashSet<Id>)

Sets all nodes as visible.

§Arguments

ids - Set of node IDs to mark as visible

§Examples

use egui_arbor::default_actions::DefaultActions;
use egui_arbor::OutlinerActions;
use std::collections::HashSet;

let mut actions = DefaultActions::<u64>::new();
let visible: HashSet<_> = (0..10).collect();
actions.set_all_visible(visible);

assert!(OutlinerActions::<TestNode>::is_visible(&actions, &5));

Source

pub fn clear_selection(&mut self)

Clears all selections.

§Examples

use egui_arbor::default_actions::DefaultActions;
use egui_arbor::OutlinerActions;

let mut actions = DefaultActions::<u64>::new();
OutlinerActions::<TestNode>::on_select(&mut actions, &1, true);
OutlinerActions::<TestNode>::on_select(&mut actions, &2, true);
assert_eq!(actions.selected_count(), 2);

actions.clear_selection();
assert_eq!(actions.selected_count(), 0);