Struct CompositionGradientStop 

pub struct CompositionGradientStop { /* private fields */ }

A gradient stop of the composition brushes, with animatable color and offset.

Implementations

impl CompositionGradientStop

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 stop.

pub fn color(&self) -> Color

pub fn set_color(&self, value: Color)

pub fn offset(&self) -> f64

pub fn set_offset(&self, value: f64)

pub fn implicit_animations(&self) -> Option<Rc<ImplicitAnimationCollection>>

The collection of implicit animations attached to this object.

pub fn set_implicit_animations( &self, value: Option<Rc<ImplicitAnimationCollection>>, )

Trait Implementations

impl AsCompositionObject for CompositionGradientStop

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 CompositionGradientStopHooks for CompositionGradientStop

InitializeDefaultsExtra activates the server object: done when the server object is created (see ServerCompositionGradientStop::new).

fn initialize_defaults_extra(&self)

fn validate_color_change(&self, _old_value: Color, _new_value: Color)

fn on_color_changed(&self)

fn on_color_changing(&self)

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

fn on_offset_changed(&self)

fn on_offset_changing(&self)

impl ICompositionObject for CompositionGradientStop

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 CompositionGradientStop

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>, )

fn stop_animation(&self, property_name: &str)

Disconnects an animation from the named property and stops it.

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 CompositionGradientStop

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 CompositionGradientStop

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 IGradientStop for CompositionGradientStop

fn color(&self) -> Color

The gradient stop color.

fn offset(&self) -> f64

The gradient stop offset.

fn as_composition_gradient_stop(&self) -> Option<&CompositionGradientStop>

The stop as a composition gradient stop, if it is one (the is CompositionGradientStop test of upstream).

fn is_immutable_gradient_stop(&self) -> bool

Whether the stop is an ImmutableGradientStop (the as ImmutableGradientStop test of upstream).

impl IRegisterForSerialization for CompositionGradientStop

fn register_for_serialization(&self)