Swiftpack.co - ryanlintott/LookingGlassUI as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by ryanlintott.
ryanlintott/LookingGlassUI 0.1.9
A realistic reflective shimmer to SwiftUI Views that uses device orientation. Position any View relative to device orientation to appear as if through a window or reflected by the screen.
⭐️ 55
🕓 4 weeks ago
iOS macOS
.package(url: "https://github.com/ryanlintott/LookingGlassUI.git", from: "0.1.9")

LookingGlassUI

Platform iOS 13 SPM compatible License - MIT Version GitHub last commit Twitter

Overview

A Swift Package with SwiftUI views that can rotate views based on device orientation. It's especially useful in faking a light reflection to create a shimmering effect when the device rotates.

  • .motionManager() - A view modifier that creates a MotionManager class that gets device rotation information from Core Motion and adds it into the environment for other views to access.
  • ShimmerView - A view similar to color that shimmers with another color as if reflecting light when your device rotates.
  • .shimmer() - A view modifier that overlays a shimmer color on any view as the device rotates.
  • LookingGlass - A view that rotates its child view to a specific 3d angle relative to the real world and positions it relative to the device.
  • .deviceRotationEffect() - A view modifier that rotates a view based on device rotation.

Gold Shimmer Demo

This package is currently used to create a gold shimmer effect on many gold elements in the Old English Wordhord app. Download it to see the effect in action.

Old English Wordhord App Shimmer v001 - Twitter

Download on the App Store

LookingGlassUIExample

Check out the example app to see how you can use this package in your iOS app.

Installation

  1. In XCode 12 go to File -> Swift Packages -> Add Package Dependency or in XCode 13 File -> Add Packages
  2. Paste in the repo's url: https://github.com/ryanlintott/LookingGlassUI and select main branch or select by version.

Usage

Import the package using import LookingGlassUI

Platforms

This package is compatible with iOS 13 or later. It's technically compatible with macOS 10.15 or later but hasn't been tested.

Is this Production-Ready?

Really it's up to you. I currently use this package in my own Old English Wordhord app.

Support

If you like this package, buy me a coffee to say thanks!

ko-fi

Details

.motionManager()

Before adding any custom views, add the .motionManager view modifier once, somewhere in the heirarchy above any other views or modifiers used in this package.

ContentView()
    .motionManager(updateInterval: 0.1, disabled: false)

ShimmerView

Use ShimmerView if you want a view that acts like Color but with a default shimmer effect. If MotionManager is disabled only the background color will be shown.

ShimmerView(color: .goldShimmer, background: .gold)

.shimmer()

Use .shimmer() view modifier if you want to add a default shimmer effect to another SwiftUI View. If MotionManager is disabled the modifier has no effect.

Text("Hello, World!")
    .shimmer(color: .gold)

LookingGlass

Use LookingGlass if you want to project any SwiftUI view or create your own custom effect. Content appears as if rotated and positioned from the center of the device regardless of positioin on the screen or if it's in a scrollview. If MotionManager is disabled nothing will be shown.

LookingGlass(.reflection, distance: 4000, perspective: 0, pitch: .degrees(45), yaw: .zero, localRoll: .zero, isShowingInFourDirections: false) {
    Text("Hello, World")
        .foregroundColor(.white)
        .frame(width: 500, height: 500)
        .background(Color.red)
}

.deviceRotationEffect()

Use .deviceRotationEffect() if you want to rotate a view based on device rotation. Content is rotated and positioned based on it's own center. If MotionManager is disabled nothing will be shown.

Text("Hello, World")
    .foregroundColor(.white)
    .frame(width: 500, height: 500)
    .background(Color.red)
    .deviceRotationEffect(.reflection, distance: 4000, perspective: 0, pitch: .degrees(10), yaw: .zero, localRoll: .zero, isShowingInFourDirections: false)

How it Works

Window and Reflection Modes

In window mode a view appears as if your phone is a window looking into a 3d environment.

In reflection mode a view appears as if your phone has a camera pointing out of the screen back at a 3d envrionment. It's not a true reflection as it doesn't take into account the viewer's eye location but it's a useful approximation.

Positioning View

Views are positioned based on a quaternion or pitch, yaw, and local roll angles. All angles at zero means the view will be visible when the phone is flat with the top pointing away from the user. (see diagram below)

  1. Local Roll rotate the view around the Z axis. 10 degrees will tilt the view counter-clockwise
  2. Pitch will rotate the view around the X axis. 90 degrees will bring the view up directly in front of the user.
  3. Yaw will rotate the view around the Z axis again. 5 degrees will move the view slightly to the left of the user. If you set isShowingInFourDirections to true the view will be copied 3 additional times and rotated at -90, 90, and 180 degrees from the position you chose.
  4. The view is then moved away from the origin based on the distance provided. The direction is dependant on choosing window or reflection.
  5. As the user moves their device around they will always see your view in the location you've set.

Don't worry about device orientation. Although Core Motion doesn't compensate for this, LookingGlassUI does.

LookingGlassUI Rotation Diagram

Additional Rotation Diagrams

3D space is confusing on iOS, especially as Core Motion and SwiftUI's rotation3dEffect each seem to use different axes. I created this diagram to keep track of how each one works. You probably won't need these unless you want to do something more custom.

iOS Rotation Diagrams

Dependencies

Fireblade Math, Copyright (c) 2018-2021 Christian Treffs

GitHub

link
Stars: 55
Last commit: 6 days ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Dependencies

Release Notes

v0.1.7
24 weeks ago

Initial release. Although currently in use in one of my production apps it may not work perfectly in your use case.

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics