ferroui-base 0.2.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

//! `CompositionSimpleBrush` (server only).
//!
//! Schema attributes: internal.

use bitflags::bitflags;
use crate::RelativePoint;
use crate::media::ITransform;
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::IServerPropertyHost;
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 `CompositionSimpleBrush` that changed since its last serialization.
    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
    pub struct CompositionSimpleBrushChangedFields: u8 {
        const OPACITY = 1;
        const TRANSFORM_ORIGIN = 2;
        const TRANSFORM = 4;
        const RELATIVE_TRANSFORM = 8;
    }
}

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

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

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

    fn on_opacity_changed(&self) {}
    fn on_opacity_changing(&self) {}

    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 `ServerCompositionSimpleBrush`.
pub struct ServerCompositionSimpleBrushProps {
    opacity: Cell<f64>,
    transform_origin: Cell<RelativePoint>,
    transform: RefCell<Option<ServerResourceRef<dyn ITransform>>>,
    relative_transform: RefCell<Option<ServerResourceRef<dyn ITransform>>>,
}

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

impl ServerCompositionSimpleBrushProps {
    /// 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::<ServerCompositionSimpleBrushProps, f64>(
                "Opacity",
                "ServerCompositionSimpleBrush",
                |obj| props_of::<ServerCompositionSimpleBrushProps>(obj).opacity.get(),
                |obj, v| props_of::<ServerCompositionSimpleBrushProps>(obj).opacity.set(v),
                Some(|obj| ExpressionVariant::create(props_of::<ServerCompositionSimpleBrushProps>(obj).opacity.get())),
                None,
            )
        })
    }

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

    pub fn set_opacity(&self, host: &dyn ServerCompositionSimpleBrushHooks, value: f64) {
        let old_value = self.opacity.get();
        let mut changed = false;
        if old_value.differs(&value) {
            ServerCompositionSimpleBrushHooks::on_opacity_changing(host);
            changed = true;
        }
        host.set_value(
            Self::id_of_opacity_property().base(),
            ServerValueChange {
                equal: old_value.default_equals(&value),
                old_resource: None,
                new_resource: None,
                assign: &mut || self.opacity.set(value),
            },
        );
        if changed {
            ServerCompositionSimpleBrushHooks::on_opacity_changed(host);
        }
    }

    /// 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::<ServerCompositionSimpleBrushProps, RelativePoint>(
                "TransformOrigin",
                "ServerCompositionSimpleBrush",
                |obj| props_of::<ServerCompositionSimpleBrushProps>(obj).transform_origin.get(),
                |obj, v| props_of::<ServerCompositionSimpleBrushProps>(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 ServerCompositionSimpleBrushHooks, value: RelativePoint) {
        let old_value = self.transform_origin.get();
        let mut changed = false;
        if old_value.differs(&value) {
            ServerCompositionSimpleBrushHooks::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 {
            ServerCompositionSimpleBrushHooks::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::<ServerCompositionSimpleBrushProps, Option<ServerResourceRef<dyn ITransform>>>(
                "Transform",
                "ServerCompositionSimpleBrush",
                |obj| props_of::<ServerCompositionSimpleBrushProps>(obj).transform.borrow().clone(),
                |obj, v| *props_of::<ServerCompositionSimpleBrushProps>(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 ServerCompositionSimpleBrushHooks, value: Option<ServerResourceRef<dyn ITransform>>) {
        let old_value = self.transform.borrow().clone();
        let mut changed = false;
        if old_value.differs(&value) {
            ServerCompositionSimpleBrushHooks::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 {
            ServerCompositionSimpleBrushHooks::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::<ServerCompositionSimpleBrushProps, Option<ServerResourceRef<dyn ITransform>>>(
                "RelativeTransform",
                "ServerCompositionSimpleBrush",
                |obj| props_of::<ServerCompositionSimpleBrushProps>(obj).relative_transform.borrow().clone(),
                |obj, v| *props_of::<ServerCompositionSimpleBrushProps>(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 ServerCompositionSimpleBrushHooks, value: Option<ServerResourceRef<dyn ITransform>>) {
        let old_value = self.relative_transform.borrow().clone();
        let mut changed = false;
        if old_value.differs(&value) {
            ServerCompositionSimpleBrushHooks::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 {
            ServerCompositionSimpleBrushHooks::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 ServerCompositionSimpleBrushHooks,
        reader: &mut BatchStreamReader<'_>,
        _committed_at: Duration,
    ) {
        let compositor = host.server_compositor();
        ServerCompositionSimpleBrushHooks::deserialize_changes_extra(host, reader);
        let changed = reader.read::<CompositionSimpleBrushChangedFields>();
        if changed.contains(CompositionSimpleBrushChangedFields::OPACITY) {
            let value = reader.read::<f64>();
            self.set_opacity(host, value);
        }
        if changed.contains(CompositionSimpleBrushChangedFields::TRANSFORM_ORIGIN) {
            let value = reader.read::<RelativePoint>();
            self.set_transform_origin(host, value);
        }
        if changed.contains(CompositionSimpleBrushChangedFields::TRANSFORM) {
            let value = read_resource(reader, compositor.as_ref(), |o| o.as_transform());
            self.set_transform(host, value);
        }
        if changed.contains(CompositionSimpleBrushChangedFields::RELATIVE_TRANSFORM) {
            let value = read_resource(reader, compositor.as_ref(), |o| o.as_transform());
            self.set_relative_transform(host, value);
        }
        ServerCompositionSimpleBrushHooks::on_fields_deserialized(host, changed);
    }

    /// Writes every property of the class, in the form
    /// [`deserialize_changes_core`](Self::deserialize_changes_core) reads.
    pub fn serialize_all_changes(
        writer: &mut BatchStreamWriter<'_>,
        opacity: f64,
        transform_origin: RelativePoint,
        transform: Option<BatchResource<dyn ITransform>>,
        relative_transform: Option<BatchResource<dyn ITransform>>,
    ) {
        writer.write(CompositionSimpleBrushChangedFields::OPACITY | CompositionSimpleBrushChangedFields::TRANSFORM_ORIGIN | CompositionSimpleBrushChangedFields::TRANSFORM | CompositionSimpleBrushChangedFields::RELATIVE_TRANSFORM);
        writer.write(opacity);
        writer.write(transform_origin);
        writer.write_resource(transform);
        writer.write_resource(relative_transform);
    }
}