Asset Flow

    Description

    The Asset Flow presents a collection of assets in a line but with a sense of depth. It puts the focus on one asset at a time (the central asset) and allows you to call up other assets further down the line using the swipe gesture or a simple control.

    Like most collections, the Asset Flow collection can include any asset type, including buttons and even other collections. Buttons in an Asset Flow can be used to trigger any action, including navigation to other Scenes. To do so:

    • Create Simple or Image buttons in the same Scene as the Asset Flow .
    • If Image buttons, select an image for each button, optionally using different images for Pressed and Released states.
    • Define actions for each button using the Triggers and Actions panel.
    • Drag these buttons into the Flow either from the Scene Structure panel or from the design canvas.
    • Using Player or Composer's Preview Mode, click on the front-and-center button in the Flow to trigger its action(s).

    AssetFlow.gif

    Properties, Triggers & Actions

    Properties

    See Common collection properties for details of common properties shared by different all collection types

    Appearance

    • Index in focus   specify which item in the collection should have focus
    • Expansion factor   defines the depth of Scene that separates the items in the line – the line expands (items appear to be further away) or contracts (items appear to be nearer)
    • Wing span   defines the degree of visibility (overlap or horizontal spacing) of the items in the line
    • Curtain aperture   defines the horizontal Scene between the item in focus (the central item) and the other items in the line
    • Max visible items   defines the maximum number of items in view at any time – enter an odd number (3 is the minimum): 3, 5, 7, etc.
    • Show curtain shadows   toggle whether or not a graphic effect should be displayed on either edge of the collection to indicate that unseen content can be scrolled into view
    • Item width   defines the maximum width of the focus item
    • Item height   defines the maximum height of the focus item
    • Show icons   displays "asset type" identification icons on the assets in the Asset Grid
    • Show scroll indicator shows a position bar indicating the position of the current focus item in relation to the other assets in the collection

    Collection-Appearance-Asset_flow.jpg

    Behavior

    • Number of items in focus   defines the number of items that will recognize touch events
    • Swipe sensitivity threshold   defines the amplitude of movement required to bring a new item into focus
    • Scroll by   defines the number of items scrolled when the scroll arrows are used
    • Initial scroll effect   a visual effect run each time a Scene is displayed to remind users that the collection is scrollable
    • Initial recenter time   defines the time required for the focus item to scroll into position when the Scene is displayed
    • Recenter time   defines the length of time it takes for a swiped Asset Flow to snap to an item after movement has slowed down to a low, predefined (and not configurable) rate.
    • Soft move speed   defines how quickly movement caused by a swipe will come to a halt. The higher the number, the longer it will take a swiped Asset Flow to stop sliding through items - i.e. the "softer" it will slow down.
    • Elasticity   defines the level of elasticity when repositioning the items
    • Allow interaction with item   toggle whether or not an item can be interacted with. For example, if this property is turned on, touching a video in a collection can cause the video to play.
    • Show usage animation   toggles whether or not to display a graphic illustrating how to interact with this collection
    • Tap item to open   toggle whether or not a touch on an item will cause a copy of that item to open outside of its parent collection.
    • Drag and drop item to open   toggle whether or not a drag-and-drop action on an item will cause a copy of that item to open outside of its parent collection.
    • Resize ratio for opened item   identify the size multiple of an opened item in comparison to its size while inside the collection. A ratio of 1 means don't change the size, a ratio of 2 means double the size, a ratio of 0.5 means reduce the size in half, and so on.

    Assetflow-behavior.jpg

    Triggers

    See Triggers Overview to get details of common triggers shared by all assets or collections

    • Index is changed: Raised when the index has changed.
    • Is moved to the next item: Raised when this collection is moved to the next item.
    • Is moved to the previous item: Raised when this collection is moved to the previous item.
    • Is scrolled: Raised when this collection has been scrolled.
    • Last item is reached: Raised when the last item has been reached.
    • Reaches index: Raised when the specified index is reached
      • Index: the index to reach

    The screenshot below illustrate the set of triggers specific to the Asset Flow Collection.
    Triggers-Asset_Flow.jpg

    Actions

    See Actions Overview to get details of common actions shared by all assets or collections

    NOTE: The Open item action requires that the collection's Visible property be set to True and that the item to be opened is already scrolled into view. If the item is not yet scrolled into view, use the Scroll to or Scroll to an asset actions before calling Open item.

    • Close all opened collection items: Close all opened collection items.
    • Next: Go to the next item.
    • Open item: Open a copy of the item outside its collection.
      • Index: The index of the item to open.
      • X: The X position to open the item at.
      • Y: The Y position to open the item at.
      • Orientation: The orientation to open the item with.
    • Previous: Go to the previous item.
    • Scroll to: Scroll to an item using its index.
      • Index: The index of the item to scroll to.
    • Scroll to an item: Scroll to an item using its Name property.
      • Item name: the asset name to scroll to.

    The screenshots below illustrate the set of actions specific to the Asset Flow Collection.
    Actions-Asset-Flow.jpg