pub struct BvhWorkspace { /* private fields */ }Expand description
Workspace data for various operations on the BVH tree.
This structure holds temporary buffers and working memory used during BVH operations such as refitting, rebuilding, and optimization. The data inside can be freed at any time without affecting the correctness of BVH results.
§Purpose
Many BVH operations require temporary allocations for intermediate results. By reusing
the same BvhWorkspace across multiple operations, you can significantly reduce allocation
overhead and improve performance, especially in performance-critical loops.
§Usage Pattern
- Create a workspace once (or use
Default::default()) - Pass it to BVH operations that accept a workspace parameter
- Reuse the same workspace for subsequent operations
- The workspace grows to accommodate the largest operation size
§Memory Management
- The workspace grows as needed but never automatically shrinks
- You can drop and recreate the workspace to free memory
- All data is private and managed internally by the BVH
§Example
use parry3d::partitioning::{Bvh, BvhBuildStrategy, BvhWorkspace};
use parry3d::bounding_volume::Aabb;
use nalgebra::Point3;
let aabbs = vec![
Aabb::new(Point3::origin(), Point3::new(1.0, 1.0, 1.0)),
Aabb::new(Point3::new(2.0, 0.0, 0.0), Point3::new(3.0, 1.0, 1.0)),
];
let mut bvh = Bvh::from_leaves(BvhBuildStrategy::default(), &aabbs);
let mut workspace = BvhWorkspace::default();
// Refit the tree after leaf movements
bvh.refit(&mut workspace);
// Reuse the same workspace for optimization
bvh.optimize_incremental(&mut workspace);
// The workspace can be reused across multiple BVH operations§See Also
Bvh::refit- Update AABBs after leaf movementBvh::optimize_incremental- Incremental tree optimization
Trait Implementations§
Source§impl Clone for BvhWorkspace
impl Clone for BvhWorkspace
Source§fn clone(&self) -> BvhWorkspace
fn clone(&self) -> BvhWorkspace
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Default for BvhWorkspace
impl Default for BvhWorkspace
Source§fn default() -> BvhWorkspace
fn default() -> BvhWorkspace
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for BvhWorkspace
impl RefUnwindSafe for BvhWorkspace
impl Send for BvhWorkspace
impl Sync for BvhWorkspace
impl Unpin for BvhWorkspace
impl UnwindSafe for BvhWorkspace
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Converts
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Converts
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Converts
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Converts
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.