Struct CompositionVisualProps 

pub struct CompositionVisualProps { /* private fields */ }

The UI-thread properties of CompositionVisual.

Implementations

impl CompositionVisualProps

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.

pub fn initialize_defaults(&self, host: &dyn CompositionVisualHooks)

The InitializeDefaults calls of the constructor chain: the base classes first, then this class.

pub fn initialize_own_defaults(&self, host: &dyn CompositionVisualHooks)

InitializeDefaults of this class alone.

pub fn root(&self) -> Option<Rc<dyn ICompositionObject>>

Root (internal).

pub fn set_root( &self, host: &dyn CompositionVisualHooks, value: Option<Rc<dyn ICompositionObject>>, )

Sets Root (internal).

pub fn parent(&self) -> Option<Rc<dyn ICompositionObject>>

Parent (internal).

pub fn set_parent( &self, host: &dyn CompositionVisualHooks, value: Option<Rc<dyn ICompositionObject>>, )

Sets Parent (internal).

pub fn visible(&self) -> bool

Visible (animated, default true).

pub fn set_visible(&self, host: &dyn CompositionVisualHooks, value: bool)

Sets Visible (animated, default true).

pub fn opacity(&self) -> f32

Opacity (animated, default 1.0).

pub fn set_opacity(&self, host: &dyn CompositionVisualHooks, value: f32)

Sets Opacity (animated, default 1.0).

pub fn clip(&self) -> Option<Arc<dyn IGeometryImpl>>

Clip (internal).

pub fn set_clip( &self, host: &dyn CompositionVisualHooks, value: Option<Arc<dyn IGeometryImpl>>, )

Sets Clip (internal).

pub fn clip_to_bounds(&self) -> bool

ClipToBounds (animated, default true).

pub fn set_clip_to_bounds(&self, host: &dyn CompositionVisualHooks, value: bool)

Sets ClipToBounds (animated, default true).

pub fn offset(&self) -> Vector3D

Offset (animated).

pub fn set_offset(&self, host: &dyn CompositionVisualHooks, value: Vector3D)

Sets Offset (animated).

pub fn translation(&self) -> Vector3D

Translation (animated).

pub fn set_translation( &self, host: &dyn CompositionVisualHooks, value: Vector3D, )

Sets Translation (animated).

pub fn size(&self) -> Vector

Size (animated).

pub fn set_size(&self, host: &dyn CompositionVisualHooks, value: Vector)

Sets Size (animated).

pub fn anchor_point(&self) -> Vector

AnchorPoint (animated).

pub fn set_anchor_point(&self, host: &dyn CompositionVisualHooks, value: Vector)

Sets AnchorPoint (animated).

pub fn center_point(&self) -> Vector3D

CenterPoint (animated).

pub fn set_center_point( &self, host: &dyn CompositionVisualHooks, value: Vector3D, )

Sets CenterPoint (animated).

pub fn rotation_angle(&self) -> f32

RotationAngle (animated).

pub fn set_rotation_angle(&self, host: &dyn CompositionVisualHooks, value: f32)

Sets RotationAngle (animated).

pub fn orientation(&self) -> Quaternion

Orientation (animated, default Quaternion::IDENTITY).

pub fn set_orientation( &self, host: &dyn CompositionVisualHooks, value: Quaternion, )

Sets Orientation (animated, default Quaternion::IDENTITY).

pub fn scale(&self) -> Vector3D

Scale (animated, default Vector3D::new(1.0, 1.0, 1.0)).

pub fn set_scale(&self, host: &dyn CompositionVisualHooks, value: Vector3D)

Sets Scale (animated, default Vector3D::new(1.0, 1.0, 1.0)).

pub fn transform_matrix(&self) -> Matrix

TransformMatrix (internal, animated, default Matrix::IDENTITY).

pub fn set_transform_matrix( &self, host: &dyn CompositionVisualHooks, value: Matrix, )

Sets TransformMatrix (internal, animated, default Matrix::IDENTITY).

pub fn adorned_visual(&self) -> Option<Rc<dyn ICompositionObject>>

AdornedVisual (internal).

pub fn set_adorned_visual( &self, host: &dyn CompositionVisualHooks, value: Option<Rc<dyn ICompositionObject>>, )

Sets AdornedVisual (internal).

pub fn adorner_is_clipped(&self) -> bool

AdornerIsClipped (internal).

pub fn set_adorner_is_clipped( &self, host: &dyn CompositionVisualHooks, value: bool, )

Sets AdornerIsClipped (internal).

pub fn opacity_mask_brush_transport_field( &self, ) -> Option<BatchResource<dyn IBrush>>

OpacityMaskBrush (private to the class).

pub fn set_opacity_mask_brush_transport_field( &self, host: &dyn CompositionVisualHooks, value: Option<BatchResource<dyn IBrush>>, )

Sets OpacityMaskBrush (private to the class).

pub fn effect(&self) -> Option<Arc<dyn IImmutableEffect>>

Effect (internal).

pub fn set_effect( &self, host: &dyn CompositionVisualHooks, value: Option<Arc<dyn IImmutableEffect>>, )

Sets Effect (internal).

pub fn render_options(&self) -> RenderOptions

RenderOptions.

pub fn set_render_options( &self, host: &dyn CompositionVisualHooks, value: RenderOptions, )

Sets RenderOptions.

pub fn text_options(&self) -> TextOptions

TextOptions.

pub fn set_text_options( &self, host: &dyn CompositionVisualHooks, value: TextOptions, )

Sets TextOptions.

pub fn cache_mode(&self) -> Option<Rc<dyn ICompositionObject>>

CacheMode (internal).

pub fn set_cache_mode( &self, host: &dyn CompositionVisualHooks, value: Option<Rc<dyn ICompositionObject>>, )

Sets CacheMode (internal).

pub fn composition_clip(&self) -> Option<Rc<dyn ICompositionObject>>

CompositionClip (FerroUI overlay).

pub fn set_composition_clip( &self, host: &dyn CompositionVisualHooks, value: Option<Rc<dyn ICompositionObject>>, )

Sets CompositionClip (FerroUI overlay).

pub fn rotation_axis(&self) -> Vector3D

RotationAxis (animated, default Vector3D::new(0.0, 0.0, 1.0), FerroUI overlay).

pub fn set_rotation_axis( &self, host: &dyn CompositionVisualHooks, value: Vector3D, )

Sets RotationAxis (animated, default Vector3D::new(0.0, 0.0, 1.0), FerroUI overlay).

pub fn relative_offset_adjustment(&self) -> Vector3D

RelativeOffsetAdjustment (animated, FerroUI overlay).

pub fn set_relative_offset_adjustment( &self, host: &dyn CompositionVisualHooks, value: Vector3D, )

Sets RelativeOffsetAdjustment (animated, FerroUI overlay).

pub fn relative_size_adjustment(&self) -> Vector

RelativeSizeAdjustment (animated, FerroUI overlay).

pub fn set_relative_size_adjustment( &self, host: &dyn CompositionVisualHooks, value: Vector, )

Sets RelativeSizeAdjustment (animated, FerroUI overlay).

pub fn is_hit_test_visible(&self) -> bool

IsHitTestVisible (default true, FerroUI overlay).

pub fn set_is_hit_test_visible( &self, host: &dyn CompositionVisualHooks, value: bool, )

Sets IsHitTestVisible (default true, FerroUI overlay).

pub fn is_pixel_snapping_enabled(&self) -> bool

IsPixelSnappingEnabled (FerroUI overlay).

pub fn set_is_pixel_snapping_enabled( &self, host: &dyn CompositionVisualHooks, value: bool, )

Sets IsPixelSnappingEnabled (FerroUI overlay).

pub fn border_mode(&self) -> CompositionBorderMode

BorderMode (FerroUI overlay).

pub fn set_border_mode( &self, host: &dyn CompositionVisualHooks, value: CompositionBorderMode, )

Sets BorderMode (FerroUI overlay).

pub fn backface_visibility(&self) -> CompositionBackfaceVisibility

BackfaceVisibility (FerroUI overlay).

pub fn set_backface_visibility( &self, host: &dyn CompositionVisualHooks, value: CompositionBackfaceVisibility, )

Sets BackfaceVisibility (FerroUI overlay).

pub fn composite_mode(&self) -> CompositionCompositeMode

CompositeMode (FerroUI overlay).

pub fn set_composite_mode( &self, host: &dyn CompositionVisualHooks, value: CompositionCompositeMode, )

Sets CompositeMode (FerroUI overlay).

pub fn parent_for_transform(&self) -> Option<Rc<dyn ICompositionObject>>

ParentForTransform (FerroUI overlay).

pub fn set_parent_for_transform( &self, host: &dyn CompositionVisualHooks, value: Option<Rc<dyn ICompositionObject>>, )

Sets ParentForTransform (FerroUI overlay).

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.

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

impl Default for CompositionVisualProps

fn default() -> Self

Returns the “default value” for a type.