Struct SpotLightProps 

pub struct SpotLightProps { /* private fields */ }

The UI-thread properties of SpotLight.

Implementations

impl SpotLightProps

pub fn new() -> Self

Creates the properties with every field at the default of its type. The defaults of the schema are applied by initialize_defaults.

pub fn base(&self) -> &CompositionLightProps

The properties of the base class.

pub fn initialize_defaults(&self, host: &dyn SpotLightHooks)

The InitializeDefaults calls of the constructor chain: the base classes first, then this class.

pub fn initialize_own_defaults(&self, host: &dyn SpotLightHooks)

InitializeDefaults of this class alone.

pub fn constant_attenuation(&self) -> f32

ConstantAttenuation (animated, default 1.0, FerroUI overlay).

pub fn set_constant_attenuation(&self, host: &dyn SpotLightHooks, value: f32)

Sets ConstantAttenuation (animated, default 1.0, FerroUI overlay).

pub fn linear_attenuation(&self) -> f32

LinearAttenuation (animated, FerroUI overlay).

pub fn set_linear_attenuation(&self, host: &dyn SpotLightHooks, value: f32)

Sets LinearAttenuation (animated, FerroUI overlay).

pub fn quadratic_attenuation(&self) -> f32

QuadraticAttenuation (animated, FerroUI overlay).

pub fn set_quadratic_attenuation(&self, host: &dyn SpotLightHooks, value: f32)

Sets QuadraticAttenuation (animated, FerroUI overlay).

pub fn coordinate_space(&self) -> Option<Rc<dyn ICompositionObject>>

CoordinateSpace (FerroUI overlay).

pub fn set_coordinate_space( &self, host: &dyn SpotLightHooks, value: Option<Rc<dyn ICompositionObject>>, )

Sets CoordinateSpace (FerroUI overlay).

pub fn direction(&self) -> Vector3D

Direction (animated, default Vector3D::new(0.0, 0.0, -1.0), FerroUI overlay).

pub fn set_direction(&self, host: &dyn SpotLightHooks, value: Vector3D)

Sets Direction (animated, default Vector3D::new(0.0, 0.0, -1.0), FerroUI overlay).

pub fn inner_cone_angle(&self) -> f32

InnerConeAngle (animated, FerroUI overlay).

pub fn set_inner_cone_angle(&self, host: &dyn SpotLightHooks, value: f32)

Sets InnerConeAngle (animated, FerroUI overlay).

pub fn inner_cone_color(&self) -> Color

InnerConeColor (animated, default crate::media::Colors::WHITE, FerroUI overlay).

pub fn set_inner_cone_color(&self, host: &dyn SpotLightHooks, value: Color)

Sets InnerConeColor (animated, default crate::media::Colors::WHITE, FerroUI overlay).

pub fn inner_cone_intensity(&self) -> f32

InnerConeIntensity (animated, default 1.0, FerroUI overlay).

pub fn set_inner_cone_intensity(&self, host: &dyn SpotLightHooks, value: f32)

Sets InnerConeIntensity (animated, default 1.0, FerroUI overlay).

pub fn outer_cone_angle(&self) -> f32

OuterConeAngle (animated, default std::f32::consts::FRAC_PI_4, FerroUI overlay).

pub fn set_outer_cone_angle(&self, host: &dyn SpotLightHooks, value: f32)

Sets OuterConeAngle (animated, default std::f32::consts::FRAC_PI_4, FerroUI overlay).

pub fn outer_cone_color(&self) -> Color

OuterConeColor (animated, default crate::media::Colors::WHITE, FerroUI overlay).

pub fn set_outer_cone_color(&self, host: &dyn SpotLightHooks, value: Color)

Sets OuterConeColor (animated, default crate::media::Colors::WHITE, FerroUI overlay).

pub fn outer_cone_intensity(&self) -> f32

OuterConeIntensity (animated, default 1.0, FerroUI overlay).

pub fn set_outer_cone_intensity(&self, host: &dyn SpotLightHooks, value: f32)

Sets OuterConeIntensity (animated, default 1.0, FerroUI overlay).

pub fn offset(&self) -> Vector3D

Offset (animated, FerroUI overlay).

pub fn set_offset(&self, host: &dyn SpotLightHooks, value: Vector3D)

Sets Offset (animated, FerroUI overlay).

pub fn min_attenuation_cutoff(&self) -> f32

MinAttenuationCutoff (animated, FerroUI overlay).

pub fn set_min_attenuation_cutoff(&self, host: &dyn SpotLightHooks, value: f32)

Sets MinAttenuationCutoff (animated, FerroUI overlay).

pub fn max_attenuation_cutoff(&self) -> f32

MaxAttenuationCutoff (animated, default f32::MAX, FerroUI overlay).

pub fn set_max_attenuation_cutoff(&self, host: &dyn SpotLightHooks, value: f32)

Sets MaxAttenuationCutoff (animated, default f32::MAX, FerroUI overlay).

pub fn start_animation( &self, host: &dyn SpotLightHooks, property_name: &str, animation: &dyn ICompositionAnimation, final_value: Option<ExpressionVariant>, ) -> bool

Connects an animation with the named property. Returns false when neither this class nor its generated bases have an animated property of that name: the caller continues with its hand-written base.

pub fn serialize_changes_core( &self, host: &dyn SpotLightHooks, writer: &mut BatchStreamWriter<'_>, )

Writes the changes of the object: the base class first, then the changed-fields mask and the changed members of this class.

Trait Implementations

impl Default for SpotLightProps

fn default() -> Self

Returns the “default value” for a type.