js/SceneKit/SCNSceneRenderer.js
'use strict'
//import SCNScene from './SCNScene'
//import SCNNode from './SCNNode'
//import SCNDebugOptions from './SCNDebugOptions'
//import SCNRenderingAPI from './SCNRenderingAPI'
//import SCNHitTestResult from './SCNHitTestResult'
//import CGPoint from '../CoreGraphics/CGPoint'
//import SCNHitTestOption from './SCNHitTestOption'
//import SCNVector3 from './SCNVector3'
//import SCNSceneRendererDelegate from './SCNSceneRendererDelegate'
/**
* Methods and properties common to the SCNView, SCNLayer and SCNRenderer classes.
* @interface
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer
*/
export default class SCNSceneRenderer {
/**
* constructor
* @access public
* @constructor
*/
constructor() {
// Presenting a Scene
/**
* Required. The scene to be displayed.
* @type {?SCNScene}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523956-scene
*/
this.scene = null
// Managing Scene Display
/**
* Required. The node from which the scene’s contents are viewed for rendering.
* @type {?SCNNode}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523982-pointofview
*/
this.pointOfView = null
/**
* Required. A Boolean value that determines whether SceneKit automatically adds lights to a scene.
* @type {boolean}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523812-autoenablesdefaultlighting
*/
this.autoenablesDefaultLighting = false
/**
* Required. A Boolean value that determines whether SceneKit applies jittering to reduce aliasing artifacts.
* @type {boolean}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1524026-isjitteringenabled
*/
this.isJitteringEnabled = false
/**
* Required. A Boolean value that determines whether SceneKit displays rendering performance statistics in an accessory view.
* @type {boolean}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522763-showsstatistics
*/
this.showsStatistics = false
/**
* Required. Options for drawing overlay content in a scene that can aid debugging.
* @type {SCNDebugOptions}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523281-debugoptions
*/
this.debugOptions = null
this._renderingAPI = null
// Managing Scene Animation Timing
/**
* Required. The current scene time.
* @type {number}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522680-scenetime
*/
this.sceneTime = 0
/**
* Required. A Boolean value that determines whether the scene is playing.
* @type {boolean}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523401-isplaying
*/
this.isPlaying = false
/**
* Required. A Boolean value that determines whether SceneKit restarts the scene time after all animations in the scene have played.
* @type {boolean}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522878-loops
*/
this.loops = false
// Participating in the Scene Rendering Process
/**
* Required. A delegate object that receives messages about SceneKit’s rendering process.
* @type {?SCNSceneRendererDelegate}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522671-delegate
*/
this.delegate = null
// Customizing Scene Rendering with Metal
this._currentRenderCommandEncoder = null
this._device = null
this._commandQueue = null
this._colorPixelFormat = null
this._depthPixelFormat = null
this._stencilPixelFormat = null
// Customizing Scene Rendering with OpenGL
this._context = null
// Rendering Sprite Kit Content over a Scene
/**
* Required. A Sprite Kit scene to be rendered on top of the SceneKit content.
* @type {?SKScene}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1524051-overlayskscene
*/
this.overlaySKScene = null
// Working With Positional Audio
/**
* Required. The node representing the listener’s position in the scene for use with positional audio effects.
* @type {?SCNNode}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523747-audiolistener
*/
this.audioListener = null
this._audioEnvironmentNode = null
this._audioEngine = null
// Instance Properties
/**
* Required.
* @type {number}
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522854-currenttime
*/
this.currentTime = 0
}
// Presenting a Scene
/**
* Required. Displays the specified scene with an animated transition.
* @access public
* @param {SCNScene} scene - The new scene to be displayed.
* @param {SKTransition} transition - An object that specifies the duration and style of the animated transition.
* @param {?SCNNode} pointOfView - The node to use as the pointOfView property when displaying the new scene.
* @param {?function(): void} [completionHandler = null] - A block that SceneKit calls after the transition animation has completed.This block takes no parameters and has no return value.
* @returns {void}
* @desc Use this method to change the scene displayed in a SceneKit view (or other renderer) with an animated transition. For details on transition styles, see SKTransition.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523028-present
*/
presentWithIncomingPointOfView(scene, transition, pointOfView, completionHandler = null) {
}
// Managing Scene Display
/**
* Required. The graphics technology SceneKit uses to render the scene.
* @type {SCNRenderingAPI}
* @desc You choose a graphics technology when initializing a scene renderer:When initializing a SCNView object, use the init(frame:options:) initializer and the preferredRenderingAPI key. Alternatively, create a view in Interface Builder and use the Rendering API control in the inspector. During initialization, the view will attempt to use the preferred API, but will fall back to a different API if the preferred one is not supported on the current hardware.To create a SCNRenderer object that renders into your own OpenGL contect, use the init(context:options:) initializer. To create a renderer for use in your own Metal workflow, use the init(device:options:) initializer.The rendering technology used by a SCNLayer object is determined by Core Animation.After initializing a renderer, this property reflects the rendering technology in use.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522616-renderingapi
*/
get renderingAPI() {
return this._renderingAPI
}
// Preloading Renderer Resources
/**
* Required. Prepares a SceneKit object for rendering.
* @access public
* @param {Object} object - An SCNScene, SCNNode, SCNGeometry, or SCNMaterial instance.
* @param {?function(): boolean} [block = null] - A block that SceneKit calls periodically while preparing the object. The block takes no parameters.Your block should return false to tell SceneKit to continue preparing the object, or true to cancel preparation.Pass nil for this parameter if you do not need an opportunity to cancel preparing the object.
* @returns {boolean} -
* @desc By default, SceneKit lazily loads resources onto the GPU for rendering. This approach uses memory and GPU bandwidth efficiently, but can lead to stutters in an otherwise smooth frame rate when you add large amounts of new content to an animated scene. To avoid such issues, use this method to prepare content for drawing before adding it to the scene. You can call this method on a secondary thread to prepare content asynchronously. SceneKit prepares all content associated with the object parameter you provide. If you provide an SCNMaterial object, SceneKit loads any texture images assigned to its material properties. If you provide an SCNGeometry object, SceneKit loads all materials attached to the geometry, as well as its vertex data. If you provide an SCNNode or SCNScene object, SceneKit loads all geometries and materials associated with the node and all its child nodes, or with the entire node hierarchy of the scene.You can use the block parameter to cancel preparation if content is no longer needed. For example, in a game you might use this method to preload areas of the game world the player is soon to enter, but if the player character dies before entering those areas, you can return true from the block to cancel preloading.You can observe the progress of this operation with the Progress class. For details, see Progress.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522798-prepare
*/
prepareShouldAbortBlock(object, block = null) {
return false
}
/**
* Required. Prepares the specified SceneKit objects for rendering, using a background thread.
* @access public
* @param {Object[]} objects - An array of containing one or more SCNScene, SCNNode, SCNGeometry, or SCNMaterial instances.
* @param {?function(arg1: boolean): void} [completionHandler = null] - A block that SceneKit calls when object preparation fails or completes.The block takes the following parameter:successtrue if all content was successfully prepared for rendering; otherwise, false.
* @returns {void}
* @desc By default, SceneKit lazily loads resources onto the GPU for rendering. This approach uses memory and GPU bandwidth efficiently, but can lead to stutters in an otherwise smooth frame rate when you add large amounts of new content to an animated scene. To avoid such issues, use this method to prepare content for drawing before adding it to the scene. SceneKit uses a secondary thread to prepare content asynchronously.SceneKit prepares all content associated with the objects you provide. If you provide an SCNMaterial object, SceneKit loads any texture images assigned to its material properties. If you provide an SCNGeometry object, SceneKit loads all materials attached to the geometry, as well as its vertex data. If you provide an SCNNode or SCNScene object, SceneKit loads all geometries and materials associated with the node and all its child nodes, or with the entire node hierarchy of the scene.You can observe the progress of this operation with the Progress class. For details, see Progress.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523375-prepare
*/
prepare(objects, completionHandler = null) {
}
// Working With Projected Scene Contents
/**
* Required. Searches the renderer’s scene for objects corresponding to a point in the rendered image.
* @access public
* @param {CGPoint} point -
* @param {?Map<SCNHitTestOption, Object>} [options = null] - A dictionary of options affecting the search. See Hit Testing Options Keys for acceptable values.
* @returns {SCNHitTestResult[]} -
* @desc A 2D point in the rendered screen coordinate space can refer to any point along a line segment in the 3D scene coordinate space. Hit-testing is the process of finding elements of a scene located along this line segment. For example, you can use this method to find the geometry corresponding to a click event in a SceneKit view.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522929-hittest
*/
hitTest(point, options = null) {
return null
}
/**
* Required. Returns a Boolean value indicating whether a node might be visible from a specified point of view.
* @access public
* @param {SCNNode} node - The node whose visibility is to be tested.
* @param {SCNNode} pointOfView - A node defining a point of view, as used by the pointOfView property.
* @returns {boolean} -
* @desc Any node containing a camera or spotlight may serve as a point of view (see the pointOfView property for details). Such a node defines a viewing frustum—a portion of the scene’s coordinate space, shaped like a truncated pyramid, that encloses all points visible from that point of view.Use this method to test whether a node lies within the viewing frustum defined by another node (which may or may not be the scene renderer’s current pointOfView node). For example, in a game scene containing multiple camera nodes, you could use this method to determine which camera is currently best for viewing a moving player character.Note that this method does not perform occlusion testing. That is, it returns true if the tested node lies within the specified viewing frustum regardless of whether that node’s contents are obscured by other geometry.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522647-isnode
*/
isNodeInsideFrustumOf(node, pointOfView) {
return false
}
/**
* Required. Returns all nodes that might be visible from a specified point of view.
* @access public
* @param {SCNNode} pointOfView - A node defining a point of view, as used by the pointOfView property.
* @returns {SCNNode[]} -
* @desc Any node containing a camera or spotlight may serve as a point of view (see the pointOfView property for details). Such a node defines a viewing frustum—a portion of the scene’s coordinate space, shaped like a truncated pyramid, that encloses all points visible from that point of view.Use this method find all nodes whose content lies within the viewing frustum defined by another node (which may or may not be the scene renderer’s current pointOfView node).Note that this method does not perform occlusion testing. That is, the returned array includes any node that lies within the specified viewing frustum regardless of whether that node’s contents are obscured by other geometry.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522942-nodesinsidefrustum
*/
nodesInsideFrustumOf(pointOfView) {
return null
}
/**
* Required. Projects a point from the 3D world coordinate system of the scene to the 2D pixel coordinate system of the renderer.
* @access public
* @param {SCNVector3} point - A point in the world coordinate system of the renderer’s scene.
* @returns {SCNVector3} -
* @desc The z-coordinate of the returned point describes the depth of the projected point relative to the near and far clipping planes of the renderer’s viewing frustum (defined by its pointOfView node). Projecting a point on the near clipping plane returns a point whose z-coordinate is 0.0; projecting a point on the far clipping plane returns a point whose z-coordinate is 1.0.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1524089-projectpoint
*/
projectPoint(point) {
return null
}
/**
* Required. Unprojects a point from the 2D pixel coordinate system of the renderer to the 3D world coordinate system of the scene.
* @access public
* @param {SCNVector3} point - A point in the screen-space (view, layer, or GPU viewport) coordinate system of the scene renderer.
* @returns {SCNVector3} -
* @desc The z-coordinate of the point parameter describes the depth at which to unproject the point relative to the near and far clipping planes of the renderer’s viewing frustum (defined by its pointOfView node). Unprojecting a point whose z-coordinate is 0.0 returns a point on the near clipping plane; unprojecting a point whose z-coordinate is 1.0 returns a point on the far clipping plane.A 2D point in the rendered screen coordinate space can refer to any point along a line segment in the 3D scene coordinate space. To test for scene contents along this line—for example, to find the geometry corresponding to the location of a click event in a view—use the hitTest(_:options:) method.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522631-unprojectpoint
*/
unprojectPoint(point) {
return null
}
// Customizing Scene Rendering with Metal
/**
* Required. The Metal render command encoder in use for the current SceneKit rendering pass.
* @type {?MTLRenderCommandEncoder}
* @desc Use this render command encoder to encode additional rendering commands before or after SceneKit draws its own content.This property is valid only during the SceneKit rendering loop—that is, within one of the methods defined in the SCNSceneRendererDelegate protocol. Accessing this property at any other time returns nil.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522609-currentrendercommandencoder
*/
get currentRenderCommandEncoder() {
return this._currentRenderCommandEncoder
}
/**
* Required. The Metal device this renderer uses for rendering.
* @type {?MTLDevice}
* @desc Use this property to create or look up other Metal resources that use the same device as your SceneKit renderer.NoteThis property is valid only for scene renderers whose renderingAPI value is metal. You create a SceneKit view that renders using Metal with the preferredRenderingAPI initialization option or in Interface Builder, or an SCNRenderer that uses Metal with the init(device:options:) method. For OpenGL-based scene renderers, this property’s value is always nil.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523935-device
*/
get device() {
return this._device
}
/**
* Required. The Metal command queue this renderer uses for rendering.
* @type {?MTLCommandQueue}
* @desc Use this property to schedule additional command buffers for the Metal device to execute as part of the render cycle. For example, you can use a compute command encoder to modify the vertex data in a Metal buffer for use by a SCNGeometrySource object.NoteThis property is valid only for scene renderers whose renderingAPI value is metal. You create a SceneKit view that renders using Metal with the preferredRenderingAPI initialization option or in Interface Builder, or an SCNRenderer that uses Metal with the init(device:options:) method. For OpenGL-based scene renderers, this property’s value is always nil.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523974-commandqueue
*/
get commandQueue() {
return this._commandQueue
}
/**
* Required. The Metal pixel format for the renderer’s color output.
* @type {MTLPixelFormat}
* @desc Use this property, along with the depthPixelFormat and stencilPixelFormat properties, if you perform custom drawing with Metal (see the SCNSceneRendererDelegate and SCNNodeRendererDelegate classes) and need to create a new MTLRenderPipelineState object to change the GPU state as part of your rendering.NoteThis property is valid only for scene renderers whose renderingAPI value is metal. You create a SceneKit view that renders using Metal with the preferredRenderingAPI initialization option or in Interface Builder, or an SCNRenderer that uses Metal with the init(device:options:) method. For OpenGL-based scene renderers, this property’s value is always nil.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523701-colorpixelformat
*/
get colorPixelFormat() {
return this._colorPixelFormat
}
/**
* Required. The Metal pixel format for the renderer’s depth buffer.
* @type {MTLPixelFormat}
* @desc Use this property, along with the colorPixelFormat and stencilPixelFormat properties, if you perform custom drawing with Metal (see the SCNSceneRendererDelegate and SCNNodeRendererDelegate classes) and need to create a new MTLRenderPipelineState object to change the GPU state as part of your rendering.NoteThis property is valid only for scene renderers whose renderingAPI value is metal. You create a SceneKit view that renders using Metal with the preferredRenderingAPI initialization option or in Interface Builder, or an SCNRenderer that uses Metal with the init(device:options:) method. For OpenGL-based scene renderers, this property’s value is always nil.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523780-depthpixelformat
*/
get depthPixelFormat() {
return this._depthPixelFormat
}
/**
* Required. The Metal pixel format for the renderer’s stencil buffer.
* @type {MTLPixelFormat}
* @desc Use this property, along with the depthPixelFormat and colorPixelFormat properties, if you perform custom drawing with Metal (see the SCNSceneRendererDelegate and SCNNodeRendererDelegate classes) and need to create a new MTLRenderPipelineState object to change the GPU state as part of your rendering.NoteThis property is valid only for scene renderers whose renderingAPI value is metal. You create a SceneKit view that renders using Metal with the preferredRenderingAPI initialization option or in Interface Builder, or an SCNRenderer that uses Metal with the init(device:options:) method. For OpenGL-based scene renderers, this property’s value is always nil.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523315-stencilpixelformat
*/
get stencilPixelFormat() {
return this._stencilPixelFormat
}
// Customizing Scene Rendering with OpenGL
/**
* Required. The OpenGL rendering context that SceneKit uses for rendering the scene.
* @type {?Object}
* @desc In macOS, the value of this property is a Core OpenGL cglContextObj object.In iOS, the value of this property is an EAGLContext object.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522840-context
*/
get context() {
return this._context
}
// Working With Positional Audio
/**
* Required. The 3D audio mixing node SceneKit uses for positional audio effects.
* @type {AVAudioEnvironmentNode}
* @desc SceneKit uses this audio node to spatialize sounds from SCNAudioPlayer objects attached to nodes in the scene. You can use this object in conjunction with the audioEngine property to rearrange the audio graph to add other, non-spatialized audio sources or mix in audio processing effects.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1523582-audioenvironmentnode
*/
get audioEnvironmentNode() {
return this._audioEnvironmentNode
}
/**
* Required. The audio engine SceneKit uses for playing scene sounds.
* @type {AVAudioEngine}
* @desc SceneKit uses this audio engine to play sounds from SCNAudioPlayer objects attached to nodes in the scene. You can use this object directly to add other sound sources not related to scene contents, or to add other sound processing nodes or mixing nodes to the audio engine. To identify the node SceneKit uses for spatializing scene sounds when connecting other nodes, use the audioEnvironmentNode property.
* @see https://developer.apple.com/documentation/scenekit/scnscenerenderer/1522686-audioengine
*/
get audioEngine() {
return this._audioEngine
}
}
