Struct avian3d::debug_render::DebugRender

pub struct DebugRender {
    pub axis_lengths: Option<Vector>,
    pub aabb_color: Option<Color>,
    pub collider_color: Option<Color>,
    pub sleeping_color_multiplier: Option<[f32; 4]>,
    pub hide_mesh: bool,
}

A component for the debug render configuration of an entity. See PhysicsDebugPlugin.

This overwrites the global PhysicsGizmos for this specific entity.

Example

use avian3d::prelude::*;
use bevy::prelude::*;

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins,
            PhysicsPlugins::default(),
            // Enables debug rendering
            PhysicsDebugPlugin::default(),
        ))
        .run();
}

fn setup(mut commands: Commands) {
    // This rigid body and its collider and AABB will get rendered
    commands.spawn((
        RigidBody::Dynamic,
        Collider::sphere(0.5),
        // Overwrite default collider color (optional)
        DebugRender::default().with_collider_color(Color::srgb(1.0, 0.0, 0.0)),
    ));
}

Fields

axis_lengths: Option<Vector>

The lengths of the axes drawn for the entity at the center of mass.

aabb_color: Option<Color>

The color of the AABB. If None, the AABB will not be rendered.

collider_color: Option<Color>

The color of the collider wireframe. If None, the collider will not be rendered.

sleeping_color_multiplier: Option<[f32; 4]>

If the entity is sleeping, its colors (in HSLA) will be multiplied by this array. If None, sleeping will have no effect on the colors.

hide_mesh: bool

Determines if the entity’s visibility should be set to Visibility::Hidden, which will only show the debug render.

Implementations

impl DebugRender

pub fn all() -> Self

Creates a DebugRender configuration with all rendering options enabled.

pub fn none() -> Self

Disables all debug rendering for this entity.

pub fn axes(axis_lengths: Vector) -> Self

Creates a DebugRender configuration with the given lengths for the axes that are drawn for the entity at the center of mass. Other debug rendering options will be disabled.

pub fn aabb(color: Color) -> Self

Creates a DebugRender configuration with a given AABB color. Other debug rendering options will be disabled.

pub fn collider(color: Color) -> Self

Creates a DebugRender configuration with a given collider color. Other debug rendering options will be disabled.

pub fn with_axes(self, axis_lengths: Vector) -> Self

Sets the lengths of the axes drawn for the entity at the center of mass.

pub fn with_aabb_color(self, color: Color) -> Self

Sets the AABB color.

pub fn with_collider_color(self, color: Color) -> Self

Sets the collider color.

pub fn with_sleeping_color_multiplier(self, color_multiplier: [f32; 4]) -> Self

Sets the multiplier used for the colors (in HSLA) of sleeping bodies.

pub fn with_mesh_visibility(self, is_visible: bool) -> Self

Sets the visibility of the entity’s visual mesh.

pub fn without_axes(self) -> Self

Disables axis debug rendering.

pub fn without_aabb(self) -> Self

Disables AABB debug rendering.

pub fn without_collider(self) -> Self

Disables collider debug rendering.

Trait Implementations

impl Clone for DebugRender

fn clone(&self) -> DebugRender

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for DebugRender

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Default for DebugRender

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for DebugRender

where Self: Any + Send + Sync, Option<Vector>: FromReflect + TypePath + RegisterForReflection, Option<Color>: FromReflect + TypePath + RegisterForReflection, Option<[f32; 4]>: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for DebugRender

where Self: Any + Send + Sync, Option<Vector>: FromReflect + TypePath + RegisterForReflection, Option<Color>: FromReflect + TypePath + RegisterForReflection, Option<[f32; 4]>: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialEq for DebugRender

fn eq(&self, other: &DebugRender) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for DebugRender

where Self: Any + Send + Sync, Option<Vector>: FromReflect + TypePath + RegisterForReflection, Option<Color>: FromReflect + TypePath + RegisterForReflection, Option<[f32; 4]>: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for DebugRender

where Self: Any + Send + Sync, Option<Vector>: FromReflect + TypePath + RegisterForReflection, Option<Color>: FromReflect + TypePath + RegisterForReflection, Option<[f32; 4]>: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for DebugRender

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for DebugRender

where Self: Any + Send + Sync, Option<Vector>: FromReflect + TypePath + RegisterForReflection, Option<Color>: FromReflect + TypePath + RegisterForReflection, Option<[f32; 4]>: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for DebugRender

impl StructuralPartialEq for DebugRender