Skip to main content

LightObject

Struct LightObject 

Source
pub struct LightObject {
    pub light: Light,
    pub kind: LightKind,
    pub distance: f64,
    pub decay: f64,
    pub angle: f64,
    pub penumbra: f64,
    pub ground_color: Color,
    pub sh: SphericalHarmonics3,
    pub target: Option<ObjectRef>,
    pub cast_shadow: bool,
    pub shadow: Option<Box<LightShadow>>,
}
Expand description

class <X>Light extends Light extends Object3D, minus the Object3D half (which is the scene-graph ObjectRef carrying this as a Payload).

Fields§

§light: Light

The color/intensity state common to every light kind.

§kind: LightKind

Which Light subclass this is.

§distance: f64

PointLight.distance / SpotLight.distance — the cutoff distance, 0 meaning no cutoff. The shader calls it cutoffDistance.

§decay: f64

PointLight.decay / SpotLight.decay, default 2.

§angle: f64

SpotLight.angle, in radians.

§penumbra: f64

SpotLight.penumbra.

§ground_color: Color

HemisphereLight.groundColor.

§sh: SphericalHarmonics3

LightProbe.sh — the probe’s irradiance as order-2 spherical harmonics. All zero, and unread, on every other kind.

§target: Option<ObjectRef>

SpotLight.target / DirectionalLight.target — an Object3D at the origin by default, never added to the scene, so its matrixWorld is just its local matrix.

§cast_shadow: bool

Object3D.castShadow.

§shadow: Option<Box<LightShadow>>

light.shadow — present for the shadow-casting light types. Boxed because the shadow owns a camera, which owns an Object3D, which can own a light.

Implementations§

Source§

impl LightObject

Source

pub fn set_power(&mut self, power: f64)

set power( power ) — PointLight only.

Source

pub fn power(&self) -> f64

get power() — luminous power in lumens, intensity * 4π.

Trait Implementations§

Source§

impl Clone for LightObject

SpotLight.copy() / DirectionalLight.copy() clone the target rather than sharing it, because the target is a real Object3D with its own transform.

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

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.