README.md

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!)

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 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

• 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: