Struct amethyst_physics::objects::PhysicsGarbageCollector

pub struct PhysicsGarbageCollector {
    pub bodies: Vec<PhysicsRigidBodyTag>,
    pub areas: Vec<PhysicsAreaTag>,
    pub shapes: Vec<PhysicsShapeTag>,
    pub joints: Vec<PhysicsJointTag>,
}

This garbage collector is used to store all the PhysicsTags to whom its associated handle get dropped.

The main benefit to use the Garbage Collector is that each PhysicsServer can implement its own destructor pipeline. Another benefit is that the user can store the PhysicsHandles even as resource or as prefer.

The alternative implementation was use a flagged storage. Using a FlaggedStorage would have been not only less powerful (since the objects are not tracked if stored elsewhere), but even more complicate. Indeed the FlaggedStorage has an handy Event system, which returns only the storage Index of the associated event. What this mean in practice is that you don't have access to PhysicsTag ID because the Index get removed and the only way would have been re implement a new storage with the capability to return PhysicsTag on component drop. Also the destruction pipeline is dictated by amethyst_physics to each physics backend.

Considering the above the GC seems a better way.

Fields

bodies: Vec<PhysicsRigidBodyTag>

List of body no more used.

areas: Vec<PhysicsAreaTag>

List of areas no more used.

shapes: Vec<PhysicsShapeTag>

List of shapes no more used.

joints: Vec<PhysicsJointTag>

List of joints no mor used.

Trait Implementations

impl Default for PhysicsGarbageCollector

fn default() -> Self

Returns the "default value" for a type.

impl Debug for PhysicsGarbageCollector

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

Formats the value using the given formatter.