Struct CropOverlay 

pub struct CropOverlay { /* private fields */ }

A crop over a picture: what is out of the frame goes dark, with thirds inside the frame and a fine grid while it turns. It is built on TransformHandles and draws the same lines as RuleOfThirdsGrid.

Handles resize it, a drag inside moves it, a drag outside turns it, and it never leaves the content: turning makes it smaller if it must. It hands back the rectangle and the angle and does not turn the picture, since the renderer has no transforms.

Keyboard: the arrows move it, with Alt they resize it, [ and ] turn it, and Shift makes each of these go further. A Protractor can share the angle through Binding::map.

use ravenrs_core::{Rect, Size};
use ravenrs_reactive::State;
use ravenrs_widgets::{ContentSpace, CropArea, CropOverlay, Protractor};

let crop = State::new(CropArea::new(Rect::new(300.0, 200.0, 1800.0, 1200.0)));
let overlay = CropOverlay::new(crop.binding())
    .aspect(Some(3.0 / 2.0))
    .space(ContentSpace::Fit(Size::new(2400.0, 1600.0)))
    .size(600.0, 400.0);
let straighten = Protractor::new(crop.binding().map(|c| c.angle, |c, angle| c.angle = angle));

Implementations

impl CropOverlay

pub fn new(area: Binding<CropArea>) -> CropOverlay

A crop bound to area, in the units of its space.

pub fn aspect(self, aspect: Option<f32>) -> CropOverlay

Holds this width over height, or lets it go free with None. A crop of other proportions is cut down to these as soon as this changes.

pub fn angle_limit(self, degrees: f32) -> CropOverlay

How far it can turn either way, in degrees (45 by default). With 0 it does not turn.

pub fn guide(self, guide: Option<CompositionGuide>) -> CropOverlay

The lines inside the frame, or none (thirds by default).

pub fn turning_guide(self, guide: Option<CompositionGuide>) -> CropOverlay

The lines inside the frame while it turns (eight parts by default).

pub fn min_size(self, pixels: f32) -> CropOverlay

The smallest side, in logical pixels on screen at the current zoom (24 by default).

pub fn on_commit(self, handler: impl Fn(CropArea) + 'static) -> CropOverlay

Runs handler with the result when a drag ends or a key changes it: one step to undo.

pub fn disabled(self, disabled: bool) -> CropOverlay

Takes no input while disabled.

pub fn label(self, label: impl Into<String>) -> CropOverlay

The name screen readers announce, instead of the one in Labels.

impl CropOverlay

pub fn size(self, width: f32, height: f32) -> CropOverlay

Fixed size in logical pixels, instead of taking the free space.

pub fn grow(self, grow: f32) -> CropOverlay

How much of the free space along the parent stack it takes: 1 by default, or 0 over a stage, which then decides the size.

pub fn stage(self, stage: impl View + 'static) -> CropOverlay

The view it goes over, such as an Image or a ZoomPanView, which gives it its size. Without one, put it in a ZStack with a fixed size.

pub fn space(self, space: ContentSpace) -> CropOverlay

Where the content is, and so the units of its coordinates: by default, its own box.

Trait Implementations

impl Debug for CropOverlay

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

Formats the value using the given formatter.

impl View for CropOverlay

fn build(&self, cx: &mut BuildCx<'_>) -> NodeId

Creates this view’s node for the current build.

fn type_name(&self) -> &'static str

The name the diagnostics panel shows this view’s cost under.