https://github.com/maxxfrazer/SceneKit-SCNLine
Draw a tube or thick line in SceneKit
https://github.com/maxxfrazer/SceneKit-SCNLine
ar-experiments arkit arkit2 augmented-reality augmentedreality drawing drawing-app geometry-library ios scenekit swift swift-package-manager swiftpm
Last synced: 3 months ago
JSON representation
Draw a tube or thick line in SceneKit
- Host: GitHub
- URL: https://github.com/maxxfrazer/SceneKit-SCNLine
- Owner: maxxfrazer
- License: mit
- Created: 2018-12-14T21:40:52.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-01-31T14:41:35.000Z (over 1 year ago)
- Last Synced: 2025-02-11T10:11:18.747Z (3 months ago)
- Topics: ar-experiments, arkit, arkit2, augmented-reality, augmentedreality, drawing, drawing-app, geometry-library, ios, scenekit, swift, swift-package-manager, swiftpm
- Language: Swift
- Size: 17.6 MB
- Stars: 94
- Watchers: 6
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - SceneKit-SCNLine - Draw a tube or thick line in SceneKit.`pod 'SCNLine' or pod 'SCNLine', '~> 1.3.0'`【 [Preview](https://github.com/maxxfrazer/SceneKit-SCNLine/blob/master/media/lines-hello-lighton.gif) 】 (OOM-Leaks-Crash / AR-VR)
- awesome - SceneKit-SCNLine - Draw a tube or thick line in SceneKit.`pod 'SCNLine' or pod 'SCNLine', '~> 1.3.0'`【 [Preview](https://github.com/maxxfrazer/SceneKit-SCNLine/blob/master/media/lines-hello-lighton.gif) 】 (OOM-Leaks-Crash / AR-VR)
README
# SCNLine
Functions and classes for creating thick line geometries in a application using SceneKit.
[](https://github.com/maxxfrazer/SceneKit-SCNLine/actions)
[](https://github.com/maxxfrazer/SceneKit-SCNLine/actions)
[](https://swift.org/)
## Introduction
SCNLine is a class for drawing lines of a given thickness in 3D space.
In most situations in 3D projects the typically used method would use [GL_LINES](https://www.glprogramming.com/red/chapter02.html#name14); which can be exercised in SceneKit with [this primitive type](https://developer.apple.com/documentation/scenekit/scngeometryprimitivetype/line). However [glLineWidth](https://developer.apple.com/documentation/opengles/1617268-gllinewidth?language=occ) is now depricated, which is initially why I made this class.
For more information on drawing primitive types in OpenGL or otherwise, please refer to [this document](http://15462.courses.cs.cmu.edu/spring2018content/lectures/00_opengl/00_opengl_slides.pdf), or if you want to see how it's applied in SceneKit, check out my [first Medium article about building primitive geometries](https://link.medium.com/umwbtn8afT).
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; that way I can see some cool uses of it!
## Installation
### Swift Package Manager
Add the URL of this repository to your Xcode 11+ Project.
`https://github.com/maxxfrazer/SceneKit-SCNLine.git`
### CocoaPods
Add to Podfile: `pod 'SCNLine', '~> 1.0'`
### Import
Add to .swift file: `import SCNLine`
## Example
It's as easy as this to a line geometry:
```
let lineGeometry = SCNGeometry.line(points: [
SCNVector3(0,-1,0),
SCNVector3(0,-1,-1),
SCNVector3(1,-1,-1)
], radius: 0.1).0
```
Or using the node directly SCNLineNode:
```
drawingNode = SCNLineNode(
with: [SCNVector3(0,-1,0), SCNVector3(0,-1,-1), SCNVector3(1,-1,-1)],
radius: 0.01,
edges: 12,
maxTurning: 12
)
drawingNode.add(point: SCNVector3(1,-2,-2))
```
The latter is recommended if you want to update the line at a later time by adding a point to it.
This will draw a line of radius 10cm from below the origin, forwards and then to the right in an ARKit setup.
The y value is set to -1 just as an example that assumes the origin of your scene graph is about 1m above the ground.
Other parameters that can be passed into SCNGeometry.path:
| name | description | default | example |
|---------------|---------------------------------------------------------------------------------|--------------------|---------------------------------|
| points | Array of SCNVector3 points to make up the line | no default | [SCNVector3(0,-1,0), SCNVector3(0,-1,-1), SCNVector3(1,-1,-1)] |
| radius | Radius of the line in meters | no default | 0.1 |
| edges | The number of vertices used around the edge of the tube shaped line to be exteneded throughout the geometry. | 12, minimum is 3 | 16 |
| maxTurning | Maximum number of points to make up the curved look when the line is turning to a new direction. | 4 | 16 |
While in the examples below it shows that this can be used for drawing apps I would not recommend this class for that in its current state, because the current class regathers vertices from the very beginning of the line right to the end, which is very inefficient as most will remain the same.
Here's some basic examples of what you can do with this Pod:
