ferroui-base 0.4.0

// @generated by scripts/generate_composition.py — do not edit

//! `SpriteVisual`.
//!
//! Defined by the FerroUI overlay (scripts/composition-schema-winui.xml).

use bitflags::bitflags;
use crate::rendering::composition::ICompositionObject;
use crate::rendering::composition::animations::ICompositionAnimation;
use crate::rendering::composition::expressions::ExpressionVariant;
use crate::rendering::composition::server::AsServerRenderResource;
use crate::rendering::composition::server::CompositionProperty;
use crate::rendering::composition::server::CompositionPropertyOf;
use crate::rendering::composition::server::IServerAnimatedPropertyHost;
use crate::rendering::composition::server::IServerObject;
use crate::rendering::composition::server::ServerPropertyValue;
use crate::rendering::composition::server::ServerValueChange;
use crate::rendering::composition::server::props_of;
use crate::rendering::composition::server::read_server_object;
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::cell::RefCell;
use std::rc::Rc;
use std::sync::OnceLock;
use std::time::Duration;
use super::CompositionContainerVisualHooks;
use super::CompositionContainerVisualProps;

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

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

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

/// The partial methods of `SpriteVisual`: implemented by the class that embeds
/// [`SpriteVisualProps`]. Every hook defaults to doing nothing.
pub trait SpriteVisualHooks: CompositionContainerVisualHooks {
    fn initialize_defaults_extra(&self) {}

    fn validate_brush_change(&self, _old_value: &Option<Rc<dyn ICompositionObject>>, _new_value: &Option<Rc<dyn ICompositionObject>>) {}
    fn on_brush_changed(&self) {}
    fn on_brush_changing(&self) {}

    fn validate_shadow_change(&self, _old_value: &Option<Rc<dyn ICompositionObject>>, _new_value: &Option<Rc<dyn ICompositionObject>>) {}
    fn on_shadow_changed(&self) {}
    fn on_shadow_changing(&self) {}
}

/// The UI-thread properties of `SpriteVisual`.
pub struct SpriteVisualProps {
    base: CompositionContainerVisualProps,
    changed_fields_of_sprite_visual: Cell<SpriteVisualChangedFields>,
    brush: RefCell<Option<Rc<dyn ICompositionObject>>>,
    shadow: RefCell<Option<Rc<dyn ICompositionObject>>>,
}

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

impl SpriteVisualProps {
    /// 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 {
            base: CompositionContainerVisualProps::new(),
            changed_fields_of_sprite_visual: Cell::new(SpriteVisualChangedFields::empty()),
            brush: RefCell::new(None),
            shadow: RefCell::new(None),
        }
    }

    /// The properties of the base class.
    pub fn base(&self) -> &CompositionContainerVisualProps {
        &self.base
    }

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

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

    /// `Brush` (FerroUI overlay).
    pub fn brush(&self) -> Option<Rc<dyn ICompositionObject>> {
        self.brush.borrow().clone()
    }

    /// Sets `Brush` (FerroUI overlay).
    pub fn set_brush(&self, host: &dyn SpriteVisualHooks, value: Option<Rc<dyn ICompositionObject>>) {
        let mut changed = false;
        let old_value = self.brush.borrow().clone();
        if old_value.differs(&value) {
            SpriteVisualHooks::validate_brush_change(host, &old_value, &value);
            SpriteVisualHooks::on_brush_changing(host);
            changed = true;
            // Update the backing value
            *self.brush.borrow_mut() = value.clone();
            // Register object for serialization in the next batch
            self.changed_fields_of_sprite_visual.set(self.changed_fields_of_sprite_visual.get() | SpriteVisualChangedFields::BRUSH);
            host.register_for_serialization();
        }
        *self.brush.borrow_mut() = value;
        if changed {
            SpriteVisualHooks::on_brush_changed(host);
        }
    }

    /// `Shadow` (FerroUI overlay).
    pub fn shadow(&self) -> Option<Rc<dyn ICompositionObject>> {
        self.shadow.borrow().clone()
    }

    /// Sets `Shadow` (FerroUI overlay).
    pub fn set_shadow(&self, host: &dyn SpriteVisualHooks, value: Option<Rc<dyn ICompositionObject>>) {
        let mut changed = false;
        let old_value = self.shadow.borrow().clone();
        if old_value.differs(&value) {
            SpriteVisualHooks::validate_shadow_change(host, &old_value, &value);
            SpriteVisualHooks::on_shadow_changing(host);
            changed = true;
            // Update the backing value
            *self.shadow.borrow_mut() = value.clone();
            // Register object for serialization in the next batch
            self.changed_fields_of_sprite_visual.set(self.changed_fields_of_sprite_visual.get() | SpriteVisualChangedFields::SHADOW);
            host.register_for_serialization();
        }
        *self.shadow.borrow_mut() = value;
        if changed {
            SpriteVisualHooks::on_shadow_changed(host);
        }
    }

    /// 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 start_animation(
        &self,
        host: &dyn SpriteVisualHooks,
        property_name: &str,
        animation: &dyn ICompositionAnimation,
        final_value: Option<ExpressionVariant>,
    ) -> bool {
        self.base.start_animation(host, property_name, animation, final_value)
    }

    /// 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 SpriteVisualHooks, writer: &mut BatchStreamWriter<'_>) {
        self.base.serialize_changes_core(host, writer);
        let changed = self.changed_fields_of_sprite_visual.get();
        writer.write(changed);
        if changed.contains(SpriteVisualChangedFields::BRUSH) {
            writer.write_server_object(self.brush.borrow().clone().map(|o| o.server()));
        }
        if changed.contains(SpriteVisualChangedFields::SHADOW) {
            writer.write_server_object(self.shadow.borrow().clone().map(|o| o.server()));
        }
        self.changed_fields_of_sprite_visual.set(SpriteVisualChangedFields::empty());
    }
}

/// The partial methods of `ServerSpriteVisual`: implemented by the class that embeds
/// [`ServerSpriteVisualProps`]. Every hook defaults to doing nothing.
pub trait ServerSpriteVisualHooks: IServerAnimatedPropertyHost {
    /// `base.DeserializeChangesCore(reader, committedAt)`: reads the changes of
    /// the hand-written base class `ServerSizeDependantVisual`.
    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: SpriteVisualChangedFields) {}

    fn on_brush_changed(&self) {}
    fn on_brush_changing(&self) {}

    fn on_shadow_changed(&self) {}
    fn on_shadow_changing(&self) {}
}

/// The server-side properties of `ServerSpriteVisual`.
pub struct ServerSpriteVisualProps {
    brush: RefCell<Option<Rc<dyn IServerObject>>>,
    shadow: RefCell<Option<Rc<dyn IServerObject>>>,
}

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

impl ServerSpriteVisualProps {
    /// 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 {
            brush: RefCell::new(None),
            shadow: RefCell::new(None),
        }
    }

    /// 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 `Brush`.
    pub fn id_of_brush_property() -> &'static CompositionPropertyOf<Option<Rc<dyn IServerObject>>> {
        static PROPERTY: OnceLock<CompositionPropertyOf<Option<Rc<dyn IServerObject>>>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerSpriteVisualProps, Option<Rc<dyn IServerObject>>>(
                "Brush",
                "ServerSpriteVisual",
                |obj| props_of::<ServerSpriteVisualProps>(obj).brush.borrow().clone(),
                |obj, v| *props_of::<ServerSpriteVisualProps>(obj).brush.borrow_mut() = v,
                None,
                None,
            )
        })
    }

    /// `Brush`.
    pub fn brush(&self) -> Option<Rc<dyn IServerObject>> {
        self.brush.borrow().clone()
    }

    pub fn set_brush(&self, host: &dyn ServerSpriteVisualHooks, value: Option<Rc<dyn IServerObject>>) {
        let old_value = self.brush.borrow().clone();
        let mut changed = false;
        if old_value.differs(&value) {
            ServerSpriteVisualHooks::on_brush_changing(host);
            changed = true;
        }
        host.set_value(
            Self::id_of_brush_property().base(),
            ServerValueChange {
                equal: old_value.default_equals(&value),
                old_resource: old_value.as_server_render_resource(),
                new_resource: value.as_server_render_resource(),
                assign: &mut || *self.brush.borrow_mut() = value.clone(),
            },
        );
        if changed {
            ServerSpriteVisualHooks::on_brush_changed(host);
        }
    }

    /// The composition property of `Shadow`.
    pub fn id_of_shadow_property() -> &'static CompositionPropertyOf<Option<Rc<dyn IServerObject>>> {
        static PROPERTY: OnceLock<CompositionPropertyOf<Option<Rc<dyn IServerObject>>>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerSpriteVisualProps, Option<Rc<dyn IServerObject>>>(
                "Shadow",
                "ServerSpriteVisual",
                |obj| props_of::<ServerSpriteVisualProps>(obj).shadow.borrow().clone(),
                |obj, v| *props_of::<ServerSpriteVisualProps>(obj).shadow.borrow_mut() = v,
                None,
                None,
            )
        })
    }

    /// `Shadow`.
    pub fn shadow(&self) -> Option<Rc<dyn IServerObject>> {
        self.shadow.borrow().clone()
    }

    pub fn set_shadow(&self, host: &dyn ServerSpriteVisualHooks, value: Option<Rc<dyn IServerObject>>) {
        let old_value = self.shadow.borrow().clone();
        let mut changed = false;
        if old_value.differs(&value) {
            ServerSpriteVisualHooks::on_shadow_changing(host);
            changed = true;
        }
        host.set_value(
            Self::id_of_shadow_property().base(),
            ServerValueChange {
                equal: old_value.default_equals(&value),
                old_resource: old_value.as_server_render_resource(),
                new_resource: value.as_server_render_resource(),
                assign: &mut || *self.shadow.borrow_mut() = value.clone(),
            },
        );
        if changed {
            ServerSpriteVisualHooks::on_shadow_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 ServerSpriteVisualHooks,
        reader: &mut BatchStreamReader<'_>,
        committed_at: Duration,
    ) {
        let compositor = host.server_compositor();
        ServerSpriteVisualHooks::base_deserialize_changes_core(host, reader, committed_at);
        ServerSpriteVisualHooks::deserialize_changes_extra(host, reader);
        let changed = reader.read::<SpriteVisualChangedFields>();
        if changed.contains(SpriteVisualChangedFields::BRUSH) {
            let value = read_server_object(reader, compositor.as_ref());
            self.set_brush(host, value);
        }
        if changed.contains(SpriteVisualChangedFields::SHADOW) {
            let value = read_server_object(reader, compositor.as_ref());
            self.set_shadow(host, value);
        }
        ServerSpriteVisualHooks::on_fields_deserialized(host, changed);
    }
}