Struct CompositionPropertySet 

pub struct CompositionPropertySet { /* private fields */ }

Property sets are composition objects that allow storage of key values pairs that can be shared across the application and are not tied to the lifetime of another composition object. Property sets are most commonly used with animations, where they maintain key-value pairs that are referenced to drive portions of composition animations. Property sets provide the ability to insert key-value pairs or retrieve a value for a given key. A property set does not support a delete function – ensure you use property sets to store values that will be shared across the application.

A property set made with new (or Compositor::create_property_set) is live, as in WinUI: it has a server counterpart that receives its entries with each batch, its entries can be animated with start_animation, and an expression that refers to it reads its current values. Upstream’s property sets live on the UI thread only, and an expression sees a copy of them taken when its animation starts; the parameters of an animation are such a set (see docs/porting/winui-composition.md).

Implementations

impl CompositionPropertySet

pub fn new(compositor: &Rc<Compositor>) -> Rc<CompositionPropertySet>

Creates a live property set (Compositor.CreatePropertySet).

pub fn is_live(&self) -> bool

Whether the set is live (has a server counterpart).

pub fn compositor(&self) -> &Rc<Compositor>

pub fn insert_color(&self, property_name: &str, value: Color)

pub fn insert_matrix3x2(&self, property_name: &str, value: Matrix3x2)

pub fn insert_matrix4x4(&self, property_name: &str, value: Matrix4x4)

pub fn insert_quaternion(&self, property_name: &str, value: Quaternion)

pub fn insert_scalar(&self, property_name: &str, value: f32)

pub fn insert_vector2(&self, property_name: &str, value: Vector2)

pub fn insert_vector3(&self, property_name: &str, value: Vector3)

pub fn insert_vector4(&self, property_name: &str, value: Vector4)

pub fn try_get_color( &self, property_name: &str, ) -> (CompositionGetValueStatus, Color)

pub fn try_get_matrix3x2( &self, property_name: &str, ) -> (CompositionGetValueStatus, Matrix3x2)

pub fn try_get_matrix4x4( &self, property_name: &str, ) -> (CompositionGetValueStatus, Matrix4x4)

pub fn try_get_quaternion( &self, property_name: &str, ) -> (CompositionGetValueStatus, Quaternion)

pub fn try_get_scalar( &self, property_name: &str, ) -> (CompositionGetValueStatus, f32)

pub fn try_get_vector2( &self, property_name: &str, ) -> (CompositionGetValueStatus, Vector2)

pub fn try_get_vector3( &self, property_name: &str, ) -> (CompositionGetValueStatus, Vector3)

pub fn try_get_vector4( &self, property_name: &str, ) -> (CompositionGetValueStatus, Vector4)

pub fn insert_boolean(&self, property_name: &str, value: bool)

pub fn try_get_boolean( &self, property_name: &str, ) -> (CompositionGetValueStatus, bool)

Trait Implementations

impl AsCompositionObject for CompositionPropertySet

fn as_composition_object(&self) -> &CompositionObject

The embedded CompositionObject.

fn composition_type_name(&self) -> &'static str

The name of the class of the object, for messages.

fn as_property_set(self: Rc<Self>) -> Option<Rc<CompositionPropertySet>>

The object as a property set, if it is one (the is CompositionPropertySet test of upstream).

impl ICompositionObjectAnimations for CompositionPropertySet

fn try_start_animation( &self, property_name: &str, animation: &dyn ICompositionAnimation, final_value: Option<ExpressionVariant>, ) -> bool

Starts an animation of an entry of a live set. As in WinUI the entry must have been inserted first; the animation starts from its current value.

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

The composition property with the given name.

fn composition_object(&self) -> &CompositionObject

The embedded CompositionObject.

fn start_animation( &self, property_name: &str, animation: &dyn ICompositionAnimation, )

Connects an animation with the named property of the object and starts the animation.

fn start_animation_with_final_value( &self, property_name: &str, animation: &dyn ICompositionAnimation, final_value: Option<ExpressionVariant>, )

See start_animation. property_name may name a sub-channel of a vector property (Offset.X, Scale.XY, components X, Y, Z, W in any case): the animation then animates a value of the sub-channel’s type (a scalar for one component, a Vector2 for two, …) and leaves the other components alone. Several sub-channels of one property run together; an animation of the whole property replaces them.

fn start_animation_with_controller( &self, property_name: &str, animation: &dyn ICompositionAnimation, controller: &Rc<AnimationController>, )

StartAnimation(propertyName, animation, animationController): starts the animation under controller, which can pause, resume, scrub and speed it up. property_name may name a sub-channel, as for start_animation.

fn try_get_animation_controller( &self, property_name: &str, ) -> Option<Rc<AnimationController>>

The controller of the animation of the named property (TryGetAnimationController): the controller it was started with, or a new controller that takes the running animation over. None when no animation was started on the property through this object, or it was stopped.

fn stop_animation(&self, property_name: &str)

Disconnects an animation from the named property and stops it, applying its stop behavior. property_name may name a sub-channel (Offset.X): the animations of the sub-channels that share a component with it are stopped.

fn start_animation_group(&self, grp: &dyn ICompositionAnimationBase)

Starts an animation group. The StartAnimationGroup method on CompositionObject lets you start CompositionAnimationGroup. All the animations in the group will be started at the same time on the object.

fn start_animation_group_part( &self, animation: &dyn ICompositionAnimation, target: &str, final_value: ExpressionVariant, ) -> bool

StartAnimationGroupPart.

fn start_animation_group_for( &self, grp: &dyn ICompositionAnimationBase, target: &str, final_value: ExpressionVariant, ) -> bool

Starts an animation or an animation group triggered by the change of property target to final_value. Returns whether one of the animations targets that property.

fn stop_animation_group(&self, grp: &dyn ICompositionAnimationBase)

Stops an animation group.

impl ICompositorSerializable for CompositionPropertySet

fn try_get_server(&self, c: &Compositor) -> Option<ServerObjectId>

The server-side counterpart of the object on compositor c, if it has one.

fn serialize_changes(&self, c: &Compositor, writer: &mut BatchStreamWriter<'_>)

Writes the pending changes of the object for compositor c.

fn serialization_key(&self) -> *const ()

The identity of the object, by which a compositor avoids queueing it twice. The default is the address of the implementing value; an adapter around an object returns the identity of that object.

fn prepare_serialization(&self, _c: &Compositor)

Called before the changes of the object are written for compositor c.