pub struct DebugShapes {
    pub shapes: Vec<Shape>,
}
Expand description

Bevy resource providing facilities to draw shapes.

Usage

use bevy::prelude::*;
use bevy_prototype_debug_lines::*;

// Draws a red cuboid (box) rotating around X.
fn some_system(time: Res<Time>, mut shapes: ResMut<DebugShapes>) {
    let seconds = time.elapsed_seconds();

    shapes
        .cuboid()
        .rotation(Quat::from_axis_angle(
            Vec3::X,
            seconds * std::f32::consts::FRAC_PI_4,
        ))
        .color(Color::RED);
}

Fields§

§shapes: Vec<Shape>

Implementations§

source§

impl DebugShapes

source

pub fn add<S>(&mut self, shape: S) -> ShapeHandle<'_, S>where S: Into<Shape>,

Add a generic shape to be drawn and return a handle to it.

source

pub fn circle(&mut self) -> ShapeHandle<'_, Circle>

Adds a Circle shape.

See ShapeHandle impl on Circle for more shape properties.

Short for DebugShapes::add.

source

pub fn cuboid(&mut self) -> ShapeHandle<'_, Cuboid>

Adds a Cuboid shape.

See ShapeHandle impl on Cuboid for more shape properties.

Short for DebugShapes::add.

source

pub fn line(&mut self) -> ShapeHandle<'_, Line>

Adds a Line shape.

See ShapeHandle impl on Line for more shape properties.

Short for DebugShapes::add.

source

pub fn sphere(&mut self) -> ShapeHandle<'_, Sphere>

Adds a Sphere shape.

See ShapeHandle impl on Sphere for more shape properties.

Short for DebugShapes::add.s

source

pub fn rect(&mut self) -> ShapeHandle<'_, Rect>

Adds a Rect shape.

See ShapeHandle impl on Rect for more shape properties.

Short for DebugShapes::add.s

Trait Implementations§

source§

impl Default for DebugShapes

source§

fn default() -> DebugShapes

Returns the “default value” for a type. Read more
source§

impl Resource for DebugShapeswhere Self: Send + Sync + 'static,

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,

§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T [ShaderType] for self. When used in [AsBindGroup] derives, it is safe to assume that all images in self exist.
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere T: Any,

§

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

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, Global>) -> Rc<dyn Any, Global>

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 Twhere T: Any + Send + Sync,

§

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

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> FromWorld for Twhere T: Default,

§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given [World]
source§

impl<T> Instrument for T

source§

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

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

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 Twhere 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, U> TryFrom<U> for Twhere 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 Twhere 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>

source§

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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