Struct amethyst_rendy::debug_drawing::DebugLinesComponent

pub struct DebugLinesComponent { /* fields omitted */ }

Component that stores persistent debug lines to be rendered in DebugLinesPass draw pass. The vector can only be cleared manually.

Methods

impl DebugLinesComponent

pub fn new() -> DebugLinesComponent

Creates a new debug lines component with an empty DebugLine vector.

pub fn with_capacity(capacity: usize) -> Self

Builder method to pre-allocate a number of lines.

pub fn add_direction(
    &mut self,
    position: Point3<f32>,
    direction: Vector3<f32>,
    color: Srgba
)

Adds a line to be rendered by giving a position and a direction.

pub fn add_line(&mut self, start: Point3<f32>, end: Point3<f32>, color: Srgba)

Adds a line to be rendered by giving a start and an end position.

pub fn add_gradient_line(
    &mut self,
    start: Point3<f32>,
    end: Point3<f32>,
    start_color: Srgba,
    end_color: Srgba
)

Adds a line to be rendered by giving a start and an end position with separate start and end colors.

pub fn add_rectangle_2d(
    &mut self,
    min: Point2<f32>,
    max: Point2<f32>,
    z: f32,
    color: Srgba
)

Adds multiple lines that form a rectangle to be rendered by giving a Z coordinate, a min and a max position.

This rectangle is aligned to the XY plane.

pub fn add_rotated_rectangle(
    &mut self,
    min: Point2<f32>,
    max: Point2<f32>,
    z: f32,
    rotation: UnitQuaternion<f32>,
    color: Srgba
)

Adds multiple lines that form a rotated rectangle to be rendered by giving a Z coordinate, a rotation, a min and a max position.

pub fn add_box(&mut self, min: Point3<f32>, max: Point3<f32>, color: Srgba)

Adds multiple lines that form a box to be rendered by giving a min and a max position.

This box is an axis aligned box.

pub fn add_rotated_box(
    &mut self,
    min: Point3<f32>,
    max: Point3<f32>,
    rotation: UnitQuaternion<f32>,
    color: Srgba
)

Adds multiple lines that form a rotated box to be rendered by giving a rotation, a min and a max position.

pub fn add_circle_2d(
    &mut self,
    center: Point3<f32>,
    radius: f32,
    points: u32,
    color: Srgba
)

Adds multiple lines that form a circle to be rendered by giving a center, a radius and an amount of points.

This circle is aligned to the XY plane.

pub fn add_rotated_circle(
    &mut self,
    center: Point3<f32>,
    radius: f32,
    points: u32,
    rotation: UnitQuaternion<f32>,
    color: Srgba
)

Adds multiple lines that form a rotated circle to be rendered by giving a center, a radius, an amount of points and a rotation.

pub fn add_sphere(
    &mut self,
    center: Point3<f32>,
    radius: f32,
    horizontal_points: u32,
    vertical_points: u32,
    color: Srgba
)

Adds multiple lines that form a sphere to be rendered by giving a center, a radius, an amount of vertical points and an amount of horizontal points.

pub fn add_cylinder(
    &mut self,
    center: Point3<f32>,
    radius: f32,
    height: f32,
    points: u32,
    color: Srgba
)

Adds multiple lines that form a cylinder to be rendered by giving a center, a radius, a height and an amount of points.

This cylinder is aligned to the y axis.

pub fn add_rotated_cylinder(
    &mut self,
    center: Point3<f32>,
    radius: f32,
    height: f32,
    points: u32,
    rotation: UnitQuaternion<f32>,
    color: Srgba
)

Adds multiple lines that form a rotated cylinder to be rendered by giving a center, a radius, a height, an amount of points and a rotation.

pub fn clear(&mut self)

Clears lines buffer.

As lines are persistent, it's necessary to use this function for updating or deleting lines.

Trait Implementations

impl Default for DebugLinesComponent

fn default() -> DebugLinesComponent

Returns the "default value" for a type.

impl Debug for DebugLinesComponent

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Component for DebugLinesComponent

type Storage = DenseVecStorage<Self>

Associated storage type for this component.