Struct Path 

pub struct Path(/* private fields */);

Handle to a Path node in the scene: cheap to copy, its methods return the node’s properties as Signals. Derefs to Node.

Implementations

impl Path

pub fn new() -> PathBuilder

Starts a builder; add it with Node::add (e.g. view.add(..)).

pub fn node(self) -> Node

The untyped node handle (same as *self).

impl Path

pub fn data(self) -> Signal<BezPath>

The data property as an animatable signal.

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: NodeBuilder>(self, child: B) -> B::Handle

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) -> Self

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) -> Self

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

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

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

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

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 Path

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Path

impl Debug for Path

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for Path

type Target = Node

The resulting type after dereferencing.

fn deref(&self) -> &Node

Dereferences the value.

impl Eq for Path

impl From<Path> for Node

fn from(h: Path) -> Node

Converts to this type from the input type.

impl Hash for Path

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Path

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Path