[go: up one dir, main page]

Vec2

Struct Vec2 

Source
pub struct Vec2 {
    pub x: f64,
    pub y: f64,
}
Expand description

A 2D vector.

This is intended primarily for a vector in the mathematical sense, but it can be interpreted as a translation, and converted to and from a point (vector relative to the origin) and size.

Fields§

§x: f64

The x-coordinate.

§y: f64

The y-coordinate.

Implementations§

Source§

impl Vec2

Source

pub const ZERO: Vec2

The vector (0, 0).

Source

pub const fn new(x: f64, y: f64) -> Vec2

Create a new vector.

Examples found in repository?
examples/z_stack.rs (line 57)
45fn build_root_widget() -> impl Widget<State> {
46    ZStack::new(
47        Button::from_label(Label::dynamic(|state: &State, _| {
48            format!(
49                "Very large button with text! Count up (currently {})",
50                state.counter
51            )
52        }))
53        .on_click(|_, state: &mut State, _| state.counter += 1),
54    )
55    .with_child(
56        Button::new("Reset").on_click(|_, state: &mut State, _| state.counter = 0),
57        Vec2::new(1.0, 1.0),
58        Vec2::ZERO,
59        UnitPoint::LEFT,
60        Vec2::new(10.0, 0.0),
61    )
62}
Source

pub const fn to_point(self) -> Point

Convert this vector into a Point.

Examples found in repository?
examples/sub_window.rs (line 148)
99    fn event(&mut self, child: &mut W, ctx: &mut EventCtx, event: &Event, data: &mut T, env: &Env) {
100        let wait_duration = Duration::from_millis(500);
101        let resched_dur = Duration::from_millis(50);
102        let cursor_size = Size::new(15., 15.);
103        let now = Instant::now();
104        let new_state = match &self.state {
105            TooltipState::Fresh => match event {
106                Event::MouseMove(me) if ctx.is_hot() => Some(TooltipState::Waiting {
107                    last_move: now,
108                    timer_expire: now + wait_duration,
109                    token: ctx.request_timer(wait_duration),
110                    position_in_window_coordinates: me.window_pos,
111                }),
112                _ => None,
113            },
114            TooltipState::Waiting {
115                last_move,
116                timer_expire,
117                token,
118                position_in_window_coordinates,
119            } => match event {
120                Event::MouseMove(me) if ctx.is_hot() => {
121                    let (cur_token, cur_expire) = if *timer_expire - now < resched_dur {
122                        (ctx.request_timer(wait_duration), now + wait_duration)
123                    } else {
124                        (*token, *timer_expire)
125                    };
126                    Some(TooltipState::Waiting {
127                        last_move: now,
128                        timer_expire: cur_expire,
129                        token: cur_token,
130                        position_in_window_coordinates: me.window_pos,
131                    })
132                }
133                Event::Timer(tok) if tok == token => {
134                    let deadline = *last_move + wait_duration;
135                    ctx.set_handled();
136                    if deadline > now {
137                        let wait_for = deadline - now;
138                        tracing::info!("Waiting another {:?}", wait_for);
139                        Some(TooltipState::Waiting {
140                            last_move: *last_move,
141                            timer_expire: deadline,
142                            token: ctx.request_timer(wait_for),
143                            position_in_window_coordinates: *position_in_window_coordinates,
144                        })
145                    } else {
146                        let tooltip_position_in_window_coordinates =
147                            (position_in_window_coordinates.to_vec2() + cursor_size.to_vec2())
148                                .to_point();
149                        let win_id = ctx.new_sub_window(
150                            WindowConfig::default()
151                                .show_titlebar(false)
152                                .window_size_policy(WindowSizePolicy::Content)
153                                .set_level(WindowLevel::Tooltip(ctx.window().clone()))
154                                .set_position(tooltip_position_in_window_coordinates),
155                            Label::<()>::new(self.tip.clone()),
156                            (),
157                            env.clone(),
158                        );
159                        Some(TooltipState::Showing(win_id))
160                    }
161                }
162                _ => None,
163            },
164            TooltipState::Showing(win_id) => {
165                match event {
166                    Event::MouseMove(me) if !ctx.is_hot() => {
167                        // TODO another timer on leaving
168                        tracing::info!("Sending close window for {:?}", win_id);
169                        ctx.submit_command(CLOSE_WINDOW.to(*win_id));
170                        Some(TooltipState::Waiting {
171                            last_move: now,
172                            timer_expire: now + wait_duration,
173                            token: ctx.request_timer(wait_duration),
174                            position_in_window_coordinates: me.window_pos,
175                        })
176                    }
177                    _ => None,
178                }
179            }
180        };
181
182        if let Some(state) = new_state {
183            self.state = state;
184        }
185
186        if !ctx.is_handled() {
187            child.event(ctx, event, data, env);
188        }
189    }
Source

pub const fn to_size(self) -> Size

Convert this vector into a Size.

Source

pub fn dot(self, other: Vec2) -> f64

Dot product of two vectors.

Source

pub fn cross(self, other: Vec2) -> f64

Cross product of two vectors.

This is signed so that (0, 1) × (1, 0) = 1.

Source

pub fn hypot(self) -> f64

Magnitude of vector.

This is similar to self.hypot2().sqrt() but defers to the platform hypot method, which in general will handle the case where self.hypot2() > f64::MAX.

Examples found in repository?
examples/invalidation.rs (line 79)
70    fn event(&mut self, ctx: &mut EventCtx, ev: &Event, data: &mut Vector<Circle>, _env: &Env) {
71        if let Event::MouseDown(ev) = ev {
72            if ev.mods.shift() {
73                data.push_back(Circle {
74                    pos: ev.pos,
75                    time: Instant::now(),
76                });
77            } else if ev.mods.ctrl() {
78                data.retain(|c| {
79                    if (c.pos - ev.pos).hypot() > RADIUS {
80                        true
81                    } else {
82                        ctx.request_paint_rect(kurbo::Circle::new(c.pos, RADIUS).bounding_box());
83                        false
84                    }
85                });
86            } else {
87                // Move the circle to a new location, invalidating the old locations. The new location
88                // will be invalidated during AnimFrame.
89                for c in data.iter() {
90                    ctx.request_paint_rect(kurbo::Circle::new(c.pos, RADIUS).bounding_box());
91                }
92                data.clear();
93                data.push_back(Circle {
94                    pos: ev.pos,
95                    time: Instant::now(),
96                });
97            }
98            ctx.request_anim_frame();
99        } else if let Event::AnimFrame(_) = ev {
100            for c in &*data {
101                ctx.request_paint_rect(kurbo::Circle::new(c.pos, RADIUS).bounding_box());
102            }
103            if !data.is_empty() {
104                ctx.request_anim_frame();
105            }
106        }
107    }
Source

pub fn length(self) -> f64

Magnitude of vector.

This is an alias for Vec2::hypot.

Source

pub fn hypot2(self) -> f64

Magnitude squared of vector.

Source

pub fn length_squared(self) -> f64

Magnitude squared of vector.

This is an alias for Vec2::hypot2.

Source

pub fn atan2(self) -> f64

Find the angle in radians between this vector and the vector Vec2 { x: 1.0, y: 0.0 } in the positive y direction.

If the vector is interpreted as a complex number, this is the argument. The angle is expressed in radians.

Source

pub fn angle(self) -> f64

Find the angle in radians between this vector and the vector Vec2 { x: 1.0, y: 0.0 } in the positive y direction.

This is an alias for Vec2::atan2.

Source

pub fn from_angle(th: f64) -> Vec2

A unit vector of the given angle.

With th at zero, the result is the positive X unit vector, and at π/2, it is the positive Y unit vector. The angle is expressed in radians.

Thus, in a Y-down coordinate system (as is common for graphics), it is a clockwise rotation, and in Y-up (traditional for math), it is anti-clockwise. This convention is consistent with Affine::rotate.

Examples found in repository?
examples/anim.rs (line 78)
74    fn paint(&mut self, ctx: &mut PaintCtx, _data: &(), _env: &Env) {
75        let t = self.t;
76        let center = Point::new(50.0, 50.0);
77        ctx.paint_with_z_index(1, move |ctx| {
78            let ambit = center + 45.0 * Vec2::from_angle((0.75 + t) * 2.0 * PI);
79            ctx.stroke(Line::new(center, ambit), &Color::WHITE, 1.0);
80        });
81
82        ctx.fill(Circle::new(center, 50.0), &Color::BLACK);
83    }
Source

pub fn lerp(self, other: Vec2, t: f64) -> Vec2

Linearly interpolate between two vectors.

Source

pub fn normalize(self) -> Vec2

Returns a vector of magnitude 1.0 with the same angle as self; i.e. a unit/direction vector.

This produces NaN values when the magnitude is 0.

Source

pub fn round(self) -> Vec2

Returns a new Vec2, with x and y rounded to the nearest integer.

§Examples
use kurbo::Vec2;
let a = Vec2::new(3.3, 3.6).round();
let b = Vec2::new(3.0, -3.1).round();
assert_eq!(a.x, 3.0);
assert_eq!(a.y, 4.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -3.0);
Source

pub fn ceil(self) -> Vec2

Returns a new Vec2, with x and y rounded up to the nearest integer, unless they are already an integer.

§Examples
use kurbo::Vec2;
let a = Vec2::new(3.3, 3.6).ceil();
let b = Vec2::new(3.0, -3.1).ceil();
assert_eq!(a.x, 4.0);
assert_eq!(a.y, 4.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -3.0);
Source

pub fn floor(self) -> Vec2

Returns a new Vec2, with x and y rounded down to the nearest integer, unless they are already an integer.

§Examples
use kurbo::Vec2;
let a = Vec2::new(3.3, 3.6).floor();
let b = Vec2::new(3.0, -3.1).floor();
assert_eq!(a.x, 3.0);
assert_eq!(a.y, 3.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -4.0);
Source

pub fn expand(self) -> Vec2

Returns a new Vec2, with x and y rounded away from zero to the nearest integer, unless they are already an integer.

§Examples
use kurbo::Vec2;
let a = Vec2::new(3.3, 3.6).expand();
let b = Vec2::new(3.0, -3.1).expand();
assert_eq!(a.x, 4.0);
assert_eq!(a.y, 4.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -4.0);
Source

pub fn trunc(self) -> Vec2

Returns a new Vec2, with x and y rounded towards zero to the nearest integer, unless they are already an integer.

§Examples
use kurbo::Vec2;
let a = Vec2::new(3.3, 3.6).trunc();
let b = Vec2::new(3.0, -3.1).trunc();
assert_eq!(a.x, 3.0);
assert_eq!(a.y, 3.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -3.0);
Source

pub fn is_finite(self) -> bool

Is this Vec2 finite?

Source

pub fn is_nan(self) -> bool

Is this Vec2 NaN?

Trait Implementations§

Source§

impl Add<TranslateScale> for Vec2

Source§

type Output = TranslateScale

The resulting type after applying the + operator.
Source§

fn add(self, other: TranslateScale) -> TranslateScale

Performs the + operation. Read more
Source§

impl Add<Vec2> for Circle

Source§

type Output = Circle

The resulting type after applying the + operator.
Source§

fn add(self, v: Vec2) -> Circle

Performs the + operation. Read more
Source§

impl Add<Vec2> for CircleSegment

Source§

type Output = CircleSegment

The resulting type after applying the + operator.
Source§

fn add(self, v: Vec2) -> CircleSegment

Performs the + operation. Read more
Source§

impl Add<Vec2> for Ellipse

Source§

fn add(self, v: Vec2) -> Ellipse

In this context adding a Vec2 applies the corresponding translation to the ellipse.

Source§

type Output = Ellipse

The resulting type after applying the + operator.
Source§

impl Add<Vec2> for Line

Source§

type Output = Line

The resulting type after applying the + operator.
Source§

fn add(self, v: Vec2) -> Line

Performs the + operation. Read more
Source§

impl Add<Vec2> for Point

Source§

type Output = Point

The resulting type after applying the + operator.
Source§

fn add(self, other: Vec2) -> Point

Performs the + operation. Read more
Source§

impl Add<Vec2> for Rect

Source§

type Output = Rect

The resulting type after applying the + operator.
Source§

fn add(self, v: Vec2) -> Rect

Performs the + operation. Read more
Source§

impl Add<Vec2> for RoundedRect

Source§

type Output = RoundedRect

The resulting type after applying the + operator.
Source§

fn add(self, v: Vec2) -> RoundedRect

Performs the + operation. Read more
Source§

impl Add<Vec2> for TranslateScale

Source§

type Output = TranslateScale

The resulting type after applying the + operator.
Source§

fn add(self, other: Vec2) -> TranslateScale

Performs the + operation. Read more
Source§

impl Add for Vec2

Source§

type Output = Vec2

The resulting type after applying the + operator.
Source§

fn add(self, other: Vec2) -> Vec2

Performs the + operation. Read more
Source§

impl AddAssign<Vec2> for Point

Source§

fn add_assign(&mut self, other: Vec2)

Performs the += operation. Read more
Source§

impl AddAssign<Vec2> for Region

Source§

fn add_assign(&mut self, rhs: Vec2)

Performs the += operation. Read more
Source§

impl AddAssign<Vec2> for TranslateScale

Source§

fn add_assign(&mut self, other: Vec2)

Performs the += operation. Read more
Source§

impl AddAssign for Vec2

Source§

fn add_assign(&mut self, other: Vec2)

Performs the += operation. Read more
Source§

impl Clone for Vec2

Source§

fn clone(&self) -> Vec2

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Data for Vec2

Source§

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

Determine whether two values are the same. Read more
Source§

impl Debug for Vec2

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Vec2

Source§

fn default() -> Vec2

Returns the “default value” for a type. Read more
Source§

impl Display for Vec2

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Div<f64> for Vec2

Source§

fn div(self, other: f64) -> Vec2

Note: division by a scalar is implemented by multiplying by the reciprocal.

This is more efficient but has different roundoff behavior than division.

Source§

type Output = Vec2

The resulting type after applying the / operator.
Source§

impl DivAssign<f64> for Vec2

Source§

fn div_assign(&mut self, other: f64)

Performs the /= operation. Read more
Source§

impl From<(f64, f64)> for Vec2

Source§

fn from(v: (f64, f64)) -> Vec2

Converts to this type from the input type.
Source§

impl From<Point2> for Vec2

Source§

fn from(vec: Point2) -> Vec2

Converts to this type from the input type.
Source§

impl Mul<f64> for Vec2

Source§

type Output = Vec2

The resulting type after applying the * operator.
Source§

fn mul(self, other: f64) -> Vec2

Performs the * operation. Read more
Source§

impl MulAssign<f64> for Vec2

Source§

fn mul_assign(&mut self, other: f64)

Performs the *= operation. Read more
Source§

impl Neg for Vec2

Source§

type Output = Vec2

The resulting type after applying the - operator.
Source§

fn neg(self) -> Vec2

Performs the unary - operation. Read more
Source§

impl PartialEq for Vec2

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl RoundFrom<(f32, f32)> for Vec2

Source§

fn round_from(p: (f32, f32)) -> Vec2

Performs the conversion.
Source§

impl RoundFrom<(f64, f64)> for Vec2

Source§

fn round_from(p: (f64, f64)) -> Vec2

Performs the conversion.
Source§

impl RoundFrom<Vec2> for (f32, f32)

Source§

fn round_from(p: Vec2) -> (f32, f32)

Performs the conversion.
Source§

impl RoundFrom<Vec2> for (f64, f64)

Source§

fn round_from(p: Vec2) -> (f64, f64)

Performs the conversion.
Source§

impl Scalable for Vec2

Source§

fn to_px(&self, scale: Scale) -> Vec2

Converts a Vec2 from display points into pixels, using the x axis scale factor for x and the y axis scale factor for y.

Source§

fn to_dp(&self, scale: Scale) -> Vec2

Converts a Vec2 from pixels into display points, using the x axis scale factor for x and the y axis scale factor for y.

Source§

impl Sub<Vec2> for Circle

Source§

type Output = Circle

The resulting type after applying the - operator.
Source§

fn sub(self, v: Vec2) -> Circle

Performs the - operation. Read more
Source§

impl Sub<Vec2> for CircleSegment

Source§

type Output = CircleSegment

The resulting type after applying the - operator.
Source§

fn sub(self, v: Vec2) -> CircleSegment

Performs the - operation. Read more
Source§

impl Sub<Vec2> for Ellipse

Source§

fn sub(self, v: Vec2) -> Ellipse

In this context subtracting a Vec2 applies the corresponding translation to the ellipse.

Source§

type Output = Ellipse

The resulting type after applying the - operator.
Source§

impl Sub<Vec2> for Line

Source§

type Output = Line

The resulting type after applying the - operator.
Source§

fn sub(self, v: Vec2) -> Line

Performs the - operation. Read more
Source§

impl Sub<Vec2> for Point

Source§

type Output = Point

The resulting type after applying the - operator.
Source§

fn sub(self, other: Vec2) -> Point

Performs the - operation. Read more
Source§

impl Sub<Vec2> for Rect

Source§

type Output = Rect

The resulting type after applying the - operator.
Source§

fn sub(self, v: Vec2) -> Rect

Performs the - operation. Read more
Source§

impl Sub<Vec2> for RoundedRect

Source§

type Output = RoundedRect

The resulting type after applying the - operator.
Source§

fn sub(self, v: Vec2) -> RoundedRect

Performs the - operation. Read more
Source§

impl Sub<Vec2> for TranslateScale

Source§

type Output = TranslateScale

The resulting type after applying the - operator.
Source§

fn sub(self, other: Vec2) -> TranslateScale

Performs the - operation. Read more
Source§

impl Sub for Vec2

Source§

type Output = Vec2

The resulting type after applying the - operator.
Source§

fn sub(self, other: Vec2) -> Vec2

Performs the - operation. Read more
Source§

impl SubAssign<Vec2> for Point

Source§

fn sub_assign(&mut self, other: Vec2)

Performs the -= operation. Read more
Source§

impl SubAssign<Vec2> for Region

Source§

fn sub_assign(&mut self, rhs: Vec2)

Performs the -= operation. Read more
Source§

impl SubAssign<Vec2> for TranslateScale

Source§

fn sub_assign(&mut self, other: Vec2)

Performs the -= operation. Read more
Source§

impl SubAssign for Vec2

Source§

fn sub_assign(&mut self, other: Vec2)

Performs the -= operation. Read more
Source§

impl Copy for Vec2

Source§

impl StructuralPartialEq for Vec2

Auto Trait Implementations§

§

impl Freeze for Vec2

§

impl RefUnwindSafe for Vec2

§

impl Send for Vec2

§

impl Sync for Vec2

§

impl Unpin for Vec2

§

impl UnwindSafe for Vec2

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AnyEq for T
where T: Any + PartialEq,

Source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IsDefault for T
where T: Default + PartialEq + Copy,

Source§

fn is_default(&self) -> bool

Checks that type has a default value.
Source§

impl<T> RoundFrom<T> for T

Source§

fn round_from(x: T) -> T

Performs the conversion.
Source§

impl<T, U> RoundInto<U> for T
where U: RoundFrom<T>,

Source§

fn round_into(self) -> U

Performs the conversion.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more