pub struct LineProbeWidget {
pub start: Vec3,
pub end: Vec3,
pub colour: [f32; 4],
pub line_width: f32,
pub handle_colour: [f32; 4],
/* private fields */
}Expand description
A two-endpoint line handle rendered in the viewport.
Drag either sphere handle to reposition the probe path. Read start and end
each frame to get the current endpoint positions.
§Usage
// Setup (once):
let mut probe = LineProbeWidget::new(
glam::Vec3::new(-2.0, 0.0, 0.0),
glam::Vec3::new( 2.0, 0.0, 0.0),
);
// Each frame:
let ctx = WidgetContext { camera, viewport_size, cursor_viewport,
drag_started, dragging, released };
probe.update(&ctx);
fd.scene.polylines.push(probe.polyline_item(LINE_ID));
fd.scene.glyphs.push(probe.handle_glyphs(HANDLE_ID_BASE, &ctx));
// Suppress orbit while dragging:
if probe.is_active() { orbit.resolve(); } else { orbit.apply_to_camera(&mut camera); }Fields§
§start: Vec3World-space position of the first endpoint.
end: Vec3World-space position of the second endpoint.
colour: [f32; 4]RGBA line and handle colour.
line_width: f32Line width in pixels.
handle_colour: [f32; 4]RGBA colour for the drag handles. When set (non-zero alpha), overrides the default LUT colouring.
Implementations§
Source§impl LineProbeWidget
impl LineProbeWidget
Sourcepub fn new(start: Vec3, end: Vec3) -> Self
pub fn new(start: Vec3, end: Vec3) -> Self
Create a new probe between two world-space positions.
Sourcepub fn hovered_endpoint(&self) -> Option<usize>
pub fn hovered_endpoint(&self) -> Option<usize>
Index of the currently hovered endpoint (0 = start, 1 = end).
Sourcepub fn update(&mut self, ctx: &WidgetContext) -> WidgetResult
pub fn update(&mut self, ctx: &WidgetContext) -> WidgetResult
Process input for this frame. Returns Updated if either endpoint moved.
Call once per frame before building render items.
Sourcepub fn polyline_item(&self, id: u64) -> PolylineItem
pub fn polyline_item(&self, id: u64) -> PolylineItem
Build the PolylineItem for the line segment between the two endpoints.
id is used as the pick ID for the line body (0 = not pickable).
Sourcepub fn handle_glyphs(&self, id_base: u64, ctx: &WidgetContext) -> GlyphItem
pub fn handle_glyphs(&self, id_base: u64, ctx: &WidgetContext) -> GlyphItem
Build a GlyphItem containing sphere handles at both endpoints.
Handle size is constant in screen space (approximately 10 px radius).
id_base is the pick ID for the start handle; the end handle uses id_base + 1.
Colour is driven by the colourmap (viridis by default). The scalar for each
handle is 0.0 when idle and 1.0 when hovered or active, so the two
states map to distinct colourmap colours.
Auto Trait Implementations§
impl Freeze for LineProbeWidget
impl RefUnwindSafe for LineProbeWidget
impl Send for LineProbeWidget
impl Sync for LineProbeWidget
impl Unpin for LineProbeWidget
impl UnsafeUnpin for LineProbeWidget
impl UnwindSafe for LineProbeWidget
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.