Struct CompositionClip 

pub struct CompositionClip { /* private fields */ }

A clip of a visual (WinUI Microsoft.UI.Composition.CompositionClip): the area of the visual that stays visible, with its own animatable transform (AnchorPoint, CenterPoint, Offset, RotationAngle, Scale, TransformMatrix) in the space of the visual.

Deviation (winui-composition.md): AnchorPoint is relative to the size of the visual the clip is set on; RotationAngleInDegrees is a view of RotationAngle and cannot be the target of an animation.

Implementations

impl CompositionClip

pub fn clip_props(&self) -> &CompositionClipProps

The generated properties of CompositionClip.

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

pub fn object(&self) -> &CompositionObject

The embedded CompositionObject.

pub fn server(&self) -> ServerObjectId

The id of the server-side clip.

pub fn is_disposed(&self) -> bool

pub fn dispose(&self)

pub fn type_name(&self) -> &'static str

The name of the concrete class, for messages.

pub fn anchor_point(&self) -> Vector

The point of the clip, relative to the size of the visual, that is placed at offset.

pub fn set_anchor_point(&self, value: Vector)

pub fn center_point(&self) -> Vector

The point the clip is scaled and rotated about.

pub fn set_center_point(&self, value: Vector)

pub fn offset(&self) -> Vector

The offset of the clip.

pub fn set_offset(&self, value: Vector)

pub fn rotation_angle(&self) -> f32

The rotation of the clip about its center point, in radians.

pub fn set_rotation_angle(&self, value: f32)

pub fn rotation_angle_in_degrees(&self) -> f32

The rotation of the clip in degrees: a view of rotation_angle.

pub fn set_rotation_angle_in_degrees(&self, value: f32)

pub fn scale(&self) -> Vector

The scale of the clip about its center point (default (1, 1)).

pub fn set_scale(&self, value: Vector)

pub fn transform_matrix(&self) -> Matrix

The transform matrix of the clip (WinUI Matrix3x2).

pub fn set_transform_matrix(&self, value: Matrix)

Trait Implementations

impl AsCompositionObject for CompositionClip

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 CompositionClipHooks for CompositionClip

fn initialize_defaults_extra(&self)

fn validate_anchor_point_change(&self, _old_value: Vector, _new_value: Vector)

fn on_anchor_point_changed(&self)

fn on_anchor_point_changing(&self)

fn validate_center_point_change(&self, _old_value: Vector, _new_value: Vector)

fn on_center_point_changed(&self)

fn on_center_point_changing(&self)

fn validate_offset_change(&self, _old_value: Vector, _new_value: Vector)

fn on_offset_changed(&self)

fn on_offset_changing(&self)

fn validate_rotation_angle_change(&self, _old_value: f32, _new_value: f32)

fn on_rotation_angle_changed(&self)

fn on_rotation_angle_changing(&self)

fn validate_scale_change(&self, _old_value: Vector, _new_value: Vector)

fn on_scale_changed(&self)

fn on_scale_changing(&self)

fn validate_transform_matrix_change( &self, _old_value: Matrix, _new_value: Matrix, )

fn on_transform_matrix_changed(&self)

fn on_transform_matrix_changing(&self)

impl GeometricClipHooks for CompositionClip

fn initialize_defaults_extra(&self)

fn validate_geometry_change( &self, _old_value: &Option<Rc<dyn ICompositionObject>>, _new_value: &Option<Rc<dyn ICompositionObject>>, )

fn on_geometry_changed(&self)

fn on_geometry_changing(&self)

fn validate_view_box_change( &self, _old_value: &Option<Rc<dyn ICompositionObject>>, _new_value: &Option<Rc<dyn ICompositionObject>>, )

fn on_view_box_changed(&self)

fn on_view_box_changing(&self)

impl ICompositionObject for CompositionClip

fn server(&self) -> ServerObjectId

The id of the server-side counterpart of the object.

fn as_any(&self) -> &dyn Any

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

impl ICompositionObjectAnimations for CompositionClip

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

StartAnimation(propertyName, animation, finalValue) of the class: returns false for a property the class does not know.

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 ICompositionObjectHost for CompositionClip

fn server(&self) -> ServerObjectId

The id of the server-side counterpart of the object.

fn pending_animations(&self) -> &PendingAnimations

The animations waiting to be sent with the next batch.

fn implicit_animation( &self, property_name: &str, ) -> Option<Rc<dyn ICompositionAnimationBase>>

The implicit animation attached to a property of the object, if there is one (ImplicitAnimations?.TryGetValue(name)).

fn start_animation_group( &self, grp: &Rc<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.

impl ICompositorSerializable for CompositionClip

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.

impl IRegisterForSerialization for CompositionClip

fn register_for_serialization(&self)

impl InsetClipHooks for CompositionClip

fn initialize_defaults_extra(&self)

fn validate_left_inset_change(&self, _old_value: f32, _new_value: f32)

fn on_left_inset_changed(&self)

fn on_left_inset_changing(&self)

fn validate_top_inset_change(&self, _old_value: f32, _new_value: f32)

fn on_top_inset_changed(&self)

fn on_top_inset_changing(&self)

fn validate_right_inset_change(&self, _old_value: f32, _new_value: f32)

fn on_right_inset_changed(&self)

fn on_right_inset_changing(&self)

fn validate_bottom_inset_change(&self, _old_value: f32, _new_value: f32)

fn on_bottom_inset_changed(&self)

fn on_bottom_inset_changing(&self)

impl RectangleClipHooks for CompositionClip

fn initialize_defaults_extra(&self)

fn validate_left_change(&self, _old_value: f32, _new_value: f32)

fn on_left_changed(&self)

fn on_left_changing(&self)

fn validate_top_change(&self, _old_value: f32, _new_value: f32)

fn on_top_changed(&self)

fn on_top_changing(&self)

fn validate_right_change(&self, _old_value: f32, _new_value: f32)

fn on_right_changed(&self)

fn on_right_changing(&self)

fn validate_bottom_change(&self, _old_value: f32, _new_value: f32)

fn on_bottom_changed(&self)

fn on_bottom_changing(&self)

fn validate_top_left_radius_change( &self, _old_value: Vector, _new_value: Vector, )

fn on_top_left_radius_changed(&self)

fn on_top_left_radius_changing(&self)

fn validate_top_right_radius_change( &self, _old_value: Vector, _new_value: Vector, )

fn on_top_right_radius_changed(&self)

fn on_top_right_radius_changing(&self)

fn validate_bottom_left_radius_change( &self, _old_value: Vector, _new_value: Vector, )

fn on_bottom_left_radius_changed(&self)

fn on_bottom_left_radius_changing(&self)

fn validate_bottom_right_radius_change( &self, _old_value: Vector, _new_value: Vector, )

fn on_bottom_right_radius_changed(&self)

fn on_bottom_right_radius_changing(&self)