pub struct CompositionPropertySet { /* private fields */ }Expand description
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.
Implementations§
Source§impl CompositionPropertySet
impl CompositionPropertySet
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§
Source§impl AsCompositionObject for CompositionPropertySet
impl AsCompositionObject for CompositionPropertySet
Source§fn as_composition_object(&self) -> &CompositionObject
fn as_composition_object(&self) -> &CompositionObject
The embedded
CompositionObject.Source§fn composition_type_name(&self) -> &'static str
fn composition_type_name(&self) -> &'static str
The name of the class of the object, for messages.
Source§fn as_property_set(self: Rc<Self>) -> Option<Rc<CompositionPropertySet>>
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).Auto Trait Implementations§
impl !Freeze for CompositionPropertySet
impl !RefUnwindSafe for CompositionPropertySet
impl !Send for CompositionPropertySet
impl !Sync for CompositionPropertySet
impl !UnwindSafe for CompositionPropertySet
impl Unpin for CompositionPropertySet
impl UnsafeUnpin for CompositionPropertySet
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> ClassDefaults for Twhere
T: ?Sized,
impl<T> ClassDefaults for Twhere
T: ?Sized,
Source§fn static_constructor()
fn static_constructor()
The static constructor of a type: work done once per thread, after
the properties of the type are registered and before its first
instance exists (class handlers,
affects_render, metadata
overrides). Read more