Struct forma_render::Layer

pub struct Layer { /* private fields */ }

A layer is a reusable collection of geometry (i.e. Paths) with common properties and order in the paint stack.

They are created by calling Composition::create_layer or Composition::get_mut_or_insert_default.

Examples

let mut composition = Composition::new();

let _layer = composition.get_mut_or_insert_default(Order::new(0).unwrap());

Implementations

impl Layer

pub fn insert(&mut self, path: &Path) -> &mut Self

Inserts path into the geometry of the layer.

The inserted paths basically contribute to a single internal path containing the geometry of all the paths.

Examples

let mut composition = Composition::new();

let line0 = PathBuilder::new().line_to(Point::new(10.0, 10.0)).build();
let line1 = PathBuilder::new().line_to(Point::new(10.0, 0.0)).build();

composition
    .get_mut_or_insert_default(Order::new(0).unwrap())
    .insert(&line0)
    .insert(&line1);

pub fn clear(&mut self) -> &mut Self

Clears the geometry stored in the layer and resets its geometry ID.

Examples

let mut composition = Composition::new();

let mut layer = composition.create_layer();

let initial_id = layer.geom_id();

layer.clear();

assert_ne!(layer.geom_id(), initial_id);

pub fn geom_id(&self) -> GeomId

Returns the layer’s geometry ID.

Used to retrieve the layer’s Order if stored in a Composition.

Examples

let mut composition = Composition::new();

let order = Order::new(0).unwrap();
let layer = composition.get_mut_or_insert_default(order);
let id = layer.geom_id();

assert_eq!(composition.get_order_if_stored(id), Some(order));

pub fn is_enabled(&self) -> bool

Returns true if the layer is enabled.

Examples

let mut composition = Composition::new();

let layer = composition.create_layer();

assert!(layer.is_enabled());

pub fn set_is_enabled(&mut self, is_enabled: bool) -> &mut Self

Sets the layer’s enabled state.

Examples

let mut composition = Composition::new();

let mut layer = composition.create_layer();

layer.set_is_enabled(false);

assert!(!layer.is_enabled());

pub fn disable(&mut self) -> &mut Self

Disables the layer.

Examples

let mut composition = Composition::new();

let mut layer = composition.create_layer();

layer.disable();

assert!(!layer.is_enabled());

pub fn enable(&mut self) -> &mut Self

Enables the layer.

Examples

let mut composition = Composition::new();

let mut layer = composition.create_layer();

layer.disable();
layer.enable();

assert!(layer.is_enabled());

pub fn transform(&self) -> GeomPresTransform

Returns the layer’s transform.

Examples

let mut composition = Composition::new();

let layer = composition.create_layer();

assert!(layer.transform().is_identity());

pub fn set_transform(&mut self, transform: GeomPresTransform) -> &mut Self

Sets the layer’s transform.

Examples

let mut composition = Composition::new();

let mut layer = composition.create_layer();

layer.set_transform(AffineTransform::from([1.0, 0.0, 0.0, 1.0, 1.0, 0.0]).try_into().unwrap());

pub fn props(&self) -> &Props

Returns the layer’s properties.

Examples

let mut composition = Composition::new();

let layer = composition.create_layer();

assert_eq!(layer.props().fill_rule, FillRule::NonZero);

pub fn set_props(&mut self, props: Props) -> &mut Self

Sets the layer’s properties.

Examples

let mut composition = Composition::new();

let mut layer = composition.create_layer();

layer.set_props(Props {
    fill_rule: FillRule::EvenOdd,
    ..Default::default()
});

Trait Implementations

impl Debug for Layer

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

Formats the value using the given formatter.

impl Drop for Layer

fn drop(&mut self)

Executes the destructor for this type.