Skip to main content

CompositionProperty

Struct CompositionProperty 

Source
pub struct CompositionProperty { /* private fields */ }
Expand description

The identity of a property of a server-side composition object: what animations, expressions and change notifications refer to.

Properties are registered once per process and are plain data (ids, names and function pointers), so the UI thread and the render thread share them.

Implementations§

Source§

impl CompositionProperty

Source

pub fn id(&self) -> i32

Source

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

Source

pub fn owner(&self) -> TypeId

The type that declares the property: the generated property block of the server class.

Source

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

The name of the server class that declares the property.

Source

pub fn get_variant(&self) -> Option<fn(&dyn IServerObject) -> ExpressionVariant>

Reads the property of an object as an expression variant; None for a property whose type has no variant form.

Source

pub fn set_variant(&self) -> Option<fn(&dyn IServerObject, ExpressionVariant)>

Stores an expression variant into the field of the property, without any notification; None for a property that cannot be animated.

This is the type-erased form of set_field an animation uses to write the value it evaluated.

Source

pub fn register<TOwner: Any, TField>( name: &'static str, owner_name: &'static str, get_field: fn(&dyn IServerObject) -> TField, set_field: fn(&dyn IServerObject, TField), get_variant: Option<fn(&dyn IServerObject) -> ExpressionVariant>, set_variant: Option<fn(&dyn IServerObject, ExpressionVariant)>, ) -> CompositionPropertyOf<TField>

Registers a property of the server class whose generated property block is TOwner.

Trait Implementations§

Source§

impl Debug for CompositionProperty

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for CompositionProperty

Source§

impl Hash for CompositionProperty

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CompositionProperty

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AnyValue for T
where T: PartialEq + 'static,

Source§

fn any_value_as_any(&self) -> &(dyn Any + 'static)

Source§

fn any_value_eq(&self, other: &(dyn AnyValue + 'static)) -> bool

Source§

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

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ClassDefaults for T
where T: ?Sized,

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ResourceKeyObject for T
where T: Eq + Hash + 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Source§

fn dyn_eq(&self, other: &(dyn ResourceKeyObject + 'static)) -> bool

Source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Source§

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

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.