Struct PolylineGeometry 

pub struct PolylineGeometry { /* private fields */ }

Represents the geometry of a polyline or polygon.

Implementations

impl PolylineGeometry

pub const TYPE: &'static TypeInfo = <PolylineGeometry as crate::StaticType>::TYPE

The runtime type of this class.

pub fn to_ref(&self) -> Ref<PolylineGeometry>

Returns a strong reference to this object.

impl PolylineGeometry

pub fn points_property() -> &'static DirectProperty<PolylineGeometry, Option<Points>>

pub fn is_filled_property() -> &'static StyledProperty<bool>

impl PolylineGeometry

pub fn construct() -> Self

Creates the class data.

pub fn new() -> Ref<Self>

pub fn with_points( points: impl IntoIterator<Item = Point>, is_filled: bool, ) -> Ref<Self>

Creates a polyline geometry with a copy of the given points.

pub fn with_points_and_fill_rule( points: impl IntoIterator<Item = Point>, is_filled: bool, fill_rule: FillRule, ) -> Ref<Self>

Creates a polyline geometry with a copy of the given points and the given fill rule.

pub fn points(&self) -> Points

The figure’s points. Panics if the property has been cleared.

pub fn set_points(&self, value: Points)

pub fn is_filled(&self) -> bool

Whether the geometry is filled.

pub fn set_is_filled(&self, value: bool)

pub fn fill_rule(&self) -> FillRule

How the intersecting areas of the geometry are combined.

Methods from Deref<Target = Geometry>

pub fn to_ref(&self) -> Ref<Geometry>

Returns a strong reference to this object.

pub fn clone_geometry(&self) -> Ref<Geometry>

Clones the geometry.

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

Creates the platform implementation of the geometry, without the transform applied.

pub fn changed_subscriber_count(&self) -> usize

The number of subscribers to the changes of the geometry (a diagnostics member, used by tests to verify that subscriptions are released).

pub fn changed(&self, handler: impl Fn() + 'static) -> Rc<dyn IDisposable>

Subscribes to changes of the geometry. Disposing the returned handle unsubscribes.

pub fn bounds(&self) -> Rect

The geometry’s bounding rectangle.

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

The platform-specific implementation of the geometry.

pub fn transform(&self) -> Option<Ref<Transform>>

A transform to apply to the geometry.

pub fn set_transform(&self, value: impl Into<Nullable<Transform>>)

pub fn get_render_bounds(&self, pen: &dyn IPen) -> Rect

Gets the geometry’s bounding rectangle with the specified pen.

pub fn fill_contains(&self, point: Point) -> bool

Indicates whether the geometry’s fill contains the specified point.

pub fn get_fill_intersection_result( &self, geometry: &Geometry, ) -> Option<IntersectionResult>

Gets the relation between this geometry’s fill and another one’s.

pub fn stroke_contains(&self, pen: &dyn IPen, point: Point) -> bool

Indicates whether the geometry’s stroke contains the specified point.

pub fn get_widened_geometry(&self, pen: &dyn IPen) -> Ref<Geometry>

Gets a geometry that is the shape defined by the stroke on the geometry produced by the specified pen.

pub fn invalidate_geometry(&self)

Invalidates the platform implementation of the geometry.

pub fn contour_length(&self) -> f64

The geometry’s total length as if all its contours are placed in a straight line.

pub fn try_get_point_at_distance(&self, distance: f64) -> Option<Point>

Attempts to get the corresponding point at the specified distance.

pub fn try_get_point_and_tangent_at_distance( &self, distance: f64, ) -> Option<(Point, Point)>

Attempts to get the corresponding point and tangent from the specified distance along the contour of the geometry.

pub fn try_get_segment( &self, start_distance: f64, stop_distance: f64, start_on_begin_figure: bool, ) -> Option<Ref<Geometry>>

Attempts to get the corresponding path segment given by the two distances specified. Imagine it like snipping a part of the current geometry.

Methods from Deref<Target = FerroObject>

pub fn dispatcher(&self) -> &Arc<Dispatcher>

Returns the Dispatcher that this object is associated with: the dispatcher of the thread that owns the object.

pub fn check_access(&self) -> bool

Returns whether the calling thread is the thread that owns this object.

pub fn verify_access(&self)

Checks that the calling thread is the thread that owns this object.

Panics

Panics when it is not.

pub fn to_ref(&self) -> Ref<FerroObject>

A strong reference to this object.

pub fn to_weak(&self) -> WeakRef<FerroObject>

A weak reference to this object.

pub fn get_type(&self) -> &'static TypeInfo

The runtime type of the object.

pub fn is<T: ObjectType>(&self) -> bool

Whether the object is of class T or a class derived from it.

pub fn downcast_ref<T: ObjectType>(&self) -> Option<&T>

Returns the object viewed as class T if it is one.

pub fn on_property_changed(&self, change: &FerroPropertyChangedEventArgs<'_>)

Invokes the on_property_changed virtual member.

pub fn inheritance_parent(&self) -> Option<Ref<FerroObject>>

The parent object that inherited property values are inherited from.

pub fn set_inheritance_parent(&self, value: impl Into<Nullable<FerroObject>>)

Sets the parent object that inherited property values are inherited from.

pub fn clear_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, )

Clears a property’s local value.

pub fn get_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, ) -> T

Gets a property value.

pub fn get_base_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, ) -> Option<T>

Gets a property’s base value: the value excluding animated values. Returns None if the value comes from inheritance or the default.

pub fn is_animating(&self, property: &FerroProperty) -> bool

Checks whether a property is animating.

pub fn is_set(&self, property: &FerroProperty) -> bool

Checks whether a styled property has a value assigned to it or a binding targeting it.

pub fn set_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, value: T, )

Sets a property value with local value priority.

pub fn set_value_with_priority<T: PropertyValue>( &self, property: &'static StyledProperty<T>, value: T, priority: BindingPriority, ) -> Option<Rc<dyn IDisposable>>

Sets a property value with the given priority. For priorities other than local value, disposing the returned handle removes the value.

pub fn set_current_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, value: T, )

Sets the value of a property without changing its value source.

This is used by a component that programmatically sets the value of one of its own properties without disabling an application’s declared use of the property: the effective value changes, but existing bindings and styles continue to work. The new value has the property’s current priority.

pub fn bind_binding( &self, property: &'static FerroProperty, binding: &dyn BindingBase, ) -> Rc<dyn BindingExpressionBase>

Binds a property to a binding. Returns the binding expression which represents the binding instance on this object.

pub fn bind_binding_with_anchor( &self, property: &'static FerroProperty, binding: &dyn BindingBase, anchor: Option<&Ref<FerroObject>>, ) -> Rc<dyn BindingExpressionBase>

Binds a property to a binding.

Some bindings need context to locate their source: a data context, named elements or resources. If this object is not an element, or is not yet attached to the tree, anchor provides that context.

pub fn indexer(&self, binding: &IndexerDescriptor) -> IndexerBinding

Gets a binding to a property of this object: the indexer taking an IndexerDescriptor (source[!Property] is source.indexer(&Property.bind())).

pub fn bind_indexer( &self, binding: &IndexerDescriptor, value: &dyn BindingBase, ) -> Rc<dyn BindingExpressionBase>

Binds the property of an IndexerDescriptor to a binding: the setter of the indexer (target[!Property] = binding is target.bind_indexer(&Property.bind(), &binding)).

pub fn bind<T: PropertyValue>( &self, property: &'static StyledProperty<T>, source: Rc<dyn IObservable<T>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a property to an observable.

pub fn bind_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, source: Rc<dyn IObservable<BindingValue<T>>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a property to an observable of binding values.

pub fn bind_untyped<T: PropertyValue>( &self, property: &'static StyledProperty<T>, source: Rc<dyn IObservable<BoxedValue>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a property to an observable of untyped values.

pub fn coerce_value(&self, property: &'static FerroProperty)

Coerces the specified property.

pub fn get_direct_value<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, ) -> T

Gets a direct property value.

pub fn set_direct_value<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, value: T, )

Sets a direct property value.

pub fn clear_direct_value<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, )

Resets a direct property to its unset value.

pub fn bind_direct<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, source: Rc<dyn IObservable<T>>, ) -> Rc<dyn IDisposable>

Binds a direct property to an observable.

pub fn bind_direct_value<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, source: Rc<dyn IObservable<BindingValue<T>>>, ) -> Rc<dyn IDisposable>

Binds a direct property to an observable of binding values.

pub fn bind_direct_untyped<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, source: Rc<dyn IObservable<BoxedValue>>, ) -> Rc<dyn IDisposable>

Binds a direct property to an observable of untyped values.

pub fn set_and_raise<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, field: &RefCell<T>, value: T, ) -> bool

Sets the backing field of a direct property, raising a change notification if the value changed. Returns true if it changed.

pub fn set_and_raise_cell<T: PropertyValue + Copy>( &self, property: &'static DirectPropertyBase<T>, field: &Cell<T>, value: T, ) -> bool

set_and_raise for Copy values stored in a Cell.

pub fn get_value_untyped(&self, property: &'static FerroProperty) -> BoxedValue

Gets a property value as an untyped value.

pub fn set_value_untyped( &self, property: &'static FerroProperty, value: &dyn Any, priority: BindingPriority, ) -> Option<Rc<dyn IDisposable>>

Sets a property from an untyped value, which must hold exactly the property’s value type or the unset marker.

pub fn set_current_value_untyped( &self, property: &'static FerroProperty, value: &dyn Any, )

set_current_value with an untyped value.

pub fn clear_value_untyped(&self, property: &'static FerroProperty)

Clears a property’s local value.

pub fn bind_property_untyped( &self, property: &'static FerroProperty, source: Rc<dyn IObservable<BoxedValue>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a property to an observable of untyped values.

pub fn property_changed( &self, handler: impl Fn(&FerroPropertyChangedEventArgs<'_>) + 'static, ) -> Rc<dyn IDisposable>

Subscribes to property changes on this object. Disposing the returned handle unsubscribes.

pub fn add_property_changed_handler( &self, handler: Rc<dyn Fn(&FerroPropertyChangedEventArgs<'_>)>, ) -> u64

Subscribes handler to property changes on this object and returns the token that remove_property_changed_handler takes: property_changed for a subscriber that keeps the object and the token itself, so that no handle is made.

pub fn remove_property_changed_handler(&self, token: u64) -> bool

Ends a subscription of add_property_changed_handler.

pub fn property_changed_subscriber_count(&self) -> usize

The number of subscribers to property changes on this object (a diagnostics member, used by tests to verify that subscriptions are released).

pub fn raise_property_changed<T: PropertyValue>( &self, property: &'static FerroProperty, old_value: Option<&T>, new_value: &T, priority: BindingPriority, is_effective_value: bool, )

Raises a property changed notification.

pub fn raise_direct_property_changed<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, old_value: &T, new_value: &T, )

Raises a property changed notification for a direct property.

Trait Implementations

impl Deref for PolylineGeometry

type Target = Geometry

The resulting type after dereferencing.

fn deref(&self) -> &Geometry

Dereferences the value.

impl FerroObjectImpl for PolylineGeometry

fn constructed(this: &Self)

Called once, right after the object has been allocated. This is where constructor logic that needs a reference to the object runs. Overrides must call parent_constructed first.

fn on_property_changed_core( this: &Self, change: &FerroPropertyChangedEventArgs<'_>, )

Called for every property change on the object, including changes of non-effective (base) values. Overriding this is rarely needed; override on_property_changed instead.

fn on_property_changed(this: &Self, change: &FerroPropertyChangedEventArgs<'_>)

Called when the effective value of a property changes on the object.

fn update_data_validation( this: &Self, property: &'static FerroProperty, state: BindingValueType, error: Option<&BindingError>, )

Called to update the validation state for properties for which data validation is enabled.

impl GeometryImpl for PolylineGeometry

fn clone_geometry(this: &Self) -> Ref<Geometry>

Clones the geometry.

fn create_defining_geometry(this: &Self) -> Option<Arc<dyn IGeometryImpl>>

Creates the platform implementation of the geometry, without the transform applied.

impl ObjectType for PolylineGeometry

type Parent = Geometry

The base class. The root class is its own parent.

type VTable = <Geometry as ObjectType>::VTable

The virtual table of the class.

fn vtable() -> &'static Self::VTable

The virtual table used by instances whose most-derived class is Self.

fn register_class()

The static initialisation of the class. The first call on a thread, after doing the same for the base class:

impl StaticType for PolylineGeometry

const TYPE: &'static TypeInfo

The runtime type.

impl<T> Subclassable<T> for PolylineGeometry

where Geometry: Subclassable<T>,

impl Upcast<PolylineGeometry> for PolylineGeometry

fn upcast(&self) -> &PolylineGeometry

impl<T: ?Sized> Upcast<T> for PolylineGeometry

where Geometry: Upcast<T>,

fn upcast(&self) -> &T