Struct CompositionViewBox 

pub struct CompositionViewBox { /* private fields */ }

The area of the shape coordinates a shape visual or a geometric clip shows (WinUI Microsoft.UI.Composition.CompositionViewBox): the rectangle (offset, size) of the shapes is mapped onto the visual by stretch and placed by the alignment ratios, as a surface brush lays out its surface. Offset, Size and the ratios are animatable.

Deviation (winui-composition.md): what is outside the mapped view box is clipped (the port’s reading of WinUI); a view box whose size is zero maps nothing (the shapes are drawn as if there were no view box).

Implementations

impl CompositionViewBox

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 view box.

pub fn is_disposed(&self) -> bool

pub fn dispose(&self)

pub fn props(&self) -> &CompositionViewBoxProps

The generated properties of the view box.

pub fn horizontal_alignment_ratio(&self) -> f32

The part of the free horizontal space left of the mapped view box (0 left, 0.5 centre, 1 right; default 0.5).

pub fn set_horizontal_alignment_ratio(&self, value: f32)

pub fn offset(&self) -> Vector

The top left corner of the view box, in shape coordinates.

pub fn set_offset(&self, value: Vector)

pub fn size(&self) -> Vector

The size of the view box, in shape coordinates.

pub fn set_size(&self, value: Vector)

pub fn stretch(&self) -> CompositionStretch

How the view box is scaled onto the visual (default Fill).

pub fn set_stretch(&self, value: CompositionStretch)

pub fn vertical_alignment_ratio(&self) -> f32

The part of the free vertical space above the mapped view box (0 top, 0.5 centre, 1 bottom; default 0.5).

pub fn set_vertical_alignment_ratio(&self, value: f32)

Trait Implementations

impl AsCompositionObject for CompositionViewBox

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 CompositionViewBoxHooks for CompositionViewBox

fn initialize_defaults_extra(&self)

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

fn on_horizontal_alignment_ratio_changed(&self)

fn on_horizontal_alignment_ratio_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_size_change(&self, _old_value: Vector, _new_value: Vector)

fn on_size_changed(&self)

fn on_size_changing(&self)

fn validate_stretch_change( &self, _old_value: CompositionStretch, _new_value: CompositionStretch, )

fn on_stretch_changed(&self)

fn on_stretch_changing(&self)

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

fn on_vertical_alignment_ratio_changed(&self)

fn on_vertical_alignment_ratio_changing(&self)

impl ICompositionObject for CompositionViewBox

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 CompositionViewBox

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 CompositionViewBox

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 CompositionViewBox

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 CompositionViewBox

fn register_for_serialization(&self)