js/SceneKit/SCNScene.js
'use strict'
import NSObject from '../ObjectiveC/NSObject'
import SKColor from '../SpriteKit/SKColor'
import SCNNode from './SCNNode'
import SCNMaterial from './SCNMaterial'
import SCNBox from './SCNBox'
//import SCNMaterialProperty from './SCNMaterialProperty'
import SCNGeometrySource from './SCNGeometrySource'
//import SCNSceneExportDelegate from './SCNSceneExportDelegate'
//import SCNSceneExportProgressHandler from './SCNSceneExportProgressHandler'
import SCNSceneSource from './SCNSceneSource'
import SCNPhysicsWorld from './SCNPhysicsWorld'
//import SCNParticleSystem from './SCNParticleSystem'
//import SCNMatrix4 from './SCNMatrix4'
import _BinaryRequest from '../util/_BinaryRequest'
import _File from '../util/_File'
import _FileReader from '../util/_FileReader'
const _Attribute = {
endTime: 'kSceneEndTimeAttributeKey',
frameRate: 'kSceneFrameRateAttributeKey',
startTime: 'kSceneStartTimeAttributeKey',
upAxis: 'kSceneUpAxisAttributeKey'
}
/**
* A scene graph—a hierarchy of nodes with attached geometries, lights, cameras and other attributes that together form a displayable 3D scene.
* @access public
* @extends {NSObject}
* @see https://developer.apple.com/documentation/scenekit/scnscene
*/
export default class SCNScene extends NSObject {
static get _propTypes() {
return {
paused: ['boolean', 'isPaused'],
rootNode: ['SCNNode', '_rootNode'],
upAxis: ['SCNVector3', null],
physicsWorld: ['SCNPhysicsWorld', (obj, value) => {
obj._physicsWorld = value
obj._physicsWorld._scene = obj
}],
background: ['SCNMaterialProperty', (obj, value) => {
obj._skyBox.geometry.firstMaterial._emission = value
obj._skyBox.geometry.firstMaterial._emission._createPresentation()
}],
startTime: ['double', null],
endTime: ['double', null],
frameRate: ['double', null],
fogDensityExponent: 'double',
fogStartDistance: 'double',
fogEndDistance: 'double',
fogColor: 'plist',
environment: ['SCNMaterialProperty', '_lightingEnvironment'],
version: ['float', null],
userAttributes: ['NSMutableDictionary', null],
sourceURL: ['NSURL', null]
}
}
/**
* Loads a scene from the specified URL.
* @access public
* @constructor
* @param {string} url - The URL to the scene file to load.
* @param {?Map<SCNSceneSource.LoadingOption, Object>} [options = null] - A dictionary of options affecting scene loading, or nil for default options. For available keys, see Scene Loading Options.
* @param {function} onload -
* @param {function} onerror -
* @throws {Error}
* @desc This method provides a convenient way to load a complete scene from a file at an arbitrary URL. For more detailed options or to load only part of a file’s scene graph, use the SCNSceneSource class.Handling Errors in Swift:
In Swift, this method returns a nonoptional result and is marked with the throws keyword to indicate that it throws an error in cases of failure.
You call this method in a try expression and handle any errors in the catch clauses of a do statement, as described in Error Handling in The Swift Programming Language (Swift 3.1) and Error Handling in Using Swift with Cocoa and Objective-C (Swift 3.1).
* @see https://developer.apple.com/documentation/scenekit/scnscene/1522660-init
*/
constructor(url, options = null, onload = null, onerror = null) {
super()
// Managing Animated Effects in a Scene
/**
* A Boolean value that determines whether to run actions, animations, particle systems, and physics simulations in the scene graph.
* @type {boolean}
* @see https://developer.apple.com/documentation/scenekit/scnscene/1523604-ispaused
*/
this.isPaused = false
// Accessing Scene Contents
this._rootNode = new SCNNode()
this._lightingEnvironment = null
// Adding Fog to a Scene
/**
* The distance from a point of view at which the scene’s contents begin to be obscured by fog. Animatable.
* @type {number}
* @see https://developer.apple.com/documentation/scenekit/scnscene/1522790-fogstartdistance
*/
this.fogStartDistance = 0
/**
* The distance from a point of view at which the scene’s contents are completely obscured by fog. Animatable.
* @type {number}
* @see https://developer.apple.com/documentation/scenekit/scnscene/1523836-fogenddistance
*/
this.fogEndDistance = 0
/**
* The transition curve for the fog’s intensity between its start and end distances. Animatable.
* @type {number}
* @see https://developer.apple.com/documentation/scenekit/scnscene/1523776-fogdensityexponent
*/
this.fogDensityExponent = 0
/**
* The color of the fog effect to be rendered with the scene. Animatable.
* @type {Object}
* @see https://developer.apple.com/documentation/scenekit/scnscene/1522774-fogcolor
*/
this.fogColor = null
// Working With Physics in the Scene
this._physicsWorld = new SCNPhysicsWorld()
this._physicsWorld._scene = this
// Working with Particle Systems in the Scene
this._particleSystems = null
this._particleSystemsTransform = null
/**
* @access private
* @type {Promise}
*/
this._dataLoadedPromise = null
if(url){
const promise = this._loadSceneWithURL(url, options)
.then((scene) => {
this._copyValue(scene)
if(onload){
onload(this)
}
})
.catch((error) => {
if(onerror){
onerror(error)
}
})
this._dataLoadedPromise = promise
}
this._createSkyBox()
/**
* @access private
* @type {Promise}
*/
this._loadedPromise = null
}
_copyValue(src) {
this.isPaused = src.isPaused
this._rootNode = src._rootNode
//this._background = src._background
this._skyBox.geometry = src._skyBox.geometry.copy()
this._lightingEnvironment = src._lightingEnvironment
this.fogStartDistance = src.fogStartDistance
this.fogEndDistance = src.fogEndDistance
this.fogDensityExponent = src.fogDensityExponent
this.fogColor = src.fogColor
this._physicsWorld = src._physicsWorld // TODO: copy SCNPhysicsWorld
this._particleSystems = src._particleSystems ? src._particleSystems.slice(0) : null
this._particleSystemsTransform = src._particleSystemsTransform ? src._particleSystemsTransform.slice(0) : null
}
/**
* @access private
* @param {string} url -
* @param {Object} options -
* @returns {Promise} -
*/
_loadSceneWithURL(url, options) {
let _options = options
if(_options === null){
_options = new Map()
}
if(typeof _options.get(SCNSceneSource.LoadingOption.assetDirectoryURLs) === 'undefined'){
const paths = url.split('/')
const name = paths.pop()
const directory = paths.join('/')
_options.set(SCNSceneSource.LoadingOption.assetDirectoryURLs, directory)
}
if(url instanceof _File){
return Promise((resolve, reject) => {
const reader = new _FileReader()
reader.onload = () => {
const scene = this._loadSceneWithData(reader.result, _options)
resolve(scene)
}
reader.onerror = () => {
reject(reader.error)
}
reader.readAsBinaryString(url)
})
}
return _BinaryRequest.get(url)
.then((data) => {
return this._loadSceneWithData(data, _options)
})
}
/**
* @access private
* @param {Blob} data -
* @param {Object} options -
* @returns {SCNScene} -
*/
_loadSceneWithData(data, options) {
const source = new SCNSceneSource(data, options)
return source.scene()
}
_createSkyBox() {
const skyBoxGeometry = new SCNBox()
const material = new SCNMaterial()
material._diffuse._contents = SKColor.black
material._ambient._contents = SKColor.black
material._emission._contents = null
material.isDoubleSided = true
skyBoxGeometry.firstMaterial = material
const texSrc = skyBoxGeometry.getGeometrySourcesForSemantic(SCNGeometrySource.Semantic.texcoord)[0]
const margin = 0.001
const w0 = 0.0
const w1 = 1.0 / 6.0
const w2 = 2.0 / 6.0
const w3 = 3.0 / 6.0
const w4 = 4.0 / 6.0
const w5 = 5.0 / 6.0
const w6 = 1.0
const data = [
w5 - margin, 1,
w5 - margin, 0,
w4 + margin, 1,
w4 + margin, 0,
w2 - margin, 1,
w2 - margin, 0,
w1 + margin, 1,
w1 + margin, 0,
w6 - margin, 1,
w6 - margin, 0,
w5 + margin, 1,
w5 + margin, 0,
w1 - margin, 1,
w1 - margin, 0,
w0 + margin, 1,
w0 + margin, 0,
w3 - margin, 1,
w3 - margin, 0,
w2 + margin, 1,
w2 + margin, 0,
w4 - margin, 1,
w4 - margin, 0,
w3 + margin, 1,
w3 + margin, 0
]
let dataIndex = 0
let srcIndex = 6
for(let i=0; i<24; i++){
texSrc._data[srcIndex + 0] = data[dataIndex + 0]
texSrc._data[srcIndex + 1] = data[dataIndex + 1]
srcIndex += 8
dataIndex += 2
}
this._skyBox = new SCNNode(skyBoxGeometry)
this._skyBox._presentation = this._skyBox
}
// Creating or Loading a Scene
/**
* Loads a scene from a file with the specified name in the app’s main bundle.
* @access public
* @param {string} name - The name of a scene file in the app bundle’s resources directory.
* @returns {void}
* @desc This method provides a convenient way to load a complete scene from a file in the app’s main bundle. Calling this method is equivalent to using the Bundle class to locate the scene file and passing the resulting URL to the init(url:options:) method, specifying no options and no error handling.For more detailed options or to load only part of a file’s scene graph, use the SCNSceneSource class.
* @see https://developer.apple.com/documentation/scenekit/scnscene/1523355-init
*/
static sceneNamed(name) {
return this.sceneNamedInDirectory(name)
}
/**
* Loads a scene from a file with the specified name in a specific subdirectory of the app’s main bundle.
* @access public
* @param {string} name - The name of a scene file in the app bundle.
* @param {?string} directory - The path to the subdirectory of the bundle’s resources directory containing the scene file.
* @param {?Map<SCNSceneSource.LoadingOption, Object>} [options = null] - A dictionary of options affecting scene loading, or nil for default options. For available keys, see Scene Loading Options.
* @returns {void}
* @desc This method provides a convenient way to load a complete scene from a file in the app’s main bundle. Calling this method is equivalent to using the Bundle class to locate the scene file and passing the resulting URL to the init(url:options:) method.For more detailed options or to load only part of a file’s scene graph, use the SCNSceneSource class.
* @see https://developer.apple.com/documentation/scenekit/scnscene/1522851-init
*/
static sceneNamedInDirectory(name, directory, options = null) {
let path = name
if(directory){
path = directory + '/' + name
}
return new SCNScene(path, options)
}
/**
* Loads a scene from the specified URL.
* @access public
* @param {string} url - The URL to the scene file to load.
* @param {?Map<SCNSceneSource.LoadingOption, Object>} [options = null] - A dictionary of options affecting scene loading, or nil for default options. For available keys, see Scene Loading Options.
* @returns {SCNScene} -
* @throws {Error}
* @desc This method provides a convenient way to load a complete scene from a file at an arbitrary URL. For more detailed options or to load only part of a file’s scene graph, use the SCNSceneSource class.Handling Errors in Swift:
In Swift, this method returns a nonoptional result and is marked with the throws keyword to indicate that it throws an error in cases of failure.
You call this method in a try expression and handle any errors in the catch clauses of a do statement, as described in Error Handling in The Swift Programming Language (Swift 3.1) and Error Handling in Using Swift with Cocoa and Objective-C (Swift 3.1).
* @see https://developer.apple.com/documentation/scenekit/scnscene/1522660-init
*/
static scene(url, options = null) {
return new SCNScene(url, options)
}
// Accessing Scene Contents
/**
* The root node of the scene graph.
* @type {SCNNode}
* @desc All scene content—nodes, geometries and their materials, lights, cameras, and related objects—is organized in a node hierarchy with a single common root node.Some scene files created using external tools may describe node hierarchies containing multiple root nodes. When SceneKit imports such files, their separate root nodes will be made children of a new, unique root node.Each child node’s coordinate system is defined relative to the transformation of its parent node. You should not modify the transform property of the root node.
* @see https://developer.apple.com/documentation/scenekit/scnscene/1524029-rootnode
*/
get rootNode() {
return this._rootNode
}
/**
* A background to be rendered before the rest of the scene.
* @type {SCNMaterialProperty}
* @desc If the material property’s contents object is nil, SceneKit does not draw any background before drawing the rest of the scene. (If the scene is presented in an SCNView instance, the view’s background color is visible behind the contents of the scene.)If you specify a cube map texture for the material property (see the discussion of the contents property), SceneKit renders the background as a skybox.
* @see https://developer.apple.com/documentation/scenekit/scnscene/1523665-background
*/
get background() {
return this._skyBox.geometry.firstMaterial._emission
}
/**
* A cube map texture that depicts the environment surrounding the scene’s contents, used for advanced lighting effects.
* @type {SCNMaterialProperty}
* @desc When rendering materials with the physicallyBased lighting model, SceneKit illuminates surfaces differently according to the environment that surrounds them. For example, with physically based shading, even a diffuse surface takes on some color from the sky above it and the ground below it.TipFor realistic results, reuse the same contents for both the lighting environment and the background property.For information about defining cube maps, see the discussion of the contents property.
* @see https://developer.apple.com/documentation/scenekit/scnscene/1639532-lightingenvironment
*/
get lightingEnvironment() {
return this._lightingEnvironment
}
// Managing Scene Attributes
/**
* Returns the scene attribute for the specified key.
* @access public
* @param {string} key - One of the constants described in Scene Attributes that identifies the attribute to be read.
* @returns {?Object} -
* @see https://developer.apple.com/documentation/scenekit/scnscene/1522858-attribute
*/
attributeForKey(key) {
return null
}
/**
* Sets a scene attribute for the specified key.
* @access public
* @param {?Object} attribute - An object that specifies the value of the attribute to be written.
* @param {string} key - One of the constants described in Scene Attributes that identifies the attribute to be written.
* @returns {void}
* @see https://developer.apple.com/documentation/scenekit/scnscene/1524229-setattribute
*/
setAttributeForKey(attribute, key) {
}
// Exporting a Scene File
/**
* Exports the scene and its contents to a file at the specified URL.
* @access public
* @param {string} url - The URL to write the scene file to. This URL must use the file scheme.
* @param {?Map<string, Object>} [options = null] - A dictionary of options affecting scene loading, or nil for default options. For available keys, see Scene Loading Options.
* @param {?SCNSceneExportDelegate} delegate - A delegate object to customize export of external resources used by the scene. Pass nil for default export of external resources.
* @param {?SCNSceneExportProgressHandler} [progressHandler = null] - A block that SceneKit calls repeatedly to report progress of the export operation.
* @returns {boolean} -
* @desc SceneKit creates and writes a file containing the scene graph in the Digital Asset Exchange (DAE) format. The format of the file created depends on OS version and on the filename extension you specify:In iOS 10.0, tvOS 10.0, watchOS 3.0, OS X v10.11, and later versions, specify the .scn extension to save a file in SceneKit’s native format. This format supports all features of SceneKit (including physics, constraints, and particle systems), and reading files in this format is faster than importing from other scene file formats.In macOS only, specify the .dae extension to export in Digital Asset Exchange (DAE) format for use by other apps. Exported DAE files do not contain scene elements specific to SceneKit, such as physics bodies and fields, constraints, and particle systems.If the scene references external resources, such as image files used in material properties, SceneKit exports these files to a nearby location and references their URLs in the exported scene file. To override SceneKit’s exporting of external resources, provide an object implementing the SCNSceneExportDelegate protocol in the delegate parameter.
* @see https://developer.apple.com/documentation/scenekit/scnscene/1523577-write
*/
writeTo(url, options = null, delegate, progressHandler = null) {
return false
}
// Working With Physics in the Scene
/**
* The physics simulation associated with the scene.
* @type {SCNPhysicsWorld}
* @desc Every scene automatically creates a physics world object to simulate physics on nodes in the scene. You use this property to access the scene’s global physics properties, such as gravity, and to manage physics interactions between nodes. To make a node in the scene participate in the physics simulation, use either or both of its physicsBody and physicsField properties.
* @see https://developer.apple.com/documentation/scenekit/scnscene/1522643-physicsworld
*/
get physicsWorld() {
return this._physicsWorld
}
// Working with Particle Systems in the Scene
/**
* Attaches a particle system to the scene, using the specified transform.
* @access public
* @param {SCNParticleSystem} system - A particle system.
* @param {SCNMatrix4} transform - A transformation matrix that positions and orients the particle system relative to the world coordinate space of the scene.
* @returns {void}
* @desc A particle system directly attached to a scene is not related to the coordinate space of any node in the scene. To attach a particle system whose emitter location follows the movement of a node within the scene, use the corresponding SCNNode method.For details on particle systems, see SCNParticleSystem.
* @see https://developer.apple.com/documentation/scenekit/scnscene/1523359-addparticlesystem
*/
addParticleSystem(system, transform) {
if(this._particleSystems === null){
this._particleSystems = []
this._particleSystemsTransform = []
}
//system._startTime = Date.now() * 0.001
system.reset()
this._particleSystems.push(system)
this._particleSystemsTransform.push(transform)
if(this._particleSystems.length !== this._particleSystemsTransform.length){
throw new Error('particleSystems array length inconsistency')
}
}
/**
* Removes a particle system attached to the scene.
* @access public
* @param {SCNParticleSystem} system - A particle system.
* @returns {void}
* @desc This method has no effect if the system parameter does not reference a particle system directly attached to the scene.
* @see https://developer.apple.com/documentation/scenekit/scnscene/1523498-removeparticlesystem
*/
removeParticleSystem(system) {
if(this._particleSystems === null){
return
}
const index = this._particleSystems.indexOf(system)
if(index < 0){
return
}
this._particleSystems.splice(index, 1)
this._particleSystemsTransform.splice(index, 1)
}
/**
* Removes any particle systems directly attached to the scene.
* @access public
* @returns {void}
* @desc Calling this method does not remove particle systems attached to nodes within the scene.
* @see https://developer.apple.com/documentation/scenekit/scnscene/1522786-removeallparticlesystems
*/
removeAllParticleSystems() {
this._particleSystems = []
this._particleSystemsTransform = []
}
/**
* The particle systems attached to the scene.
* @type {?SCNParticleSystem[]}
* @desc An array of SCNParticleSystem objects directly attached to the scene. This array does not include particle systems attached to nodes within the scene.For details on particle systems, see SCNParticleSystem.
* @see https://developer.apple.com/documentation/scenekit/scnscene/1522787-particlesystems
*/
get particleSystems() {
return this._particleSystems.slice(0)
}
/**
* @access private
* @returns {Promise} -
*/
_getLoadedPromise() {
if(this._loadedPromise){
return this._loadedPromise
}
if(!this._dataLoadedPromise){
return Promise.resolve()
}
this._loadedPromise = this._dataLoadedPromise.then(() => {
const promises = []
promises.push(this._rootNode.didLoad)
promises.push(this._skyBox.didLoad)
if(this._lightingEnvironment){
promises.push(this._lightingEnvironment.didLoad)
}
return Promise.all(promises)
})
return this._loadedPromise
}
/**
* @access public
* @type {Promise} -
*/
get didLoad() {
return this._getLoadedPromise()
}
// Structures
/**
* @type {Object} Attribute
* @property {string} endTime A floating-point value (in an NSNumber object) for the end time of the scene.
* @property {string} frameRate A floating-point value (in an NSNumber object) for the frame rate of the scene.
* @property {string} startTime A floating-point value (in an NSNumber object) for the start time of the scene.
* @property {string} upAxis An SCNVector3 structure (in an NSValue object) specifying the orientation of the scene.
* @see https://developer.apple.com/documentation/scenekit/scnscene.attribute
*/
static get Attribute() {
return _Attribute
}
}
