Struct bevy::prelude::Gizmos

pub struct Gizmos<'s> { /* private fields */ }

A SystemParam for drawing gizmos.

They are drawn in immediate mode, which means they will be rendered only for the frames in which they are spawned. Gizmos should be spawned before the Last schedule to ensure they are drawn.

Implementations

impl<'s> Gizmos<'s>

pub fn line(&mut self, start: Vec3, end: Vec3, color: Color)

Draw a line in 3D from start to end.

This should be called for each frame the line needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.line(Vec3::ZERO, Vec3::X, Color::GREEN);
}

pub fn line_gradient( &mut self, start: Vec3, end: Vec3, start_color: Color, end_color: Color )

Draw a line in 3D with a color gradient from start to end.

This should be called for each frame the line needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.line_gradient(Vec3::ZERO, Vec3::X, Color::GREEN, Color::RED);
}

pub fn ray(&mut self, start: Vec3, vector: Vec3, color: Color)

Draw a line in 3D from start to start + vector.

This should be called for each frame the line needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.ray(Vec3::Y, Vec3::X, Color::GREEN);
}

pub fn ray_gradient( &mut self, start: Vec3, vector: Vec3, start_color: Color, end_color: Color )

Draw a line in 3D with a color gradient from start to start + vector.

This should be called for each frame the line needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.ray_gradient(Vec3::Y, Vec3::X, Color::GREEN, Color::RED);
}

pub fn linestrip( &mut self, positions: impl IntoIterator<Item = Vec3>, color: Color )

Draw a line in 3D made of straight segments between the points.

This should be called for each frame the line needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.linestrip([Vec3::ZERO, Vec3::X, Vec3::Y], Color::GREEN);
}

pub fn linestrip_gradient( &mut self, points: impl IntoIterator<Item = (Vec3, Color)> )

Draw a line in 3D made of straight segments between the points, with a color gradient.

This should be called for each frame the lines need to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.linestrip_gradient([
        (Vec3::ZERO, Color::GREEN),
        (Vec3::X, Color::RED),
        (Vec3::Y, Color::BLUE)
    ]);
}

pub fn circle( &mut self, position: Vec3, normal: Vec3, radius: f32, color: Color ) -> CircleBuilder<'_, 's>

Draw a circle in 3D at position with the flat side facing normal.

This should be called for each frame the circle needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.circle(Vec3::ZERO, Vec3::Z, 1., Color::GREEN);

    // Circles have 32 line-segments by default.
    // You may want to increase this for larger circles.
    gizmos
        .circle(Vec3::ZERO, Vec3::Z, 5., Color::RED)
        .segments(64);
}

pub fn sphere( &mut self, position: Vec3, rotation: Quat, radius: f32, color: Color ) -> SphereBuilder<'_, 's>

Draw a wireframe sphere in 3D made out of 3 circles around the axes.

This should be called for each frame the sphere needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.sphere(Vec3::ZERO, Quat::IDENTITY, 1., Color::BLACK);

    // Each circle has 32 line-segments by default.
    // You may want to increase this for larger spheres.
    gizmos
        .sphere(Vec3::ZERO, Quat::IDENTITY, 5., Color::BLACK)
        .circle_segments(64);
}

pub fn rect(&mut self, position: Vec3, rotation: Quat, size: Vec2, color: Color)

Draw a wireframe rectangle in 3D.

This should be called for each frame the rectangle needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.rect(Vec3::ZERO, Quat::IDENTITY, Vec2::ONE, Color::GREEN);
}

pub fn cuboid(&mut self, transform: impl TransformPoint, color: Color)

Draw a wireframe cube in 3D.

This should be called for each frame the cube needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.cuboid(Transform::IDENTITY, Color::GREEN);
}

pub fn line_2d(&mut self, start: Vec2, end: Vec2, color: Color)

Draw a line in 2D from start to end.

This should be called for each frame the line needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.line_2d(Vec2::ZERO, Vec2::X, Color::GREEN);
}

pub fn line_gradient_2d( &mut self, start: Vec2, end: Vec2, start_color: Color, end_color: Color )

Draw a line in 2D with a color gradient from start to end.

This should be called for each frame the line needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.line_gradient_2d(Vec2::ZERO, Vec2::X, Color::GREEN, Color::RED);
}

pub fn linestrip_2d( &mut self, positions: impl IntoIterator<Item = Vec2>, color: Color )

Draw a line in 2D made of straight segments between the points.

This should be called for each frame the line needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.linestrip_2d([Vec2::ZERO, Vec2::X, Vec2::Y], Color::GREEN);
}

pub fn linestrip_gradient_2d( &mut self, positions: impl IntoIterator<Item = (Vec2, Color)> )

Draw a line in 2D made of straight segments between the points, with a color gradient.

This should be called for each frame the line needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.linestrip_gradient_2d([
        (Vec2::ZERO, Color::GREEN),
        (Vec2::X, Color::RED),
        (Vec2::Y, Color::BLUE)
    ]);
}

pub fn ray_2d(&mut self, start: Vec2, vector: Vec2, color: Color)

Draw a line in 2D from start to start + vector.

This should be called for each frame the line needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.ray_2d(Vec2::Y, Vec2::X, Color::GREEN);
}

pub fn ray_gradient_2d( &mut self, start: Vec2, vector: Vec2, start_color: Color, end_color: Color )

Draw a line in 2D with a color gradient from start to start + vector.

This should be called for each frame the line needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.line_gradient(Vec3::Y, Vec3::X, Color::GREEN, Color::RED);
}

pub fn circle_2d( &mut self, position: Vec2, radius: f32, color: Color ) -> Circle2dBuilder<'_, 's>

Draw a circle in 2D.

This should be called for each frame the circle needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.circle_2d(Vec2::ZERO, 1., Color::GREEN);

    // Circles have 32 line-segments by default.
    // You may want to increase this for larger circles.
    gizmos
        .circle_2d(Vec2::ZERO, 5., Color::RED)
        .segments(64);
}

pub fn arc_2d( &mut self, position: Vec2, direction_angle: f32, arc_angle: f32, radius: f32, color: Color ) -> Arc2dBuilder<'_, 's>

Draw an arc, which is a part of the circumference of a circle, in 2D.

This should be called for each frame the arc needs to be rendered.

Arguments

• position sets the center of this circle.
• radius controls the distance from position to this arc, and thus its curvature.
• direction_angle sets the clockwise angle in radians between Vec2::Y and the vector from position to the midpoint of the arc.
• arc_angle sets the length of this arc, in radians.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.arc_2d(Vec2::ZERO, 0., PI / 4., 1., Color::GREEN);

    // Arcs have 32 line-segments by default.
    // You may want to increase this for larger arcs.
    gizmos
        .arc_2d(Vec2::ZERO, 0., PI / 4., 5., Color::RED)
        .segments(64);
}

pub fn rect_2d( &mut self, position: Vec2, rotation: f32, size: Vec2, color: Color )

Draw a wireframe rectangle in 2D.

This should be called for each frame the rectangle needs to be rendered.

Example

fn system(mut gizmos: Gizmos) {
    gizmos.rect_2d(Vec2::ZERO, 0., Vec2::ONE, Color::GREEN);
}

Trait Implementations

impl SystemParam for Gizmos<'_>

type State = FetchState

Used to store data which persists across invocations of a system.

type Item<'w, 's> = Gizmos<'s>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state( world: &mut World, system_meta: &mut SystemMeta ) -> <Gizmos<'_> as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

fn new_archetype( state: &mut <Gizmos<'_> as SystemParam>::State, archetype: &Archetype, system_meta: &mut SystemMeta )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).

fn apply( state: &mut <Gizmos<'_> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during apply_deferred.

unsafe fn get_param<'w, 's>( state: &'s mut <Gizmos<'_> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick ) -> <Gizmos<'_> as SystemParam>::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's> ReadOnlySystemParam for Gizmos<'s>where Deferred<'s, GizmoBuffer>: ReadOnlySystemParam,