pub struct CompositionVisualProps { /* private fields */ }Expand description
The UI-thread properties of CompositionVisual.
Implementations§
Source§impl CompositionVisualProps
impl CompositionVisualProps
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates the properties with every field at the default of its type.
The defaults of the schema are applied by
initialize_defaults.
Sourcepub fn initialize_defaults(&self, host: &dyn CompositionVisualHooks)
pub fn initialize_defaults(&self, host: &dyn CompositionVisualHooks)
The InitializeDefaults calls of the constructor chain: the base
classes first, then this class.
Sourcepub fn initialize_own_defaults(&self, host: &dyn CompositionVisualHooks)
pub fn initialize_own_defaults(&self, host: &dyn CompositionVisualHooks)
InitializeDefaults of this class alone.
Sourcepub fn root(&self) -> Option<Rc<dyn ICompositionObject>>
pub fn root(&self) -> Option<Rc<dyn ICompositionObject>>
Root (internal).
Sourcepub fn set_root(
&self,
host: &dyn CompositionVisualHooks,
value: Option<Rc<dyn ICompositionObject>>,
)
pub fn set_root( &self, host: &dyn CompositionVisualHooks, value: Option<Rc<dyn ICompositionObject>>, )
Sets Root (internal).
Sourcepub fn parent(&self) -> Option<Rc<dyn ICompositionObject>>
pub fn parent(&self) -> Option<Rc<dyn ICompositionObject>>
Parent (internal).
Sourcepub fn set_parent(
&self,
host: &dyn CompositionVisualHooks,
value: Option<Rc<dyn ICompositionObject>>,
)
pub fn set_parent( &self, host: &dyn CompositionVisualHooks, value: Option<Rc<dyn ICompositionObject>>, )
Sets Parent (internal).
Sourcepub fn set_visible(&self, host: &dyn CompositionVisualHooks, value: bool)
pub fn set_visible(&self, host: &dyn CompositionVisualHooks, value: bool)
Sets Visible (animated, default true).
Sourcepub fn set_opacity(&self, host: &dyn CompositionVisualHooks, value: f32)
pub fn set_opacity(&self, host: &dyn CompositionVisualHooks, value: f32)
Sets Opacity (animated, default 1.0).
Sourcepub fn clip(&self) -> Option<Arc<dyn IGeometryImpl>>
pub fn clip(&self) -> Option<Arc<dyn IGeometryImpl>>
Clip (internal).
Sourcepub fn set_clip(
&self,
host: &dyn CompositionVisualHooks,
value: Option<Arc<dyn IGeometryImpl>>,
)
pub fn set_clip( &self, host: &dyn CompositionVisualHooks, value: Option<Arc<dyn IGeometryImpl>>, )
Sets Clip (internal).
Sourcepub fn clip_to_bounds(&self) -> bool
pub fn clip_to_bounds(&self) -> bool
ClipToBounds (animated, default true).
Sourcepub fn set_clip_to_bounds(&self, host: &dyn CompositionVisualHooks, value: bool)
pub fn set_clip_to_bounds(&self, host: &dyn CompositionVisualHooks, value: bool)
Sets ClipToBounds (animated, default true).
Sourcepub fn set_offset(&self, host: &dyn CompositionVisualHooks, value: Vector3D)
pub fn set_offset(&self, host: &dyn CompositionVisualHooks, value: Vector3D)
Sets Offset (animated).
Sourcepub fn translation(&self) -> Vector3D
pub fn translation(&self) -> Vector3D
Translation (animated).
Sourcepub fn set_translation(
&self,
host: &dyn CompositionVisualHooks,
value: Vector3D,
)
pub fn set_translation( &self, host: &dyn CompositionVisualHooks, value: Vector3D, )
Sets Translation (animated).
Sourcepub fn set_size(&self, host: &dyn CompositionVisualHooks, value: Vector)
pub fn set_size(&self, host: &dyn CompositionVisualHooks, value: Vector)
Sets Size (animated).
Sourcepub fn anchor_point(&self) -> Vector
pub fn anchor_point(&self) -> Vector
AnchorPoint (animated).
Sourcepub fn set_anchor_point(&self, host: &dyn CompositionVisualHooks, value: Vector)
pub fn set_anchor_point(&self, host: &dyn CompositionVisualHooks, value: Vector)
Sets AnchorPoint (animated).
Sourcepub fn center_point(&self) -> Vector3D
pub fn center_point(&self) -> Vector3D
CenterPoint (animated).
Sourcepub fn set_center_point(
&self,
host: &dyn CompositionVisualHooks,
value: Vector3D,
)
pub fn set_center_point( &self, host: &dyn CompositionVisualHooks, value: Vector3D, )
Sets CenterPoint (animated).
Sourcepub fn rotation_angle(&self) -> f32
pub fn rotation_angle(&self) -> f32
RotationAngle (animated).
Sourcepub fn set_rotation_angle(&self, host: &dyn CompositionVisualHooks, value: f32)
pub fn set_rotation_angle(&self, host: &dyn CompositionVisualHooks, value: f32)
Sets RotationAngle (animated).
Sourcepub fn orientation(&self) -> Quaternion
pub fn orientation(&self) -> Quaternion
Orientation (animated, default Quaternion::IDENTITY).
Sourcepub fn set_orientation(
&self,
host: &dyn CompositionVisualHooks,
value: Quaternion,
)
pub fn set_orientation( &self, host: &dyn CompositionVisualHooks, value: Quaternion, )
Sets Orientation (animated, default Quaternion::IDENTITY).
Sourcepub fn set_scale(&self, host: &dyn CompositionVisualHooks, value: Vector3D)
pub fn set_scale(&self, host: &dyn CompositionVisualHooks, value: Vector3D)
Sets Scale (animated, default Vector3D::new(1.0, 1.0, 1.0)).
Sourcepub fn transform_matrix(&self) -> Matrix
pub fn transform_matrix(&self) -> Matrix
TransformMatrix (internal, animated, default Matrix::IDENTITY).
Sourcepub fn set_transform_matrix(
&self,
host: &dyn CompositionVisualHooks,
value: Matrix,
)
pub fn set_transform_matrix( &self, host: &dyn CompositionVisualHooks, value: Matrix, )
Sets TransformMatrix (internal, animated, default Matrix::IDENTITY).
Sourcepub fn adorned_visual(&self) -> Option<Rc<dyn ICompositionObject>>
pub fn adorned_visual(&self) -> Option<Rc<dyn ICompositionObject>>
AdornedVisual (internal).
Sourcepub fn set_adorned_visual(
&self,
host: &dyn CompositionVisualHooks,
value: Option<Rc<dyn ICompositionObject>>,
)
pub fn set_adorned_visual( &self, host: &dyn CompositionVisualHooks, value: Option<Rc<dyn ICompositionObject>>, )
Sets AdornedVisual (internal).
Sourcepub fn adorner_is_clipped(&self) -> bool
pub fn adorner_is_clipped(&self) -> bool
AdornerIsClipped (internal).
Sourcepub fn set_adorner_is_clipped(
&self,
host: &dyn CompositionVisualHooks,
value: bool,
)
pub fn set_adorner_is_clipped( &self, host: &dyn CompositionVisualHooks, value: bool, )
Sets AdornerIsClipped (internal).
Sourcepub fn opacity_mask_brush_transport_field(
&self,
) -> Option<BatchResource<dyn IBrush>>
pub fn opacity_mask_brush_transport_field( &self, ) -> Option<BatchResource<dyn IBrush>>
OpacityMaskBrush (private to the class).
Sourcepub fn set_opacity_mask_brush_transport_field(
&self,
host: &dyn CompositionVisualHooks,
value: Option<BatchResource<dyn IBrush>>,
)
pub fn set_opacity_mask_brush_transport_field( &self, host: &dyn CompositionVisualHooks, value: Option<BatchResource<dyn IBrush>>, )
Sets OpacityMaskBrush (private to the class).
Sourcepub fn effect(&self) -> Option<Arc<dyn IImmutableEffect>>
pub fn effect(&self) -> Option<Arc<dyn IImmutableEffect>>
Effect (internal).
Sourcepub fn set_effect(
&self,
host: &dyn CompositionVisualHooks,
value: Option<Arc<dyn IImmutableEffect>>,
)
pub fn set_effect( &self, host: &dyn CompositionVisualHooks, value: Option<Arc<dyn IImmutableEffect>>, )
Sets Effect (internal).
Sourcepub fn render_options(&self) -> RenderOptions
pub fn render_options(&self) -> RenderOptions
RenderOptions.
Sourcepub fn set_render_options(
&self,
host: &dyn CompositionVisualHooks,
value: RenderOptions,
)
pub fn set_render_options( &self, host: &dyn CompositionVisualHooks, value: RenderOptions, )
Sets RenderOptions.
Sourcepub fn text_options(&self) -> TextOptions
pub fn text_options(&self) -> TextOptions
TextOptions.
Sourcepub fn set_text_options(
&self,
host: &dyn CompositionVisualHooks,
value: TextOptions,
)
pub fn set_text_options( &self, host: &dyn CompositionVisualHooks, value: TextOptions, )
Sets TextOptions.
Sourcepub fn cache_mode(&self) -> Option<Rc<dyn ICompositionObject>>
pub fn cache_mode(&self) -> Option<Rc<dyn ICompositionObject>>
CacheMode (internal).
Sourcepub fn set_cache_mode(
&self,
host: &dyn CompositionVisualHooks,
value: Option<Rc<dyn ICompositionObject>>,
)
pub fn set_cache_mode( &self, host: &dyn CompositionVisualHooks, value: Option<Rc<dyn ICompositionObject>>, )
Sets CacheMode (internal).
Sourcepub fn start_animation(
&self,
host: &dyn CompositionVisualHooks,
property_name: &str,
animation: &dyn ICompositionAnimation,
final_value: Option<ExpressionVariant>,
) -> bool
pub fn start_animation( &self, host: &dyn CompositionVisualHooks, property_name: &str, animation: &dyn ICompositionAnimation, final_value: Option<ExpressionVariant>, ) -> bool
Connects an animation with the named property. Returns false when
neither this class nor its generated bases have an animated property
of that name: the caller continues with its hand-written base.
Sourcepub fn serialize_changes_core(
&self,
host: &dyn CompositionVisualHooks,
writer: &mut BatchStreamWriter<'_>,
)
pub fn serialize_changes_core( &self, host: &dyn CompositionVisualHooks, writer: &mut BatchStreamWriter<'_>, )
Writes the changes of the object: the base class first, then the changed-fields mask and the changed members of this class.
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for CompositionVisualProps
impl !RefUnwindSafe for CompositionVisualProps
impl !Send for CompositionVisualProps
impl !Sync for CompositionVisualProps
impl !UnwindSafe for CompositionVisualProps
impl Unpin for CompositionVisualProps
impl UnsafeUnpin for CompositionVisualProps
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
Source§impl<T> ClassDefaults for Twhere
T: ?Sized,
impl<T> ClassDefaults for Twhere
T: ?Sized,
Source§fn static_constructor()
fn static_constructor()
affects_render, metadata
overrides). Read more