ferroui-base 0.3.0

The base library of FerroUI: the property system, layout, input, styling, media, text, animation, data binding and the compositor
Documentation
// @generated by scripts/generate_composition.py — do not edit

//! `CompositionExperimentalAcrylicVisual`.
//!
//! Schema attributes: internal, custom constructor on the UI thread, custom constructor on the server.

use bitflags::bitflags;
use crate::CornerRadius;
use crate::media::ImmutableExperimentalAcrylicMaterial;
use crate::rendering::composition::ICompositionObjectHost;
use crate::rendering::composition::server::CompositionProperty;
use crate::rendering::composition::server::CompositionPropertyOf;
use crate::rendering::composition::server::IServerAnimatedPropertyHost;
use crate::rendering::composition::server::ServerPropertyValue;
use crate::rendering::composition::server::ServerValueChange;
use crate::rendering::composition::server::props_of;
use crate::rendering::composition::transport::BatchStreamReader;
use crate::rendering::composition::transport::BatchStreamWriter;
use crate::rendering::composition::transport::BatchValue;
use crate::rendering::composition::transport::BatchValueReader;
use std::any::Any;
use std::any::TypeId;
use std::cell::Cell;
use std::sync::OnceLock;
use std::time::Duration;

bitflags! {
    /// The fields of `CompositionExperimentalAcrylicVisual` that changed since its last serialization.
    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
    pub struct CompositionExperimentalAcrylicVisualChangedFields: u8 {
        const MATERIAL = 1;
        const CORNER_RADIUS = 2;
    }
}

impl BatchValue for CompositionExperimentalAcrylicVisualChangedFields {
    #[inline]
    fn write_to(&self, out: &mut Vec<u8>) {
        self.bits().write_to(out);
    }

    #[inline]
    fn read_from(input: &mut BatchValueReader<'_>) -> Self {
        CompositionExperimentalAcrylicVisualChangedFields::from_bits_retain(u8::read_from(input))
    }
}

/// The partial methods of `CompositionExperimentalAcrylicVisual`: implemented by the class that embeds
/// [`CompositionExperimentalAcrylicVisualProps`]. Every hook defaults to doing nothing.
pub trait CompositionExperimentalAcrylicVisualHooks: ICompositionObjectHost {
    /// `base.SerializeChangesCore(writer)`: serializes the changes of the
    /// hand-written base class `CompositionDrawListVisual`.
    fn base_serialize_changes_core(&self, writer: &mut BatchStreamWriter<'_>);

    fn initialize_defaults_extra(&self) {}

    fn validate_material_change(&self, _old_value: ImmutableExperimentalAcrylicMaterial, _new_value: ImmutableExperimentalAcrylicMaterial) {}
    fn on_material_changed(&self) {}
    fn on_material_changing(&self) {}

    fn validate_corner_radius_change(&self, _old_value: CornerRadius, _new_value: CornerRadius) {}
    fn on_corner_radius_changed(&self) {}
    fn on_corner_radius_changing(&self) {}
}

/// The UI-thread properties of `CompositionExperimentalAcrylicVisual`.
pub struct CompositionExperimentalAcrylicVisualProps {
    changed_fields_of_composition_experimental_acrylic_visual: Cell<CompositionExperimentalAcrylicVisualChangedFields>,
    material: Cell<ImmutableExperimentalAcrylicMaterial>,
    corner_radius: Cell<CornerRadius>,
}

impl Default for CompositionExperimentalAcrylicVisualProps {
    fn default() -> Self {
        Self::new()
    }
}

impl CompositionExperimentalAcrylicVisualProps {
    /// Creates the properties with every field at the default of its type.
    /// The defaults of the schema are applied by
    /// [`initialize_defaults`](Self::initialize_defaults).
    pub fn new() -> Self {
        Self {
            changed_fields_of_composition_experimental_acrylic_visual: Cell::new(CompositionExperimentalAcrylicVisualChangedFields::empty()),
            material: Cell::new(Default::default()),
            corner_radius: Cell::new(Default::default()),
        }
    }

    /// The `InitializeDefaults` calls of the constructor chain: the base
    /// classes first, then this class.
    pub fn initialize_defaults(&self, host: &dyn CompositionExperimentalAcrylicVisualHooks) {
        self.initialize_own_defaults(host);
    }

    /// `InitializeDefaults` of this class alone.
    pub fn initialize_own_defaults(&self, host: &dyn CompositionExperimentalAcrylicVisualHooks) {
        CompositionExperimentalAcrylicVisualHooks::initialize_defaults_extra(host);
    }

    /// `Material`.
    pub fn material(&self) -> ImmutableExperimentalAcrylicMaterial {
        self.material.get()
    }

    /// Sets `Material`.
    pub fn set_material(&self, host: &dyn CompositionExperimentalAcrylicVisualHooks, value: ImmutableExperimentalAcrylicMaterial) {
        let mut changed = false;
        let old_value = self.material.get();
        if old_value.differs(&value) {
            CompositionExperimentalAcrylicVisualHooks::validate_material_change(host, old_value, value);
            CompositionExperimentalAcrylicVisualHooks::on_material_changing(host);
            changed = true;
            // Update the backing value
            self.material.set(value);
            // Register object for serialization in the next batch
            self.changed_fields_of_composition_experimental_acrylic_visual.set(self.changed_fields_of_composition_experimental_acrylic_visual.get() | CompositionExperimentalAcrylicVisualChangedFields::MATERIAL);
            host.register_for_serialization();
        }
        self.material.set(value);
        if changed {
            CompositionExperimentalAcrylicVisualHooks::on_material_changed(host);
        }
    }

    /// `CornerRadius`.
    pub fn corner_radius(&self) -> CornerRadius {
        self.corner_radius.get()
    }

    /// Sets `CornerRadius`.
    pub fn set_corner_radius(&self, host: &dyn CompositionExperimentalAcrylicVisualHooks, value: CornerRadius) {
        let mut changed = false;
        let old_value = self.corner_radius.get();
        if old_value.differs(&value) {
            CompositionExperimentalAcrylicVisualHooks::validate_corner_radius_change(host, old_value, value);
            CompositionExperimentalAcrylicVisualHooks::on_corner_radius_changing(host);
            changed = true;
            // Update the backing value
            self.corner_radius.set(value);
            // Register object for serialization in the next batch
            self.changed_fields_of_composition_experimental_acrylic_visual.set(self.changed_fields_of_composition_experimental_acrylic_visual.get() | CompositionExperimentalAcrylicVisualChangedFields::CORNER_RADIUS);
            host.register_for_serialization();
        }
        self.corner_radius.set(value);
        if changed {
            CompositionExperimentalAcrylicVisualHooks::on_corner_radius_changed(host);
        }
    }

    /// Writes the changes of the object: the base class first, then the
    /// changed-fields mask and the changed members of this class.
    pub fn serialize_changes_core(&self, host: &dyn CompositionExperimentalAcrylicVisualHooks, writer: &mut BatchStreamWriter<'_>) {
        CompositionExperimentalAcrylicVisualHooks::base_serialize_changes_core(host, writer);
        let changed = self.changed_fields_of_composition_experimental_acrylic_visual.get();
        writer.write(changed);
        if changed.contains(CompositionExperimentalAcrylicVisualChangedFields::MATERIAL) {
            writer.write_value(Some(self.material.get()));
        }
        if changed.contains(CompositionExperimentalAcrylicVisualChangedFields::CORNER_RADIUS) {
            writer.write(self.corner_radius.get());
        }
        self.changed_fields_of_composition_experimental_acrylic_visual.set(CompositionExperimentalAcrylicVisualChangedFields::empty());
    }
}

/// The partial methods of `ServerCompositionExperimentalAcrylicVisual`: implemented by the class that embeds
/// [`ServerCompositionExperimentalAcrylicVisualProps`]. Every hook defaults to doing nothing.
pub trait ServerCompositionExperimentalAcrylicVisualHooks: IServerAnimatedPropertyHost {
    /// `base.DeserializeChangesCore(reader, committedAt)`: reads the changes of
    /// the hand-written base class `ServerCompositionDrawListVisual`.
    fn base_deserialize_changes_core(&self, reader: &mut BatchStreamReader<'_>, committed_at: Duration);

    fn deserialize_changes_extra(&self, _reader: &mut BatchStreamReader<'_>) {}
    fn on_fields_deserialized(&self, _changed: CompositionExperimentalAcrylicVisualChangedFields) {}

    fn on_material_changed(&self) {}
    fn on_material_changing(&self) {}

    fn on_corner_radius_changed(&self) {}
    fn on_corner_radius_changing(&self) {}
}

/// The server-side properties of `ServerCompositionExperimentalAcrylicVisual`.
pub struct ServerCompositionExperimentalAcrylicVisualProps {
    material: Cell<ImmutableExperimentalAcrylicMaterial>,
    corner_radius: Cell<CornerRadius>,
}

impl Default for ServerCompositionExperimentalAcrylicVisualProps {
    fn default() -> Self {
        Self::new()
    }
}

impl ServerCompositionExperimentalAcrylicVisualProps {
    /// Creates the properties with every field at the default of its type; the
    /// values of the UI thread arrive with the first batch.
    pub fn new() -> Self {
        Self {
            material: Cell::new(Default::default()),
            corner_radius: Cell::new(Default::default()),
        }
    }

    /// This block or the block of a base class, by type: what
    /// `IServerObject::get_props` of the embedding class returns.
    pub fn find_props(&self, type_id: TypeId) -> Option<&dyn Any> {
        if type_id == TypeId::of::<Self>() {
            return Some(self);
        }
        None
    }

    /// The composition property of `Material`.
    pub fn id_of_material_property() -> &'static CompositionPropertyOf<ImmutableExperimentalAcrylicMaterial> {
        static PROPERTY: OnceLock<CompositionPropertyOf<ImmutableExperimentalAcrylicMaterial>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerCompositionExperimentalAcrylicVisualProps, ImmutableExperimentalAcrylicMaterial>(
                "Material",
                "ServerCompositionExperimentalAcrylicVisual",
                |obj| props_of::<ServerCompositionExperimentalAcrylicVisualProps>(obj).material.get(),
                |obj, v| props_of::<ServerCompositionExperimentalAcrylicVisualProps>(obj).material.set(v),
                None,
                None,
            )
        })
    }

    /// `Material`.
    pub fn material(&self) -> ImmutableExperimentalAcrylicMaterial {
        self.material.get()
    }

    pub fn set_material(&self, host: &dyn ServerCompositionExperimentalAcrylicVisualHooks, value: ImmutableExperimentalAcrylicMaterial) {
        let old_value = self.material.get();
        let mut changed = false;
        if old_value.differs(&value) {
            ServerCompositionExperimentalAcrylicVisualHooks::on_material_changing(host);
            changed = true;
        }
        host.set_value(
            Self::id_of_material_property().base(),
            ServerValueChange {
                equal: old_value.default_equals(&value),
                old_resource: None,
                new_resource: None,
                assign: &mut || self.material.set(value),
            },
        );
        if changed {
            ServerCompositionExperimentalAcrylicVisualHooks::on_material_changed(host);
        }
    }

    /// The composition property of `CornerRadius`.
    pub fn id_of_corner_radius_property() -> &'static CompositionPropertyOf<CornerRadius> {
        static PROPERTY: OnceLock<CompositionPropertyOf<CornerRadius>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerCompositionExperimentalAcrylicVisualProps, CornerRadius>(
                "CornerRadius",
                "ServerCompositionExperimentalAcrylicVisual",
                |obj| props_of::<ServerCompositionExperimentalAcrylicVisualProps>(obj).corner_radius.get(),
                |obj, v| props_of::<ServerCompositionExperimentalAcrylicVisualProps>(obj).corner_radius.set(v),
                None,
                None,
            )
        })
    }

    /// `CornerRadius`.
    pub fn corner_radius(&self) -> CornerRadius {
        self.corner_radius.get()
    }

    pub fn set_corner_radius(&self, host: &dyn ServerCompositionExperimentalAcrylicVisualHooks, value: CornerRadius) {
        let old_value = self.corner_radius.get();
        let mut changed = false;
        if old_value.differs(&value) {
            ServerCompositionExperimentalAcrylicVisualHooks::on_corner_radius_changing(host);
            changed = true;
        }
        host.set_value(
            Self::id_of_corner_radius_property().base(),
            ServerValueChange {
                equal: old_value.default_equals(&value),
                old_resource: None,
                new_resource: None,
                assign: &mut || self.corner_radius.set(value),
            },
        );
        if changed {
            ServerCompositionExperimentalAcrylicVisualHooks::on_corner_radius_changed(host);
        }
    }

    /// Reads the changes of the object: the base class first, then the
    /// changed-fields mask and the changed members of this class.
    pub fn deserialize_changes_core(
        &self,
        host: &dyn ServerCompositionExperimentalAcrylicVisualHooks,
        reader: &mut BatchStreamReader<'_>,
        committed_at: Duration,
    ) {
        ServerCompositionExperimentalAcrylicVisualHooks::base_deserialize_changes_core(host, reader, committed_at);
        ServerCompositionExperimentalAcrylicVisualHooks::deserialize_changes_extra(host, reader);
        let changed = reader.read::<CompositionExperimentalAcrylicVisualChangedFields>();
        if changed.contains(CompositionExperimentalAcrylicVisualChangedFields::MATERIAL) {
            let value = match reader.read_value::<ImmutableExperimentalAcrylicMaterial>() {
                Some(value) => value,
                None => panic!("a batch holds no value for a property that is not nullable"),
            };
            self.set_material(host, value);
        }
        if changed.contains(CompositionExperimentalAcrylicVisualChangedFields::CORNER_RADIUS) {
            let value = reader.read::<CornerRadius>();
            self.set_corner_radius(host, value);
        }
        ServerCompositionExperimentalAcrylicVisualHooks::on_fields_deserialized(host, changed);
    }
}