Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ejeinc/MetalScope
Metal-backed 360° panorama view for iOS
https://github.com/ejeinc/MetalScope
cardboard ios metal panorama scenekit swift video
Last synced: about 2 months ago
JSON representation
Metal-backed 360° panorama view for iOS
- Host: GitHub
- URL: https://github.com/ejeinc/MetalScope
- Owner: ejeinc
- License: mit
- Archived: true
- Created: 2017-01-19T16:32:42.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-05-04T11:07:08.000Z (over 4 years ago)
- Last Synced: 2024-09-18T16:51:25.772Z (4 months ago)
- Topics: cardboard, ios, metal, panorama, scenekit, swift, video
- Language: Swift
- Homepage:
- Size: 21.6 MB
- Stars: 324
- Watchers: 11
- Forks: 72
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - MetalScope - Metal-backed 360° panorama view for iOS.【 [Preview](https://raw.githubusercontent.com/ejeinc/MetalScope/master/Resources/panorama-preview.gif) 】 (OOM-Leaks-Crash / Panorama)
README
# MetalScope
  
Metal-backed 360° panorama view for iOS.
| | Features
|--------------------------|---------
| :metal: | Built on top of SceneKit + Metal
| :eyes: | Distorted stereo view for Cardboard
| :globe_with_meridians: | Support mono/stereo equirectangular images/videos
| :arrow_forward: | Direct access to AVPlayer for video control
| :point_up_2: | Smooth touch rotation and re-centering
| :sunrise_over_mountains: | Custom SCNScene presentation
| :bird: | Written in Swift 3
## Usage
### PanoramaView
Use `PanoramaView` to display an equirectangular image or video.
```swift
import MetalScope
import Metal
import AVFoundation
guard let device = MTLCreateSystemDefaultDevice() else {
fatalError("MetalScope requires Metal 🤘")
}
let panoramaView = PanoramaView(frame: ..., device: device)
// load monoscopic panorama image
let panoramaImage = UIImage(...)
panoramaView.load(panoramaImage, format: .mono)
// load stereoscopic panorama video
let videoURL = URL(...)
let player = AVPlayer(url: videoURL)
panoramaView.load(player, format: .stereoOverUnder)
player.play()
// load any SCNScene
panoramaView.scene = ...
```
`PanoramaView` rotates the point of view by device motions and user's pan gesture. To reset rotation, just call `setNeedsResetRotation()`
```swift
let panoramaView: PanoramaView = ...
// double tap to re-center the scene
let recognizer = UITapGestureRecognizer(
target: panoramaView,
action: #selector(PanoramaView.setNeedsResetRotation(_:)))
recognizer.numberOfTapsRequired = 2
panoramaView.addGestureRecognizer(recognizer)
// if you want to disable pan gesture:
panoramaView.panGestureRecognizer.isEnabled = false
```
[60 FPS demo](https://youtu.be/D7wTFA5K96U) on YouTube
### StereoView
For stereo display for Google's Cardboard, use `StereoView` or `StereoViewController` instead.
```swift
let stereoViewController = StereoViewController(device: ...)
// load media
stereoViewController.load(image, format: .stereoOverUnder)
// or any SCNScene
stereoViewController.scene = panoramaView.scene
// customize stereo parameters if needed
stereoViewController.stereoParameters = StereoParameters(
screenModel: .default,
viewerModel: .cardboardMay2015)
present(stereoViewController, animated: true, completion: nil)
```
Check example apps for more samples.
### Simulator
`PanoramaView`, `StereoView` and `StereoViewController` can also be used on iOS simulator by using alternative initializers.
```swift
#if arch(arm) || arch(arm64)
let panoramaView = PanoramaView(frame: view.bounds, device: device)
#else
let panoramaView = PanoramaView(frame: view.bounds) // simulator
#endif
```
Please note that these classes are significantly limited in functionality on the simulator. For example, `PanoramaView` can display photos, but cannot display videos. For `StereoView` and `StereoViewController`, it is a placeholder and nothing is displayed.
## Requirements
- Xcode 8.2+
- iOS 9.0+
- Swift 3.0+
- Metal (Apple A7+)
NOTE: Metal is not supported in the iOS Simulator 😢
## Installation
### Carthage
If you use [Carthage](https://github.com/Carthage/Carthage) to manage your dependencies, add MetalScope to your `Cartfile`:
```
github "ejeinc/MetalScope"
```
### CocoaPods
If you use [CocoaPods](https://github.com/CocoaPods/CocoaPods) to manage your dependencies, add MetalScope to your `Podfile`:
```
pod 'MetalScope'
```
### Manually
You can also manually install the framework by dragging and dropping the `MetalScope.xcodeproj` into your project or workspace.
## License
MetalScope is released under the MIT license. See LICENSE for details.