ferroui-base 0.4.0

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

//! `CompositionGeometry`.
//!
//! Defined by the FerroUI overlay (scripts/composition-schema-winui.xml).
//!
//! Schema attributes: abstract.

use bitflags::bitflags;
use crate::rendering::composition::ICompositionObjectHost;
use crate::rendering::composition::animations::AnimationInstanceFactory;
use crate::rendering::composition::animations::ICompositionAnimation;
use crate::rendering::composition::expressions::ExpressionVariant;
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::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 `CompositionGeometry` that changed since its last serialization.
    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
    pub struct CompositionGeometryChangedFields: u8 {
        const TRIM_END = 1;
        const TRIM_END_ANIMATED = 2;
        const TRIM_OFFSET = 4;
        const TRIM_OFFSET_ANIMATED = 8;
        const TRIM_START = 16;
        const TRIM_START_ANIMATED = 32;
    }
}

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

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

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

    fn validate_trim_end_change(&self, _old_value: f32, _new_value: f32) {}
    fn on_trim_end_changed(&self) {}
    fn on_trim_end_changing(&self) {}

    fn validate_trim_offset_change(&self, _old_value: f32, _new_value: f32) {}
    fn on_trim_offset_changed(&self) {}
    fn on_trim_offset_changing(&self) {}

    fn validate_trim_start_change(&self, _old_value: f32, _new_value: f32) {}
    fn on_trim_start_changed(&self) {}
    fn on_trim_start_changing(&self) {}
}

/// The UI-thread properties of `CompositionGeometry`.
pub struct CompositionGeometryProps {
    changed_fields_of_composition_geometry: Cell<CompositionGeometryChangedFields>,
    trim_end: Cell<f32>,
    trim_offset: Cell<f32>,
    trim_start: Cell<f32>,
}

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

impl CompositionGeometryProps {
    /// 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_geometry: Cell::new(CompositionGeometryChangedFields::empty()),
            trim_end: Cell::new(Default::default()),
            trim_offset: Cell::new(Default::default()),
            trim_start: 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 CompositionGeometryHooks) {
        self.initialize_own_defaults(host);
    }

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

    /// `TrimEnd` (animated, default `1.0`, FerroUI overlay).
    pub fn trim_end(&self) -> f32 {
        self.trim_end.get()
    }

    /// Sets `TrimEnd` (animated, default `1.0`, FerroUI overlay).
    pub fn set_trim_end(&self, host: &dyn CompositionGeometryHooks, value: f32) {
        let mut changed = false;
        let old_value = self.trim_end.get();
        if old_value.differs(&value) {
            CompositionGeometryHooks::validate_trim_end_change(host, old_value, value);
            CompositionGeometryHooks::on_trim_end_changing(host);
            changed = true;
            // Update the backing value
            self.trim_end.set(value);
            // Register object for serialization in the next batch
            self.changed_fields_of_composition_geometry.set(self.changed_fields_of_composition_geometry.get() | CompositionGeometryChangedFields::TRIM_END);
            host.register_for_serialization();
            // Reset previous animation if any
            host.pending_animations().remove(ServerCompositionGeometryProps::id_of_trim_end_property().base());
            self.changed_fields_of_composition_geometry.set(self.changed_fields_of_composition_geometry.get() & !CompositionGeometryChangedFields::TRIM_END_ANIMATED);
            // Check for implicit animations
            if let Some(animation) = host.implicit_animation("TrimEnd") {
                // Animation affects only current property
                if let Some(a) = animation.as_composition_animation() {
                    self.changed_fields_of_composition_geometry.set(self.changed_fields_of_composition_geometry.get() | CompositionGeometryChangedFields::TRIM_END_ANIMATED);
                    host.pending_animations().set(
                        ServerCompositionGeometryProps::id_of_trim_end_property().base(),
                        a.create_instance(host.server(), Some(ExpressionVariant::create(value))),
                    );
                }
                // Animation is triggered by the current field, but does not necessary affects it
                host.start_animation_group(&animation, "TrimEnd", ExpressionVariant::create(value));
            }
        }
        self.trim_end.set(value);
        if changed {
            CompositionGeometryHooks::on_trim_end_changed(host);
        }
    }

    /// `TrimOffset` (animated, FerroUI overlay).
    pub fn trim_offset(&self) -> f32 {
        self.trim_offset.get()
    }

    /// Sets `TrimOffset` (animated, FerroUI overlay).
    pub fn set_trim_offset(&self, host: &dyn CompositionGeometryHooks, value: f32) {
        let mut changed = false;
        let old_value = self.trim_offset.get();
        if old_value.differs(&value) {
            CompositionGeometryHooks::validate_trim_offset_change(host, old_value, value);
            CompositionGeometryHooks::on_trim_offset_changing(host);
            changed = true;
            // Update the backing value
            self.trim_offset.set(value);
            // Register object for serialization in the next batch
            self.changed_fields_of_composition_geometry.set(self.changed_fields_of_composition_geometry.get() | CompositionGeometryChangedFields::TRIM_OFFSET);
            host.register_for_serialization();
            // Reset previous animation if any
            host.pending_animations().remove(ServerCompositionGeometryProps::id_of_trim_offset_property().base());
            self.changed_fields_of_composition_geometry.set(self.changed_fields_of_composition_geometry.get() & !CompositionGeometryChangedFields::TRIM_OFFSET_ANIMATED);
            // Check for implicit animations
            if let Some(animation) = host.implicit_animation("TrimOffset") {
                // Animation affects only current property
                if let Some(a) = animation.as_composition_animation() {
                    self.changed_fields_of_composition_geometry.set(self.changed_fields_of_composition_geometry.get() | CompositionGeometryChangedFields::TRIM_OFFSET_ANIMATED);
                    host.pending_animations().set(
                        ServerCompositionGeometryProps::id_of_trim_offset_property().base(),
                        a.create_instance(host.server(), Some(ExpressionVariant::create(value))),
                    );
                }
                // Animation is triggered by the current field, but does not necessary affects it
                host.start_animation_group(&animation, "TrimOffset", ExpressionVariant::create(value));
            }
        }
        self.trim_offset.set(value);
        if changed {
            CompositionGeometryHooks::on_trim_offset_changed(host);
        }
    }

    /// `TrimStart` (animated, FerroUI overlay).
    pub fn trim_start(&self) -> f32 {
        self.trim_start.get()
    }

    /// Sets `TrimStart` (animated, FerroUI overlay).
    pub fn set_trim_start(&self, host: &dyn CompositionGeometryHooks, value: f32) {
        let mut changed = false;
        let old_value = self.trim_start.get();
        if old_value.differs(&value) {
            CompositionGeometryHooks::validate_trim_start_change(host, old_value, value);
            CompositionGeometryHooks::on_trim_start_changing(host);
            changed = true;
            // Update the backing value
            self.trim_start.set(value);
            // Register object for serialization in the next batch
            self.changed_fields_of_composition_geometry.set(self.changed_fields_of_composition_geometry.get() | CompositionGeometryChangedFields::TRIM_START);
            host.register_for_serialization();
            // Reset previous animation if any
            host.pending_animations().remove(ServerCompositionGeometryProps::id_of_trim_start_property().base());
            self.changed_fields_of_composition_geometry.set(self.changed_fields_of_composition_geometry.get() & !CompositionGeometryChangedFields::TRIM_START_ANIMATED);
            // Check for implicit animations
            if let Some(animation) = host.implicit_animation("TrimStart") {
                // Animation affects only current property
                if let Some(a) = animation.as_composition_animation() {
                    self.changed_fields_of_composition_geometry.set(self.changed_fields_of_composition_geometry.get() | CompositionGeometryChangedFields::TRIM_START_ANIMATED);
                    host.pending_animations().set(
                        ServerCompositionGeometryProps::id_of_trim_start_property().base(),
                        a.create_instance(host.server(), Some(ExpressionVariant::create(value))),
                    );
                }
                // Animation is triggered by the current field, but does not necessary affects it
                host.start_animation_group(&animation, "TrimStart", ExpressionVariant::create(value));
            }
        }
        self.trim_start.set(value);
        if changed {
            CompositionGeometryHooks::on_trim_start_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 CompositionGeometryHooks,
        property_name: &str,
        animation: &dyn ICompositionAnimation,
        final_value: Option<ExpressionVariant>,
    ) -> bool {
        if property_name == "TrimEnd" {
            let server = animation.create_instance(host.server(), final_value);
            host.pending_animations().set(ServerCompositionGeometryProps::id_of_trim_end_property().base(), server);
            self.changed_fields_of_composition_geometry.set(self.changed_fields_of_composition_geometry.get() | CompositionGeometryChangedFields::TRIM_END_ANIMATED);
            host.register_for_serialization();
            return true;
        }
        if property_name == "TrimOffset" {
            let server = animation.create_instance(host.server(), final_value);
            host.pending_animations().set(ServerCompositionGeometryProps::id_of_trim_offset_property().base(), server);
            self.changed_fields_of_composition_geometry.set(self.changed_fields_of_composition_geometry.get() | CompositionGeometryChangedFields::TRIM_OFFSET_ANIMATED);
            host.register_for_serialization();
            return true;
        }
        if property_name == "TrimStart" {
            let server = animation.create_instance(host.server(), final_value);
            host.pending_animations().set(ServerCompositionGeometryProps::id_of_trim_start_property().base(), server);
            self.changed_fields_of_composition_geometry.set(self.changed_fields_of_composition_geometry.get() | CompositionGeometryChangedFields::TRIM_START_ANIMATED);
            host.register_for_serialization();
            return true;
        }
        false
    }

    /// 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 CompositionGeometryHooks, writer: &mut BatchStreamWriter<'_>) {
        let changed = self.changed_fields_of_composition_geometry.get();
        writer.write(changed);
        if changed.contains(CompositionGeometryChangedFields::TRIM_END_ANIMATED) {
            writer.write_value(host.pending_animations().get_and_remove(ServerCompositionGeometryProps::id_of_trim_end_property().base()));
        } else if changed.contains(CompositionGeometryChangedFields::TRIM_END) {
            writer.write(self.trim_end.get());
        }
        if changed.contains(CompositionGeometryChangedFields::TRIM_OFFSET_ANIMATED) {
            writer.write_value(host.pending_animations().get_and_remove(ServerCompositionGeometryProps::id_of_trim_offset_property().base()));
        } else if changed.contains(CompositionGeometryChangedFields::TRIM_OFFSET) {
            writer.write(self.trim_offset.get());
        }
        if changed.contains(CompositionGeometryChangedFields::TRIM_START_ANIMATED) {
            writer.write_value(host.pending_animations().get_and_remove(ServerCompositionGeometryProps::id_of_trim_start_property().base()));
        } else if changed.contains(CompositionGeometryChangedFields::TRIM_START) {
            writer.write(self.trim_start.get());
        }
        self.changed_fields_of_composition_geometry.set(CompositionGeometryChangedFields::empty());
    }
}

/// The partial methods of `ServerCompositionGeometry`: implemented by the class that embeds
/// [`ServerCompositionGeometryProps`]. Every hook defaults to doing nothing.
pub trait ServerCompositionGeometryHooks: IServerAnimatedPropertyHost {
    fn deserialize_changes_extra(&self, _reader: &mut BatchStreamReader<'_>) {}
    fn on_fields_deserialized(&self, _changed: CompositionGeometryChangedFields) {}
}

/// The server-side properties of `ServerCompositionGeometry`.
pub struct ServerCompositionGeometryProps {
    trim_end: Cell<f32>,
    trim_offset: Cell<f32>,
    trim_start: Cell<f32>,
}

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

impl ServerCompositionGeometryProps {
    /// 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 {
            trim_end: Cell::new(Default::default()),
            trim_offset: Cell::new(Default::default()),
            trim_start: 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 `TrimEnd`.
    pub fn id_of_trim_end_property() -> &'static CompositionPropertyOf<f32> {
        static PROPERTY: OnceLock<CompositionPropertyOf<f32>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerCompositionGeometryProps, f32>(
                "TrimEnd",
                "ServerCompositionGeometry",
                |obj| props_of::<ServerCompositionGeometryProps>(obj).trim_end.get(),
                |obj, v| props_of::<ServerCompositionGeometryProps>(obj).trim_end.set(v),
                Some(|obj| ExpressionVariant::create(props_of::<ServerCompositionGeometryProps>(obj).trim_end.get())),
                Some(|obj, v: ExpressionVariant| props_of::<ServerCompositionGeometryProps>(obj).trim_end.set(v.cast_or_default::<f32>())),
            )
        })
    }

    /// `TrimEnd` (animated).
    pub fn trim_end(&self) -> f32 {
        self.trim_end.get()
    }

    pub fn set_trim_end(&self, host: &dyn ServerCompositionGeometryHooks, value: f32) {
        self.trim_end.set(value);
        host.remove_animation_for_property(Self::id_of_trim_end_property().base());
    }

    /// The composition property of `TrimOffset`.
    pub fn id_of_trim_offset_property() -> &'static CompositionPropertyOf<f32> {
        static PROPERTY: OnceLock<CompositionPropertyOf<f32>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerCompositionGeometryProps, f32>(
                "TrimOffset",
                "ServerCompositionGeometry",
                |obj| props_of::<ServerCompositionGeometryProps>(obj).trim_offset.get(),
                |obj, v| props_of::<ServerCompositionGeometryProps>(obj).trim_offset.set(v),
                Some(|obj| ExpressionVariant::create(props_of::<ServerCompositionGeometryProps>(obj).trim_offset.get())),
                Some(|obj, v: ExpressionVariant| props_of::<ServerCompositionGeometryProps>(obj).trim_offset.set(v.cast_or_default::<f32>())),
            )
        })
    }

    /// `TrimOffset` (animated).
    pub fn trim_offset(&self) -> f32 {
        self.trim_offset.get()
    }

    pub fn set_trim_offset(&self, host: &dyn ServerCompositionGeometryHooks, value: f32) {
        self.trim_offset.set(value);
        host.remove_animation_for_property(Self::id_of_trim_offset_property().base());
    }

    /// The composition property of `TrimStart`.
    pub fn id_of_trim_start_property() -> &'static CompositionPropertyOf<f32> {
        static PROPERTY: OnceLock<CompositionPropertyOf<f32>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerCompositionGeometryProps, f32>(
                "TrimStart",
                "ServerCompositionGeometry",
                |obj| props_of::<ServerCompositionGeometryProps>(obj).trim_start.get(),
                |obj, v| props_of::<ServerCompositionGeometryProps>(obj).trim_start.set(v),
                Some(|obj| ExpressionVariant::create(props_of::<ServerCompositionGeometryProps>(obj).trim_start.get())),
                Some(|obj, v: ExpressionVariant| props_of::<ServerCompositionGeometryProps>(obj).trim_start.set(v.cast_or_default::<f32>())),
            )
        })
    }

    /// `TrimStart` (animated).
    pub fn trim_start(&self) -> f32 {
        self.trim_start.get()
    }

    pub fn set_trim_start(&self, host: &dyn ServerCompositionGeometryHooks, value: f32) {
        self.trim_start.set(value);
        host.remove_animation_for_property(Self::id_of_trim_start_property().base());
    }

    /// 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 ServerCompositionGeometryHooks,
        reader: &mut BatchStreamReader<'_>,
        committed_at: Duration,
    ) {
        ServerCompositionGeometryHooks::deserialize_changes_extra(host, reader);
        let changed = reader.read::<CompositionGeometryChangedFields>();
        if changed.contains(CompositionGeometryChangedFields::TRIM_END_ANIMATED) {
            let Some(animation) = reader.read_value::<AnimationInstanceFactory>().map(AnimationInstanceFactory::create) else {
                panic!("a batch starts an animation of `TrimEnd` without an animation instance");
            };
            host.set_animated_value(
                Self::id_of_trim_end_property().base(),
                ExpressionVariant::create(self.trim_end.get()),
                committed_at,
                animation,
            );
        } else if changed.contains(CompositionGeometryChangedFields::TRIM_END) {
            let value = reader.read::<f32>();
            self.set_trim_end(host, value);
        }
        if changed.contains(CompositionGeometryChangedFields::TRIM_OFFSET_ANIMATED) {
            let Some(animation) = reader.read_value::<AnimationInstanceFactory>().map(AnimationInstanceFactory::create) else {
                panic!("a batch starts an animation of `TrimOffset` without an animation instance");
            };
            host.set_animated_value(
                Self::id_of_trim_offset_property().base(),
                ExpressionVariant::create(self.trim_offset.get()),
                committed_at,
                animation,
            );
        } else if changed.contains(CompositionGeometryChangedFields::TRIM_OFFSET) {
            let value = reader.read::<f32>();
            self.set_trim_offset(host, value);
        }
        if changed.contains(CompositionGeometryChangedFields::TRIM_START_ANIMATED) {
            let Some(animation) = reader.read_value::<AnimationInstanceFactory>().map(AnimationInstanceFactory::create) else {
                panic!("a batch starts an animation of `TrimStart` without an animation instance");
            };
            host.set_animated_value(
                Self::id_of_trim_start_property().base(),
                ExpressionVariant::create(self.trim_start.get()),
                committed_at,
                animation,
            );
        } else if changed.contains(CompositionGeometryChangedFields::TRIM_START) {
            let value = reader.read::<f32>();
            self.set_trim_start(host, value);
        }
        ServerCompositionGeometryHooks::on_fields_deserialized(host, changed);
    }

    /// The composition property with the given name, among the properties
    /// of this class and of its generated bases that have a variant form.
    pub fn get_composition_property(name: &str) -> Option<&'static CompositionProperty> {
        if name == "TrimEnd" {
            return Some(Self::id_of_trim_end_property().base());
        }
        if name == "TrimOffset" {
            return Some(Self::id_of_trim_offset_property().base());
        }
        if name == "TrimStart" {
            return Some(Self::id_of_trim_start_property().base());
        }
        None
    }
}