Struct bevy_render::primitives::HalfSpace

source ·
pub struct HalfSpace { /* private fields */ }
Expand description

A region of 3D space, specifically an open set whose border is a bisecting 2D plane. This bisecting plane partitions 3D space into two infinite regions, the half-space is one of those regions and excludes the bisecting plane.

Each instance of this type is characterized by:

  • the bisecting plane’s unit normal, normalized and pointing “inside” the half-space,
  • the signed distance along the normal from the bisecting plane to the origin of 3D space.

The distance can also be seen as:

  • the distance along the inverse of the normal from the origin of 3D space to the bisecting plane,
  • the opposite of the distance along the normal from the origin of 3D space to the bisecting plane.

Any point p is considered to be within the HalfSpace when the length of the projection of p on the normal is greater or equal than the opposite of the distance, meaning: if the equation normal.dot(p) + distance > 0. is satisfied.

For example, the half-space containing all the points with a z-coordinate lesser or equal than 8.0 would be defined by: HalfSpace::new(Vec3::NEG_Z.extend(-8.0)). It includes all the points from the bisecting plane towards NEG_Z, and the distance from the plane to the origin is -8.0 along NEG_Z.

It is used to define a Frustum, but is also a useful mathematical primitive for rendering tasks such as light computation.

Implementations§

source§

impl HalfSpace

source

pub fn new(normal_d: Vec4) -> Self

Constructs a HalfSpace from a 4D vector whose first 3 components represent the bisecting plane’s unit normal, and the last component is the signed distance along the normal from the plane to the origin. The constructor ensures the normal vector is normalized and the distance is appropriately scaled.

source

pub fn normal(&self) -> Vec3A

Returns the unit normal vector of the bisecting plane that characterizes the HalfSpace.

source

pub fn d(&self) -> f32

Returns the signed distance from the bisecting plane to the origin along the plane’s unit normal vector.

source

pub fn normal_d(&self) -> Vec4

Returns the bisecting plane’s unit normal vector and the signed distance from the plane to the origin.

Trait Implementations§

source§

impl Clone for HalfSpace

source§

fn clone(&self) -> HalfSpace

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for HalfSpace

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for HalfSpace

source§

fn default() -> HalfSpace

Returns the “default value” for a type. Read more
source§

impl Copy for HalfSpace

Auto Trait Implementations§

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, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &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)

Convert &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> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromWorld for T
where T: Default,

source§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

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>,

§

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> TypeData for T
where T: 'static + Send + Sync + Clone,

source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> ConditionalSend for T
where T: Send,

source§

impl<T> Settings for T
where T: 'static + Send + Sync,

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,