Struct heron::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) {
  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 Component for SensorShapewhere
    SensorShape: 'static + Send + Sync,

type Storage = TableStorage

impl Debug for SensorShape

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

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

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the [TypeInfo] of the underlying type.

fn into_any(self: Box<SensorShape, Global>) -> Box<dyn Any + 'static, Global>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

Clones the value as a Reflect trait object.

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

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

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

Applies a reflected value to this value.

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

Returns an enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

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

Returns a “partial equality” comparison result.

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.

impl Struct for SensorShape

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

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 + 'static)>

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 + 'static)>

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 + 'static)>

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 struct’s fields.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a [DynamicStruct].

impl Typed for SensorShape

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for SensorShape