Skip to main content

PolylineWidget

Struct PolylineWidget 

Source
pub struct PolylineWidget {
    pub points: Vec<Vec3>,
    pub colour: [f32; 4],
    pub line_width: f32,
    pub handle_colour: [f32; 4],
    pub hovered_point: Option<usize>,
    pub active_point: Option<usize>,
    /* private fields */
}
Expand description

An interactive polyline widget with N draggable control points.

Unlike crate::SplineWidget, this uses straight line segments between points (no interpolation). Control points can be added and removed programmatically, and via double-click when ctx.double_clicked is set by the host.

§Usage

let mut pw = PolylineWidget::new(vec![
    glam::Vec3::new(-2.0, 0.0, 0.0),
    glam::Vec3::new( 0.0, 1.0, 0.0),
    glam::Vec3::new( 2.0, 0.0, 0.0),
]);

// Each frame:
let result = pw.update(&ctx);
fd.scene.polylines.push(pw.polyline_item(PL_ID));
fd.scene.glyphs.push(pw.handle_glyphs(HANDLE_ID, &ctx));

Fields§

§points: Vec<Vec3>

Control point positions in world space.

§colour: [f32; 4]

RGBA colour for the line segments.

§line_width: f32

Line width in pixels.

§handle_colour: [f32; 4]

RGBA colour for the drag handles.

§hovered_point: Option<usize>

Index of the currently hovered control point.

§active_point: Option<usize>

Index of the point actively being dragged.

Implementations§

Source§

impl PolylineWidget

Source

pub fn new(points: Vec<Vec3>) -> Self

Create a new polyline widget. Must have at least two points; extras are ignored if fewer are provided by adding a default second point.

Source

pub fn is_active(&self) -> bool

True while a control point drag is in progress.

Source

pub fn add_point(&mut self, pos: Vec3)

Append a point at the end of the polyline.

Source

pub fn remove_point(&mut self, index: usize)

Remove the point at index. No-op if the polyline would drop below two points.

Source

pub fn update(&mut self, ctx: &WidgetContext) -> WidgetResult

Process input for this frame. Returns Updated if state changed.

Double-click behavior (requires ctx.double_clicked):

  • On a hovered control point: removes that point (minimum 2 enforced).
  • On a line segment: inserts a new point at the projected position.
Source

pub fn polyline_item(&self, id: u64) -> PolylineItem

Build a PolylineItem through all control points.

Source

pub fn handle_glyphs(&self, id_base: u64, ctx: &WidgetContext) -> GlyphItem

Build a GlyphItem with sphere handles for each control point.

Hovered and active handles appear brighter (scalar = 1.0 vs 0.2). id_base is the pick ID for the first point; each subsequent point uses id_base + i.

Auto Trait Implementations§

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> 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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

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

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

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
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,