Struct LeaderLayer 

pub struct LeaderLayer { /* private fields */ }

A composited layer that can be followed by a FollowerLayer.

This layer collapses the accumulated offset into a transform and passes Offset::ZERO to its child layers in the Layer::add_to_scene / add_children_to_scene methods, so that ContainerLayer::apply_transform will work reliably.

Implementations

impl LeaderLayer

pub fn new(app: &mut App, link: Handle<LayerLink>) -> Handle<LeaderLayer>

Creates a leader layer.

The link property must not have been provided to any other LeaderLayer layers that are attached to the layer tree at the same time.

The offset property must be non-null before the compositing phase of the pipeline.

pub fn link(self: Handle<Self>, app: &App) -> Handle<LayerLink>

The object with which this layer should register.

The link will be established when this layer is Layer::attached, and will be cleared when this layer is Layer::detached.

pub fn set_link(self: Handle<Self>, app: &mut App, value: Handle<LayerLink>)

See link.

pub fn offset(self: Handle<Self>, app: &App) -> Offset

Offset from parent in the parent’s coordinate system.

The scene must be explicitly recomposited after this property is changed (as described at Layer).

The offset property must be non-null before the compositing phase of the pipeline.

pub fn set_offset(self: Handle<Self>, app: &mut App, value: Offset)

See offset.

Trait Implementations

impl ContainerLayer for LeaderLayer

fn apply_transform( self: Handle<Self>, app: &App, _child: Option<AnyLayer>, transform: &mut Matrix4, )

Applies the transform that would be applied when compositing the given child to the given matrix.

See ContainerLayer::apply_transform for details.

The child argument may be null, as the same transform is applied to all children.

fn container_layer_data(self: Handle<Self>, app: &App) -> &ContainerLayerData

Mixin field access.

fn container_layer_data_mut( self: Handle<Self>, app: &mut App, ) -> &mut ContainerLayerData

See container_layer_data.

const AS_OFFSET: Option<fn() -> &'static OffsetLayerVTable> = None

The offset table when this type extends OffsetLayer; container_layer_accessors!(offset) sets it. Dart’s layer is OffsetLayer.

fn as_container_layer(self: Handle<Self>) -> AnyContainerLayer

Dart’s implicit upcast of a concrete layer to ContainerLayer.

fn fire_composition_callbacks( self: Handle<Self>, app: &mut App, include_children: bool, )

ContainerLayer._fireCompositionCallbacks.

fn supports_rasterization(self: Handle<Self>, app: &App) -> bool

ContainerLayer.supportsRasterization.

fn dispose(self: Handle<Self>, app: &mut App)

ContainerLayer.dispose.

fn find_annotations( self: Handle<Self>, app: &App, result: &mut AnnotationSearch, local_position: Offset, only_first: bool, ) -> bool

ContainerLayer.findAnnotations.

fn attach(self: Handle<Self>, app: &mut App, owner: HandleId)

ContainerLayer.attach.

fn detach(self: Handle<Self>, app: &mut App)

ContainerLayer.detach.

fn redepth_children(self: Handle<Self>, app: &mut App)

ContainerLayer.redepthChildren.

fn add_to_scene(self: Handle<Self>, app: &mut App, builder: &mut SceneBuilder)

ContainerLayer.addToScene.

impl Layer for LeaderLayer

const AS_CONTAINER: Option<fn() -> &'static ContainerLayerVTable>

The container table when this type extends ContainerLayer; layer_accessors!(container) sets it. Dart’s layer is ContainerLayer.

fn layer_data(self: Handle<Self>, app: &App) -> &LayerData

Dart’s base-class fields, held under the field layer ([layer_accessors!]).

fn layer_data_mut(self: Handle<Self>, app: &mut App) -> &mut LayerData

See layer_data.

fn supports_rasterization(self: Handle<Self>, app: &App) -> bool

Whether or not this layer, or any child layers, can be rasterized with Scene.toImage.

fn dispose(self: Handle<Self>, app: &mut App)

Clears any retained resources that this layer holds.

fn attach(self: Handle<Self>, app: &mut App, owner: HandleId)

Mark this layer as attached to the given owner.

fn detach(self: Handle<Self>, app: &mut App)

Mark this layer as detached from its owner.

fn redepth_children(self: Handle<Self>, app: &mut App)

Adjust the depth of this node’s children, if any.

fn find_annotations( self: Handle<Self>, app: &App, result: &mut AnnotationSearch, local_position: Offset, only_first: bool, ) -> bool

Search this layer and its subtree for annotations of the searched type at the location described by local_position.

fn add_to_scene(self: Handle<Self>, app: &mut App, builder: &mut SceneBuilder)

Override this method to upload this layer to the engine.

fn fire_composition_callbacks( self: Handle<Self>, app: &mut App, include_children: bool, )

Dart’s _fireCompositionCallbacks; ContainerLayer recurses into its children.

fn describe_clip_bounds(self: Handle<Self>, app: &App) -> Option<Rect>

Describes the clip that would be applied to contents of this layer, if any.

fn always_needs_add_to_scene(self: Handle<Self>, app: &App) -> bool

Subclasses may override this to true to disable retained rendering.