Latest 1.0
Homepage https://github.com/asynchrony/Re-Lax
License MIT
Platforms tvos 9.0, requires ARC
Authors , ,

icon

Re:Lax Carthage compatible pod License

From the tvOS HIG

If your app uses UIKit and the focus API to implement its user interface, the motion and visual effects of the focus model apply to your interface elements. This makes your app feel native to the platform and helps reduce friction as people move through your interface. When people use the Siri Remote with your app, they’ll find transitioning between focusable elements fluid and intuitive.

Apple have a few ways to create parallax effects using only tools. Parallax previewer is a stand alone application that can have image layers added to it and can be exported as an LCR file, which is Apple’s proprietary parallax file format. They also provide a Photoshop plugin that can export a PSD file as an LCR file. Lastly, there is a command line utility, layerutil, that can export LSR or PSD files into an LCR file.


Re:Lax in Action

Re:Lax provides a way to create parallax effects at runtime, eliminating latency for the users of your app and server-side support required to generate parallax images. It provides ways to create custom parallax effects to any programmatic view as well as the ability to generate a parallax LCR file at runtime! See for yourself:


LCR Files

LCR files are most useful when creating Top Shelf extensions that display dynamic parallax content. If your app retrieves layered images from a server at runtime, you must provide those images as LCR files. LCR files are generated from .lsr or Photoshop files using the layerutil command-line tool that’s installed with Xcode, or by using ParallaxPreviewer.app. This process does not scale when creating parallax files for dynamic content; fortunately, Re:Lax fixes this.

We have reverse engineered the LCR image format in order to make this convenient for content providers. This can be done on the fly without the need to use a server to distribute the parallax image files. Re:Lax makes programmatically generating LCR files within your app or extension a breeze.

let parallaxImage = ParallaxImage(images: images)
let lcrImage: UIImage = parallaxImage.image()

You also have access to the raw image data if you’d rather write the image to a file to save for later

try parallaxImage.imageData().write(to: someFileUrl, options: [])

The Example app includes a TopShelf extension which demonstrates how to dynamically create LCR files at runtime and display them on the Top Shelf


Programmatic Effect

Re:Lax makes creating programmatic parallax effects easy by providing a constructor that takes an array of UIImages

let parallaxView = ParallaxView(images: images)

For more flexibility, ParallaxView can be constructed with a layerContainer which is a custom view that will apply the parallax effect to all subviews. An effectMultiplier is also available if you want to force the parallax effect to be more subtle.

// The Parallax Effect is applied to this view, made up of a UIImageView and a UILabel
class ParallaxImageView: UIView, ParallaxContainer {
    private let imageView: UIImageView()
    private let label: UILabel()

    // ...

    func setupView(with image: UIImage, text: String) {
        imageView.iamge = image
        label.text = text
    }

    func focusChanged(_ focus: ParallaxFocusState) {}
    func parallaxShadow(forFocus: ParallaxFocusState, defaultShadow: Shadow) -> Shadow? {
        return defaultShadow
    }
}

class ParallaxCell: UICollectionViewCell {
    private let parallaxView: ParallaxView<ParallaxImageView>
    private let container: ParallaxImageView

    init(container: ParallaxImageView) {
        container = layerContainer
        parallaxView = ParallaxView(layerContainer: container, effectMultiplier: 1.0)
        super.init(frame: .zero)
        addSubview(parallaxView)
    }

    override var isHighlighted: Bool {
        didSet {
            if isFocused {
                let focus: ParallaxFocusState = isHighlighted ? .focusedDepressed : .focused
                parallaxView.setFocusState(focus, animationType: .animated)
            }
        }
    }

    override func didUpdateFocus(in context: UIFocusUpdateContext, with coordinator: UIFocusAnimationCoordinator) {
        super.didUpdateFocus(in: context, with: coordinator)
        parallaxView.didUpdateFocus(in: context, with: coordinator)
    }
}

Tips

  • If you are noticing jagged edges on subviews of your ParallaxContainer, set yourView.layer.allowsEdgeAntialiasing = true.
  • Providing an appropriate shadowPath to the parallaxShadow method can improve performance.
  • Generated LCR files can only contain up to 5 layers. This is a limitation of the file format.

Installation

Our weapon of choice is subprojects + Frameworks, but we’re just happy that you want to use our library.

Carthage

github "Asynchrony/Re-Lax"

CocoaPods

pod 'Re-Lax'

Requirements

  • tvOS 9.0
  • Xcode 8

License

Re:Lax is available using an MIT license. See the LICENSE file for more info.

We’d Love to Know If You’re Using ReLax!

Tweet us at @marksands or @JARinteractive to let us know if you’re using the library :+1:

Latest podspec

{
    "name": "Re-Lax",
    "version": "1.0",
    "summary": "Recreating Parallax on tvOS",
    "homepage": "https://github.com/asynchrony/Re-Lax",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "authors": {
        "Mark Sands": "[email protected]",
        "James Rantanen": "[email protected]",
        "Asynchrony": null
    },
    "social_media_url": "http://twitter.com/asynchrony",
    "source": {
        "git": "https://github.com/asynchrony/Re-Lax.git",
        "tag": "v1.0"
    },
    "source_files": "ReLax/ReLax/**/*.swift",
    "resources": [
        "ReLax/ReLax/blue-radiosity",
        "ReLax/ReLax/bomTableStart",
        "ReLax/ReLax/tmfkLayerData",
        "ReLax/ReLax/tmfkPrefixData"
    ],
    "requires_arc": true,
    "platforms": {
        "tvos": "9.0"
    },
    "pushed_with_swift_version": "3.0"
}

Pin It on Pinterest

Share This