Skip to main content

ClippingGroup

Struct ClippingGroup 

Source
pub struct ClippingGroup {
    pub clipping_planes: Vec<Plane>,
    pub enabled: bool,
    pub clip_intersection: bool,
    pub clip_shadows: bool,
}
Expand description

ClippingGroup — a Group whose clipping planes clip every descendant, which is how WebGPURenderer encodes clipping in the scene graph (Material.clippingPlanes and renderer.clippingPlanes are WebGL-only).

The renderer’s walk keeps a clipping context per group it enters (ClippingContext.getGroupContext()): a nested group’s planes are added to its parent’s, as an intersection when clip_intersection is set and as a union otherwise. The planes are world-space and read every frame, so moving one needs nothing; changing how many there are rebuilds the programs below the group, as a new cache key does in three.js.

The node is an Object3D with type = 'ClippingGroup' and isGroup = true; this state is its Payload::ClippingGroup.

Fields§

§clipping_planes: Vec<Plane>

ClippingGroup.clippingPlanes, world-space.

§enabled: bool

ClippingGroup.enabled — with it off the group clips nothing and its descendants keep the context they would have had without it.

§clip_intersection: bool

ClippingGroup.clipIntersection — clip only what is behind all of the planes, rather than what is behind any one of them.

§clip_shadows: bool

ClippingGroup.clipShadows — whether the planes also clip the descendants’ shadow-map draws.

Implementations§

Source§

impl ClippingGroup

Source

pub fn new() -> ObjectRef

new ClippingGroup(), as a scene-graph ObjectRef, with no planes.

Source

pub fn of(group: Self) -> ObjectRef

A ClippingGroup node holding group.

Trait Implementations§

Source§

impl Clone for ClippingGroup

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClippingGroup

Source§

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

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

impl Default for ClippingGroup

Source§

fn default() -> Self

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

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> 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

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