Struct CollisionRect

pub struct CollisionRect<const ID: usize = 0> { /* private fields */ }

Rectagle shape to be used in the QuadTreePlugin and as a Component in the ECS.

Also, implemented CollisionQuery trait to be used as boundary in the QuadTree::query.

Panic

Rotation is not supported for CollisionRect, see CollisionRotatedRect instead.

Implementations

impl CollisionRect

pub fn new(rect: Rect) -> Self

Create a new CollisionRect from a Rect with ID = 0.

The initial size is set to the size of the rect. It is used to compute the size with the GlobalTransform’s scale.

The initial center is set to the center of the rect. It is covered by the GlobalTransform’s translation during the update.

impl<const ID: usize> CollisionRect<ID>

pub fn new_id(rect: Rect) -> Self

Create a new CollisionRect from a Rect with given ID.

pub fn set_init_size(&mut self, size: Vec2)

Set the initial size of the rect, which is used to compute the size with the GlobalTransform’s scale.

Trait Implementations

impl<const D: usize> AsDynCollision for CollisionRect<D>

fn as_dyn_collision(&self) -> Box<dyn DynCollision>

impl<const ID: usize> Clone for CollisionRect<ID>

fn clone(&self) -> CollisionRect<ID>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Collision<CollisionCircle> for CollisionRect

fn detect(&self, circle: &CollisionCircle) -> Relation

Return collision detection result.

impl Collision<CollisionRect> for CollisionCircle

fn detect(&self, rect: &CollisionRect) -> Relation

Return collision detection result.

impl Collision<CollisionRect> for CollisionRect

fn detect(&self, rect: &CollisionRect) -> Relation

Return collision detection result.

impl Collision<CollisionRect> for CollisionRotatedRect

fn detect(&self, rect: &CollisionRect) -> Relation

Return collision detection result.

impl Collision<CollisionRotatedRect> for CollisionRect

fn detect(&self, r_rect: &CollisionRotatedRect) -> Relation

Return collision detection result.

impl CollisionQuery for CollisionRect

fn query(&self, obj: &dyn DynCollision) -> Relation

Detect the relation between the boundary and objects from the tree.

impl<const ID: usize> Component for CollisionRect<ID>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

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

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl<const ID: usize> Debug for CollisionRect<ID>

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

Formats the value using the given formatter.

impl<const ID: usize> From<&CollisionRect<ID>> for CollisionRect<0>

fn from(value: &CollisionRect<ID>) -> Self

Convert the shape with ID to the shape with ID = 0. Used to eliminate the ID in the collision detection.

impl From<Rect> for CollisionRect

fn from(rect: Rect) -> Self

Create a new CollisionRect from a Rect with ID = 0.

See Self::new for details.

impl<const ID: usize> UpdateCollision<GlobalTransform> for CollisionRect<ID>

fn update() -> impl FnOnce(Mut<'_, Self>, &GlobalTransform)

Set the attributes of the shape. Used for updating the position of the shape in PreUpdate stage when GlobalTransform changed.

impl<const ID: usize> UpdateCollision<Sprite> for CollisionRect<ID>

Available on crate feature sprite only.

fn update() -> impl FnOnce(Mut<'_, Self>, &Sprite)

Set the attributes of the shape. Used for updating the position of the shape in PreUpdate stage when GlobalTransform changed.