maxxfrazer/arkit-scnpath

Create paths for your Augmented Reality environments using just points to represent the centre of the path.

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:

arkit-scnpath's Issues

Find a way to make this work with RealityKit

Feature Request

What do you want to add?

The same path geometry working in RealityKit - without exporting from SceneKit as a USDz

How should it look like?

The same as in SceneKit

Notes

RealityKit doesn't seem to support custom geometries, I'll continue to investigate but want to get this repo working with RealityKit.

Material cutting out on curved surfaces.

A feature request

What do you want to add?

If this feature is already here I would truly appreciate someone pointing it out, thanks in advance!

I have multiple planes created by a list of paths.

I also have 1 material that I would like to repeat across these planes, but as it stands now it seems to cut when the curve appears. I am not quite sure how this cut happens yet, but I would appreciate a way for it to not be cut.

How should it look like?

Please add images.

Simply a material that works across multiple curved planes.

Occlusions working with iOS 12?

I was trying to get occlusions going with 12.1.4 and they no longer seems to work. Any clue? (Not that I tried with 11)

The Path is created is display against the wall

Hi I have implemented the Scnpath.
But the problem im facing is that im able to see the path across the wall.
PFA is attached screenshot

Error:- No such module 'SCNPath'

Im getting No such module 'SCNPath'.

Please suggest. attachéd is the screenshot.

ARSmartHItTest error

Hello Im getting error in ViewController class

Error:-
Cannot assign value of type 'ARSCNView?' to type 'ARSmartHitTest?'

Line no :- 38
self.focusSquare.viewDelegate = self.sceneView

Please suggest.

Add ability to store map/paths and retrieve

Not really a bug, just a feature request. Would it be possible to add a way to store map data and paths to retrieve later.

Getting distance between you and path.

Hi,
This is just an improvement or a question... is there a way to calculate the minimum distance between the path and the center of the camera? Supposing that you are not on the path and you want to calculate the minimum distance between you and the path.
Another option is: instead to calculate the distance, is there a way to check if the focusNode is on the path or not?
Thanks in advance.

Can't install the pod file into the project?

Below is the error.
[!] Unable to find a specification for SCNPath