Skip to content

Commit b51ee78

Browse files
committed
Add migration guide
1 parent 69084cf commit b51ee78

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

migration-guides/0.5-to-main.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,27 @@ since the latest release. These guides are evolving and may not be polished yet.
66
See [migration-guides/README.md](./README.md) and existing entries for information about Avian's
77
migration guide process and what to put here.
88

9+
## Broad Phase Rework
10+
11+
PR [#927](https://github.com/avianphysics/avian/pull/927) overhauled broad phase collision detection
12+
to use a Bounding Volume Hierarchy (BVH).
13+
14+
`BroadPhasePlugin` has been replaced by two plugins:
15+
16+
- `BroadPhaseCorePlugin`: Sets up resources, system sets, and diagnostics required for broad phase collision detection.
17+
- `BvhBroadPhasePlugin`: Implements a broad phase using a BVH to efficiently find overlapping AABBs.
18+
19+
The latter can be swapped out for a custom broad phase implementation if desired.
20+
See the documentation of the `broad_phase plugin for more information.
21+
22+
The `BroadPhaseSystems::UpdateStructures` system set has also been removed.
23+
The BVH acceleration structures are updated by the `ColliderTreePlugin`,
24+
in `ColliderTreeSystems::UpdateAabbs`.
25+
26+
Contact pair creation order can be different from before due to the new broad phase algorithm,
27+
resulting in slightly changed behavior (but you should not rely on a specific contact order anyway).
28+
The order should still be deterministic across runs, given the same inputs.
29+
930
## `ReadRigidBodyForces` and `WriteRigidBodyForces`
1031

1132
PR [#908](https://github.com/avianphysics/avian/pull/908) introduced two new traits: `ReadRigidBodyForces` and `WriteRigidBodyForces`, and `RigidyBodyForces` is now defined as:

0 commit comments

Comments
 (0)