Struct bevy::gizmos::grid::GridBuilder2d

pub struct GridBuilder2d<'a, 'w, 's, Config, Clear>
where
    Config: GizmoConfigGroup,
    Clear: 'static + Send + Sync,
{ /* private fields */ }

A builder returned by Gizmos::grid and Gizmos::grid_2d

Implementations

impl<Config, Clear> GridBuilder2d<'_, '_, '_, Config, Clear>

where Config: GizmoConfigGroup, Clear: 'static + Send + Sync,

pub fn skew_x(self, skew: f32) -> GridBuilder2d<'_, '_, '_, Config, Clear>

Skews the grid by tan(skew) in the x direction. skew is in radians

pub fn skew_y(self, skew: f32) -> GridBuilder2d<'_, '_, '_, Config, Clear>

Skews the grid by tan(skew) in the y direction. skew is in radians

pub fn skew(self, skew: Vec2) -> GridBuilder2d<'_, '_, '_, Config, Clear>

Skews the grid by tan(skew) in the x and y directions. skew is in radians

pub fn outer_edges_x(self) -> GridBuilder2d<'_, '_, '_, Config, Clear>

Declare that the outer edges of the grid along the x axis should be drawn. By default, the outer edges will not be drawn.

pub fn outer_edges_y(self) -> GridBuilder2d<'_, '_, '_, Config, Clear>

Declare that the outer edges of the grid along the y axis should be drawn. By default, the outer edges will not be drawn.

pub fn outer_edges(self) -> GridBuilder2d<'_, '_, '_, Config, Clear>

Declare that all outer edges of the grid should be drawn. By default, the outer edges will not be drawn.

Examples found in repository

examples/gizmos/2d_gizmos.rs (line 55)

fn draw_example_collection(
    mut gizmos: Gizmos,
    mut my_gizmos: Gizmos<MyRoundGizmos>,
    time: Res<Time>,
) {
    let sin = time.elapsed_seconds().sin() * 50.;
    gizmos.line_2d(Vec2::Y * -sin, Vec2::splat(-80.), RED);
    gizmos.ray_2d(Vec2::Y * sin, Vec2::splat(80.), LIME);

    gizmos
        .grid_2d(
            Vec2::ZERO,
            0.0,
            UVec2::new(16, 12),
            Vec2::new(60., 60.),
            // Light gray
            LinearRgba::gray(0.65),
        )
        .outer_edges();

    // Triangle
    gizmos.linestrip_gradient_2d([
        (Vec2::Y * 300., BLUE),
        (Vec2::new(-255., -155.), RED),
        (Vec2::new(255., -155.), LIME),
        (Vec2::Y * 300., BLUE),
    ]);

    gizmos.rect_2d(
        Vec2::ZERO,
        time.elapsed_seconds() / 3.,
        Vec2::splat(300.),
        BLACK,
    );

    // The circles have 32 line-segments by default.
    my_gizmos.circle_2d(Vec2::ZERO, 120., BLACK);
    my_gizmos.ellipse_2d(
        Vec2::ZERO,
        time.elapsed_seconds() % TAU,
        Vec2::new(100., 200.),
        YELLOW_GREEN,
    );
    // You may want to increase this for larger circles.
    my_gizmos.circle_2d(Vec2::ZERO, 300., NAVY).segments(64);

    // Arcs default amount of segments is linearly interpolated between
    // 1 and 32, using the arc length as scalar.
    my_gizmos.arc_2d(Vec2::ZERO, sin / 10., PI / 2., 350., ORANGE_RED);

    gizmos.arrow_2d(
        Vec2::ZERO,
        Vec2::from_angle(sin / -10. + PI / 2.) * 50.,
        YELLOW,
    );

    // You can create more complex arrows using the arrow builder.
    gizmos
        .arrow_2d(Vec2::ZERO, Vec2::from_angle(sin / -10.) * 50., GREEN)
        .with_double_end()
        .with_tip_length(10.);
}

Trait Implementations

impl<Config, Clear> Drop for GridBuilder2d<'_, '_, '_, Config, Clear>

where Config: GizmoConfigGroup, Clear: 'static + Send + Sync,

fn drop(&mut self)

Executes the destructor for this type.