Struct Axes 

pub struct Axes { /* private fields */ }

A plotting area: a box with ranges, a grid, axes with arrows, ticks and labels. Derefs to Node, so it moves and fades like any node.

let axes = view.add(Axes::new().x_range(-5.0..5.0).y_range(-2.0..2.0).width(pct(80)));
let sin = axes.plot(|x| x.sin());
sin.draw_on().await;
axes.x_range().to(-10.0..10.0, 1.0).await;

Implementations

impl Axes

pub fn new() -> AxesBuilder

Axes over -5..5 by -5..5, 80 % of the frame wide and 60 % high.

pub fn x_range(&self) -> Signal<Interval>

The horizontal data range. .to(0.0..20.0, 1.0) zooms the axes.

pub fn y_range(&self) -> Signal<Interval>

The vertical data range.

pub fn c2p(&self, x: f64, y: f64) -> Vec2

The scene point (relative to the axes) of data point (x, y), for the ranges right now.

pub fn place(&self, node: impl Into<Node>, x: f64, y: f64)

Keeps node at data point (x, y) while the ranges change. The node becomes a child of the axes.

pub fn plot(&self, f: impl Fn(f64) -> f64 + 'static) -> Plot

A curve of f over the visible x range. Sampled again every frame, finer where it bends, and broken where it jumps (no line across the gap of tan). Accent, 4 px; .stroke() and .line_width() change it.

pub fn point_on(&self, plot: &Plot, x: Signal<f64>) -> Circle

A dot that sits on plot at data x x and follows it.

pub fn line_series( &self, points: impl IntoIterator<Item = (f64, f64)>, ) -> Series

A polyline through data points. Each point is a signal of the series.

pub fn scatter( &self, points: impl IntoIterator<Item = (f64, f64)>, ) -> Vec<Circle>

A dot per data point. Returns the dots in order.

pub fn bars(&self, values: impl IntoIterator<Item = f64>) -> Bars

A bar per value at x = 0, 1, 2, …, growing up from y = 0, with the value printed above it. Set the x range to -0.5..n - 0.5.

pub fn matrix(&self) -> Signal<Mat2>

The matrix the plane is mapped through; the identity at first.

pub fn apply_matrix(&self, m: impl Into<Mat2>, duration: f64) -> Tween<Mat2>

Maps the plane through m (row by row, [[a, b], [c, d]]) over duration seconds, after any matrix applied before. Plots, series, vectors and placed nodes move with it, and the grid deforms. Placed nodes keep their own shape; only their position follows.

pub fn vector(&self, x: f64, y: f64) -> Vector

An arrow from the origin to data point (x, y). The tip is two signals, Vector::x and Vector::y, and follows the ranges and apply_matrix. Accent, 6 px.

pub fn node(&self) -> Node

The untyped node handle.

Methods from Deref<Target = Node>

pub fn id(self) -> NodeId

Index of the node in the scene graph.

pub fn x(self) -> Signal<f64>

The x property as an animatable signal.

pub fn y(self) -> Signal<f64>

The y property as an animatable signal.

pub fn rotation(self) -> Signal<f64>

Degrees, clockwise.

The rotation property as an animatable signal.

pub fn scale(self) -> Signal<Vec2>

The scale property as an animatable signal.

pub fn opacity(self) -> Signal<f64>

The opacity property as an animatable signal.

pub fn fill(self) -> Signal<Color>

The fill property as an animatable signal.

pub fn stroke(self) -> Signal<Color>

The stroke property as an animatable signal.

pub fn line_width(self) -> Signal<f64>

The line_width property as an animatable signal.

pub fn start(self) -> Signal<f64>

Start of the drawn part of the outline (fraction of its length).

The start property as an animatable signal.

pub fn end(self) -> Signal<f64>

End of the drawn part of the outline.

The end property as an animatable signal.

pub fn fill_gradient(self) -> Signal<Option<Gradient>>

The fill_gradient property as an animatable signal.

pub fn stroke_gradient(self) -> Signal<Option<Gradient>>

The stroke_gradient property as an animatable signal.

pub fn dash(self) -> Signal<Vec<f64>>

The dash property as an animatable signal.

pub fn dash_offset(self) -> Signal<f64>

The dash_offset property as an animatable signal.

pub fn line_cap(self) -> Signal<LineCap>

The line_cap property as an animatable signal.

pub fn line_join(self) -> Signal<LineJoin>

The line_join property as an animatable signal.

pub fn blur(self) -> Signal<f64>

The blur property as an animatable signal.

pub fn shadow_color(self) -> Signal<Color>

The shadow_color property as an animatable signal.

pub fn shadow_blur(self) -> Signal<f64>

The shadow_blur property as an animatable signal.

pub fn shadow_offset(self) -> Signal<Vec2>

The shadow_offset property as an animatable signal.

pub fn clip(self) -> Signal<bool>

The clip property as an animatable signal.

pub fn blend(self) -> Signal<BlendMode>

The blend property as an animatable signal.

pub fn z_index(self) -> Signal<f64>

The z_index property as an animatable signal.

pub fn anchor(self) -> Signal<Vec2>

The anchor property as an animatable signal.

pub fn grow(self) -> Signal<f64>

The grow property as an animatable signal.

pub fn shrink(self) -> Signal<f64>

The shrink property as an animatable signal.

pub fn basis(self) -> Signal<Option<f64>>

The basis property as an animatable signal.

pub fn margin(self) -> Signal<f64>

The margin property as an animatable signal.

pub fn align_self(self) -> Signal<Option<LayoutAlign>>

The align_self property as an animatable signal.

pub fn add<B>(self, child: B) -> <B as NodeBuilder>::Handle

where B: NodeBuilder,

Adds a child node; children are positioned relative to the parent.

The call site is stored on the node (oxframe check and oxframe inspect print it). .name("title") overrides the automatic label.

pub fn remove(self)

Detaches the node from its parent; it stops being drawn.

pub fn fade_in(self) -> Tween<f64>

Fades the node in from transparent, over the theme’s normal duration with its enter easing.

pub fn pop_in(self) -> Tween<Vec2>

Grows the node from nothing to its current scale with a small overshoot (the theme’s emphasis easing, OUT_BACK by default).

pub fn draw_on(self) -> Tween<f64>

Draws the outline from start to end (end from 0 to 1), as if with a pen. Works on every shape with an outline: paths, lines, rectangles, circles, polygons.

pub fn slide_in(self, from: Side) -> impl Future<Output = ()> + 'static

Slides the node into its place from SLIDE_DISTANCE pixels towards from, fading in on the way.

pub fn next_to(self, other: impl Into<Node>, side: Side) -> Node

Sits just outside other. The gap is the theme’s Md step, and the position is recomputed every frame.

pub fn align_to(self, other: impl Into<Node>, edge: Edge) -> Node

Lines this node’s edge up with the same edge of other.

pub fn to_edge(self, edge: Edge) -> Node

Pins one edge to the safe area. The other axis is left as it is.

pub fn center_in(self, other: impl Into<Node>) -> Node

Same center as other.

pub fn fade_out(self) -> Tween<f64>

Fades the node out, over the theme’s normal duration with its exit easing.

pub fn reparent(self, parent: impl Into<Node>)

Moves the node under another parent.

pub fn effect(self, effect: EffectBuilder) -> Effect

Runs a shader effect on this node’s pixels, children included.

let ring = card.effect(shaders::ripple().strength(0.0));
ring.strength().to(1.0, 0.6).await;

A node has one effect; a second call replaces the first. The node must not sit inside a group with opacity below 1, a blur, a clip, a blend, a shadow or another effect: there its pixels are not finished, and check reports input_cycle.

pub fn children(self) -> Vec<Node>

Direct children, in creation order.

pub fn size(self) -> (f64, f64)

Size of the node’s box in its own coordinates.

pub fn absolute_position(self) -> Vec2

Position of the node’s origin in scene coordinates.

Trait Implementations

impl Clone for Axes

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for Axes

type Target = Node

The resulting type after dereferencing.

fn deref(&self) -> &Node

Dereferences the value.