Skip to main content

BspWorld

Struct BspWorld 

Source
pub struct BspWorld<'a> {
    pub planes: &'a [Plane],
    pub nodes: &'a [Node],
    pub leaves: &'a [Leaf],
    pub faces: &'a [Face],
    pub marksurfaces: &'a [u16],
    pub vertices: &'a [[f32; 3]],
    pub uvs: &'a [[f32; 2]],
    pub lm_uvs: &'a [[f32; 2]],
    pub vis: &'a [u8],
    pub vis_offsets: &'a [u32],
    pub num_clusters: u16,
}
Expand description

The complete borrowed BSP world.

Construct with BspWorld::new from your static lumps, then pass a &BspWorld into K3dengine::record_bsp every frame. No allocator needed.

Fields§

§planes: &'a [Plane]§nodes: &'a [Node]§leaves: &'a [Leaf]§faces: &'a [Face]§marksurfaces: &'a [u16]

Indirection table: leaves[i].first_marksurface indexes into this.

§vertices: &'a [[f32; 3]]§uvs: &'a [[f32; 2]]

Per-vertex surface UV coordinates (parallel to vertices).

§lm_uvs: &'a [[f32; 2]]

Per-vertex lightmap UV coordinates (parallel to vertices). May be empty when lightmaps are unused.

§vis: &'a [u8]

Quake-style RLE-compressed PVS blob. Empty = always visible.

§vis_offsets: &'a [u32]

vis_offsets[cluster_id] = byte offset into vis for that cluster.

§num_clusters: u16

Implementations§

Source§

impl<'a> BspWorld<'a>

Source

pub fn new( planes: &'a [Plane], nodes: &'a [Node], leaves: &'a [Leaf], faces: &'a [Face], marksurfaces: &'a [u16], vertices: &'a [[f32; 3]], uvs: &'a [[f32; 2]], lm_uvs: &'a [[f32; 2]], vis: &'a [u8], vis_offsets: &'a [u32], num_clusters: u16, ) -> Self

Source§

impl<'a> BspWorld<'a>

Source

pub fn leaf_for_point(&self, p: [f32; 3]) -> usize

Walk the BSP tree to find which leaf contains world-space point p.

Iterative — zero stack usage beyond the function call frame. Handles degenerate trees (0 nodes) by returning leaf 0.

Source

pub fn cluster_visible(&self, from_cluster: i16, test_cluster: i16) -> bool

Test whether test_cluster is potentially visible from from_cluster.

Returns true unconditionally when:

  • from_cluster < 0 (leaf with no PVS — Quake convention: always visible), or
  • The PVS blob is empty (no vis data compiled — developer/test use), or
  • test_cluster == from_cluster (every cluster sees itself).

Otherwise decodes Quake-style RLE: the vis row for from_cluster is a stream of non-zero bytes (each byte is 8 cluster bits) and zero runs encoded as [0x00, count] (skips count * 8 clusters).

Auto Trait Implementations§

§

impl<'a> Freeze for BspWorld<'a>

§

impl<'a> RefUnwindSafe for BspWorld<'a>

§

impl<'a> Send for BspWorld<'a>

§

impl<'a> Sync for BspWorld<'a>

§

impl<'a> Unpin for BspWorld<'a>

§

impl<'a> UnsafeUnpin for BspWorld<'a>

§

impl<'a> UnwindSafe for BspWorld<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

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

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.