Struct ServerCompositionPropertySet 

pub struct ServerCompositionPropertySet { /* private fields */ }

The server-side counterpart of a live CompositionPropertySet: its entries, animatable, readable by the expressions that refer to the set.

Not from upstream, whose property sets have no server side: an expression sees a copy of a referenced set taken when its animation starts. WinUI’s property sets are live and their entries can be animated, which the WinUI composition API relies on (the property sets of ElementCompositionPreview, the effect property set of a connected animation, the interaction tracker).

Implementations

impl ServerCompositionPropertySet

pub fn new( compositor: &Rc<ServerCompositor>, ) -> Rc<ServerCompositionPropertySet>

Creates the property set, active: its animations run from the start, as a property set is not part of a tree that activates it.

pub fn get_value(&self, name: &str) -> ExpressionVariant

The current value of an entry, animated or not; the default variant for an entry the set does not have.

pub fn changed(&self) -> &ServerCompositionSurfaceChanged

Raised when an entry of the set changed, by a batch or by an animation (not from upstream; the effect brushes follow the entries that are their animatable properties).

Trait Implementations

impl IAnimatedServerObject for ServerCompositionPropertySet

fn get_composition_property( &self, field_name: &str, ) -> Option<&'static CompositionProperty>

Every name is an entry of a property set; one that was never inserted reads as the default variant, as a missing parameter does.

fn server_object(&self) -> &ServerObject

The embedded ServerObject part.

fn as_server_object_dyn(&self) -> &dyn IServerObject

The object as the base contract (an explicit upcast).

fn read_property_variant( &self, property: &'static CompositionProperty, ) -> ExpressionVariant

Reads a property of the object as a variant. The default reads the field through CompositionProperty::get_variant; an object with dynamic properties (a property set) reads its own storage.

fn write_property_variant( &self, property: &'static CompositionProperty, value: ExpressionVariant, )

Writes a variant into a property of the object without notification (what an animation does with the value it evaluated). The default writes the field through CompositionProperty::set_variant; an object with dynamic properties writes its own storage.

impl IServerAnimatedPropertyHost for ServerCompositionPropertySet

fn set_animated_value( &self, property: &'static CompositionProperty, current_value: ExpressionVariant, committed_at: Duration, animation: Rc<dyn IAnimationInstance>, )

SetAnimatedValue(prop, ref field, committedAt, animation): starts animation on the property. current_value is the value of the field as a variant; the animation writes the field through CompositionProperty::set_variant.

fn remove_animation_for_property(&self, property: &'static CompositionProperty)

The tail of SetAnimatedValue(prop, out field, value): the field has been assigned directly, so the animation of the property, if any, is removed.

fn notify_animated_value_changed(&self, _property: &'static CompositionProperty)

An animation wrote a new value into the field of property.

impl IServerObject for ServerCompositionPropertySet

fn deserialize_changes_core( &self, reader: &mut BatchStreamReader<'_>, committed_at: Duration, )

Reads the changes of the object from a batch.

fn as_animated(self: Rc<Self>) -> Option<Rc<dyn IAnimatedServerObject>>

The object as an animatable object, if it is one.

fn as_any(&self) -> &dyn Any

fn into_any_rc(self: Rc<Self>) -> Rc<dyn Any>

fn values_invalidated(&self)

Called after a group of values of the object changed.

fn deserialize_changes( &self, reader: &mut BatchStreamReader<'_>, committed_at: Duration, )

Applies the changes of the object from a batch.

fn dispose(&self)

Releases the object: it has been disposed on the UI thread.

fn as_render_resource(self: Rc<Self>) -> Option<Rc<dyn IServerRenderResource>>

The object as a render resource, if it is one.

fn as_brush(self: Rc<Self>) -> Option<Rc<dyn IBrush>>

The object as a brush, if it is a server-side brush.

fn as_pen(self: Rc<Self>) -> Option<Rc<dyn IPen>>

The object as a pen, if it is a server-side pen.

fn as_render_data_geometry( self: Rc<Self>, ) -> Option<Rc<dyn IRenderDataGeometry>>

The object as a geometry usable by render data, if it is a server-side geometry.

fn as_transform(self: Rc<Self>) -> Option<Rc<dyn ITransform>>

The object as a transform, if it is a server-side transform.

fn as_gradient_stop(self: Rc<Self>) -> Option<Rc<dyn IGradientStop>>

The object as a gradient stop, if it is a server-side gradient stop.

fn as_surface(self: Rc<Self>) -> Option<Rc<dyn IServerCompositionSurface>>

The object as a composition surface, if it is one.

fn get_props(&self, _type_id: TypeId) -> Option<&dyn Any>

The generated property block of the given type embedded in the object, if it has one. A class that embeds generated properties forwards to their find_props; composition properties locate their fields through it.

impl IServerPropertyHost for ServerCompositionPropertySet

fn server_compositor(&self) -> Option<Rc<ServerCompositor>>

The compositor of the object, while it is alive. Used to resolve the server objects a batch refers to.

fn set_value( &self, property: &'static CompositionProperty, change: ServerValueChange<'_>, )

SetValue(prop, ref field, value) as the class of the object defines it. A plain server object assigns; an animated object also invalidates the subscriptions of the property; a render resource goes through super::ServerRenderResourceCore::set_value.