Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxxfrazer/arkit-scnpath
Create paths for your Augmented Reality environments using just points to represent the centre of the path.
https://github.com/maxxfrazer/arkit-scnpath
arkit arkit-scnpath augmented-reality geometry-processing ios scenekit scenekit-arkit swift
Last synced: 19 days ago
JSON representation
Create paths for your Augmented Reality environments using just points to represent the centre of the path.
- Host: GitHub
- URL: https://github.com/maxxfrazer/arkit-scnpath
- Owner: maxxfrazer
- License: mit
- Created: 2018-12-15T19:54:56.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2021-03-15T11:05:20.000Z (over 3 years ago)
- Last Synced: 2024-10-11T22:51:10.814Z (about 1 month ago)
- Topics: arkit, arkit-scnpath, augmented-reality, geometry-processing, ios, scenekit, scenekit-arkit, swift
- Language: Swift
- Homepage:
- Size: 14.1 MB
- Stars: 358
- Watchers: 23
- Forks: 41
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ARKit-SCNPath
Functions and classes for creating path geometries in a SceneKit application on iOS. Main use-case being for ARKit.
I'm hoping to add RealityKit support once it is possible to generate meshes. (If anyone knows a way how, please let me know!)
[](https://cocoapods.org/pods/SCNPath)
[](https://cocoapods.org/pods/SCNPath)
[](https://cocoapods.org/pods/SCNPath)
[](https://github.com/apple/swift-package-manager)
[](https://swift.org/)
[](https://github.com/maxxfrazer/ARKit-SCNPath/actions)
## Introduction
Navigation seems to be a strong point for people making AR apps. So here's a class to easily create a path in AR along a set of centre points. This class can also be used to draw out a racetrack, road for an animated character to follow, or even draw a pentagram on the floor!
[Check out the full tutorial on Medium](https://medium.com/@maxxfrazer/arkit-pods-scnpath-d4b491803019) on how I made the examples in the below gifs using this Pod and about 30 lines of non boilerplate code.
Please feel free to use and contribute this library however you like.
I only ask that you let me know when you're doing so, so I can see some cool uses of it!
If you're having issues with Swift Package dependencies there's some great resources online:
https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app
## Requirements
- Swift 5.0
- iOS 11.0
## Compatibility
- [x] SceneKit
- [ ] RealityKit
## Example
It's as easy as this to make a node with this path as a geometry:
```
let pathNode = SCNPathNode(path: [
SCNVector3(0, -1, 0),
SCNVector3(0, -1, -1),
SCNVector3(1, -1, -1)
])
```
Alternatively, you can grab the geometry directly:
```
let pathGeometry = SCNGeometry.path(path: [
SCNVector3(0, -1, 0),
SCNVector3(0, -1, -1),
SCNVector3(1, -1, -1)
])
```
The y value is set to -1 just as an example that assumes the origin of your scene graph is 1m above the ground. Use plane detection to actually hit the ground correctly.
Other parameters that can be passed into both the SCNPathNode class and the SCNGeometry.path functions:
| name | description | default | example |
|---------------|---------------------------------------------------------------------------------|--------------------|---------------------------------|
| path | Array of SCNVector3 points to make up the path | no default | [SCNVector3(0,-1,0), SCNVector3(0,-1,-1), SCNVector3(1,-1,-1)] |
| width | width of the path in meters | 0.5 | 0.1 |
| curvePoints | number of points to make up the curved look when the path is turning to a new direction. | 8 | 16 |
| materials | materials to be applied to the geometry. | a blue SCNMaterial | [SCNMaterial()] |
| curveDistance | distance from the centre of the curve as a multiple of half the width to set the corner radius. Minimum value is 1. | 1.5 | 2 |
Here's some basic examples of what you can do with this Package:
