Incisor® | Documentation

INCISOR
`IncisorAPI.js`, `line 13785`

MEMBERS

appEvents :AppEvents
`IncisorAPI.js`, `line 13922`

Object housing Incisor® AppEvents, which enable callbacks for software events including screen updates, cursor/pointer/mouse events, keyboard events, and many more.

cameras :Cameras
`IncisorAPI.js`, `line 14090`

Dictionary of all registered Cameras in this project.

constants :Constants
`IncisorAPI.js`, `line 14368`

Object housing predefined constant values for various Incisor® options and modes.

constructDefs
`IncisorAPI.js`, `line 14177`

Dictionary of available ConstructDefitions.

defaultFocusFallback :SceneObject
`IncisorAPI.js`, `line 13965`

The default focusFallback value for new SceneObjects. This property can be changed at the top of any block of code where a lot of related SceneObjects are instantiated, and as a result all of those SceneObjects will receive the same new default focusFallback value.

Default Value:

undefined

defaultPauseImmunity :Array.<PauseEvent>|PauseEvent
`IncisorAPI.js`, `line 13947`

This is the pause immunity that is automatically applied if the 'pauseImmunity' parameter of any pausable-process-initiating method is left undefined. This value can be changed between big blocks of code to distinguish how groups of functionality react to different pauseEvents without needing to include specific 'pauseImmunity' for every single process initiated within each block.

Default Value:

[nc.pauseEvents.MainPauseEvent]

defaultSpeedControl :Array.<SpeedControl>|SpeedControl
`IncisorAPI.js`, `line 13956`

The SpeedControl(s) that are automatically applied if the 'speedControl' parameter is left undefined in any method that initiates a speed controllable process. This value can be changed between big blocks of code to distinguish how groups of functionality interact with different sets of SpeedControls without needing to include specific 'speedControl' parameters for every single applicable process initiated within each block.

Default Value:

[nc.speedControls.MainSpeedControl]

effectControllers :EffectControllers
`IncisorAPI.js`, `line 13899`

Dictionary of EffectControllerInfos for all of the registered EffectControllers.

effectNodes :EffectNodes
`IncisorAPI.js`, `line 14059`

Dictionary of all defined EffectNodes.

fileIO :FileIO
`IncisorAPI.js`, `line 14032`

Object housing functionality to perform file IO tasks such as 'writeTextFile', 'moveTo', 'createDirectory' an more. This functionality only exists within un-built projects, and also requires that the user account has access to the FileIO features.

fontNames :FontNames
`IncisorAPI.js`, `line 13893`

Dictionary of the names of the fonts available within this project.

geometries :Geometries
`IncisorAPI.js`, `line 14333`

Dictionary of all registered Geometries.

globalRenderTargetResolutionScaler :number
`IncisorAPI.js`, `line 14261`

Value that multiplies the resolution scale of all RenderTargets whose 'globalRenderTargetResolutionScaling' property is true.

Default Value:

graphicAssets :GraphicAssets
`IncisorAPI.js`, `line 14243`

Dictionary of all registered GraphicAssets.

incisorApp :IncisorApp
`IncisorAPI.js`, `line 14302`

Object housing functionality allowing for direct interactions with the Incisor® application from within the javascript runtime. Such functionality includes the ability to get/set project and application settings, initiate the hosting of files in local directories, script the opening of new browser tabs, and perform other transactions with the Incisor® application. [REQUIREMENT: unpublished projects only] [REQUIREMENT: user subscription access - 'advancedTools']

incisorAppBasic :IncisorAppBasic
`IncisorAPI.js`, `line 14311`

Object housing basic functionality allowing for direct interactions with the Incisor® application from within the javascript runtime. Such functionality includes the ability to get the list of optional code modules from the Incisor™ application. See 'nc.incisorApp' for many more application interaction options. [REQUIREMENT: unpublished projects only]

keyDownStates :object
`IncisorAPI.js`, `line 14383`

Dictionary with the current state of each key on the keyboard, regardless of pause states or focused objects (see nc.singularFocusObject). This can be used used to check the state of modifier keys such as the 'shift' or 'option' key. If the key in question is down, this object will have a member (with the key as the name) that is true, otherise the member will be undefined.

layers :Layers
`IncisorAPI.js`, `line 14136`

Dictionary of all registered Layers in this project.

layersByScene :LayersByScene
`IncisorAPI.js`, `line 14149`

A 2D dictionary that lists the available Layers in each Scene. These dictionaries are not ordered, for the order of the Layers in a given Scene, see 'Scene.layerOrderLedger'.

loadingTiers :LoadingTiers
`IncisorAPI.js`, `line 14106`

Dictionary of loading tiers - each loading tier has a number designation. Loading tiers are a means to organize AssetComponents into separately downloadable groups.

mainCamera :OrthographicCamera
`IncisorAPI.js`, `line 14096`

The 'MainCamera' Camera.

mainRenderTarget :RenderTarget
`IncisorAPI.js`, `line 14267`

The main canvas RenderTarget.

mainScene :Scene
`IncisorAPI.js`, `line 14142`

The 'MainScene' Scene.

masks :Masks
`IncisorAPI.js`, `line 14076`

The Masks available in this project.

motionTypes :MotionTypes
`IncisorAPI.js`, `line 13848`

Object housing all defined MotionTypes. MotionTypes are used in conjunction with Motions and define a method of continuous change for numeric properties.

multiTapInterval :number
`IncisorAPI.js`, `line 14067`

The max amount of time between two Button presses for the Button presses to be considered part of the same 'doubleTap' or 'tripleTap'.

Default Value:

0.25

particleSystemDefinitions :ParticleSystemDefinitions
`IncisorAPI.js`, `line 14022`

Dictionary of all registered ParticleSystemDefinitions.

paths :Paths
`IncisorAPI.js`, `line 13884`

Object housing functionality manipulate paths including 'splitPath', 'getFileName', and 'getParentDirectory'.

pauseEvents :PauseEvents
`IncisorAPI.js`, `line 13930`

Object housing all defined PauseEvents. A given PauseEvent can be used as a parameter in 'nc.pause' and 'nc.resume' to pause and resume various time-based and user-interaction processes. Pausable processes react to pausing or resuming with PauseEvents unless those processes have a given PauseEvent as part of their designated 'pauseImmunity', which can determined in the parameters of a pausable-process-initiating method.

pixelsObjects :PixelsObjects
`IncisorAPI.js`, `line 14116`

Object housing functionality for PixelsObjects, which are RGBA bitmap images in a simple, 'data-only' format, used for basic image access and manipulation.

precomps
`IncisorAPI.js`, `line 14224`

Dictionary of Precomps

projectConfiguration :ProjectConfiguration
`IncisorAPI.js`, `line 13913`

Object housing the configuration settings for this project. Many of the members of this object are customizable on a 'per configuration' basis by editing the 'ProjectSettings' file within the project. The user-customizable 'PreloadConfiguration' code is executed within this object, so members created within that code will be accessible on this object.

readonly projectName :string
`IncisorAPI.js`, `line 13793`

The name of the project.

publishing :Publishing
`IncisorAPI.js`, `line 14216`

Object housing functionality for publishing projects. [REQUIREMENT: unpublished projects only] [REQUIREMENT: user subscription access - 'publishing']

renderTargets :RenderTargets
`IncisorAPI.js`, `line 14254`

Dictionary of all registered RenderTargets in this project. RenderTargets are objects that contain Textures to render to, as well as settings for how those textures may be resized automatically based on environmental factors such as canvas size, canvas aspect ratio, and the current asset package scale.

scenes :Scenes
`IncisorAPI.js`, `line 14130`

Dictionary of all registered Scenes in this project. Scenes are the root SceneObjects in hierarchies. All SceneObjects are either Scenes or descendants of Scenes.

singularFocusButtonPressRequirements :Array.<Button>
`IncisorAPI.js`, `line 14007`

Optional array of Buttons that can be supplied while a given object is the singularFocusObject; any cursor press must then be within one of the given Buttons in order for that focus to be maintained. A cursor press anywhere outside of these buttons will result in nc.reliquishFocus to be called. When a TextBox is focused via editing or selecting, this value is automatically set to the TextBox, and as a result, any exterior cursor press un-focuses the TextBox. When this property is undefined, cursor presses do not affect focus at all.

Default Value:

undefined

singularFocusObject :SceneObject
`IncisorAPI.js`, `line 13995`

The singularFocusObject determines which callbacks connected to certain user-input AppEvents are invoked. For example, when a 'keyboardEvent' callback is added, a 'singularFocusRequirements' parameter can be supplied and that callback will only be invoked if the singularFocusObject is listed in the supplied 'singularFocusRequirements'. This is a way of adding keyboard AppEvent callbacks that will only be called if an associated contextual object is 'focused'.

softwareSpeed :number
`IncisorAPI.js`, `line 13987`

When changed from 1, this value will increase or decrease the pacing of the fixedUpdate (independently from the 'targetFixedUpdateRate'), as well as the playback rate of all sounds played. The screenUpdate is not effected by this value. Manipulating this value can serve as a 'fast-forward' for the entire project.

Default Value:

sounds :Sounds
`IncisorAPI.js`, `line 13809`

Dictionary of all registered Sounds. [REQUIREMENT: optional code module - 'sounds']

specialSubstitutionCharacter :string
`IncisorAPI.js`, `line 14350`

A special character that can be used in Texts or TextBoxes to flag certain characters so that they can be replaced by custom GraphicAssets. See 'TextBox.specialCharacters' for more information.

speedControls :SpeedControls
`IncisorAPI.js`, `line 13938`

Object housing all defined SpeedControls. SpeedControls can be used to control the speed of time-based sequencing processes such as Motions, Swoops, or Timelines. Applicable processes can subscribe to multiple SpeedControls; the 'speed' values of all of the SpeedControls a process subscribes to are multiplied together to determine the overall pacing of the given time-based process.

targetFixedUpdateRate :number
`IncisorAPI.js`, `line 13972`

The number of times per second that the fixedUpdate will occur.

Default Value:

targetScreenUpdateRate :number
`IncisorAPI.js`, `line 13979`

The number of times per second that the screenUpdate will occur.

Default Value:

textures :Textures
`IncisorAPI.js`, `line 13838`

Dictionary of all registered Textures.

timeStamp :TimeStamp
`IncisorAPI.js`, `line 14160`

Object housing functionality for time stamps, the Incisor® standardized format for date and time. [REQUIREMENT: optional code module - 'timeStamp']

tweenTypes :TweenTypes
`IncisorAPI.js`, `line 14321`

Object housing all defined TweenTypes. TweenTypes are used in conjunction with 'Swoopers' and define a method of numeric property interpolation between any two values or sets of values. TweenTypes can vary the timing of interpolation between two sets of values, as well as the path of the interpolation.

uiStyle :UiStyle
`IncisorAPI.js`, `line 13826`

Object housing default TextFormats, and Colors for various Gui objects such as 'UiButton', 'DropDownMenu' and 'PopUpWindow'.

uiZoom :UiZoom
`IncisorAPI.js`, `line 13867`

Object housing functionality associated with the user interface zoom, which enables end-users to increase or decrease the overall size of text and other user interface items (when those items have uiZoom functionality enabled).

urlParameterIterator :UrlParameterIterator
`IncisorAPI.js`, `line 14196`

Object housing testing functionality that enables a project to refresh itself repeatedly with different url parameters. Such functionality can help with batch testing of a project's configurations or settings. To use this functionality, first call the 'UrlParameterIteration.setup' method, passing it an array of objects where each object represents the url parameters you would like the browser to refresh with. When ready to start the iteration, call 'UrlParameterIteration.start'. Then add the desired functionality per url parameter - be sure to implement what you want conditionally based on the url params (otherwise everything will happen on every refresh). When the desired tasks (testing, screen shots, etc...) have completed for each set of url parameters, call 'UrlParameterIteration.next', this will proceed to refresh with the next set of url parameters. [REQUIREMENT: optional code module - 'urlParameterIterator']

readonly visualFocusObject :UiVisualFocus
`IncisorAPI.js`, `line 14046`

Read-only property denoting which object (if any) is currently visually focused. 'VisualFocus' is a mode that focuses the end-user's attention the given SceneObject by placing it in front of a dimmer layer whenever the object is the the current 'singularFocusObject'. See 'SceneObject.configureUiVisualFocus' for more information. [REQUIREMENT: optional code module - 'extendedUi']

volumeControls :VolumeControls
`IncisorAPI.js`, `line 13816`

Dictionary of all registered VolumeControls. [REQUIREMENT: optional code module - 'sounds']

METHODS

addButton(graphicAsset (opt), parent (opt), name (opt)) returns {Button}
`IncisorAPI.js`, `line 14935`

Adds a Button set to the provided GraphicAsset as a child of the given SceneObject.

Parameters:

Name	Type	Attributes	Default	Description
`graphicAsset`	GraphicAsset	<optional>	nc.graphicAssets.WhiteBox	The GraphicAsset that the new Button will initially be set to. For a list of available GraphicAssets, see 'nc.graphicAssets'. [DEFAULT: nc.graphicAssets.WhiteBox]
`parent`	SceneObject	<optional>	nc.mainScene	The SceneObject that will become the new Button's parent in the Scene hierarchy. [DEFAULT: nc.mainScene]
`name`	string	<optional>	'Button'	The name of the new Button. [DEFAULT: 'Button']

Returns:

Button

Example:

// Objective: Use Incisor to add a Button.
// Expected Result: The console should display all of the properties of the new button. 

let button = nc.addButton( nc.graphicAssets.WhiteBox, nc.mainScene, "MyButton" );
console.log(button);

addGraphicObject(graphicAsset (opt), parent (opt), name (opt)) returns {GraphicObject}
`IncisorAPI.js`, `line 14967`

Adds a GraphicObject set to the provided GraphicAsset as a child of the given SceneObject.

Parameters:

Name	Type	Attributes	Default	Description
`graphicAsset`	GraphicAsset	<optional>	nc.graphicAssets.WhiteBox	The GraphicAsset that the new GraphicObject will initially be set to. For a list of available GraphicAssets, see 'nc.graphicAssets'. [DEFAULT: nc.graphicAssets.WhiteBox]
`parent`	SceneObject	<optional>	nc.mainScene	The SceneObject that will become the new GraphicObject's parent in the Scene hierarchy. [DEFAULT: nc.mainScene]
`name`	string	<optional>	'GraphicObject'	The name of the new GraphicObject. [DEFAULT: 'GraphicObject']

Returns:

GraphicObject

Example:

// Objective: Use Incisor to add a GraphicObject, rotate it, change its color and move its position.
// Expected Result: You should see a blue, diamond shaped box, moved up and left of center. 

let graphicObject = nc.addGraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "MyGraphicObject" );

// rotate 45 degrees around the z axis to create a "diamond" shape
graphicObject.rotation.z = 45;
// set the red and green channels to zero to make the box blue
graphicObject.colorMultiply.red = 0;
graphicObject.colorMultiply.green = 0;
// move the box up and to the left
graphicObject.position.x = -500;
graphicObject.position.y = 500;

addLayoutStack(parent (opt), name (opt)) returns {LayoutStack}
`IncisorAPI.js`, `line 14780`

Adds a LayoutStack as a child of the given SceneObject.

Parameters:

Name	Type	Attributes	Default	Description
`parent`	SceneObject	<optional>		The SceneObject that will be the new LayoutStack's parent.
`name`	string	<optional>		The name of the new LayoutStack. [DEFAULT: 'LayoutStack']

Returns:

LayoutStack

addLayoutStack(parent (opt), name (opt)) returns {LayoutStack}
`IncisorAPI.js`, `line 15295`

Adds a LayoutStack as a child of the given SceneObject.

Parameters:

Name	Type	Attributes	Default	Description
`parent`	SceneObject	<optional>		The SceneObject that will be the new LayoutStack's parent.
`name`	string	<optional>		The name of the new LayoutStack. [DEFAULT: 'LayoutStack']

Returns:

LayoutStack

Example:

// Objective: Use a LayoutStack to vertically align elements.
// Expected Result: You will see 3 elements stacked vertically.

// create a TextAssembly
let text = new TextAssembly( nc.mainScene, "MyText" );
text.string = "With Incisor, you need only build it once.";

// create a white box GraphicObject
let whiteBox = new GraphicObject( nc.graphicAssets.whiteBox, nc.mainScene, "MyWhiteBox" );

// create a link
let link = new TextBox( nc.mainScene, "MyButton" );
link.string = "Click Here";
link.colorMultiply = new Color( 0, 0, 1, 1 );
link.scale.x = .5;
link.scale.y = .5;

// add a LayoutStack to the main Scene and add 3 elements to it
let layoutStack = nc.addLayoutStack( nc.mainScene, "MyLayoutStack" );
layoutStack.addElements( [text, whiteBox, link ] );
layoutStack.isVertical = true; // set vertical alignment

addMotion(propertyOwners, propertyNames, lowerBounds, upperBounds, motionSpeed (opt), motionType (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Motion}
`IncisorAPI.js`, `line 14512`

Adds a motion defining a continuous change a given numeric property or set of properties, and returns a Motion object, which can be used to control the motion dynamically.

Parameters:

Name	Type	Attributes	Description
`propertyOwners`	object \| Array.<object>		The object or array of objects owning the numeric properties to add motion to.
`propertyNames`	string \| Array.<string>		The name or array of names of the numeric properties to add motion to.
`lowerBounds`	number \| Array.<number>		The lower bounds for the motion being added.
`upperBounds`	number \| Array.<number>		The upper bounds for the motion being added.
`motionSpeed`	number	<optional>	The speed factor for the added motion. [DEFAULT: 1]
`motionType`	MotionType	<optional>	The MotionType, determining the nature of the motion being added. [DEFAULT: nc.motionTypes.Pendulum]
`pauseImmunity`	PauseEvent \| Array.<PauseEvent>	<optional>	The PauseEvent or Array of PauseEvents that this Motion will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
`speedControl`	SpeedControl \| Array.<SpeedControl>	<optional>	The SpeedControl or Array of SpeedControls that this Motion is affected by. [DEFAULT: nc.defaultSpeedControl]
`eventCallbackOwner`	object	<optional>	The object owning the callback function that is called with each fixedUpdate during the motion.
`eventCallbackName`	string	<optional>	The name of the function that is called with each fixedUpdate during the motion.

Returns:

Motion

Example:

// Objective: Add motion to the white box along the x axis.
// Expected Result: The white box should continuously move back and forth.

let whiteSquare = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "WhiteSquare" );
// add motion to the "x" property of the position of the white square
nc.addMotion( whiteSquare.position, "x", -500, 500, .5 );

addOrthographicCamera(parent (opt), name (opt)) returns {OrthographicCamera}
`IncisorAPI.js`, `line 15014`

Adds an OrthographicCamera to the given parent.

Parameters:

Name	Type	Attributes	Default	Description
`parent`	SceneObject	<optional>		The SceneObject that will become the new OrthographicCamera's parent. [DEFAULT: nc.mainScene]
`name`	string	<optional>		The name of the new OrthographicCamera. This name must be unique among camera names. [DEFAULT: OrthographicCamera]

Returns:

OrthographicCamera

addParticleSystem(particleSystemDefinition (opt), parent (opt), name (opt), pauseImmunity (opt), speedControl (opt)) returns {ParticleSystem}
`IncisorAPI.js`, `line 14809`

Adds a ParticleSystem set to the provided ParticleSystemDefinition as a child of the given SceneObject.

Parameters:

Name	Type	Attributes	Description
`particleSystemDefinition`	ParticleSystemDefinition	<optional>	The definition used to build this ParticleSystem. If left undefined, then 'MainParticleSystem' will be chosen - if 'MainParticleSystem' is not yet defined, it will automatically be defined and then used as the default. [DEFAULT: nc.particleSystemDefinitions.MainParticleSystem]
`parent`	SceneObject	<optional>	The SceneObject that will become the new ParticleSystem's parent in the Scene hierarchy. [DEFAULT: nc.mainScene]
`name`	string	<optional>	The name of the new ParticleSystem. [DEFAULT: 'ParticleSystem']
`pauseImmunity`	PauseEvent \| Array.<PauseEvent>	<optional>	The PauseEvent or Array of PauseEvents that this ParticleSystem will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
`speedControl`	SpeedControl \| Array.<SpeedControl>	<optional>	The SpeedControl or Array of SpeedControls that this ParticleSystem is affected by. [DEFAULT: nc.defaultSpeedControl]

Returns:

ParticleSystem

Example:

// Objective: Add a ParticleSystem.
// Expected Result: You will see white triangles continuously "bursting" out from the center of the screen.

// add a ParticleSystem using the predefined "BurstWithGravity" ParticleSystemDefinition
let particles = nc.addParticleSystem( nc.particleSystemDefinitions.BurstWithGravity, nc.mainScene, "MyParticles" );
particles.playbackController.play();

addSceneObject(parent (opt), name (opt)) returns {SceneObject}
`IncisorAPI.js`, `line 14886`

Adds a SceneObject as a child of the given SceneObject.

Parameters:

Name	Type	Attributes	Default	Description
`parent`	SceneObject	<optional>		The SceneObject that will be the new SceneObject's parent.
`name`	string	<optional>	'SceneObject'	The name of the new SceneObject. [DEFAULT: 'SceneObject']

Returns:

SceneObject

Example:

// Objective: Add a SceneObject with a graphic and rotate it.
// Expected Result: The white box has rotated 45 degrees into a diamond shape.

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
let mySceneObject = nc.addSceneObject( nc.mainScene, "MySceneObject" );
// Add a GraphicObject to the SceneObject using the GraphicObject constructor.
// Note: To use a custom graphic, add your image file to the assets directory and access it using nc.graphicAssets['MyImage']
new GraphicObject( nc.graphicAssets.WhiteBox, mySceneObject, "MyGraphicObject" );
// Rotate the SceneObject 45 degrees around the z axis.
mySceneObject.rotation.z = 45;

addTextAssembly(parent (opt), name (opt)) returns {TextAssembly}
`IncisorAPI.js`, `line 14588`

Adds a TextAssembly as a child of the given SceneObject.

Parameters:

Name	Type	Attributes	Default	Description
`parent`	SceneObject	<optional>		The SceneObject that will become the new TextAssembly's parent in the Scene hierarchy. [DEFAULT: nc.mainScene]
`name`	string	<optional>		The name of the new TextAssembly. [DEFAULT: 'TextBox']

Returns:

TextAssembly

Example:

// Objective: Add a TextAssembly.
// Expected Result: You will see the text "Incisor - Build It Once." on screen.

let textAssembly = nc.addTextAssembly( nc.mainScene );
textAssembly.string = "Incisor - Build It Once."

addTextBox(parent (opt), name (opt)) returns {TextBox}
`IncisorAPI.js`, `line 15519`

Adds a TextBox as a child of the given SceneObject.

Parameters:

Name	Type	Attributes	Default	Description
`parent`	SceneObject	<optional>		The SceneObject that will become the new TextBox's parent in the Scene hierarchy. [DEFAULT: nc.mainScene]
`name`	string	<optional>		The name of the new TextBox. [DEFAULT: 'TextBox']

Returns:

TextBox

Example:

// Objective: Add a TextBox.
// Expected Result: You will see the text "Incisor - Build It Once." on screen.

let textBox = nc.addTextBox( nc.mainScene );
textBox.string = "Incisor - Build It Once."

addTierLoadedCallback(tiers, callbackOwner, callbackName, callbackArgs (opt), callbackOrder (opt))
`IncisorAPI.js`, `line 15032`

Adds a callback that will be called once the designated tier(s) are loaded.

Parameters:

Name	Type	Attributes	Description
`tiers`	number \| Array.<number>		The tier or tiers whose loading will trigger this callback.
`callbackOwner`	object		The object owning the callback function.
`callbackName`	string		The name of the callback function.
`callbackArgs`	Array \| any	<optional>	Arguments for the callback function.
`callbackOrder`	number	<optional>	Number designating the order the callback will be invoked relative to the other callbacks associated with this tier. [DEFAULT: 0]

assessCumulativeLoadingTierRequirements(sceneObject, ignoreCachedAssessment (opt)) returns {Array.<number>}
`IncisorAPI.js`, `line 14894`

Returns the list of LoadingTiers that must be loaded for the given SceneObject, its descendants, and all Textures and Geometries to be fully loaded.

Parameters:

Name	Type	Attributes	Default	Description
`sceneObject`	SceneObject			The SceneObject whose LoadingTier will be assessed.
`ignoreCachedAssessment`	boolean	<optional>		Boolean determining if any cached assessments will be ignored, forcing an entirely new assessment to be made. [DEFAULT: false]

Returns:

Array.<number>

async awaitLoadedTiers(tiers)
`IncisorAPI.js`, `line 15039`

An awaitable asyncronous function that delays until the specified tier(s) are loaded.

Parameters:

Name	Type	Attributes	Default	Description
`tiers`	number \| Array.<number>			The tier or tiers whose loading is being awaited.

copyToClipboard(text)
`IncisorAPI.js`, `line 14742`

Copies the given text to the clipboard.

Parameters:

Name	Type	Attributes	Default	Description
`text`	string			The text to be copied to the clipboard.

defineAppEvent(eventName) returns {AppEvent}
`IncisorAPI.js`, `line 14647`

Defines a new custom Incisor® AppEvent that can have callbacks added and can be triggered using 'AppEvent.trigger'.

Parameters:

Name	Type	Attributes	Default	Description
`eventName`	string			The name of the new AppEvent being defined.

Returns:

AppEvent

Example:

// Objective: Trigger a custom AppEvent.
// Expected Result: You will see a green square.

// create a white box GraphicObject
this.whiteBox = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "WhiteBox" );

// define a custom AppEvent and add its callback
nc.defineAppEvent( "MyCustomAppEvent" );
nc.appEvents.MyCustomAppEvent.addCallback( this, "myAppEventCallback" );

// the AppEvent callback will update the fillColor of the box
this.myAppEventCallback = function( r, g, b, a ) {
    this.whiteBox.fillColor = new Color( r, g, b, a );
}

// trigger my AppEvent passing in parameters as an array (set the red and blue to zero)
nc.appEvents.MyCustomAppEvent.trigger( [0, 1, 0, 1] );

defineAppEventWithFocus(eventName) returns {AppEventWithFocus}
`IncisorAPI.js`, `line 14658`

Defines a new custom Incisor® AppEventWithFocus that can have callbacks added and can be triggered using 'AppEventWithFocus.trigger'. The 'withFocus' designation means that there are addtional parameters in the 'addCallback' method that enable the callbacks to require that a specific object (or objects) be 'focused' in order to be invoked. This functionality can be used to ensure that callbacks are restricted to items associated with what is currently focused according to 'nc.singularFocusObject' (ei keyboard driven callbacks etc...).

Parameters:

Name	Type	Attributes	Default	Description
`eventName`	string			The name of the new AppEventWithFocus being defined.

Returns:

AppEventWithFocus

defineConstruct(name, blueprint (opt)) returns {ConstructDefinition}
`IncisorAPI.js`, `line 15096`

A means to manually create a ConstructDefinition. It should be noted that most users will not need to use this function, as Constructs are typically created in the Incisor® GUI.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			The name of the new ConstructDefinition. This name must be a unique class name, must not start with digits, and must not contain special characters or spaces.
`blueprint`	Blueprint	<optional>		Object containing the core instructions for recreating the collection of objects that will define this Construct. The function 'nc.gatherObjectBlueprint' can be used to get a Blueprint object from a pre-existing object. If this parameter is left undefined, then an empty Construct is defined.

Returns:

ConstructDefinition

defineEffectController(name, baseType, componentNames, defaultValues, mixMode, likelyRanges (opt), effectControllerDescription (opt), componentDescriptions (opt))
`IncisorAPI.js`, `line 14609`

Defines a new EffectController for use in conjunction with an EffectNode. EffectControllers provide the ability to dynamically control EffectNodes and their resulting visual effects. EffectControllers are generally one of 3 base types, Vectors, numbers, and Textures. Once defined, EffectControllers will be generally available on all SceneObjects, Materials, MaterialMaster, CharacterMaterial objects; It should be noted that while these objects will have all EffectControllers as members, only the EffectControllers tied to the objects' current EffectNodes will cause any change visually. It should also be noted EffectControllers with 'mixMode=materialOnly' will not be available on SceneObjects for inheritance, and will instead only be on Material and MaterialMaster objects for direct manipulation.

Parameters:

Name	Type	Attributes	Description
`name`	string		The name of the new EffectController. This name must be unique, and it must not contain any javascript delimeters (no spaces, commas, periods, etc...)
`baseType`	string		The base type of the new EffectController. For a list of available base types, see 'nc.constants.effectControllerBaseTypes'.
`componentNames`	Array.<string>		An array of names for the components of this EffectController. An example would be ['magnitude', 'brightness', 'fadeAmount']. It should be noted that EffectControllers with componentNames ["red","green","blue","alpha"] will automatically have type 'Color', and similarly componentNames ["x","y", etc...] will have the associated 'Vector' type. For non-Vector types this can be left undefined.
`defaultValues`	Array.<number> \| number \| Texture		An array of numbers (for Vector baseTypes), number (for number baseTypes), or Texture (for Texture baseTypes) that serve as the default value(s) for this EffectController's components.
`mixMode`	string		The means by which parent and child EffectControllers' values are blended together. Please note that a mixMode value of 'materialOnly' means that the given EffectController will only appear directly on Material and MaterialMaster objects, and therefor no mixing of values will ever take place. For a list of available mixModes, see 'nc.constants.effectControllerMixModes'.
`likelyRanges`	Array.<Array.<number>>	<optional>	A list of likely ranges for the components of this EffectController. This is used to inform the Incisor® GUI, specifically the sensativity of EffectoController 'sliders'. [DEFAULT: [[0,10],[0,10]...]]
`effectControllerDescription`	string	<optional>	Optional description to help populate IDE autocomplete related to this EffectController. [DEFAULT: ""]
`componentDescriptions`	Array.<string>	<optional>	Optional list of component descriptions to help populate IDE autocomplete related to this EffectController. [DEFAULT: []]

defineEffectNode(name, vertexNodeSupport, vertexNode, fragmentNodeSupport, fragmentNode, associatedEffectControllers, requiresDerivativesShaderExtension (opt), requiresFragDepthShaderExtension (opt), requiresDrawBuffersShaderExtension (opt), requiresTextureLODShaderExtension (opt)) returns {EffectNode}
`IncisorAPI.js`, `line 14913`

Defines a new EffectNode. Defined EffectNodes are available at 'nc.effectNodes'. EffectNodes are GPU-driven visual effects assigned to SceneObjects, GraphicObjects, and ultimately Materials. Each EffectNode can be manipulated dynamically by one or more EffectControllers, which are accessable as direct members of the given SceneObject or Material. When a GraphicObject is set to a particular GraphicAsset, it's Materials adopt the GraphicAsset's EffectNode and EffectController presets by default, but they can be customized at any time.

Parameters:

Name	Type	Attributes	Description
`name`	string		The name of the new EffectNode. This name must be unique among EffectNodes.
`vertexNodeSupport`	Array.<string> \| string		The portion of the GLSL shader code for this EffectNode above the 'vertex main'. This segment of code is where uniform and varying variables for the vertex portion of this effect are likely to be declared.
`vertexNode`	string		The portion of the GLSL shader code for this EffectNode within the 'vertex main'. This segment of code is is where this effect can make its adjustments to the 'vertex' vec3.
`fragmentNodeSupport`	Array.<string> \| string		The portion of the GLSL shader code for this EffectNode above the 'fragment main'. This segment of code is where uniform and varying variables for the fragment portion of this effect are likely to be declared.
`fragmentNode`	string		The portion of the GLSL shader code for this EffectNode within the 'fragment main'. This segment of code is is where this effect can make its adjustments to the 'fragment' vec4.
`associatedEffectControllers`	Array.<string> \| string		The array of the EffectController that this EffectNode is associated with. These EffectControllers will be the means of dynamic manipulation for this this EffectNode's visual effects. See 'nc.effectControllers' for a list of available EffectControllers.
`requiresDerivativesShaderExtension`	boolean	<optional>	Boolean determining if the shader of any Material with this EffectNode is compiled to support the 'FragDepth' extension. [DEFAULT: false]
`requiresFragDepthShaderExtension`	boolean	<optional>	Boolean determining if the shader of any Material with this EffectNode is compiled to support the 'FragDepth' extension. [DEFAULT: false]
`requiresDrawBuffersShaderExtension`	boolean	<optional>	Boolean determining if the shader of any Material with this EffectNode is compiled to support the 'DrawBuffers' extension. [DEFAULT: false]
`requiresTextureLODShaderExtension`	boolean	<optional>	Boolean determining if the shader of any Material with this EffectNode is compiled to support the 'TextureLOD' extension. [DEFAULT: false]

Returns:

EffectNode

defineGeometry(name, createBox) returns {GeometryEditor}
`IncisorAPI.js`, `line 15486`

Defines a new square 100x100 Geometry, and returns a GeometryEditor object for further customization.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			The name of the new Geometry being defined. This name must be unique among Geometries.
`createBox`	boolean			Whether to initialize the geometry with a 100x100 box with positon and uv attributes. [DEFAULT: true]

Returns:

GeometryEditor

defineGraphicAssetFromPixelsObject(name, pixelsObject, includeNormals (opt)) returns {GraphicAsset}
`IncisorAPI.js`, `line 15235`

Defines a new GraphicAsset from a supplied PixelsObject. See 'nc.graphicAssets' for a list of all available GraphicAssets.

Parameters:

Name	Type	Attributes	Description
`name`	string		The name of the new GraphicAsset. This name must be unique among registered GraphicAssets, Geometries, and Textures.
`pixelsObject`	PixelsObject		The PixelsObject that will be the source for this new GraphicAsset.
`includeNormals`	boolean	<optional>	Boolean determining if the vertex data in the geometry of the new GraphicAsset will have the 'normals' attribute. [DEFAULT: false]

Returns:

GraphicAsset

defineGraphicAssetFromRenderTarget(name, renderTarget, disconnectFromRenderTarget (opt), includeNormals (opt)) returns {GraphicAsset}
`IncisorAPI.js`, `line 15248`

Defines a new GraphicAsset based on the RenderTarget supplied. Unless otherwise specified, this GraphicAsset will have a dynamic connection to the RenderTarget, so that if the RenderTarget is rendered to, GraphicObjects set to this new GraphicAsset will reflect new contents of the RenderTarget. See 'nc.graphicAssets' for a list of all available GraphicAssets.

Parameters:

Name	Type	Attributes	Description
`name`	string		The name of the new GraphicAsset. This name must be unique among registered GraphicAssets, Geometries, and Textures.
`renderTarget`	RenderTarget		The RenderTarget that will be the source for this new GraphicAsset.
`disconnectFromRenderTarget`	boolean	<optional>	Boolean determining if the new GraphicAsset will maintain a dynamic connection to the supplied RenderTarget. [DEFAULT: false]
`includeNormals`	boolean	<optional>	Boolean determining if the vertex data in the geometry of the new GraphicAsset will have the 'normals' attribute. [DEFAULT: false]

Returns:

GraphicAsset

defineLayer(name, scene (opt), placeBehindThisLayer (opt))
`IncisorAPI.js`, `line 15063`

Defines a new Layer within a Scene.

Parameters:

Name	Type	Attributes	Description
`name`	string		The name of the new Layer.
`scene`	Scene	<optional>	The Scene in which to define a new layer. [DEFAULT: nc.mainScene]
`placeBehindThisLayer`	Layer	<optional>	Supply this optional Layer, and the newly defined Layer will be populated behind the provided Layer. [DEFAULT: nc.layers.DefaultLayer]

defineMask(maskName) returns {Mask}
`IncisorAPI.js`, `line 14997`

Defines a new mask. Masks can be used to selectively render partial areas of GraphicObjects. Once a Mask is defined, GraphicObjects can be made into 'maskers', which results in their shape contributing to the Mask area. GraphicObjects can also be made into 'masked', which results in them only rendering within the designated Mask area. Please note that the masking area is calculated off of the full-fill Geometry of the 'masker' GraphicObjects; the transperancy of pixels within a 'masker' GraphicObject does not make any difference to masking.

Parameters:

Name	Type	Attributes	Default	Description
`maskName`	string			The name of the new Mask. This must be a unique name among Masks.

Returns:

Mask

Example:

// Objective: Use a mask to reveal only a portion of the phrase "Hello World."
// Expected Result: You will see the word "World." on screen.

// define "MyMask"
let mask = nc.defineMask( "MyMask" );
 
// create a TextBox
let textBox = nc.addTextBox( nc.mainScene );
textBox.string = "Hello World."
textBox.makeMasked( nc.masks.MyMask ); // mask it with "MyMask"

// create a GraphicObject rectangle and position it to cover the word "World."
this.masker = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "Masker" );
this.masker.scale.x = 2; // rectangle
this.masker.position.x = 75; // position
this.masker.makeMasker( nc.masks.MyMask ); // make it a masker for "MyMask"

defineMotionType(name, motionFunction, motionControllerNames (opt), motionControllerDefaultValues (opt), description (opt), controllerDescriptions (opt)) returns {MotionType}
`IncisorAPI.js`, `line 14488`

Defines a new MotionType. MotionTypes are used in conjunction with 'Motions' and define a method of continuous change for numeric properties. The MotionType 'Pendulum' is automatically defined, which defines a smooth sinusoidal oscillation between the lower and upper bounds. All defined MotionTypes can be found at 'nc.motionTypes'.

Parameters:

Name	Type	Attributes	Description
`name`	string		The name of the new MotionType.
`motionFunction`	function		The function controlling the continuous change of the numeric properties being affected by the Motion using this MotionType. This function should be implemented to take a single 'Motion' parameter, using it's 'progress', 'lowerBound', 'upperBound', 'motionSpeed', and 'motionArgs' members to calculate and return an array of current values.
`motionControllerNames`	Array.<string>	<optional>	The names of optional controllers that can be used to dynamically affect the nature of the motion type.
`motionControllerDefaultValues`	Array.<string>	<optional>	The names of optional controllers that can be used to dynamically affect the nature of the motion type.
`description`	string	<optional>	The description of the MotionType - this will appear in the autocomplete documentation.
`controllerDescriptions`	Array.<string>	<optional>	The descriptions of the MotionType controllers - these will appear in the autocomplete documentation.

Returns:

MotionType

Example:

// Objective: Define a custom MotionType.
// Expected Result: The white box will move continuously in a circular motion.

function moveInCircleFunction(motion) {   
    let progress = motion.progress;
    // Calculate circle center and radius.
    let centerX = (motion.lowerBounds[0]+motion.upperBounds[0])*.5;
    let centerY = (motion.lowerBounds[1]+motion.upperBounds[1])*.5;
    let radiusX = motion.upperBounds[0]-centerX;
    let radiusY = motion.upperBounds[1]-centerY;
    // Apply circle math.
    motion.currentValues[0]=centerX+radiusX*Math.cos(progress*Math.PI);
    motion.currentValues[1]=centerY+radiusY*Math.sin(progress*Math.PI);
    motion.currentValues[2]=0;
}

// Define 'MoveInCircle' Motion
nc.defineMotionType(
    "MoveInCircle",
    moveInCircleFunction,
    undefined,
    undefined,
    "This MotionType moves x and y components in a circle."
 );

 // Create a GraphicObject.
 let graphicObject = new GraphicObject();
 // Add a motion to the GraphicObject's position using the 'MoveInCircle' TweenType. A 'Motion' object is returned and can be manipulted.
 let motion = graphicObject.position.addMotion.each([-300,-100,0],[300,100,10],1,nc.motionTypes.MoveInCircle);

defineParticleSystem(name) returns {ParticleSystemDefinition}
`IncisorAPI.js`, `line 14790`

Defines a new ParticleSystemDefinition. This can then be used to instantiate a new ParticleSystem. Multiple ParticleSystemDefinitions that use the same ParticleSystemDefinition will share the Geometry and EffectNode created by the ParticleSystemDefinition. Therefore, creation of additional ParticleSystemDefinitions that use the same ParticleSystemDefinition incur much less memory usage and initialization time compared to multiple ParticleSystemDefinitions that each use their own ParticleSystemDefinition.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			The name of the ParticleSystemDefinition.

Returns:

ParticleSystemDefinition

definePauseEvent(pauseEventName) returns {PauseEvent}
`IncisorAPI.js`, `line 14668`

Defines a new PauseEvent. The various time-based and user-interaction processes in Incisor® can be paused by calling 'nc.pause' with a PauseEvent parameter. Pausable processes can also opt out of being paused by providing a 'pauseImmunity' list during their initiation (as will be indicated in initiating method parameters). The pauseImmunity list is a list of PauseEvents that the given process will be immune to. All defined PauseEvents can be found at 'nc.pauseEvents'.

Parameters:

Name	Type	Attributes	Default	Description
`pauseEventName`	string			The name of the new PauseEvent.

Returns:

PauseEvent

defineSpeedControl(speedControlName) returns {SpeedControl}
`IncisorAPI.js`, `line 14725`

Defines a new SpeedControl. SpeedControls can be used to control the speed of time-based sequencing processes such as Motions, Swoops, or Timelines. Applicable processes can subscribe to multiple SpeedControls; the 'speed' values of all of the SpeedControls a process subscribes to are multiplied together to determine the overall pacing of the given time-based process. All defined SpeedControls can be found at 'nc.speedControls'.

Parameters:

Name	Type	Attributes	Default	Description
`speedControlName`	string			The name of the new SpeedControl.

Returns:

SpeedControl

defineSyncedLoopingTrackGroup(name, includedSounds)
`IncisorAPI.js`, `line 14424`

Defines a new group of sounds that will stay synced while looping. Sounds in HTML5 run on a separate thread from the main javascript thread, and as a result there can be small delays between the instructions to play sounds, and when the sounds actually play. These discrepancies can lead to difficulty with keeping multiple looping tracks in sync. This function creates a group of sounds whose instructions are linked in a way that keeps them in sync, regardless of pausing/resuming, changes to volume, or lazy-loaded sounds starting mid-stream. [REQUIREMENT: optional code module - 'sounds']

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			The name of the new SyncedLoopingTrackGroup. This name must be unique among SyncedLoopingTrackGroups.
`includedSounds`	Array.<Sound>			Array of Sounds to include in the SyncedLoopingTrackGroup.

defineTexture(name, pixelsObject) returns {Texture}
`IncisorAPI.js`, `line 14444`

Defines a new Texture from a supplied PixelsObject. For a list of all available Textures, see 'nc.textures'.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			The name of the new Texture. This name must be unique among registered Textures.
`pixelsObject`	PixelsObject			The PixelsObject that will be the source for this new Texture.

Returns:

Texture

defineTweenType(name, tweenFunction, tweenControllerNames (opt), tweenControllerDefaultValues (opt), description (opt), controllerDescriptions (opt)) returns {TweenType}
`IncisorAPI.js`, `line 15387`

Defines a new TweenType. TweenTypes are used in conjunction with Swoopers and define a method of interpolation between any two values or sets of values. The TweenType 'Linear' is automatically defined, and it defines a perfectly even interpolation between the startValues and endValues. TweenTypes can vary the timing of interpolation between two sets of values, as well as the path of the interpolation. All defined TweenTypes can be found at 'nc.tweenTypes'.

Parameters:

Name	Type	Attributes	Description
`name`	string		The name of the new TweenType.
`tweenFunction`	function		The function controlling the interpolation between values. This function should be implemented to take a single 'Swooper' parameter, using it's 'progress', 'startValues', 'endValues', and 'tweenArgs' members to calculate and set its 'currentValues' property.
`tweenControllerNames`	Array.<string>	<optional>	The names of optional controllers that can be used to dynamically affect the nature of the motion for this TweenType.
`tweenControllerDefaultValues`	Array.<string>	<optional>	The names of optional controllers that can be used to dynamically affect the nature of the motion for this TweenType.
`description`	string	<optional>	The description of the TweenType - this will appear in the autocomplete documentation.
`controllerDescriptions`	Array.<string>	<optional>	The descriptions of the TweenType controllers - these will appear in the autocomplete documentation.

Returns:

TweenType

Example:

// Objective: Define a custom TweenType.
// Expected Result: The white box will zigzag while moving up along the y axis.

// create a white box
let graphic = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "Box" );

// define a TweenType function. Use the given swooper progress 
// to update the box's position as it completes its swoop
let myTweenFunction = function( swooper ) {
    let progress = swooper.progress;
  
    let updatedX = swooper.currentValues[0] ? swooper.currentValues[0] : 0;
    let updatedY = swooper.endValues[1] * progress;

     if ( progress < .20 ) {
         updatedX += 10 * progress;
     } else if ( progress >= .20 && progress < .40 ) {
         updatedX -= 8 * progress;
     } else if ( progress >= .40 && progress < .60 ) {
         updatedX += 6 * progress;
     } else if ( progress >= .60 && progress < .80 ) {
         updatedX -= 4 * progress;
     } else {
         updatedX += 2 * progress;
     }
 
     swooper.currentValues = [ updatedX, updatedY, 0 ];

 }

// define the TweenType with our custom function and swoop the box's position
let myTweenType = nc.defineTweenType( "MyTweenType", myTweenFunction );
graphic.position.swoop.each( [0,500,0], 10, myTweenType );

defineVolumeControl(name) returns {VolumeControl}
`IncisorAPI.js`, `line 14434`

Defines a new VolumeControl. VolumeControls are a way to control the volumes of groups of sounds, much like a 'audio bus'. To make a particular Sound subscribe to a VolumeControl, add the VolumeControl to the Sound's 'volumeControl' array. [REQUIREMENT: optional code module - 'sounds']

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			The name of the new VolumeControl. This name must be unique among VolumeControls.

Returns:

VolumeControl

dispose(objectForDisposal)
`IncisorAPI.js`, `line 15079`

Removes the provided object from all Incisor® registries. Send any object slated for deletion to this function to ensure that references to the object are not being kept in Incisor®'s regestries. Doing this can help prevent memory leaks.

Parameters:

Name	Type	Attributes	Default	Description
`objectForDisposal`	object			The object that will be disposed.

async editGeometry(geometry, callbackOwner (opt), callbackName (opt), callbackArgs (opt)) returns {GeometryEditor}
`IncisorAPI.js`, `line 14763`

Asyncronously retrieves a GeometryEditor to enable the editing of the Geometry provided. Please note that before you attempt to do any editing, the source Geometry must be loaded; you must either asyncronously await this function call, or provide a callback, which will be called once the souece Geometry is loaded. The first parameter of the callback will be the desired GeometryEditor.

Parameters:

Name	Type	Attributes	Description
`geometry`	Geometry		The source Geometry to be edited.
`callbackOwner`	object	<optional>	The object owning the callback that will be called when the source Geometry loads.
`callbackName`	string	<optional>	The name of the callback that will be called when the source Geometry loads.
`callbackArgs`	Array \| any	<optional>	The arguments for the callback that will be called when the source Geometry loads.

Returns:

GeometryEditor

gatherObjectBlueprint(sceneObject, includeRoot (opt))
`IncisorAPI.js`, `line 15106`

This function can be used to collect the core information needed to define a Construct based on a group of objects whithin a Scene. Just provide a root SceneObject and information about its entire sub-hierarchy will be gathered and returned in the form of a 'Blueprint' object, which can then be used to define Constructs using 'nc.defineConstruct'. It should be noted that most users will not need to use this functionality; it is used in the Creation of Constructs, which are typically just created in the Incisor® GUI.

Parameters:

Name	Type	Attributes	Default	Description
`sceneObject`	SceneObject			The root SceneObject to gather a Blueprint for.
`includeRoot`	boolean	<optional>		If true, the provided root will be included in the construct, if false the root will be omitted. [DEFAULT: true]

getAllEventRecipients() returns {object}
`IncisorAPI.js`, `line 14731`

Returns a dictionary containing lists of all active callbacks per AppEvent.

Returns:

object

getAncestors(sceneObject) returns {Array.<SceneObject>}
`IncisorAPI.js`, `line 14858`

Returns a list of all of the ancesters of the given SceneObject. Ancesters consist of the SceneObject's parent, and that parent's parent, etc...

Parameters:

Name	Type	Attributes	Default	Description
`sceneObject`	SceneObject			The SceneObject whose ancestors will be listed.

Returns:

Array.<SceneObject>

getCanvasPixelResolution() returns {Vector2}
`IncisorAPI.js`, `line 15497`

Returns a Vector2 with the pixel resolution of nc.mainRenderTarget.

Returns:

Vector2

async getClipboardText() returns {string}
`IncisorAPI.js`, `line 14749`

Retrieves text from the clipboard.

Returns:

string -

text The text to be copied to the clipboard.

getDescendants(sceneObject, enabledOnly, includeEnclosedScenes) returns {Array.<SceneObject>}
`IncisorAPI.js`, `line 14867`

Returns a list of all of the descendants of the given SceneObject. Descendants consist of the SceneObject's children, and their children, etc...

Parameters:

Name	Type	Description
`sceneObject`	SceneObject	The SceneObject whose descendants will be listed.
`enabledOnly`	boolean	Boolean determining if only enabled SceneObjects are added to the returned list. [DEFAULT: true]
`includeEnclosedScenes`	boolean	Boolean determining if sub-descendants of ScrollingPanels' Scenes will be included in the returned list. [DAFAULT: false]

Returns:

Array.<SceneObject>

inheritButton(obj, graphicAsset (opt), parent (opt), name (opt))
`IncisorAPI.js`, `line 14920`

Adds Button functionality to the object supplied.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	object			The object that Button functionality is being added to.
`graphicAsset`	GraphicAsset	<optional>	nc.graphicAssets.WhiteBox	The GraphicAsset that the new Button will initially be set to. For a list of available GraphicAssets, see 'nc.graphicAssets'. [DEFAULT: nc.graphicAssets.WhiteBox]
`parent`	SceneObject	<optional>	nc.mainScene	The SceneObject that will become the new Button's parent in the Scene hierarchy. [DEFAULT: nc.mainScene]
`name`	string	<optional>	'Button'	The name of the new Button. [DEFAULT: 'Button']

inheritCursorInputOverrideButton(obj, graphicAsset (opt), parent (opt), name (opt))
`IncisorAPI.js`, `line 15528`

Adds CursorInputOverrideButton functionality to the object supplied.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that CursorInputOverrideButton functionality is being added to.
`graphicAsset`	GraphicAsset	<optional>	The GraphicAsset that the new CursorInputOverrideButton will initially be set to. For a list of available GraphicAssets, see 'nc.graphicAssets'. [DEFAULT: nc.graphicAssets.WhiteBox]
`parent`	SceneObject	<optional>	The SceneObject that will become the new CursorInputOverrideButton's parent in the Scene hierarchy. [DEFAULT: nc.mainScene]
`name`	string	<optional>	The name of the new CursorInputOverrideButton. [DEFAULT: 'CursorInputOverrideButton']

inheritGraphicObject(obj, graphicAsset (opt), parent (opt), name (opt))
`IncisorAPI.js`, `line 14943`

Adds GraphicObject functionality to the object supplied.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	object			The object that GraphicObject functionality is being added to.
`graphicAsset`	GraphicAsset	<optional>	nc.graphicAssets.WhiteBox	The GraphicAsset that the new GraphicObject will initially be set to. For a list of available GraphicAssets, see 'nc.graphicAssets'. [DEFAULT: nc.graphicAssets.WhiteBox]
`parent`	SceneObject	<optional>	nc.mainScene	The SceneObject that will become the new GraphicObject's parent in the Scene hierarchy. [DEFAULT: nc.mainScene]
`name`	string	<optional>	'GraphicObject'	The name of the new GraphicObject. [DEFAULT: 'GraphicObject']

inheritLayoutStack(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 14772`

Adds LayoutStack functionality to the object supplied.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that LayoutStack functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new LayoutStack's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new LayoutStack. [DEFAULT: 'LayoutStack']

inheritLayoutStack(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15265`

Adds LayoutStack functionality to the object supplied.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that LayoutStack functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new LayoutStack's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new LayoutStack. [DEFAULT: 'LayoutStack']

inheritLazyUpdater(obj, updateCallbackOwner, updateCallbackName, updateCallbackArgs (opt))
`IncisorAPI.js`, `line 15320`

Adds LazyUpdater functionality to the object supplied.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that LazyUpdater functionality is being added to.
`updateCallbackOwner`	object		The object owning the callback function being managed by this LazyUpdater.
`updateCallbackName`	string		The name of the callback function being managed by this LazyUpdater.
`updateCallbackArgs`	Array \| any	<optional>	Arguments for the callback function.

inheritMaterial(obj)
`IncisorAPI.js`, `line 15084`

Adds Material functionality to the object supplied.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	object			The object that Material functionality is being added to.

inheritOrthographicCamera(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15006`

Adds OrthographicCamera functionality to the object supplied.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that Camera functionality is being added to.
`parent`	SceneObject	<optional>	The parent of the new Camera. [DEFAULT: nc.mainScene]
`name`	string	<optional>	The name of the new Camera.

inheritParticleSystemRamp1(obj)
`IncisorAPI.js`, `line 14815`

Adds ParticleSystemRamp1 functionality to the object supplied.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	object			The object that ParticleSystemRamp1 functionality is being added to.

inheritParticleSystemRamp2(obj)
`IncisorAPI.js`, `line 14821`

Adds ParticleSystemRamp2 functionality to the object supplied.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	object			The object that ParticleSystemRamp2 functionality is being added to.

inheritParticleSystemRamp3(obj)
`IncisorAPI.js`, `line 14827`

Adds ParticleSystemRamp3 functionality to the object supplied.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	object			The object that ParticleSystemRamp3 functionality is being added to.

inheritParticleSystemRamp4(obj)
`IncisorAPI.js`, `line 14833`

Adds ParticleSystemRamp4 functionality to the object supplied.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	object			The object that ParticleSystemRamp4 functionality is being added to.

inheritPrecomp(obj, name, coreWidth, coreHeight, autoRender)
`IncisorAPI.js`, `line 15158`

Adds Precomp functionality to the object supplied.

Parameters:

Name	Type	Description
`obj`	object	The object that Precomp functionality is being added to.
`name`	string	The name of the new Precomp. This name must be unique among Precomps, GraphicAssets, Geometries, and Textures.
`coreWidth`	number	The number informing the initial coreViewWidth of the Precomp's Camera, and the initial coreWidth of the Precomp's RenderTarget.
`coreHeight`	number	The number informing the initial coreViewHeight of the Precomp's Camera, and the initial coreHeight of the Precomp's RenderTarget.
`autoRender`	boolean	The initial 'autoRender' setting for the Precomp's Camera. It should be noted that if autoRender is set to false, an internal callback will automatically render this Precomp once when its content is loaded.

inheritRenderTarget(obj, name, coreWidth, coreHeight)
`IncisorAPI.js`, `line 15257`

Adds RenderTarget functionality to the supplied object.

Parameters:

Name	Type	Description
`obj`	object	The object to give RenderTarget funcionality to.
`name`	string	The name given to the RenderTarget. This name must be unique.
`coreWidth`	number	The base width value of this RenderTarget, prior to the application of any automatic resolution or aspect ratio adjustments that can occur.
`coreHeight`	number	The base height value of this RenderTarget, prior to the application of any automatic resolution or aspect ratio adjustments that can occur.

inheritScene(obj, name)
`IncisorAPI.js`, `line 15055`

Adds Scene functionality to the object supplied.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	object			The object that Scene functionality is being added to.
`name`	string			The name of the new Scene.

inheritSceneObject(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 14851`

Adds SceneObject functionality to the object supplied.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	object			The object that SceneObject functionality is being added to.
`parent`	SceneObject	<optional>		The SceneObject that will become the new SceneObject's parent in the Scene hierarchy.
`name`	string	<optional>	'SceneObject'	The name of the new SceneObject. [DEFAULT: 'SceneObject']

inheritSceneObject(obj, name (opt), pauseImmunity (opt), speedControl (opt))
`IncisorAPI.js`, `line 15137`

Adds PlaybackController functionality to the object supplied.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that PlaybackController functionality is being added to.
`name`	string	<optional>	The name of the PlaybackController. [DEFAULT: "PlaybackController"]
`pauseImmunity`	PauseEvent \| Array.<PauseEvent>	<optional>	The PauseEvent or Array of PauseEvents that this PlaybackController will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
`speedControl`	SpeedControl \| Array.<SpeedControl>	<optional>	The SpeedControl or Array of SpeedControls that this PlaybackController is affected by. [DEFAULT: nc.defaultSpeedControl]

inheritScrollingPanel(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15071`

Adds ScrollingPanel functionality to the object supplied.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that ScrollingPanel functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new ScrollingPanel's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new ScrollingPanel. [DEFAULT: 'ScrollingPanel']

inheritSupervisor(obj, owner)
`IncisorAPI.js`, `line 15557`

Adds Supervisor functionality to the object supplied.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	object			The object that Supervisor functionality is being added to.
`owner`	SceneObject			The SceneObject owning the visual components associated with the Supervisor.

inheritTextAssembly(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 14574`

Adds TextAssembly functionality to the object supplied.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that TextAssembly functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new TextAssembly's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new TextAssembly.

inheritTextBox(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15505`

Adds TextBox functionality to the object supplied.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that TextBox functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new TextBox's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new TextBox.

inheritTextFormat(obj, fontName (opt), characterScaleX (opt), characterScaleY (opt), kerning (opt), verticalShift (opt), lineHeightMultiplier (opt))
`IncisorAPI.js`, `line 15334`

Adds TextFormat functionality to the object supplied.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that TextFormat functionality is being added to.
`fontName`	string	<optional>	The name of the font that characters with this TextFormat will use. [DEFAULT: "MainFont"]
`characterScaleX`	number	<optional>	The x-axis scale multiplier for the characters that use this TextFormat. [DEFAULT: 1]
`characterScaleY`	number	<optional>	The y-axis scale multiplier for the characters that use this TextFormat. [DEFAULT: 1]
`kerning`	number	<optional>	Number representing an added or reduced spacing between the characters that use this TextFormat [DEFAULT: 0]
`verticalShift`	number	<optional>	Number representing a veritcal offset that will be applied to the characters that use this TextForamt. [DEFAULT: 0]
`lineHeightMultiplier`	number	<optional>	Number that multiplies the effective layout height of the characters that use this TextFormat. [DEFAULT: 1]

inheritUiBooleanSupervisor_checkbox(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15146`

Adds UiBooleanSupervisor_checkbox functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiBooleanSupervisor_checkbox functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiBooleanSupervisor_checkbox's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiBooleanSupervisor_checkbox. [DEFAULT: 'UiBooleanSupervisor_checkbox']

inheritUiButton(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 14525`

Adds UiButton functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiButton functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiButton's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiButton. [DEFAULT: 'UiButton']

inheritUiCollapsibleStack(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 14566`

Adds UiCollapsibleStack functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiCollapsibleStack functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiCollapsibleStack's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiCollapsibleStack. [DEFAULT: 'UiCollapsibleStack']

inheritUiDropDownButton(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 14414`

Adds UiDropDownMenu functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiDropDownMenu functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiDropDownMenu's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiDropDownMenu. [DEFAULT: 'UiDropDownMenu']

inheritUiGraphicButton(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15050`

Adds UiGraphicButton functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiGraphicButton functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiGraphicButton's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiGraphicButton. [DEFAULT: 'UiGraphicButton']

inheritUiLinkButton(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15128`

Adds UiLinkButton functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiLinkButton functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiLinkButton's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiLinkButton. [DEFAULT: 'UiLinkButton']

inheritUiMenu(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15537`

Adds UiMenu functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiMenu functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiMenu's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiMenu. [DEFAULT: 'UiMenu']

inheritUiNumberSupervisor_textField(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15313`

Adds UiNumberSupervisor_textField functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiNumberSupervisor_textField functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiNumberSupervisor_textField's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiNumberSupervisor_textField. [DEFAULT: 'UiNumberSupervisor_textField']

inheritUiPopupWindow(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15548`

Adds UiPopupWindow functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiPopupWindow functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiPopupWindow's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiPopupWindow. [DEFAULT: 'UiPopupWindow']

inheritUiStringSupervisor_menu(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15228`

Adds UiStringSupervisor_menu functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiStringSupervisor_menu functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiStringSupervisor_menu's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiStringSupervisor_menu. [DEFAULT: 'UiStringSupervisor_menu']

inheritUiStringSupervisor_textField(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15304`

Adds UiStringSupervisor_textField functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiStringSupervisor_textField functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiStringSupervisor_textField's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiStringSupervisor_textField. [DEFAULT: 'UiStringSupervisor_textField']

inheritUiText(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 14619`

Adds UiText functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiText functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiText's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiText. [DEFAULT: 'UiText']

inheritUiTextField(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 15168`

Adds UiTextField functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that UiTextField functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new UiTextField's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new UiTextField. [DEFAULT: 'UiTextField']

inheritUiVectorSupervisor_textField(obj, parent (opt), name (opt))
`IncisorAPI.js`, `line 14405`

Adds inheritUiVectorSupervisor_textField functionality to the object supplied. [REQUIREMENT: optional code module - 'extendedUi']

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object that inheritUiVectorSupervisor_textField functionality is being added to.
`parent`	SceneObject	<optional>	The SceneObject that will become the new inheritUiVectorSupervisor_textField's parent in the Scene hierarchy.
`name`	string	<optional>	The name of the new inheritUiVectorSupervisor_textField. [DEFAULT: 'inheritUiVectorSupervisor_textField']

inheritVector1(obj, x (opt))
`IncisorAPI.js`, `line 15478`

Adds Vector1 functionality to the supplied object.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	object			The object to give Vector1 functionality to.
`x`	number	<optional>		The value for the first component. [DEFAULT: 0]

inheritVector2(obj, x (opt), y (opt))
`IncisorAPI.js`, `line 15471`

Adds Vector2 functionality to the supplied object.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object to give Vector2 functionality to.
`x`	number	<optional>	The value for the first component. [DEFAULT: 0]
`y`	number	<optional>	The value for the second component. [DEFAULT: 0]

inheritVector3(obj, x (opt), y (opt), z (opt))
`IncisorAPI.js`, `line 15463`

Adds Vector3 functionality to the supplied object.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object to give Vector3 functionality to.
`x`	number	<optional>	The value for the first component. [DEFAULT: 0]
`y`	number	<optional>	The value for the second component. [DEFAULT: 0]
`z`	number	<optional>	The value for the third component. [DEFAULT: 0]

inheritVector4(obj, x (opt), y (opt), z (opt), w (opt))
`IncisorAPI.js`, `line 15454`

Adds Vector4 functionality to the supplied object.

Parameters:

Name	Type	Attributes	Description
`obj`	object		The object to give Vector4 functionality to.
`x`	number	<optional>	The value for the first component. [DEFAULT: 0]
`y`	number	<optional>	The value for the second component. [DEFAULT: 0]
`z`	number	<optional>	The value for the third component. [DEFAULT: 0]
`w`	number	<optional>	The value for the forth component. [DEFAULT: 0]

inheritWaitThen(obj, name)
`IncisorAPI.js`, `line 15219`

Adds WaitThen functionality to the supplied object. [REQUIREMENT: optional code module - 'waitThens']

Parameters:

Name	Type	Attributes	Default	Description
`obj`	object			The object to give WaitThen functionality to.
`name`	string			The name of the new WaitThen object.

loadTier(tier, prioritize (opt))
`IncisorAPI.js`, `line 15022`

Initiates the process of loading all of the assets in a given loading tier. This function does not need to be called for 'auto-loaded' LoadingTiers.

Parameters:

Name	Type	Attributes	Default	Description
`tier`	number			The desired tier for loading. For a list of available LoadingTiers, see nc.LoadingTiers.
`prioritize`	boolean	<optional>		Bool determining if the tier in question will jump to the frot of the loading queue. [DEFAULT: true]

pause(pauseEvent)
`IncisorAPI.js`, `line 14692`

Pauses the various time-based and user-interaction processes that can be paused by the supplied PauseEvent. Processes that list the supplied PauseEvent in their 'pauseImmunity' will be immune to this pause.

Parameters:

Name	Type	Attributes	Default	Description
`pauseEvent`	PauseEvent			The PauseEvent being triggered. Available PauseEvents can be found in 'nc.pauseEvents'.

Example:

// Objective: Pause and resume motion.
// Expected Result: The white box will move up and down along the y axis for 3 seconds, then pause for 3 seconds, then resume again.

// create a GraphicObject with the white box asset
let graphic = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "Box" );
// add motion to the position of this GraphicObject along the y axis with a motion speed of 2
graphic.position.addMotion.y( -300, 300, 2 );
// create a PauseEvent
nc.definePauseEvent("BoxPause");
// wait 3 seconds, then call "pause", passing BoxPause as the PauseEvent
nc.waitThen( 3, nc, "pause", [nc.pauseEvents.BoxPause] );
       
// wait 6 seconds, then call "resume"
// NOTE: At this point, "resume" is paused by the BoxPause event. This is why we must also
// pass the BoxPause event as the "pauseImmunity" parameter.
nc.waitThen( 6, nc, "resume", nc.pauseEvents.BoxPause , undefined, nc.pauseEvents.BoxPause );

recreateObjectFromBlueprint(parent, blueprint) returns {Array.<SceneObject>}
`IncisorAPI.js`, `line 15115`

Recreates the objects stored in the Blueprint, placing them in the provided parent SceneObject, and returning the newly created root-most object(s). This functionality is the foundation for Incisor® Constructs.

Parameters:

Name	Type	Attributes	Default	Description
`parent`	SceneObject			The SceneObject that will be the parent of the newly recreated collection of objects.
`blueprint`	Blueprint			The blueprint containing the information about the collection of objects that will be recreated.

Returns:

Array.<SceneObject>

relinquishFocus()
`IncisorAPI.js`, `line 14736`

Sets nc.singularFocusObject to nc.singularFocusObject.focusFallback.

resume(pauseEvent)
`IncisorAPI.js`, `line 14715`

Resumes the processes that were paused by the supplied PauseEvent. Some processes may not resume if they are still being affected by other PauseEvents.

Parameters:

Name	Type	Attributes	Default	Description
`pauseEvent`	PauseEvent			The PauseEvent being resumed. Available PauseEvents can be found in 'nc.pauseEvents'.

Example:

// Objective: Pause and resume motion.
// Expected Result: The white box will move up and down along the y axis for 3 seconds, then pause for 3 seconds, then resume again.

// create a GraphicObject with the white box asset
let graphic = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "Box" );
// add motion to the position of this GraphicObject along the y axis with a motion speed of 2
graphic.position.addMotion.y( -300, 300, 2 );
// create a PauseEvent
nc.definePauseEvent("BoxPause");
// wait 3 seconds, then call "pause", passing BoxPause as the PauseEvent
nc.waitThen( 3, nc, "pause", [nc.pauseEvents.BoxPause] );
       
// wait 6 seconds, then call "resume"
// NOTE: At this point, "resume" is paused by the BoxPause event. This is why we must also
// pass the BoxPause event as the "pauseImmunity" parameter.
nc.waitThen( 6, nc, "resume", nc.pauseEvents.BoxPause , undefined, nc.pauseEvents.BoxPause );

sanitizeNameForCode(name) returns {string}
`IncisorAPI.js`, `line 15493`

Sanitizes the provided name to make it suitable for code by removing any leading digits, spaces, or special characters.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			The name to be sanitized.

Returns:

string

stopAllWaitThensByCallback(callbackOwner, callbackName, performCallback (opt))
`IncisorAPI.js`, `line 15211`

Stops all currently active WaitThens whose callback info matches the given callback info. [REQUIREMENT: optional code module - 'waitThens']

Parameters:

Name	Type	Attributes	Description
`callbackOwner`	object		The owner of the callback associated with the WaitThens to stop.
`callbackName`	string		The name of the callback associated with the WaitThens to stop.
`performCallback`	boolean	<optional>	Boolean determining if the callback function will be called immediately, or if it will be skipped entirely. [DEFAULT: false]

stopAllWaitThensByName(name, performCallback (opt))
`IncisorAPI.js`, `line 15202`

Stops all currently active WaitThens whose name matches the name given. [REQUIREMENT: optional code module - 'waitThens']

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			The name of the WaitThens to stop.
`performCallback`	boolean	<optional>		Boolean determining if the callback function will be called immediately, or if it will be skipped entirely. [DEFAULT: false]

swoopValue(propertyOwner, propertyName, endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
`IncisorAPI.js`, `line 15425`

Swoops (interpolates) a given numeric property from its current value to a designated end value over a duration.

Parameters:

Name	Type	Attributes	Description
`propertyOwner`	object		The object owning the numeric property to be swooped.
`propertyName`	string		The name of the numeric property to be swooped.
`endValue`	number		The ending value for the numeric property being swooped.
`duration`	number	<optional>	The duration for the interpolation. [DEFAULT: 0]
`tweenType`	TweenType	<optional>	The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
`completionCallbackOwner`	object	<optional>	The object owning the callback function that is called when the Swooper completes.
`completionCallbackName`	string	<optional>	The name of the function that is called when the Swooper completes.
`completionCallbackArgs`	Array \| any	<optional>	Arguments for the function that is called when the Swooper completes.
`pauseImmunity`	PauseEvent \| Array.<PauseEvent>	<optional>	The PauseEvent or Array of PauseEvents that this Swooper will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
`speedControl`	SpeedControl \| Array.<SpeedControl>	<optional>	The SpeedControl or Array of SpeedControls that this Swooper is affected by. [DEFAULT: nc.defaultSpeedControl]
`eventCallbackOwner`	object	<optional>	The object owning the callback function that is called with each fixedUpdate during the swooping process.
`eventCallbackName`	string	<optional>	The name of the function that is called with each fixedUpdate during the swooping process.

Returns:

Swooper

Example:

// Objective: Adjust the motion speed of a "bouncing" white box.
// Expected Result: The white box will bounce, gradually slowing down over a period of 5 seconds, then it will gradually speed back up over a period of 5 seconds.

// Create a GraphicObject using the white box GraphicAsset and add it to the main Scene.
let myGraphicObject = new GraphicObject( nc.graphicAssets.whiteBox, nc.mainScene, "MyGraphicObject" );
// Give the box motion along the y axis. Set the speed to 2.
myGraphicObject.position.addMotion.y(-300,300,2);
 
// Swoop the 'speed' property of the MainSpeedControl down to .05 over a period of 5 seconds and provide callback arguments to swoop the 'speed' property again back up to speed 1 over a period of 10 seconds.
nc.swoopValue( 
            nc.speedControls.MainSpeedControl, 
            "speed", 
            .05, 
            5, 
            undefined, 
            nc, 
            "swoopValue", 
            [nc.speedControls.MainSpeedControl, "speed", 1, 10] 
            );

swoopValues(propertyOwners, propertyNames, endValues, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
`IncisorAPI.js`, `line 15443`

Swoops (interpolates) a given set of numeric properties from their current values to a designated set of end values over a duration.

Parameters:

Name	Type	Attributes	Description
`propertyOwners`	Array.<object>		The object or objects owning the numeric properties to be swooped.
`propertyNames`	Array.<string>		The names of the numeric property to be swooped.
`endValues`	Array.<number>		The ending values for the numeric properties being swooped.
`duration`	number	<optional>	The duration for the interpolation. [DEFAULT: 0]
`tweenType`	TweenType	<optional>	The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
`completionCallbackOwner`	object	<optional>	The object owning the callback function that is called when the Swooper completes.
`completionCallbackName`	string	<optional>	The name of the function that is called when the Swooper completes.
`completionCallbackArgs`	Array \| any	<optional>	Arguments for the function that is called when the Swooper completes.
`pauseImmunity`	PauseEvent \| Array.<PauseEvent>	<optional>	The PauseEvent or Array of PauseEvents that this Swooper will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
`speedControl`	SpeedControl \| Array.<SpeedControl>	<optional>	The SpeedControl or Array of SpeedControls that this Swooper is affected by. [DEFAULT: nc.defaultSpeedControl]
`eventCallbackOwner`	object	<optional>	The object owning the callback function that is called with each fixedUpdate during the swooping process.
`eventCallbackName`	string	<optional>	The name of the function that is called with each fixedUpdate during the swooping process.

Returns:

Swooper

waitThen(duration, callbackOwner, callbackName, callbackArgs (opt), name (opt), pauseImmunity (opt), speedControl (opt))
`IncisorAPI.js`, `line 15194`

Sets up a WaitThen (from an internal pool), invoking the given callback after the specified delay. Since the WaitThen being used here is internal, the object itself cannot be referenced; to stop a pooled WaitThen, call 'nc.stopAllWaitThensByName' or 'nc.stopAllWaitThensByCallback'. [REQUIREMENT: optional code module - 'waitThens']

Parameters:

Name	Type	Attributes	Description
`duration`	number		Seconds before the callback will occur.
`callbackOwner`	object		The object owning the callback function that is called when the WaitThen completes.
`callbackName`	string		The name of the function that is called when the WaitThen completes.
`callbackArgs`	Array \| any	<optional>	Arguments for the function that is called when the WaitThen completes.
`name`	string	<optional>	The name of this WaitThen. [DEFAULT: "WaitThen"]
`pauseImmunity`	PauseEvent \| Array.<PauseEvent>	<optional>	The PauseEvent or Array of PauseEvents that this WaitThen will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
`speedControl`	SpeedControl \| Array.<SpeedControl>	<optional>	The SpeedControl or Array of SpeedControls that this WaitThen is affected by. [DEFAULT: nc.defaultSpeedControl]

Example:

// Objective: Use a waitThen function
// Expected Result: The screen will show "Wait for it..." for 3 seconds then "Incisor!" will appear.

this.textBox = new TextBox( nc.mainScene );
this.textBox.string = "Wait for it...";

// call waitThen with a duration of 3 seconds
nc.waitThen( 3, this, "waitThenCallback" );

this.waitThenCallback = function() {
    this.textBox.string = "Incisor!";
}

INCISOR IncisorAPI.js, line 13785

MEMBERS

appEvents :AppEvents IncisorAPI.js, line 13922

cameras :Cameras IncisorAPI.js, line 14090

constants :Constants IncisorAPI.js, line 14368

constructDefs IncisorAPI.js, line 14177

defaultFocusFallback :SceneObject IncisorAPI.js, line 13965

defaultPauseImmunity :Array.<PauseEvent>|PauseEvent IncisorAPI.js, line 13947

defaultSpeedControl :Array.<SpeedControl>|SpeedControl IncisorAPI.js, line 13956

effectControllers :EffectControllers IncisorAPI.js, line 13899

effectNodes :EffectNodes IncisorAPI.js, line 14059

fileIO :FileIO IncisorAPI.js, line 14032

fontNames :FontNames IncisorAPI.js, line 13893

geometries :Geometries IncisorAPI.js, line 14333

globalRenderTargetResolutionScaler :number IncisorAPI.js, line 14261

graphicAssets :GraphicAssets IncisorAPI.js, line 14243

incisorApp :IncisorApp IncisorAPI.js, line 14302

incisorAppBasic :IncisorAppBasic IncisorAPI.js, line 14311

keyDownStates :object IncisorAPI.js, line 14383

layers :Layers IncisorAPI.js, line 14136

layersByScene :LayersByScene IncisorAPI.js, line 14149

loadingTiers :LoadingTiers IncisorAPI.js, line 14106

mainCamera :OrthographicCamera IncisorAPI.js, line 14096

mainRenderTarget :RenderTarget IncisorAPI.js, line 14267

mainScene :Scene IncisorAPI.js, line 14142

masks :Masks IncisorAPI.js, line 14076

motionTypes :MotionTypes IncisorAPI.js, line 13848

multiTapInterval :number IncisorAPI.js, line 14067

particleSystemDefinitions :ParticleSystemDefinitions IncisorAPI.js, line 14022

paths :Paths IncisorAPI.js, line 13884

pauseEvents :PauseEvents IncisorAPI.js, line 13930

pixelsObjects :PixelsObjects IncisorAPI.js, line 14116

precomps IncisorAPI.js, line 14224

projectConfiguration :ProjectConfiguration IncisorAPI.js, line 13913

readonly projectName :string IncisorAPI.js, line 13793

publishing :Publishing IncisorAPI.js, line 14216

renderTargets :RenderTargets IncisorAPI.js, line 14254

scenes :Scenes IncisorAPI.js, line 14130

singularFocusButtonPressRequirements :Array.<Button> IncisorAPI.js, line 14007

singularFocusObject :SceneObject IncisorAPI.js, line 13995

softwareSpeed :number IncisorAPI.js, line 13987

sounds :Sounds IncisorAPI.js, line 13809

specialSubstitutionCharacter :string IncisorAPI.js, line 14350

speedControls :SpeedControls IncisorAPI.js, line 13938

targetFixedUpdateRate :number IncisorAPI.js, line 13972

targetScreenUpdateRate :number IncisorAPI.js, line 13979

textures :Textures IncisorAPI.js, line 13838

timeStamp :TimeStamp IncisorAPI.js, line 14160

tweenTypes :TweenTypes IncisorAPI.js, line 14321

uiStyle :UiStyle IncisorAPI.js, line 13826

uiZoom :UiZoom IncisorAPI.js, line 13867

urlParameterIterator :UrlParameterIterator IncisorAPI.js, line 14196

readonly visualFocusObject :UiVisualFocus IncisorAPI.js, line 14046

volumeControls :VolumeControls IncisorAPI.js, line 13816

METHODS

addButton(graphicAsset (opt), parent (opt), name (opt)) returns {Button} IncisorAPI.js, line 14935

Parameters:

Returns:

Example:

addGraphicObject(graphicAsset (opt), parent (opt), name (opt)) returns {GraphicObject} IncisorAPI.js, line 14967

Parameters:

Returns:

Example:

addLayoutStack(parent (opt), name (opt)) returns {LayoutStack} IncisorAPI.js, line 14780

Parameters:

Returns:

addLayoutStack(parent (opt), name (opt)) returns {LayoutStack} IncisorAPI.js, line 15295

Parameters:

Returns:

Example:

addMotion(propertyOwners, propertyNames, lowerBounds, upperBounds, motionSpeed (opt), motionType (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Motion} IncisorAPI.js, line 14512

Parameters:

Returns:

Example:

addOrthographicCamera(parent (opt), name (opt)) returns {OrthographicCamera} IncisorAPI.js, line 15014

Parameters:

Returns:

addParticleSystem(particleSystemDefinition (opt), parent (opt), name (opt), pauseImmunity (opt), speedControl (opt)) returns {ParticleSystem} IncisorAPI.js, line 14809

Parameters:

Returns:

INCISOR
`IncisorAPI.js`, `line 13785`

appEvents :AppEvents
`IncisorAPI.js`, `line 13922`

cameras :Cameras
`IncisorAPI.js`, `line 14090`

constants :Constants
`IncisorAPI.js`, `line 14368`

constructDefs
`IncisorAPI.js`, `line 14177`

defaultFocusFallback :SceneObject
`IncisorAPI.js`, `line 13965`

defaultPauseImmunity :Array.<PauseEvent>|PauseEvent
`IncisorAPI.js`, `line 13947`

defaultSpeedControl :Array.<SpeedControl>|SpeedControl
`IncisorAPI.js`, `line 13956`

effectControllers :EffectControllers
`IncisorAPI.js`, `line 13899`

effectNodes :EffectNodes
`IncisorAPI.js`, `line 14059`

fileIO :FileIO
`IncisorAPI.js`, `line 14032`

fontNames :FontNames
`IncisorAPI.js`, `line 13893`

geometries :Geometries
`IncisorAPI.js`, `line 14333`

globalRenderTargetResolutionScaler :number
`IncisorAPI.js`, `line 14261`

graphicAssets :GraphicAssets
`IncisorAPI.js`, `line 14243`

incisorApp :IncisorApp
`IncisorAPI.js`, `line 14302`

incisorAppBasic :IncisorAppBasic
`IncisorAPI.js`, `line 14311`

keyDownStates :object
`IncisorAPI.js`, `line 14383`

layers :Layers
`IncisorAPI.js`, `line 14136`

layersByScene :LayersByScene
`IncisorAPI.js`, `line 14149`

loadingTiers :LoadingTiers
`IncisorAPI.js`, `line 14106`

mainCamera :OrthographicCamera
`IncisorAPI.js`, `line 14096`

mainRenderTarget :RenderTarget
`IncisorAPI.js`, `line 14267`

mainScene :Scene
`IncisorAPI.js`, `line 14142`

masks :Masks
`IncisorAPI.js`, `line 14076`

motionTypes :MotionTypes
`IncisorAPI.js`, `line 13848`

multiTapInterval :number
`IncisorAPI.js`, `line 14067`

particleSystemDefinitions :ParticleSystemDefinitions
`IncisorAPI.js`, `line 14022`

paths :Paths
`IncisorAPI.js`, `line 13884`

pauseEvents :PauseEvents
`IncisorAPI.js`, `line 13930`

pixelsObjects :PixelsObjects
`IncisorAPI.js`, `line 14116`

precomps
`IncisorAPI.js`, `line 14224`

projectConfiguration :ProjectConfiguration
`IncisorAPI.js`, `line 13913`

readonly projectName :string
`IncisorAPI.js`, `line 13793`

publishing :Publishing
`IncisorAPI.js`, `line 14216`

renderTargets :RenderTargets
`IncisorAPI.js`, `line 14254`

scenes :Scenes
`IncisorAPI.js`, `line 14130`

singularFocusButtonPressRequirements :Array.<Button>
`IncisorAPI.js`, `line 14007`

singularFocusObject :SceneObject
`IncisorAPI.js`, `line 13995`

softwareSpeed :number
`IncisorAPI.js`, `line 13987`

sounds :Sounds
`IncisorAPI.js`, `line 13809`

specialSubstitutionCharacter :string
`IncisorAPI.js`, `line 14350`

speedControls :SpeedControls
`IncisorAPI.js`, `line 13938`

targetFixedUpdateRate :number
`IncisorAPI.js`, `line 13972`

targetScreenUpdateRate :number
`IncisorAPI.js`, `line 13979`

textures :Textures
`IncisorAPI.js`, `line 13838`

timeStamp :TimeStamp
`IncisorAPI.js`, `line 14160`

tweenTypes :TweenTypes
`IncisorAPI.js`, `line 14321`

uiStyle :UiStyle
`IncisorAPI.js`, `line 13826`

uiZoom :UiZoom
`IncisorAPI.js`, `line 13867`

urlParameterIterator :UrlParameterIterator
`IncisorAPI.js`, `line 14196`

readonly visualFocusObject :UiVisualFocus
`IncisorAPI.js`, `line 14046`

volumeControls :VolumeControls
`IncisorAPI.js`, `line 13816`

addButton(graphicAsset (opt), parent (opt), name (opt)) returns {Button}
`IncisorAPI.js`, `line 14935`

addGraphicObject(graphicAsset (opt), parent (opt), name (opt)) returns {GraphicObject}
`IncisorAPI.js`, `line 14967`

addLayoutStack(parent (opt), name (opt)) returns {LayoutStack}
`IncisorAPI.js`, `line 14780`

addLayoutStack(parent (opt), name (opt)) returns {LayoutStack}
`IncisorAPI.js`, `line 15295`

addMotion(propertyOwners, propertyNames, lowerBounds, upperBounds, motionSpeed (opt), motionType (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Motion}
`IncisorAPI.js`, `line 14512`

addOrthographicCamera(parent (opt), name (opt)) returns {OrthographicCamera}
`IncisorAPI.js`, `line 15014`

addParticleSystem(particleSystemDefinition (opt), parent (opt), name (opt), pauseImmunity (opt), speedControl (opt)) returns {ParticleSystem}
`IncisorAPI.js`, `line 14809`

addSceneObject(parent (opt), name (opt)) returns {SceneObject}
`IncisorAPI.js`, `line 14886`

addTextAssembly(parent (opt), name (opt)) returns {TextAssembly}
`IncisorAPI.js`, `line 14588`

addTextBox(parent (opt), name (opt)) returns {TextBox}
`IncisorAPI.js`, `line 15519`

addTierLoadedCallback(tiers, callbackOwner, callbackName, callbackArgs (opt), callbackOrder (opt))
`IncisorAPI.js`, `line 15032`

assessCumulativeLoadingTierRequirements(sceneObject, ignoreCachedAssessment (opt)) returns {Array.<number>}
`IncisorAPI.js`, `line 14894`

async awaitLoadedTiers(tiers)
`IncisorAPI.js`, `line 15039`

copyToClipboard(text)
`IncisorAPI.js`, `line 14742`

defineAppEvent(eventName) returns {AppEvent}
`IncisorAPI.js`, `line 14647`

defineAppEventWithFocus(eventName) returns {AppEventWithFocus}
`IncisorAPI.js`, `line 14658`

defineConstruct(name, blueprint (opt)) returns {ConstructDefinition}
`IncisorAPI.js`, `line 15096`

defineEffectController(name, baseType, componentNames, defaultValues, mixMode, likelyRanges (opt), effectControllerDescription (opt), componentDescriptions (opt))
`IncisorAPI.js`, `line 14609`

defineGeometry(name, createBox) returns {GeometryEditor}
`IncisorAPI.js`, `line 15486`

defineGraphicAssetFromPixelsObject(name, pixelsObject, includeNormals (opt)) returns {GraphicAsset}
`IncisorAPI.js`, `line 15235`

defineGraphicAssetFromRenderTarget(name, renderTarget, disconnectFromRenderTarget (opt), includeNormals (opt)) returns {GraphicAsset}
`IncisorAPI.js`, `line 15248`

defineLayer(name, scene (opt), placeBehindThisLayer (opt))
`IncisorAPI.js`, `line 15063`

defineMask(maskName) returns {Mask}
`IncisorAPI.js`, `line 14997`

defineMotionType(name, motionFunction, motionControllerNames (opt), motionControllerDefaultValues (opt), description (opt), controllerDescriptions (opt)) returns {MotionType}
`IncisorAPI.js`, `line 14488`

defineParticleSystem(name) returns {ParticleSystemDefinition}
`IncisorAPI.js`, `line 14790`

definePauseEvent(pauseEventName) returns {PauseEvent}
`IncisorAPI.js`, `line 14668`

defineSpeedControl(speedControlName) returns {SpeedControl}
`IncisorAPI.js`, `line 14725`