ferroui-base 0.3.0

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

//! `CompositionBrush`.

use bitflags::bitflags;
use crate::RelativePoint;
use crate::media::ITransform;
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::AsServerRenderResource;
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::ServerResourceRef;
use crate::rendering::composition::server::ServerValueChange;
use crate::rendering::composition::server::props_of;
use crate::rendering::composition::server::read_resource;
use crate::rendering::composition::transport::BatchResource;
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::sync::OnceLock;
use std::time::Duration;

bitflags! {
    /// The fields of `CompositionBrush` that changed since its last serialization.
    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
    pub struct CompositionBrushChangedFields: u8 {
        const OPACITY = 1;
        const OPACITY_ANIMATED = 2;
        const TRANSFORM_ORIGIN = 4;
        const TRANSFORM = 8;
        const RELATIVE_TRANSFORM = 16;
    }
}

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

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

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

    fn validate_opacity_change(&self, _old_value: f64, _new_value: f64) {}
    fn on_opacity_changed(&self) {}
    fn on_opacity_changing(&self) {}

    fn validate_transform_origin_change(&self, _old_value: RelativePoint, _new_value: RelativePoint) {}
    fn on_transform_origin_changed(&self) {}
    fn on_transform_origin_changing(&self) {}

    fn validate_transform_change(&self, _old_value: &Option<BatchResource<dyn ITransform>>, _new_value: &Option<BatchResource<dyn ITransform>>) {}
    fn on_transform_changed(&self) {}
    fn on_transform_changing(&self) {}

    fn validate_relative_transform_change(&self, _old_value: &Option<BatchResource<dyn ITransform>>, _new_value: &Option<BatchResource<dyn ITransform>>) {}
    fn on_relative_transform_changed(&self) {}
    fn on_relative_transform_changing(&self) {}
}

/// The UI-thread properties of `CompositionBrush`.
pub struct CompositionBrushProps {
    changed_fields_of_composition_brush: Cell<CompositionBrushChangedFields>,
    opacity: Cell<f64>,
    transform_origin: Cell<RelativePoint>,
    transform: RefCell<Option<BatchResource<dyn ITransform>>>,
    relative_transform: RefCell<Option<BatchResource<dyn ITransform>>>,
}

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

impl CompositionBrushProps {
    /// 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_brush: Cell::new(CompositionBrushChangedFields::empty()),
            opacity: Cell::new(Default::default()),
            transform_origin: Cell::new(Default::default()),
            transform: RefCell::new(None),
            relative_transform: RefCell::new(None),
        }
    }

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

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

    /// `Opacity` (animated, default `1.0`).
    pub fn opacity(&self) -> f64 {
        self.opacity.get()
    }

    /// Sets `Opacity` (animated, default `1.0`).
    pub fn set_opacity(&self, host: &dyn CompositionBrushHooks, value: f64) {
        let mut changed = false;
        let old_value = self.opacity.get();
        if old_value.differs(&value) {
            CompositionBrushHooks::validate_opacity_change(host, old_value, value);
            CompositionBrushHooks::on_opacity_changing(host);
            changed = true;
            // Update the backing value
            self.opacity.set(value);
            // Register object for serialization in the next batch
            self.changed_fields_of_composition_brush.set(self.changed_fields_of_composition_brush.get() | CompositionBrushChangedFields::OPACITY);
            host.register_for_serialization();
            // Reset previous animation if any
            host.pending_animations().remove(ServerCompositionBrushProps::id_of_opacity_property().base());
            self.changed_fields_of_composition_brush.set(self.changed_fields_of_composition_brush.get() & !CompositionBrushChangedFields::OPACITY_ANIMATED);
            // Check for implicit animations
            if let Some(animation) = host.implicit_animation("Opacity") {
                // Animation affects only current property
                if let Some(a) = animation.as_composition_animation() {
                    self.changed_fields_of_composition_brush.set(self.changed_fields_of_composition_brush.get() | CompositionBrushChangedFields::OPACITY_ANIMATED);
                    host.pending_animations().set(
                        ServerCompositionBrushProps::id_of_opacity_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, "Opacity", ExpressionVariant::create(value));
            }
        }
        self.opacity.set(value);
        if changed {
            CompositionBrushHooks::on_opacity_changed(host);
        }
    }

    /// `TransformOrigin`.
    pub fn transform_origin(&self) -> RelativePoint {
        self.transform_origin.get()
    }

    /// Sets `TransformOrigin`.
    pub fn set_transform_origin(&self, host: &dyn CompositionBrushHooks, value: RelativePoint) {
        let mut changed = false;
        let old_value = self.transform_origin.get();
        if old_value.differs(&value) {
            CompositionBrushHooks::validate_transform_origin_change(host, old_value, value);
            CompositionBrushHooks::on_transform_origin_changing(host);
            changed = true;
            // Update the backing value
            self.transform_origin.set(value);
            // Register object for serialization in the next batch
            self.changed_fields_of_composition_brush.set(self.changed_fields_of_composition_brush.get() | CompositionBrushChangedFields::TRANSFORM_ORIGIN);
            host.register_for_serialization();
        }
        self.transform_origin.set(value);
        if changed {
            CompositionBrushHooks::on_transform_origin_changed(host);
        }
    }

    /// `Transform`.
    pub fn transform(&self) -> Option<BatchResource<dyn ITransform>> {
        self.transform.borrow().clone()
    }

    /// Sets `Transform`.
    pub fn set_transform(&self, host: &dyn CompositionBrushHooks, value: Option<BatchResource<dyn ITransform>>) {
        let mut changed = false;
        let old_value = self.transform.borrow().clone();
        if old_value.differs(&value) {
            CompositionBrushHooks::validate_transform_change(host, &old_value, &value);
            CompositionBrushHooks::on_transform_changing(host);
            changed = true;
            // Update the backing value
            *self.transform.borrow_mut() = value.clone();
            // Register object for serialization in the next batch
            self.changed_fields_of_composition_brush.set(self.changed_fields_of_composition_brush.get() | CompositionBrushChangedFields::TRANSFORM);
            host.register_for_serialization();
        }
        *self.transform.borrow_mut() = value;
        if changed {
            CompositionBrushHooks::on_transform_changed(host);
        }
    }

    /// `RelativeTransform`.
    pub fn relative_transform(&self) -> Option<BatchResource<dyn ITransform>> {
        self.relative_transform.borrow().clone()
    }

    /// Sets `RelativeTransform`.
    pub fn set_relative_transform(&self, host: &dyn CompositionBrushHooks, value: Option<BatchResource<dyn ITransform>>) {
        let mut changed = false;
        let old_value = self.relative_transform.borrow().clone();
        if old_value.differs(&value) {
            CompositionBrushHooks::validate_relative_transform_change(host, &old_value, &value);
            CompositionBrushHooks::on_relative_transform_changing(host);
            changed = true;
            // Update the backing value
            *self.relative_transform.borrow_mut() = value.clone();
            // Register object for serialization in the next batch
            self.changed_fields_of_composition_brush.set(self.changed_fields_of_composition_brush.get() | CompositionBrushChangedFields::RELATIVE_TRANSFORM);
            host.register_for_serialization();
        }
        *self.relative_transform.borrow_mut() = value;
        if changed {
            CompositionBrushHooks::on_relative_transform_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 CompositionBrushHooks,
        property_name: &str,
        animation: &dyn ICompositionAnimation,
        final_value: Option<ExpressionVariant>,
    ) -> bool {
        if property_name == "Opacity" {
            let server = animation.create_instance(host.server(), final_value);
            host.pending_animations().set(ServerCompositionBrushProps::id_of_opacity_property().base(), server);
            self.changed_fields_of_composition_brush.set(self.changed_fields_of_composition_brush.get() | CompositionBrushChangedFields::OPACITY_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 CompositionBrushHooks, writer: &mut BatchStreamWriter<'_>) {
        let changed = self.changed_fields_of_composition_brush.get();
        writer.write(changed);
        if changed.contains(CompositionBrushChangedFields::OPACITY_ANIMATED) {
            writer.write_value(host.pending_animations().get_and_remove(ServerCompositionBrushProps::id_of_opacity_property().base()));
        } else if changed.contains(CompositionBrushChangedFields::OPACITY) {
            writer.write(self.opacity.get());
        }
        if changed.contains(CompositionBrushChangedFields::TRANSFORM_ORIGIN) {
            writer.write(self.transform_origin.get());
        }
        if changed.contains(CompositionBrushChangedFields::TRANSFORM) {
            writer.write_resource(self.transform.borrow().clone());
        }
        if changed.contains(CompositionBrushChangedFields::RELATIVE_TRANSFORM) {
            writer.write_resource(self.relative_transform.borrow().clone());
        }
        self.changed_fields_of_composition_brush.set(CompositionBrushChangedFields::empty());
    }
}

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

    fn on_transform_origin_changed(&self) {}
    fn on_transform_origin_changing(&self) {}

    fn on_transform_changed(&self) {}
    fn on_transform_changing(&self) {}

    fn on_relative_transform_changed(&self) {}
    fn on_relative_transform_changing(&self) {}
}

/// The server-side properties of `ServerCompositionBrush`.
pub struct ServerCompositionBrushProps {
    opacity: Cell<f64>,
    transform_origin: Cell<RelativePoint>,
    transform: RefCell<Option<ServerResourceRef<dyn ITransform>>>,
    relative_transform: RefCell<Option<ServerResourceRef<dyn ITransform>>>,
}

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

impl ServerCompositionBrushProps {
    /// 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 {
            opacity: Cell::new(Default::default()),
            transform_origin: Cell::new(Default::default()),
            transform: RefCell::new(None),
            relative_transform: 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 `Opacity`.
    pub fn id_of_opacity_property() -> &'static CompositionPropertyOf<f64> {
        static PROPERTY: OnceLock<CompositionPropertyOf<f64>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerCompositionBrushProps, f64>(
                "Opacity",
                "ServerCompositionBrush",
                |obj| props_of::<ServerCompositionBrushProps>(obj).opacity.get(),
                |obj, v| props_of::<ServerCompositionBrushProps>(obj).opacity.set(v),
                Some(|obj| ExpressionVariant::create(props_of::<ServerCompositionBrushProps>(obj).opacity.get())),
                Some(|obj, v: ExpressionVariant| props_of::<ServerCompositionBrushProps>(obj).opacity.set(v.cast_or_default::<f64>())),
            )
        })
    }

    /// `Opacity` (animated).
    pub fn opacity(&self) -> f64 {
        self.opacity.get()
    }

    pub fn set_opacity(&self, host: &dyn ServerCompositionBrushHooks, value: f64) {
        self.opacity.set(value);
        host.remove_animation_for_property(Self::id_of_opacity_property().base());
    }

    /// The composition property of `TransformOrigin`.
    pub fn id_of_transform_origin_property() -> &'static CompositionPropertyOf<RelativePoint> {
        static PROPERTY: OnceLock<CompositionPropertyOf<RelativePoint>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerCompositionBrushProps, RelativePoint>(
                "TransformOrigin",
                "ServerCompositionBrush",
                |obj| props_of::<ServerCompositionBrushProps>(obj).transform_origin.get(),
                |obj, v| props_of::<ServerCompositionBrushProps>(obj).transform_origin.set(v),
                None,
                None,
            )
        })
    }

    /// `TransformOrigin`.
    pub fn transform_origin(&self) -> RelativePoint {
        self.transform_origin.get()
    }

    pub fn set_transform_origin(&self, host: &dyn ServerCompositionBrushHooks, value: RelativePoint) {
        let old_value = self.transform_origin.get();
        let mut changed = false;
        if old_value.differs(&value) {
            ServerCompositionBrushHooks::on_transform_origin_changing(host);
            changed = true;
        }
        host.set_value(
            Self::id_of_transform_origin_property().base(),
            ServerValueChange {
                equal: old_value.default_equals(&value),
                old_resource: None,
                new_resource: None,
                assign: &mut || self.transform_origin.set(value),
            },
        );
        if changed {
            ServerCompositionBrushHooks::on_transform_origin_changed(host);
        }
    }

    /// The composition property of `Transform`.
    pub fn id_of_transform_property() -> &'static CompositionPropertyOf<Option<ServerResourceRef<dyn ITransform>>> {
        static PROPERTY: OnceLock<CompositionPropertyOf<Option<ServerResourceRef<dyn ITransform>>>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerCompositionBrushProps, Option<ServerResourceRef<dyn ITransform>>>(
                "Transform",
                "ServerCompositionBrush",
                |obj| props_of::<ServerCompositionBrushProps>(obj).transform.borrow().clone(),
                |obj, v| *props_of::<ServerCompositionBrushProps>(obj).transform.borrow_mut() = v,
                None,
                None,
            )
        })
    }

    /// `Transform`.
    pub fn transform(&self) -> Option<ServerResourceRef<dyn ITransform>> {
        self.transform.borrow().clone()
    }

    pub fn set_transform(&self, host: &dyn ServerCompositionBrushHooks, value: Option<ServerResourceRef<dyn ITransform>>) {
        let old_value = self.transform.borrow().clone();
        let mut changed = false;
        if old_value.differs(&value) {
            ServerCompositionBrushHooks::on_transform_changing(host);
            changed = true;
        }
        host.set_value(
            Self::id_of_transform_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.transform.borrow_mut() = value.clone(),
            },
        );
        if changed {
            ServerCompositionBrushHooks::on_transform_changed(host);
        }
    }

    /// The composition property of `RelativeTransform`.
    pub fn id_of_relative_transform_property() -> &'static CompositionPropertyOf<Option<ServerResourceRef<dyn ITransform>>> {
        static PROPERTY: OnceLock<CompositionPropertyOf<Option<ServerResourceRef<dyn ITransform>>>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerCompositionBrushProps, Option<ServerResourceRef<dyn ITransform>>>(
                "RelativeTransform",
                "ServerCompositionBrush",
                |obj| props_of::<ServerCompositionBrushProps>(obj).relative_transform.borrow().clone(),
                |obj, v| *props_of::<ServerCompositionBrushProps>(obj).relative_transform.borrow_mut() = v,
                None,
                None,
            )
        })
    }

    /// `RelativeTransform`.
    pub fn relative_transform(&self) -> Option<ServerResourceRef<dyn ITransform>> {
        self.relative_transform.borrow().clone()
    }

    pub fn set_relative_transform(&self, host: &dyn ServerCompositionBrushHooks, value: Option<ServerResourceRef<dyn ITransform>>) {
        let old_value = self.relative_transform.borrow().clone();
        let mut changed = false;
        if old_value.differs(&value) {
            ServerCompositionBrushHooks::on_relative_transform_changing(host);
            changed = true;
        }
        host.set_value(
            Self::id_of_relative_transform_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.relative_transform.borrow_mut() = value.clone(),
            },
        );
        if changed {
            ServerCompositionBrushHooks::on_relative_transform_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 ServerCompositionBrushHooks,
        reader: &mut BatchStreamReader<'_>,
        committed_at: Duration,
    ) {
        let compositor = host.server_compositor();
        ServerCompositionBrushHooks::deserialize_changes_extra(host, reader);
        let changed = reader.read::<CompositionBrushChangedFields>();
        if changed.contains(CompositionBrushChangedFields::OPACITY_ANIMATED) {
            let Some(animation) = reader.read_value::<AnimationInstanceFactory>().map(AnimationInstanceFactory::create) else {
                panic!("a batch starts an animation of `Opacity` without an animation instance");
            };
            host.set_animated_value(
                Self::id_of_opacity_property().base(),
                ExpressionVariant::create(self.opacity.get()),
                committed_at,
                animation,
            );
        } else if changed.contains(CompositionBrushChangedFields::OPACITY) {
            let value = reader.read::<f64>();
            self.set_opacity(host, value);
        }
        if changed.contains(CompositionBrushChangedFields::TRANSFORM_ORIGIN) {
            let value = reader.read::<RelativePoint>();
            self.set_transform_origin(host, value);
        }
        if changed.contains(CompositionBrushChangedFields::TRANSFORM) {
            let value = read_resource(reader, compositor.as_ref(), |o| o.as_transform());
            self.set_transform(host, value);
        }
        if changed.contains(CompositionBrushChangedFields::RELATIVE_TRANSFORM) {
            let value = read_resource(reader, compositor.as_ref(), |o| o.as_transform());
            self.set_relative_transform(host, value);
        }
        ServerCompositionBrushHooks::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 == "Opacity" {
            return Some(Self::id_of_opacity_property().base());
        }
        None
    }
}