ribir_core 0.4.0-alpha.43

A non-intrusive declarative GUI framework, to build modern native/wasm cross-platform applications.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

use ribir_geom::Transform;

use super::WidgetCtxImpl;
use crate::{
  prelude::{Painter, ProviderCtx, WidgetId},
  widget::WidgetTree,
};

pub struct PaintingCtx<'a> {
  id: WidgetId,
  tree: &'a WidgetTree,
  painter: &'a mut Painter,
  provider_ctx: ProviderCtx,
  /// The matrix transforms a content painter into the box widget painter.
  /// Widgets like `Background`, `Border`, etc., need to use the box painter to
  /// draw decorations and ignore the padding transform, starting from the
  /// widget box's origin. For example, in `Padding<Background<Text>>`, the
  /// text requires translation, but the background should not.
  /// The `Background` should utilize a `box_painter` that applies this matrix.
  box_offset: Transform,
}

impl<'a> WidgetCtxImpl for PaintingCtx<'a> {
  #[inline]
  fn id(&self) -> WidgetId { self.id }

  #[inline]
  fn tree(&self) -> &WidgetTree { self.tree }
}

impl<'a> PaintingCtx<'a> {
  pub(crate) fn new(id: WidgetId, tree: &'a WidgetTree, painter: &'a mut Painter) -> Self {
    let provider_ctx = if let Some(p) = id.parent(tree) {
      ProviderCtx::collect_from(p, tree)
    } else {
      ProviderCtx::default()
    };

    let box_offset = Transform::identity();
    Self { id, tree, painter, provider_ctx, box_offset }
  }

  /// Called by the framework when the painting widget is finished.
  #[inline]
  pub(crate) fn finish(&mut self) { self.provider_ctx.pop_providers_for(self.id); }

  #[inline]
  pub(crate) fn switch_to(&mut self, id: WidgetId) {
    self.box_offset = Transform::identity();
    self.id = id;
  }

  /// Apply a transformation apply only for the content but should not effect
  /// the box widget painter.
  pub fn content_only_transform_apply(&mut self, matrix: &Transform) {
    let box_matrix = self.box_offset.then(self.painter.transform());
    self.painter.apply_transform(matrix);
    self.box_offset = box_matrix.then(
      &self
        .painter
        .transform()
        .inverse()
        .unwrap_or_default(),
    );
  }

  /// Return the 2d painter to draw 2d things.
  #[inline]
  pub fn painter(&mut self) -> &mut Painter { self.painter }

  /// Provide a box painter that can draw decorations from the widget box's
  /// origin point without being affected by padding transformations. Any
  /// transform made to this painter will be restore when it is dropped.
  pub fn box_painter(&mut self) -> BoxPainter<'_> {
    let content = *self.painter.transform();
    let box_matrix = self.box_offset.then(&content);
    let painter = self.painter.set_transform(box_matrix);

    BoxPainter { content, painter }
  }

  #[inline]
  pub fn provider_ctx_and_painter(&mut self) -> (&'_ mut ProviderCtx, &mut Painter) {
    (&mut self.provider_ctx, self.painter)
  }

  pub fn provider_ctx_and_box_painter(&mut self) -> (&'_ mut ProviderCtx, BoxPainter<'_>) {
    // Safety: The Provider context and box painter operate independently.
    let provider_ctx = &mut (unsafe { &mut *(self as *mut Self) }).provider_ctx;
    let painter = self.box_painter();
    (provider_ctx, painter)
  }
}

impl<'w> AsRef<ProviderCtx> for PaintingCtx<'w> {
  #[inline]
  fn as_ref(&self) -> &ProviderCtx { &self.provider_ctx }
}

impl<'w> AsMut<ProviderCtx> for PaintingCtx<'w> {
  #[inline]
  fn as_mut(&mut self) -> &mut ProviderCtx { &mut self.provider_ctx }
}

pub struct BoxPainter<'a> {
  content: Transform,
  painter: &'a mut Painter,
}

impl std::ops::Deref for BoxPainter<'_> {
  type Target = Painter;

  #[inline]
  fn deref(&self) -> &Self::Target { self.painter }
}

impl std::ops::DerefMut for BoxPainter<'_> {
  #[inline]
  fn deref_mut(&mut self) -> &mut Self::Target { self.painter }
}

impl Drop for BoxPainter<'_> {
  fn drop(&mut self) { self.painter.set_transform(self.content); }
}