Controls/io.nacular.doodle.controls.carousel/SlicerPresenter

SlicerPresenter

class SlicerPresenter<T>(numSlices: Int = 5, orientation: Orientation = Vertical, anchor: Anchor = Leading, cutRelativeTo: SlicerPresenter.CutRelativeTo = Carousel, itemConstraints: ConstraintDslContext.(Bounds) -> Unit = fill) : ConstraintBasedPresenter<T> (source)

Shows contents of a Carousel one by one, and "slices" them into ribbons as it transitions between frames.

Parameters

numSlices

to split the frame into when transitioning

orientation

indicates which direction the items fill travel when transitioning

anchor

indicates which part of the item starts moving first

cutRelativeTo

indicates whether cuts are relative to the Carousel or the item

itemConstraints

that determine the bounds of each item relative to the Carousel

Constructors

SlicerPresenter

constructor(numSlices: Int = 5, orientation: Orientation = Vertical, anchor: Anchor = Leading, cutRelativeTo: SlicerPresenter.CutRelativeTo = Carousel, itemConstraints: ConstraintDslContext.(Bounds) -> Unit = fill)

Types

CutRelativeTo

enum CutRelativeTo : Enum<SlicerPresenter.CutRelativeTo>

Functions

boundsFromConstraint

protected fun boundsFromConstraint(item: Carousel.PresentedItem, viewPort: Size, forceSetup: Boolean = false): Rectangle

distanceToNext

open override fun distanceToNext(carousel: Carousel<T, *>, position: CarouselBehavior.Presenter.Position, offset: Vector2D): CarouselBehavior.Presenter.Distance

A Carousel will call this method when trying to do manual movement. This is a fundamentally different problem than it needs to solve when skipping through items (interpolate between indexes). This requires mapping pixel offsets to indexes. Only a Carousel's Presenter knows how items are laid out and can provide any information about "distance" between them. Hence, this API.

item

fun Carousel<T, *>.item(at: CarouselBehavior.Presenter.Position?): Carousel.PresentedItem?

Creates/recycles PresentedItem given a Position

present

open override fun present(carousel: Carousel<T, *>, position: CarouselBehavior.Presenter.Position, progressToNext: Float, supplementalViews: List<View>): CarouselBehavior.Presenter.Presentation

Called by Carousel to update the Presentation it should display.

setBounds

protected fun setBounds(item: Carousel.PresentedItem, viewPort: Size, adjust: (Rectangle) -> Rectangle = { it })

Sets the bounds of item based on the result of adjust. This method tries to handle cases where the item being constrained adjusts its size after a bounds change. This would be the case for an item that maintains an aspect ratio for example. The calculation is run a second time in these cases to allow any constraint to adjust as needed.

update

fun Carousel<T, *>.update()

Indicate that the stage is outdated and suggest the Carousel invoke present.