Struct LineBatchBuilder

pub struct LineBatchBuilder<'a, 'ctx>(/* private fields */);

Implementations

impl<'ctx> LineBatchBuilder<'_, 'ctx>

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

Sets the world_from_obj matrix for the entire batch.

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

Sets an outline mask for every element in the batch.

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

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

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

Sets the depth offset for the entire batch.

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)

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)

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

Adds a 3D series of line connected points.

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

Adds a single 3D line segment connecting two points.

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

Adds a series of unconnected 3D line segments.

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)

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.

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)

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.

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.

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.

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)

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

impl Drop for LineBatchBuilder<'_, '_>

fn drop(&mut self)

Executes the destructor for this type.