Struct avian3d::debug_render::PhysicsGizmos

pub struct PhysicsGizmos {

    pub axis_lengths: Option<Vector>,
    pub aabb_color: Option<Color>,
    pub collider_color: Option<Color>,
    pub sleeping_color_multiplier: Option<[f32; 4]>,
    pub contact_point_color: Option<Color>,
    pub contact_normal_color: Option<Color>,
    pub contact_normal_scale: ContactGizmoScale,
    pub joint_anchor_color: Option<Color>,
    pub joint_separation_color: Option<Color>,
    pub raycast_color: Option<Color>,
    pub raycast_point_color: Option<Color>,
    pub raycast_normal_color: Option<Color>,
    pub shapecast_color: Option<Color>,
    pub shapecast_shape_color: Option<Color>,
    pub shapecast_point_color: Option<Color>,
    pub shapecast_normal_color: Option<Color>,
    pub hide_meshes: bool,
}

Gizmos used for debug rendering physics. See PhysicsDebugPlugin

You can configure what is rendered by inserting the PhysicsGizmos configuration group or by getting it from the GizmoConfigStore resource and mutating the returned configuration.

To configure the debug rendering of specific entities, use the DebugRender component.

Example

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

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins,
            PhysicsPlugins::default(),
            // Enables debug rendering
            PhysicsDebugPlugin::default(),
        ))
        // Overwrite default debug rendering configuration (optional)
        .insert_gizmo_config(
            PhysicsGizmos {
                aabb_color: Some(Color::WHITE),
                ..default()
            },
            GizmoConfig::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)));
}

Fields

axis_lengths: Option<Vector>

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

aabb_color: Option<Color>

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

collider_color: Option<Color>

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

sleeping_color_multiplier: Option<[f32; 4]>

The colors (in HSLA) for sleeping bodies will be multiplied by this array. If None, sleeping will have no effect on the colors.

contact_point_color: Option<Color>

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

contact_normal_color: Option<Color>

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

contact_normal_scale: ContactGizmoScale

The scale used for contact normals.

joint_anchor_color: Option<Color>

The color of the lines drawn from the centers of bodies to their joint anchors.

joint_separation_color: Option<Color>

The color of the lines drawn between joint anchors, indicating the separation.

raycast_color: Option<Color>

The color used for the rays in raycasts.

raycast_point_color: Option<Color>

The color used for the hit points in raycasts.

raycast_normal_color: Option<Color>

The color used for the hit normals in raycasts.

shapecast_color: Option<Color>

The color used for the ray in shapecasts.

shapecast_shape_color: Option<Color>

The color used for the shape in shapecasts.

shapecast_point_color: Option<Color>

The color used for the hit points in shapecasts.

shapecast_normal_color: Option<Color>

The color used for the hit normals in shapecasts.

hide_meshes: bool

Determines if the visibility of entities with colliders should be set to Visibility::Hidden, which will only show the debug renders.

Implementations

impl PhysicsGizmos

pub fn all() -> Self

Creates a PhysicsGizmos configuration with all rendering options enabled.

pub fn none() -> Self

Creates a PhysicsGizmos configuration with debug rendering enabled but all options turned off.

Note: this doesn’t affect entities with DebugRender component; their debug gizmos will be visible.

pub fn axes(axis_lengths: Vector) -> Self

Creates a PhysicsGizmos 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 aabbs(color: Color) -> Self

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

pub fn colliders(color: Color) -> Self

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

pub fn contact_points(color: Color) -> Self

Creates a PhysicsGizmos configuration with a given contact point color. Other debug rendering options will be disabled.

pub fn contact_normals(color: Color) -> Self

Creates a PhysicsGizmos configuration with a given contact normal color. Other debug rendering options will be disabled.

pub fn joints( anchor_color: Option<Color>, separation_color: Option<Color> ) -> Self

Creates a PhysicsGizmos configuration with given colors for joint anchors and separation distances. 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.

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_contact_point_color(self, color: Color) -> Self

Sets the contact point color.

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

Sets the contact normal color.

pub fn with_contact_normal_scale(self, scale: ContactGizmoScale) -> Self

Sets the contact normal scale.

pub fn with_joint_colors( anchor_color: Option<Color>, separation_color: Option<Color> ) -> Self

Sets the colors used for debug rendering joints.

pub fn with_raycast_colors( self, ray: Option<Color>, hit_point: Option<Color>, hit_normal: Option<Color> ) -> Self

Sets the colors used for debug rendering raycasts.

pub fn with_shapecast_colors( self, ray: Option<Color>, shape: Option<Color>, hit_point: Option<Color>, hit_normal: Option<Color> ) -> Self

Sets the colors used for debug rendering shapecasts.

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_aabbs(self) -> Self

Disables AABB debug rendering.

pub fn without_colliders(self) -> Self

Disables collider debug rendering.

pub fn without_contact_points(self) -> Self

Disables contact point debug rendering.

pub fn without_contact_normals(self) -> Self

Disables contact normal debug rendering.

pub fn without_joints(self) -> Self

Disables joint debug rendering.

pub fn without_raycasts(self) -> Self

Disables raycast debug rendering.

pub fn without_shapecasts(self) -> Self

Disables shapecast debug rendering.

Trait Implementations

impl Default for PhysicsGizmos

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for PhysicsGizmos

where Self: Any + Send + Sync, Option<Vector>: FromReflect + TypePath + RegisterForReflection, Option<Color>: FromReflect + TypePath + RegisterForReflection, Option<[f32; 4]>: FromReflect + TypePath + RegisterForReflection, ContactGizmoScale: 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 PhysicsGizmos

where Self: Any + Send + Sync, Option<Vector>: FromReflect + TypePath + RegisterForReflection, Option<Color>: FromReflect + TypePath + RegisterForReflection, Option<[f32; 4]>: FromReflect + TypePath + RegisterForReflection, ContactGizmoScale: 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 Reflect for PhysicsGizmos

where Self: Any + Send + Sync, Option<Vector>: FromReflect + TypePath + RegisterForReflection, Option<Color>: FromReflect + TypePath + RegisterForReflection, Option<[f32; 4]>: FromReflect + TypePath + RegisterForReflection, ContactGizmoScale: 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 PhysicsGizmos

where Self: Any + Send + Sync, Option<Vector>: FromReflect + TypePath + RegisterForReflection, Option<Color>: FromReflect + TypePath + RegisterForReflection, Option<[f32; 4]>: FromReflect + TypePath + RegisterForReflection, ContactGizmoScale: 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 PhysicsGizmos

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 PhysicsGizmos

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

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl GizmoConfigGroup for PhysicsGizmos

where Self: Reflect + TypePath + Default,