pub struct LineBatchBuilder<'a, 'ctx>(&'a mut LineDrawableBuilder<'ctx>);

Tuple Fields§

§0: &'a mut LineDrawableBuilder<'ctx>

Implementations§

source§

impl<'a, 'ctx> LineBatchBuilder<'a, 'ctx>

source

fn batch_mut(&mut self) -> &mut LineBatchInfo

source

fn add_vertices( &mut self, points: impl ExactSizeIterator<Item = Vec3>, strip_index: u32 ) -> Result<(), DataTextureSourceWriteError>

source

fn create_strip_builder( &mut self, num_strips_added: usize, num_vertices_added: usize ) -> LineStripBuilder<'_, 'ctx>

num_vertices_added excludes start sentinel.

source

pub fn world_from_obj(self, world_from_obj: Affine3A) -> Self

Sets the world_from_obj matrix for the entire batch.

source

pub fn outline_mask_ids(self, outline_mask_ids: OutlineMaskPreference) -> Self

Sets an outline mask for every element in the batch.

source

pub fn picking_object_id(self, picking_object_id: PickingLayerObjectId) -> Self

Sets the picking object id for every element in the batch.

source

pub fn depth_offset(self, depth_offset: DepthOffset) -> Self

Sets the depth offset for the entire batch.

source

pub fn triangle_cap_length_factor(self, triangle_cap_length_factor: f32) -> Self

Sets the length factor as multiple of a line’s radius applied to all triangle caps in this batch.

This controls how far the “pointy end” of the triangle/arrow-head extends. (defaults to 4.0)

source

pub fn triangle_cap_width_factor(self, triangle_cap_width_factor: f32) -> Self

Sets the width factor as multiple of a line’s radius applied to all triangle caps in this batch.

This controls how wide the triangle/arrow-head is orthogonal to the line’s direction. (defaults to 2.0)

source

pub fn add_strip( &mut self, points: impl ExactSizeIterator<Item = Vec3> ) -> LineStripBuilder<'_, 'ctx>

Adds a 3D series of line connected points.

source

pub fn add_segment(&mut self, a: Vec3, b: Vec3) -> LineStripBuilder<'_, 'ctx>

Adds a single 3D line segment connecting two points.

source

pub fn add_segments( &mut self, segments: impl ExactSizeIterator<Item = (Vec3, Vec3)> ) -> LineStripBuilder<'_, 'ctx>

Adds a series of unconnected 3D line segments.

source

pub fn add_box_outline_from_transform( &mut self, transform: Affine3A ) -> LineStripBuilder<'_, 'ctx>

Add box outlines from a unit cube transformed by transform.

Disables color gradient since we don’t support gradients in this setup yet (i.e. enabling them does not look good)

source

pub fn add_box_outline( &mut self, bbox: &BoundingBox ) -> Option<LineStripBuilder<'_, 'ctx>>

Add box outlines.

Internally a single closed line strip. Disables color gradient since we don’t support gradients in this setup yet (i.e. enabling them does not look good)

Returns None for empty and non-finite boxes.

source

fn add_box_from_corners( &mut self, corners: [Vec3; 8] ) -> LineStripBuilder<'_, 'ctx>

source

pub fn add_rectangle_outline( &mut self, top_left_corner: Vec3, extent_u: Vec3, extent_v: Vec3 ) -> LineStripBuilder<'_, 'ctx>

Add rectangle outlines.

Internally adds a single linestrip with 5 vertices. Disables color gradient since we don’t support gradients in this setup yet (i.e. enabling them does not look good)

source

pub fn add_strip_2d( &mut self, points: impl ExactSizeIterator<Item = Vec2> ) -> LineStripBuilder<'_, 'ctx>

Adds a 2D series of line connected points.

Uses autogenerated depth value.

source

pub fn add_segment_2d(&mut self, a: Vec2, b: Vec2) -> LineStripBuilder<'_, 'ctx>

Adds a single 2D line segment connecting two points. Uses autogenerated depth value.

source

pub fn add_segments_2d( &mut self, segments: impl ExactSizeIterator<Item = (Vec2, Vec2)> ) -> LineStripBuilder<'_, 'ctx>

Adds a series of unconnected 2D line segments.

Uses autogenerated depth value, all segments get the same depth value.

source

pub fn add_rectangle_outline_2d( &mut self, top_left_corner: Vec2, extent_u: Vec2, extent_v: Vec2 ) -> LineStripBuilder<'_, 'ctx>

Add 2D rectangle outlines.

Internally adds 4 2D line segments with rounded line heads. Disables color gradient since we don’t support gradients in this setup yet (i.e. enabling them does not look good)

source

pub fn add_axis_aligned_rectangle_outline_2d( &mut self, min: Vec2, max: Vec2 ) -> LineStripBuilder<'_, 'ctx>

Add 2D rectangle outlines with axis along X and Y.

Internally adds 4 2D line segments with rounded line heads. Disables color gradient since we don’t support gradients in this setup yet (i.e. enabling them does not look good)

Trait Implementations§

source§

impl<'a, 'ctx> Drop for LineBatchBuilder<'a, 'ctx>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'a, 'ctx> Freeze for LineBatchBuilder<'a, 'ctx>

§

impl<'a, 'ctx> !RefUnwindSafe for LineBatchBuilder<'a, 'ctx>

§

impl<'a, 'ctx> Send for LineBatchBuilder<'a, 'ctx>

§

impl<'a, 'ctx> Sync for LineBatchBuilder<'a, 'ctx>

§

impl<'a, 'ctx> Unpin for LineBatchBuilder<'a, 'ctx>

§

impl<'a, 'ctx> !UnwindSafe for LineBatchBuilder<'a, 'ctx>

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

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

§

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

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

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

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

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

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

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

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

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

§

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

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further 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.

§

impl<T> Instrument for T

§

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

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

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
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

§

type Output = T

Should always be Self
§

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

§

fn to<T>(self) -> T
where Self: Into<T>,

Converts to T by calling Into<T>::into.
§

fn try_to<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Tries to convert to T by calling TryInto<T>::try_into.
source§

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

§

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

§

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

impl<T> Upcast<T> for T

§

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

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

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