Skip to main content

PolylineItem

Struct PolylineItem 

Source
#[non_exhaustive]
pub struct PolylineItem {
Show 15 fields pub positions: Vec<[f32; 3]>, pub scalars: Vec<f32>, pub strip_lengths: Vec<u32>, pub scalar_range: Option<(f32, f32)>, pub colormap_id: Option<ColormapId>, pub default_color: [f32; 4], pub line_width: f32, pub id: u64, pub node_colors: Vec<[f32; 4]>, pub edge_scalars: Vec<f32>, pub edge_colors: Vec<[f32; 4]>, pub node_radii: Vec<f32>, pub node_vectors: Vec<[f32; 3]>, pub edge_vectors: Vec<[f32; 3]>, pub vector_scale: f32,
}
Expand description

A polyline (stream tracer) item to render in the viewport.

All streamlines for one source are concatenated into a single vertex buffer. strip_lengths records how many vertices belong to each individual streamline.

§Curve network quantities

In addition to the existing per-node scalar path (scalars/colormap_id), this item supports several curve-network quantities:

  • Per-edge scalars (edge_scalars): one value per segment; rendered as a flat constant color per edge (both endpoints share the same LUT value).
  • Per-node colors (node_colors): direct RGBA per node; takes priority over scalar-driven coloring.
  • Per-edge colors (edge_colors): direct RGBA per segment; takes priority over edge scalars.
  • Per-node radius (node_radii): per-node line width in pixels; overrides the global line_width.
  • Node vectors (node_vectors): world-space 3-D arrows at each node, rendered automatically as GlyphItem arrows.
  • Edge vectors (edge_vectors): world-space 3-D arrows at each segment midpoint, also rendered as GlyphItem arrows.

Color priority per segment: node_colors/edge_colors (direct) > edge_scalars > scalars (per-node) > default_color.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§positions: Vec<[f32; 3]>

World-space positions for all streamlines, concatenated.

§scalars: Vec<f32>

Per-node scalar values (same length as positions). Empty = no scalar coloring.

§strip_lengths: Vec<u32>

Number of vertices per individual streamline strip.

§scalar_range: Option<(f32, f32)>

Scalar range for LUT mapping. None = auto from min/max of scalars or edge_scalars.

§colormap_id: Option<ColormapId>

Colormap for scalar coloring. None = viridis.

§default_color: [f32; 4]

Fallback color when no scalar or direct-color data is provided.

§line_width: f32

Global line width in pixels. Used when node_radii is empty.

§id: u64

Unique ID for identification. 0 = not pickable.

§node_colors: Vec<[f32; 4]>

Per-node direct RGBA colors. Length must match positions. Empty = not used. Takes priority over scalar-driven coloring when non-empty.

§edge_scalars: Vec<f32>

Per-edge scalar values. Length = total segment count across all strips (sum of strip_lengths[i] - 1). Used when scalars is empty; both endpoints of each segment share the same LUT value (flat constant color per edge).

§edge_colors: Vec<[f32; 4]>

Per-edge direct RGBA colors. Length = total segment count. Takes priority over edge_scalars when non-empty.

§node_radii: Vec<f32>

Per-node line width in pixels. Length must match positions. When non-empty, overrides the global line_width; adjacent endpoints are linearly interpolated along each segment.

§node_vectors: Vec<[f32; 3]>

Per-node world-space vectors. Length must match positions. When non-empty the renderer automatically generates a GlyphItem (arrows at node positions).

§edge_vectors: Vec<[f32; 3]>

Per-edge world-space vectors. Length = total segment count. When non-empty the renderer automatically generates a GlyphItem (arrows at segment midpoints).

§vector_scale: f32

Scale applied to generated arrow glyphs from node_vectors/edge_vectors.

Trait Implementations§

Source§

impl Clone for PolylineItem

Source§

fn clone(&self) -> PolylineItem

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 Default for PolylineItem

Source§

fn default() -> Self

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

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> 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> 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> 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, 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,