Struct heron_core::SensorShape

pub struct SensorShape;

Mark the CollisionShape of the same entity as being a sensor.

This is especially useful to add sensor to an existing (non-sensor) rigid body without the need to create a RigidBody::Sensor in between.

It has no effect if the concerned rigid body is already a RigidBody::Sensor.

Example

fn spawn(mut commands: Commands, mut materials: ResMut<Assets<ColorMaterial>>) {
  commands.spawn_bundle(todo!("Spawn your sprite/mesh, incl. at least a GlobalTransform"))
    .insert(RigidBody::Dynamic) // <-- A non-sensor rigid body
    .with_children(|children| {
      children.spawn_bundle((
            CollisionShape::Sphere { radius: 1.0 }, // <-- A physics collision shape
            Transform::default(), // <-- Optionally define it's position
            GlobalTransform::default(),
      ));
  
      children.spawn_bundle((
          CollisionShape::Sphere { radius: 1.0 }, // <-- A *sensor* collision shape.
          SensorShape,
          Transform::default(), // <-- Optionally define it's position
          GlobalTransform::default(),
      ));
    });
}

Trait Implementations

impl Clone for SensorShape

fn clone(&self) -> SensorShape

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SensorShape

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

Formats the value using the given formatter.

impl Default for SensorShape

fn default() -> SensorShape

Returns the “default value” for a type.

impl GetTypeRegistration for SensorShape

fn get_type_registration() -> TypeRegistration

impl Reflect for SensorShape

fn type_name(&self) -> &str

fn any(&self) -> &dyn Any

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

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

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

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

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

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

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

Returns a serializable value, if serialization is supported. Otherwise None will be returned.

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

Returns a hash of the value (which includes the type) if hashing is supported. Otherwise None will be returned.

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

Returns a “partial equal” comparison result if comparison is supported. Otherwise None will be returned.

impl Struct for SensorShape

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

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

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

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

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

fn field_len(&self) -> usize

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

fn clone_dynamic(&self) -> DynamicStruct

impl Copy for SensorShape