// Objective: Create a TextAssembly.
// Expected Result: You will see the words "Build It Once." on the screen.

// Create a TextAssembly
this.textAssembly = new TextAssembly();
this.textAssembly.string = "Build It Once.";

MEMBERS

baselinePosition :number

IncisorAPI.js, line 2058

Number representing the vertical placement of the baseline within each line of text in this TextAssembly. A value of 0 corresponds to the baseline of the text being positioned at the very bottom of each line, and a value of .5 corresponds to the baseline of the text being positioned in the middle of each line.

Default Value:

• .22

boxHeight :number

IncisorAPI.js, line 1989

The maximum height that the laid out text will adhere to if 'scaleToFit' is true. When greater than 0, this value also determines the positioning of top-justified or bottom-justified text. A value of 0 corresponds to no limits on the height of the text.

Default Value:

• 0

boxWidth :number

IncisorAPI.js, line 1980

The maximum width that the laid out text will adhere to if 'wrapToFit' or 'scaleToFit' are true. When greater than 0, this value also determines the positioning of left or right justified text. A value of 0 corresponds to no limits on the width of the text.

Default Value:

• 0

horizontalJustification :string

IncisorAPI.js, line 2014

The horizontalJustification of this TextAssembly. For acceptable values, see 'nc.constants.justfications'. Setting this value will change the horizontal justification for all of the text in this TextAssembly, but the value can be set for individual sections of the text using 'TextAssembly.setHorizontalJustification'.

Default Value:

• "left"

inheritedTypes :object

IncisorAPI.js, line 1964

Dictionary object listing all of the types this object is compatible with.

Inherited From:

• SceneObject.inheritedTypes()

layoutLazyUpdater :LazyUpdater

IncisorAPI.js, line 2077

The LazyUpdater ultimately responsible for initiating the layout of the text. The setting of 'needsUpdate' and the calling of 'updateIfNeeded' is magaged as much as is possible internally by Incisor®, but if the need to force an update arises, set 'needsUpdate' to true, and call 'updateIfNeeded'.

scaleToFit :boolean

IncisorAPI.js, line 2004

Bool determining if the text will automatically be scaled down to fit within the boxWidth and/or boxHeight.

Default Value:

• true

readonly scaleToFitFactor :number

IncisorAPI.js, line 2049

For Texts or Textboxes with 'scaleToFit' set to true, this number denotes the multiplier that was applied in order for the given text to fit within the boxWidth, and boxHeight.

showWhiteSpace :boolean

IncisorAPI.js, line 2084

Boolean indicating if whitespace characters will be visible in this TextAssembly.

Default Value:

• false

string :string

IncisorAPI.js, line 1971

The string value of the text to be displayed by this TextAssembly.

Default Value:

• ""

textFormat :TextFormat

IncisorAPI.js, line 2069

Object housing information about the customization of the characters within this TextAssembly. This includes font, scale, baseline shift, kerning, line height, as well as information about EffectNodes and EffectController values used on the characters. Setting or adjusting this value will set the TextFormat for all of the characters in this TextAssembly. See 'TextAssembly.setTextFormat' to set the TextFormat for individual sections of this TextAssembly.

Default Value:

• new TextFormat()

readonly textHeight :number

IncisorAPI.js, line 2041

The read-only height of the text (once laid out). This number encapsulates the final height of the laid out text, including all of the TextFormats, the boxWidth and boxHeight, scaleToFit, wrapToFit etc...

readonly textWidth :number

IncisorAPI.js, line 2032

The read-only width of the text (once laid out). This number encapsulates the final width of the laid out text, including all of the TextFormats, the boxWidth and boxHeight, scaleToFit, wrapToFit etc...

type :string

IncisorAPI.js, line 1958

Type identifier.

Inherited From:

• SceneObject.type()

verticalJustification :string

IncisorAPI.js, line 2023

The verticalJustification of this TextAssembly. For acceptable values, see 'nc.constants.justfications'. Setting this value will change the vertical justification for all of the text in this TextAssembly.

Default Value:

• "top"

wrapToFit :boolean

IncisorAPI.js, line 1997

Bool determining if text will automatically flow onto new lines in order to fit the text within the designated 'boxWidth' value.

Default Value:

• true

Members below are inherited from the parent class.

children :Array.<SceneObject>

IncisorAPI.js, line 5059

The the array of this SceneObject's children SceneObjects in the hierarchy.

Inherited From:

• SceneObject.children()

Example:

// Objective: Add children to a SceneObject.
// Expected Result: The console log should read "children count 2".

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
let mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );
// Add 2 GraphicObjects to the SceneObject using the GraphicObject constructor.
new GraphicObject( nc.graphicAssets.WhiteBox, this.mySceneObject, "WhiteBox" );
new GraphicObject( nc.graphicAssets.WhiteTriangle, this.mySceneObject, "WhiteTriangle" );
console.log("children count", mySceneObject.children.length); 

colorMultiply :Color

IncisorAPI.js, line 5301

The EffectController for the 'ColorMultiply' EffectNode, which multiplies the red, green, blue, and alpha color values of the Material it is applied to.

Inherited From:

• SceneObject.colorMultiply()

readonly containingScene :Scene

IncisorAPI.js, line 5099

The Scene in which this SceneObject resides.

Inherited From:

• SceneObject.containingScene()

Example:

// Objective: Determine the containing scene of a SceneObject.
// Expected Result: The console should have 2 log messages as follows:
//    The containing scene for 'MyMainSceneObject' is MainScene
//    The containing scene for 'MyOtherSceneObject' is MyScene

// Create a SceneObject using the SceneObject constructor. This will add "MyMainSceneObject" to the main scene.
let mySceneObject = new SceneObject( nc.mainScene, "MyMainSceneObject" );
console.log("The containing scene for 'MyMainSceneObject' is", mySceneObject.containingScene.name);

// Create a new Scene and name it "MyScene".
let myScene = new Scene("MyScene");
// Create a SceneObject using the SceneObject constructor. This will add "MyOtherSceneObject" to myScene ("MyScene").
let myOtherSceneObject = new SceneObject( myScene, "MyOtherSceneObject" );
console.log("The containing scene for 'MyOtherSceneObject' is", myOtherSceneObject.containingScene.name);

enabled :boolean

IncisorAPI.js, line 5043

Boolean determining if this SceneObject is enabled. Enabled SceneObjects are shown normally within the Scene while disabled SceneObjects are not shown. If a SceneObject is disabled, all of its children inherit its disabled state, but if it is enabled all of its childrens' states depend on their own 'enabled' properties.

Inherited From:

• SceneObject.enabled()

Default Value:

• true

Example:

// Objective: Disable a SceneObject to disable its children.
// Expected Result: You do not see the white box.

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
let mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );
// Add a GraphicObject to the SceneObject using the GraphicObject constructor.
new GraphicObject( nc.graphicAssets.WhiteBox, mySceneObject, "WhiteBox" );
// Set mySceneObject to enabled = false.
mySceneObject.enabled = false;

fillColor :Color

IncisorAPI.js, line 5297

The EffectController for the 'FillColor' EffectNode, which entirely fills the associated Geometry with the red, green, blue, and alpha color values provided.

Inherited From:

• SceneObject.fillColor()

focusFallback :SceneObject

IncisorAPI.js, line 5291

Sets up a 'focus fallback' for this SceneObject. Once set, if 'nc.relinquishFocus' is called while this SceneObject is focused, then the fallback object will automatically become the new focused object.

Inherited From:

• SceneObject.focusFallback()

Default Value:

• nc.defaultFocusFallback

readonly hierarchyDepth :number

IncisorAPI.js, line 5209

Number indicating how many ancesters this SceneObject has.

Inherited From:

• SceneObject.hierarchyDepth()

Example:

// Objective: Retrieve the hierarchy depth of a SceneObject.
// Expected Result: The console log should read "myGraphicObject2 hierarchy depth is 3".

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
let mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject1" to the SceneObject.
let myGraphicObject1 = new GraphicObject( nc.graphicAssets.WhiteBox, mySceneObject, "GraphicObject1" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject2" to the GraphicObject myGraphicObject1 (GraphicObject1). 
let myGraphicObject2 = new GraphicObject( nc.graphicAssets.WhiteTriangle, myGraphicObject1, "GraphicObject2" );
// Console log the hierarchy depth of myGraphicObject2 ("GraphicObject2").
console.log("myGraphicObject2 hierarchy depth is", myGraphicObject2.hierarchyDepth);

readonly isEnabledWithInheritance :boolean

IncisorAPI.js, line 5190

Boolean that reflects if the overall state of this SceneObject is 'enabled', incorporating the state of its anscesters.

Inherited From:

• SceneObject.isEnabledWithInheritance()

Example:

// Objective: Use isEnabledWithInheritance to determine the enabled value at various levels of the heirarchy.
// Expected Result: The console should have 2 log messages as follows:
//   Top level scene object, enabled is true
//   Bottom level scene object, enabled is false

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
let mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject1" to the SceneObject.
let myGraphicObject1 = new GraphicObject( nc.graphicAssets.WhiteBox, mySceneObject, "GraphicObject1" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject2" to the GraphicObject myGraphicObject1 (GraphicObject1). 
let myGraphicObject2 = new GraphicObject( nc.graphicAssets.WhiteTriangle, myGraphicObject1, "GraphicObject2" );

// Set myGraphicObject1 to enabled = false. ("GraphicObject1").
myGraphicObject1.enabled = false;
// Console log the isEnabledWithInheritance value of the top level SceneObject ("MySceneObject").
console.log("Top level scene object, enabled is", mySceneObject.isEnabledWithInheritance); // true
// Console log the isEnabledWithInheritance value of the bottom level SceneObject ("GraphicObject2").
console.log("Bottom level scene object, enabled is", myGraphicObject2.isEnabledWithInheritance); // false

layoutObject :LayoutObject

IncisorAPI.js, line 5238

Object housing information about this particular SceneObject's LayoutObject functionality. LayoutObject functionality applies to SceneObjects that have been added as elements to a LayoutStack, which is responsible for organizing visual content (TextBoxes, Graphics, Buttons, etc...) into dynamic vertical or horizontal stacks. Until a SceneObject has been configured with LayoutObject functionality (either by calling 'SceneObject.configureLayoutObject' or by adding the SceneObject as an element to a LayoutStack), the 'SceneObject.layoutObject' member will be undefined. [NON-INSTANTIABLE]

Inherited From:

• SceneObject.layoutObject()

Example:

// Objective: Configure a layout object.
// Expected Result: The console should read "layout object width and height after configuration: 20 10".

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
this.mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );

// Add a callback function.
this.myCallback = function(args) {
    // return a Vector2 with a width of 20 and a height of 10
    return new Vector2( 20, 10 ); 
}

// Add a reference to a callback function passing the owner of the function and the function name.
this.mySceneObject.configureLayoutObject( this, "myCallback" );
console.log('layout object width and height after configuration:', this.mySceneObject.layoutObject.width, this.mySceneObject.layoutObject.height);

name :string

IncisorAPI.js, line 5023

The name of the SceneObject.

Inherited From:

• SceneObject.name()

Default Value:

• 'SceneObject'

Example:

// Objective: Set and Get the name of a SceneObject.
// Expected Result: The console should have 2 log messages as follows:
//    original name is MySceneObject
//    new name is MyDifferentSceneObject
 
// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
let mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );
console.log("original name is", mySceneObject.name );
// Update the name of the SceneObject.
mySceneObject.name = "MyDifferentSceneObject";
console.log("new name is", mySceneObject.name );

parent :SceneObject

IncisorAPI.js, line 5077

The SceneObject that is this SceneObject's parent in the hierarcy. If this SceneObject is of type 'Scene', this value is left undefined. Set this property to change the parent of this SceneObject, or use 'SceneObject.setParent' to do the same thing but with the 'maintainGlobalPostion' optional parameter.

Inherited From:

• SceneObject.parent()

Example:

// Objective: Get the parent of a scene object.
// Expected Result: The console log should read "parent name is MySceneObject".

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
let mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );
// Add a GraphicObject to the SceneObject using the GraphicObject constructor.
let myGraphicObject = new GraphicObject( nc.graphicAssets.WhiteBox, this.mySceneObject, "WhiteBox" );
// Console log the parent name of this GraphicObject.
console.log("parent name is", myGraphicObject.parent.name);

position :Vector3

IncisorAPI.js, line 5119

The position of this SceneObject relative to it's parent.

Inherited From:

• SceneObject.position()

Default Value:

• new Vector3(0,0,0)

Example:

// Objective: Move the position of the "WhiteTriangle" relative to the "WhiteBox".
// Expected Result: The "WhiteTriangle" is 300 world units above and 300 world units to the right of the "WhiteBox".

// Note: To use a custom graphic, add your image file to the assets directory and access it using nc.graphicAssets['MyImage']

// Add a GraphicObject to the main scene using the GraphicObject constructor.
new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "WhiteBox" );
// Add another GraphicObject to the main scene using the GraphicObject constructor, this time using the WhiteTriangle GraphicAsset.
let whiteTriangleGraphicObject =  new GraphicObject( nc.graphicAssets.WhiteTriangle, nc.mainScene, "WhiteTriangle" );
// Update the position of the "WhiteTriangle", moving it 300 world units above and 300 world units to the right of the "WhiteBox".
whiteTriangleGraphicObject.position.x = 300;
whiteTriangleGraphicObject.position.y = 300;

rotation :Vector3

IncisorAPI.js, line 5164

The rotation (in degrees) of this SceneObject relative to it's parent. Positive values correspond to counter-clockwise rotation around the given axis.

Inherited From:

• SceneObject.rotation()

Default Value:

• new Vector3(0,0,0)

Example:

// Objective: Create 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 = new SceneObject( 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;

scale :Vector3

IncisorAPI.js, line 5146

The scale of this SceneObject relative to it's parent.

Inherited From:

• SceneObject.scale()

Default Value:

• new Vector3(1,1,1)

Example:

// Objective: Using the scale property, increase the size of a GraphicObject.
// Expected Result: You will see a blue box in the center of the screen and a larger red box, now in the shape of a rectangle, to the right of it.

// Note: To use a custom graphic, add your image file to the assets directory and access it using nc.graphicAssets['MyImage']

// Add a GraphicObject to the main scene using the GraphicObject constructor. 
let blueBox = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "BlueBox" );
// Use fillColor to make it blue.
blueBox.fillColor = new Color( 0, 0, 1, 1 ); // blue

// Add another GraphicObject to the main scene using the GraphicObject constructor.
let redBox = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "RedBox" );
// Use fillColor to make it red.
redBox.fillColor = new Color( 1, 0, 0, 1 ); // red
// Use position to move the red box to the right 500 world units.
redBox.position.x = 500;
// Use scale to make the red box a larger rectangle 
redBox.scale.x = 2;
redBox.scale.y = 4;

shapify :shapify

IncisorAPI.js, line 5307

The EffectController for the 'Shapify' EffectNode. The Shapify EffectNode converts edge data stored in a 'shapified' Texture into a presentable image with edges that stay sharp regardless of the scale of the associated GraphicObject. This is an instance of a dynamically defined EffectController with base type 'Vector2'. To get a new instance, use 'nc.effectControllers['shapify'].new'shapify()'.

Inherited From:

• SceneObject.shapify()

snapToNearestWorldPosition :boolean

IncisorAPI.js, line 5283

Flag that determines if this SceneObject's global position is always snapped to the nearest integer (for x and y only). This property is mainly used to help provide pixel-perfect rendering for TextBoxes, see 'TextBox.useNearestPixelRendering' for more information.

Inherited From:

• SceneObject.snapToNearestWorldPosition()

Default Value:

• false

uiKeyboardNavigable :UiKeyboardNavigable

IncisorAPI.js, line 5263

Object housing functionality that enables for this SceneObject to be accessible via keyboard navigation. Keyboard navigation enables the end-user to press the arrow keys, tab, space, and enter keys to outline and trigger any 'uiKeyboardNavigable' SceneObjects within a UiKeyboardNavigator-enabled parent that is currently 'in focus' according to 'nc.singularFocusObject'. This property defaults to undefined, but can be enabled, by calling 'SceneObject.configureUiKeyboardNavigable()'. [NON-INSTANTIABLE] [REQUIREMENT: optional code module - 'extendedUi']

Inherited From:

• SceneObject.uiKeyboardNavigable()

uiKeyboardNavigator :UiKeyboardNavigator

IncisorAPI.js, line 5250

Object housing functionality that enables for keyboard navigation of this SceneObject's ui-related descendants. Keyboard navigation enables the end-user to press the tab, space, and enter keys to outline and trigger any 'uiKeyboardNavigable' descendants of the SceneObject owning this UiKeyboardNavigator when it is 'in focus' according to 'nc.singularFocusObject'. This property defaults to undefined, but can be enabled, by calling 'SceneObject.configureUiKeyboardNavigator()'. [NON-INSTANTIABLE] [REQUIREMENT: optional code module - 'extendedUi']

Inherited From:

• SceneObject.uiKeyboardNavigator()

uiVisualFocus :UiVisualFocus

IncisorAPI.js, line 5275

Object housing functionality that enables for the SceneObject owning it to be 'visually focused', which 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'. Calling 'configureUiVisualFocus' populates the 'uiVisualFocus' member for the owning SceneObject. It should be noted that the dimmer layer that the newly focused item is placed in front of is actually a button which, when pressed, calls the 'attemptExitUiVisualFocus' member of the current singularFocusObject if that member is defined. [NON-INSTANTIABLE] [REQUIREMENT: optional code module - 'extendedUi']

Inherited From:

• SceneObject.uiVisualFocus()

METHODS

addStringUpdateCallback(callbackOwner, callbackName, callbackArgs (opt))

IncisorAPI.js, line 2143

Adds a callback that occurs whenever this TextBox string changed. The updated string is sent to the callback as its first parameter.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback function that occurs whenever this TextBox string changed.
callbackName	string			The name of the callback function that occurs whenever this TextBox string changed.
callbackArgs	Array | any	<optional>		Args for the callback function that occurs whenever this TextBox string changed.

clearPools()

IncisorAPI.js, line 2134

Several object-pooling techniques are used internally within the TextAssembly and TextBox objects. Displaying/rendering text with large numbers of characters can leave a significant memory-footprint in these pools. This memory can be freed by calling this method - though the call itself may result in a one-time performance hit if large strings have been displayed/rendered previously.

delete(startIndex, count)

IncisorAPI.js, line 2126

Deletes the given range of characters.

Parameters:

Name	Type	Attributes	Default	Description
startIndex	number			The index of the first character to delete.
count	number			The number of characters to delete.

insert(startIndex, stringToInsert)

IncisorAPI.js, line 2119

Inserts the given string at the given index.

Parameters:

Name	Type	Attributes	Default	Description
startIndex	number			The index that the first character of the inserted string.
stringToInsert	string			The string to insert.

removeStringUpdateCallback(callbackOwner, callbackName)

IncisorAPI.js, line 2150

Removes the given stringUpdate callback.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback to be removed.
callbackName	string			The name of the callback to be removed.

setHorizontalJustification(justification, startIdx (opt), numChars (opt))

IncisorAPI.js, line 2112

Sets the horizontal justification of the given range of characters. It should be noted that when characters are laid out into multiple lines, the horizontal justification for a given line is determined by the horizontal horizontalJustification value associated with the first character on that line.

Parameters:

Name	Type	Attributes	Default	Description
justification	string			The horizontal justification that the specified characters will adopt. See 'nc.constants.justifications' for justification values.
startIdx	number	<optional>		The index of the first character in the segment affected by this change. If left undefined, the given horizontalJustification will be applied to all characters.
numChars	number	<optional>		The length of the segment affected by this change. [DEFAULT: infinity]

setSubstitutionCharacter(characterToSubstitute, graphicAsset (opt), textFormat (opt))

IncisorAPI.js, line 2094

Method used to swap all instances of the given character with a designated GraphicAsset. A TextFormat can also be supplied to help position and format the substituted GraphicAsset within the text.

Parameters:

Name	Type	Attributes	Default	Description
characterToSubstitute	string			The the character that will be replaced with the designated GraphicAsset.
graphicAsset	GraphicAsset	<optional>		The GraphicAsset that will substitute for the given characters. When this parameter is undefined, any previously defined substitution using the provided character will be disposed. The formats for previously substituted characters will need to be dealt with separately.
textFormat	TextFormat	<optional>		Optional TextFromat to apply to the substituted GraphicAsset, which can be used to adjust its positioning and formating.

setTextFormat(textFormat, startIdx (opt), numChars (opt))

IncisorAPI.js, line 2102

Sets the text format of the designated portion of text within a TextAssembly.

Parameters:

Name	Type	Attributes	Default	Description
textFormat	TextFormat			The TextFormat that the specified characters will adopt.
startIdx	number	<optional>		The index of the first character in the segment affected by this change. If left undefined, the given textFormat will be applied to all characters.
numChars	number	<optional>		The length of the segment affected by this change. [DEFAULT: infinity]

Methods below are inherited from the parent class.

addDisposalCallback(callbackOwner, callbackName, callbackArgs (opt))

IncisorAPI.js, line 5472

Adds a callback function to the list of callbacks that occur when this SceneObject is disposed.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback function that is called when this SceneObject is disposed.
callbackName	string			The name of the function that is called when this SceneObject is disposed.
callbackArgs	Array | any	<optional>		Arguments for the function that is called when this SceneObject is disposed.

Inherited From:

• SceneObject.addDisposalCallback()

Example:

// Objective: Add a 'Disposal' callback.
// Expected Result: The console should read "disposal callback: myDisposalData".

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
this.mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );

// Add a callback function.
this.myCallback = function(args) {
   console.log('disposal callback:', args);
}

// Add a reference to a callback function passing the owner of the function, the function name, and any additional data we want.
this.mySceneObject.addDisposalCallback( this, "myCallback", ["myDisposalData"] );
// Call dispose() on mySceneObject. This will fire a disposal callback.
this.mySceneObject.dispose();

addEffectNodes(effectNodes, alsoAddToDescendants (opt))

IncisorAPI.js, line 5691

Adds the given EffectNodes to the Materials associated with this SceneObject. 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	Default	Description
effectNodes	Array.<EffectNode> | EffectNode			The EffectNodes to add to this SceneObject and its Materials.
alsoAddToDescendants	boolean	<optional>	true	Boolean determining if the given EffectNodes will also be added to the SceneObject's descendants' Materials. [DEFAULT: true]

Inherited From:

• SceneObject.addEffectNodes()

addEnabledStateChangeCallback(callbackOwner, callbackName, callbackArgs (opt))

IncisorAPI.js, line 5384

Adds a callback function to the list of callbacks that occur whenever the state of this SceneObject's 'enabled' property changes. The true/false enabled state is sent to the callback as its first paremeter, followed by any 'callbackArgs' provided.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback function that is called when this SceneObject's enabled state changes.
callbackName	string			The name of the function that is called when this SceneObject's enabled state changes.
callbackArgs	Array | any	<optional>		Arguments for the function that is called when this SceneObject's enabled state changes.

Inherited From:

• SceneObject.addEnabledStateChangeCallback()

Example:

// Objective: Add an 'Enabled State Change' callback.
// Expected Result: The console should have 2 log messages as follows:
//    enabled state is false
//    enabled state is true

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
this.mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );

// Add a callback function.
this.myCallback = function(args) {
   console.log('enabled state is', args);
}

// Add a reference to a callback function passing the owner of the function and the function name.
this.mySceneObject.addEnabledStateChangeCallback( this, "myCallback" );
// Set mySceneObject to enabled = false. This will fire an enabled state change callback.
this.mySceneObject.enabled = false;
// Set mySceneObject to enabled = true. This will fire an enabled state change callback.
this.mySceneObject.enabled = true;

configureLayoutObject(refreshLayoutCallbackOwner, refreshLayoutCallbackName, refreshLayoutCallbackArgs)

IncisorAPI.js, line 5773

Function to configure the SceneObject with LayoutObject functionality, which prepares it to be added as an element to a LayoutStack. Once configured, the configuration information can be found (and adjusted if necessary) in the SceneObject.layoutObject. Most SceneObject-inheriting objects have standard LayoutObject functionality that is automatically configured when they are added as elements to a LayoutStack, so this method is mainly for creating custom LayoutObject functionality. Configuration consists of supplying a callback to a user-defined function that refreshes the layout of the SceneObject in question and returns a Vector2 containing the resulting dimensions.

Parameters:

Name	Type	Attributes	Default	Description
refreshLayoutCallbackOwner	object			The object owning the callback function that is called by the LayoutStack containing this LayoutObject when the layout is refreshed.
refreshLayoutCallbackName	string			The name of the callback function that is called by the LayoutStack containing this LayoutObject when the layout is refreshed.
refreshLayoutCallbackArgs	Array | any			Arguments for the callback function that is called by the LayoutStack containing this LayoutObject when the layout is refreshed.

Inherited From:

• SceneObject.configureLayoutObject()

Example:

// Objective: Configure a layout object.
// Expected Result: The console should read "layout object width and height after configuration: 20 10".

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
this.mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );

// Add a callback function.
this.myCallback = function(args) {
    // return a Vector2 with a width of 20 and a height of 10
    return new Vector2( 20, 10 ); 
}

// Add a reference to a callback function passing the owner of the function and the function name.
this.mySceneObject.configureLayoutObject( this, "myCallback" );
console.log('layout object width and height after configuration:', this.mySceneObject.layoutObject.width, this.mySceneObject.layoutObject.height);

configureUiKeyboardNavigable(setOutlineCallbackOwner, setOutlineCallbackName, triggerCallbackOwner, triggerCallbackName)

IncisorAPI.js, line 5792

Function to configure the SceneObject with UiKeyboardNavigable functionality, which enables the end-user access the SceneObject using keyboard navigation.
Calling 'configureUiKeyboardNavigable' populates the 'uiKeyboardNavigable' member for the owning SceneObject.

Parameters:

Name	Type	Attributes	Default	Description
setOutlineCallbackOwner	object			The owner of the callback that occurs whenever keyboard navigation changes the 'outline' state of the UiKeyboardNavigable object. The outline state will be sent to the callback as its first parameter.
setOutlineCallbackName	string			The name of the callback that occurs whenever keyboard navigation changes the 'outline' state of the UiKeyboardNavigable object. The outline state will be sent to the callback as its first parameter.
triggerCallbackOwner	object			The owner of the callback that occurs whenever keyboard navigation triggers the UiKeyboardNavigable object via the spacebar or enter keys.
triggerCallbackName	string			The name of the callback that occurs whenever keyboard navigation triggers the UiKeyboardNavigable object via the spacebar or enter keys

Inherited From:

• SceneObject.configureUiKeyboardNavigable()

configureUiKeyboardNavigator()

IncisorAPI.js, line 5781

Function to configure the SceneObject with UiKeyboardNavigator functionality, which enables the end-user to press the tab, space, and enter keys to outline and trigger any 'uiKeyboardNavigable' descendants of the SceneObject owning this UiKeyboardNavigator when it is 'in focus' according to 'nc.singularFocusObject'. Calling 'configureUiKeyboardNavigator' populates the 'uiKeyboardNavigator' member for the owning SceneObject.

Inherited From:

• SceneObject.configureUiKeyboardNavigator()

configureUiVisualFocus()

IncisorAPI.js, line 5801

Function to configure the SceneObject with UiVisualFocus functionality, which focuses the end-user's attention on the given SceneObject by placing it in front of a dimmer layer whenever the object is the the current 'singularFocusObject'. Calling 'configureUiVisualFocus' populates the 'uiVisualFocus' member for the owning SceneObject. It should be noted that the dimmer layer that the newly focused item is placed in front of is actually a button which, when pressed, calls the 'attemptExitUiVisualFocus' member of the current singularFocusObject if that member is defined.

Inherited From:

• SceneObject.configureUiVisualFocus()

disable()

IncisorAPI.js, line 5355

Sets this SceneObject's 'enabled' value to false.

Inherited From:

• SceneObject.disable()

Example:

// Objective: Call disable() on a previously enabled SceneObject.
// Expected Result: The console should read "enabled state is false".

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
this.mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );

// Add a callback function.
this.myCallback = function(args) {
    console.log('enabled state is', args);
}

// Add a reference to a callback function passing the owner of the function and the function name.
this.mySceneObject.addEnabledStateChangeCallback( this, "myCallback" );
// By default, the SceneObject is already enabled. Call disable() on mySceneObject. This will fire an enabled state change callback.
this.mySceneObject.disable();

dispose()

IncisorAPI.js, line 5448

Removes this SceneObject and its descendants from the hierarchy, and removes internal Incisor® references to aid memory management.

Inherited From:

• SceneObject.dispose()

Example:

// Objective: Call dispose() on a SceneObject.
// Expected Result: The console should have 2 log messages as follows:
//    descendants before disposal 3
//    after wait descendants after disposal 1 

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
let mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject1" to the SceneObject.
let myGraphicObject1 = new GraphicObject( nc.graphicAssets.WhiteBox, mySceneObject, "GraphicObject1" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject2" to myGraphicObject1.
let myGraphicObject2 = new GraphicObject( nc.graphicAssets.WhiteTriangle, myGraphicObject1, "GraphicObject2" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject3" to myGraphicObject2.
let myGraphicObject3 = new GraphicObject( nc.graphicAssets.WhiteTriangle, myGraphicObject2, "GraphicObject3" );

// Log the number of descendants of mySceneObject before calling dispose().
console.log( "descendants before disposal", mySceneObject.getDescendants().length );
// Call dispose() on myGraphicObject2.
myGraphicObject2.dispose();

// The call to dispose() can take some time to complete so lets wait 2 seconds before we log again.

// Create a callback function to log the descendants after calling dispose().
this.myWait = function() {
    console.log( "after wait descendants after disposal", mySceneObject.getDescendants().length );
}
// Using nc.WaitThen, wait 2 seconds before attempting to log the descendants again.
nc.waitThen( 2, this, "myWait" );

enable()

IncisorAPI.js, line 5334

Sets this SceneObject's 'enabled' value to true.

Inherited From:

• SceneObject.enable()

Example:

// Objective: Call enable() on a previously disabled SceneObject.
// Expected Result: The console should have 2 log messages as follows:
//    enabled state is false
//    enabled state is true

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
this.mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );

// Add a callback function.
this.myCallback = function(args) {
    console.log('enabled state is', args);
}

// Add a reference to a callback function passing the owner of the function and the function name.
this.mySceneObject.addEnabledStateChangeCallback( this, "myCallback" );
// Set the enabled state of mySceneObject to false.
this.mySceneObject.enabled = false;
// Call enable() on mySceneObject. This will fire an enabled state change callback.
this.mySceneObject.enable();

getAncestors() returns {Array.<SceneObject>}

IncisorAPI.js, line 5527

Returns a list of this SceneObject's ancesters.

Returns:

Array.<SceneObject>

Inherited From:

• SceneObject.getAncestors()

Example:

// Objective: Get the ancestors of a SceneObject.
// Expected Result: The console should have 2 log messages as follows:
//    myGraphicObject3 ancestors count 4
//    myGraphicObject1 ancestors count 2

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
let mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject1" to the SceneObject.
let myGraphicObject1 = new GraphicObject( nc.graphicAssets.WhiteBox, mySceneObject, "GraphicObject1" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject2" to the GraphicObject myGraphicObject1 (GraphicObject1). 
let myGraphicObject2 = new GraphicObject( nc.graphicAssets.WhiteTriangle, myGraphicObject1, "GraphicObject2" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject3" to the GraphicObject myGraphicObject2 (GraphicObject2). 
let myGraphicObject3 = new GraphicObject( nc.graphicAssets.WhiteTriangle, myGraphicObject2, "GraphicObject3" );
// Console log the ancestors count.
console.log( "myGraphicObject3 ancestors count", myGraphicObject3.getAncestors().length );
console.log( "myGraphicObject1 ancestors count", myGraphicObject1.getAncestors().length );

getDescendants(enabledOnly, includeEnclosedScenes) returns {Array.<SceneObject>}

IncisorAPI.js, line 5552

Returns a list of this SceneObject's descendants.

Parameters:

Name	Type	Attributes	Default	Description
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>

Inherited From:

• SceneObject.getDescendants()

Example:

// Objective: Get the descendants of a SceneObject.
// Expected Result: The console should have 2 log messages as follows:
//    myGraphicObject3 descendants count 0
//    myGraphicObject1 descendants count 2

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
let mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject1" to the SceneObject.
let myGraphicObject1 = new GraphicObject( nc.graphicAssets.WhiteBox, mySceneObject, "GraphicObject1" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject2" to the GraphicObject myGraphicObject1 (GraphicObject1). 
let myGraphicObject2 = new GraphicObject( nc.graphicAssets.WhiteTriangle, myGraphicObject1, "GraphicObject2" );
// Using the GraphicObject constructor, add a GraphicObject named "GraphicObject3" to the GraphicObject myGraphicObject2 (GraphicObject2). 
let myGraphicObject3 = new GraphicObject( nc.graphicAssets.WhiteTriangle, myGraphicObject2, "GraphicObject3" );
// Console log the descendants count.
console.log( "myGraphicObject3 descendants count", myGraphicObject3.getDescendants().length );
console.log( "myGraphicObject1 descendants count", myGraphicObject1.getDescendants().length );

getGlobalPosition(returnVector3 (opt)) returns {Vector3}

IncisorAPI.js, line 5577

Returns a Vector3 with the global position of this SceneObject within the Scene.

Parameters:

Name	Type	Attributes	Default	Description
returnVector3	Vector3	<optional>		Optional Vector3 that can be supplied to avoid the generation of a new Vector3 object for efficiency.

Returns:

Vector3

Inherited From:

• SceneObject.getGlobalPosition()

Example:

// Objective: Get the global position of a SceneObject.
// Expected Result: 'InnerSceneObject' global position x,y 200 200

// Create a new Scene and name it "MyScene".
let myScene = new Scene("MyScene");
// Create a SceneObject using the SceneObject constructor. This will add "OuterSceneObject" to "MyScene".
let outerSceneObject = new SceneObject( myScene, "OuterSceneObject" );
// Create a SceneObject using the SceneObject constructor. This will add "InnerSceneObject" to "OuterSceneObject".
let innerSceneObject = new SceneObject( outerSceneObject, "InnerSceneObject" );
// Update the position of the outerSceneObject, moving it up and to the right, 100 world units.
outerSceneObject.position.x = 100;
outerSceneObject.position.y = 100;   
// Update the position of the innerSceneObject, moving it up and to the right, 100 world units.
innerSceneObject.position.x = 100;
innerSceneObject.position.y = 100;  
// Console log the x and y of mySceneObject using getGlobalPosition(). 
console.log( "'InnerSceneObject' global position x,y", innerSceneObject.getGlobalPosition().x, innerSceneObject.getGlobalPosition().y );

getGlobalScale(returnVector3 (opt)) returns {Vector3}

IncisorAPI.js, line 5617

Returns a Vector3 with the global scale of this SceneObject within the Scene.

Parameters:

Name	Type	Attributes	Default	Description
returnVector3	Vector3	<optional>		Optional Vector3 that can be supplied to avoid the generation of a new Vector3 object for efficiency.

Returns:

Vector3

Inherited From:

• SceneObject.getGlobalScale()

Example:

// Objective: Get the global scale of a SceneObject.
// Expected Result: The console should read "scale x,y 2 2.
   
// Add a GraphicObject to the main scene using the GraphicObject constructor. 
let whiteBox = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "WhiteBox" );
// Use scale to make the "WhiteBox" twice as large
whiteBox.scale.x = 2;
whiteBox.scale.y = 2;

console.log( "scale x,y", whiteBox.getGlobalScale().x, whiteBox.getGlobalScale().y );

getViewPosition(camera, returnVector3 (opt)) returns {Vector3}

IncisorAPI.js, line 5667

Returns a Vector3 containing the coordinates for this SceneObject within the given Camera's view area. The camera's view area bounds are confined to x within [-.5, .5] and y within [-.5, .5] where -.5 corresponds to left and bottom.

Parameters:

Name	Type	Attributes	Default	Description
camera	Camera			The Camera to 'look through' when obtaining the view position of this SceneObject. [DEFAULT: nc.mainCamera]
returnVector3	Vector3	<optional>		Optional Vector3 that can be supplied to avoid the generation of a new Vector3 object for efficiency.

Returns:

Vector3

Inherited From:

• SceneObject.getViewPosition()

Example:

// Objective: Get the view position of a SceneObject within a Camera's view area
// Expected Result: The console should have 2 log messages that look something like the following:
//    'MyGraphicObject' view position x,y 0.030978934324659233 0
//    'MyGraphicObject' view position x,y 0.061957868649318466 0
//
// NOTE: Because view position is relative to the Camera's view area, your x value will depend on the resolution of your screen. 
//       Try resizing your screen and running the test again. You will notice your x value has changed.
//

// Using the GraphicObject constructor, add a GraphicObject named "MyGraphicObject" to the main scene
let myGraphicObject = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "MyGraphicObject" );
// Update the x position of myGraphicObject, moving it to the right 100 world units.
myGraphicObject.position.x = 100;
// Console log the x and y of "MyGraphicObject" using getViewPosition(). 
console.log( "'MyGraphicObject' view position x,y", myGraphicObject.getViewPosition().x, myGraphicObject.getViewPosition().y );
// Update the x position of myGraphicObject again, moving it to the right 200 world units.
myGraphicObject.position.x = 200;
// Console log the x and y of "MyGraphicObject" using getViewPosition(). 
console.log( "'MyGraphicObject' view position x,y", myGraphicObject.getViewPosition().x, myGraphicObject.getViewPosition().y );

removeDisposalCallback(callbackOwner, callbackName)

IncisorAPI.js, line 5479

Removes the given callback function from the list of callbacks that occur when this SceneObject is disposed.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback function that is called when this SceneObject is disposed.
callbackName	string			The name of the function that is called when this SceneObject is disposed.

Inherited From:

• SceneObject.removeDisposalCallback()

removeEnabledStateChangeCallback(callbackOwner, callbackName)

IncisorAPI.js, line 5415

Removes an 'enabledStateChange' callback.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback function to remove.
callbackName	string			The name of the callback function to remove.

Inherited From:

• SceneObject.removeEnabledStateChangeCallback()

Example:

// Objective: Add an 'Enabled State Change' callback.
// Expected Result: The console should have 2 log messages as follows:
//    enabled state is false
//    enabled state is true

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
this.mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );

// Add a callback function.
this.myCallback = function(args) {
    console.log('enabled state is', args);
}

// Add a reference to a callback function passing the owner of the function and the function name.
this.mySceneObject.addEnabledStateChangeCallback( this, "myCallback" );
// Set mySceneObject to enabled = false. This will fire an enabled state change callback.
this.mySceneObject.enabled = false;
// Set mySceneObject to enabled = true. This will fire an enabled state change callback.
this.mySceneObject.enabled = true;
// Remove the reference to a callback function passing the owner of the function and the function name.
this.mySceneObject.removeEnabledStateChangeCallback( this, "myCallback" );
// Set mySceneObject to enabled = false. This will NO LONGER fire an enabled state change callback and no console message will be logged.
this.mySceneObject.enabled = false;

setEffectNodes(effectNodes, alsoSetDescendants (opt))

IncisorAPI.js, line 5679

Sets the EffectNodes for the Materials associated with this SceneObject.
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	Default	Description
effectNodes	Array.<EffectNode> | EffectNode			The new list of EffectNodes that will apply to the Materials associated with this SceneObject.
alsoSetDescendants	boolean	<optional>	true	Boolean determining if this SceneObject's descendants' Materials will also adopt the provided list of EffectNodes. [DEFAULT: true]

Inherited From:

• SceneObject.setEffectNodes()

setLayers(layer, sceneObjectList (opt))

IncisorAPI.js, line 5735

Sets the Layers of all of the GraphicObject descendants of this SceneObject to the supplied Layer.

Parameters:

Name	Type	Attributes	Default	Description
layer	Layer			The layer to change this SceneObject's descendants to.
sceneObjectList	Array.<SceneObject>	<optional>		Optional list designating exactly which decendants to set the layers for. If left undefined, all GraphicObject descendants' layers will be updated.

Inherited From:

• SceneObject.setLayers()

Example:

// Objective: Swap the position of GraphicObjects using setLayers().
// Action: Click the white triangle Button to swap the layering of the red and white boxes.
// Expected Result: Upon clicking the white triangle Button, the red and white boxes will swap positions.

// Start by creating 2 different GraphicObjects, red and white.
let redBox = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "RedBox" );
redBox.fillColor = new Color( 1,0,0,1 ); // make the white box red

let whiteBox = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "WhiteBox" );
// Offset the White Box, 25 world units, down and to the right.
whiteBox.position.x = 25;
whiteBox.position.y = -25;

// Define a new Layer named "LayerA" and set the red box to "LayerA".
nc.defineLayer( "LayerA", nc.mainScene );
redBox.layer = nc.layers.LayerA;
// Define a new Layer named "LayerB" and set the white box to "LayerB".
nc.defineLayer( "LayerB", nc.mainScene );
whiteBox.layer = nc.layers.LayerB;

// Using the nc factory method, create a white triangle button to handle the action of swapping layers.
let button = nc.addButton( nc.graphicAssets.WhiteTriangle, nc.mainScene, "MyButton" );
button.position.x = -120; // offset the button to the left
// Add a button callback function.
this.mySwapCallback = function(args) {
    // Swap the red and white Layers of the boxes.
    if ( redBox.layer === nc.layers.LayerA ) {
        redBox.setLayers( nc.layers.LayerB );
        whiteBox.setLayers( nc.layers.LayerA );
    } else {
        redBox.setLayers( nc.layers.LayerA );
        whiteBox.setLayers( nc.layers.LayerB );
    }
}
// Add a reference to a callback function passing the owner of the function and the function name.
button.addReleaseCallback( this, "mySwapCallback" );

setParent(parent, maintainGlobalPosition (opt))

IncisorAPI.js, line 5504

Makes this SceneObject the child of the given SceneObject in the hierachy.

Parameters:

Name	Type	Attributes	Default	Description
parent	SceneObject			The SceneObject that will become this SceneObject's new parent.
maintainGlobalPosition	boolean	<optional>		Boolean determining if the global position, scale, and rotation should be preserved during the change in hierarchy. Note that this preservation is not always possible during a parent change. [DEFAULT: false]

Inherited From:

• SceneObject.setParent()

Example:

// Objective: Set the parent of a SceneObject
// Expected Result: The console should have 2 log messages as follows:
//    GraphicObjectChild's parent is GraphicObjectA
//    GraphicObjectChild's parent is now GraphicObjectB

// Create a GraphicObject using the GraphicObject constructor. Name it "GraphicObjectA".
let graphicObjectA = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "GraphicObjectA" );
// Create a second GraphicObject using the GraphicObject constructor. Name it "GraphicObjectB".
let graphicObjectB = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "GraphicObjectB" );
// Create a third GraphicObject using the GraphicObject constructor. This time, make its parent graphicObjectA. Name it "GraphicObjectChild".
let graphicObjectChild = new GraphicObject( nc.graphicAssets.WhiteBox, graphicObjectA, "GraphicObjectChild" );
// Console log the parent.
console.log("GraphicObjectChild's parent is", graphicObjectChild.parent.name);
// Set the parent to graphicObjectB.
graphicObjectChild.setParent( graphicObjectB );
// Console log the parent.
console.log("GraphicObjectChild's parent is now", graphicObjectChild.parent.name);

setSubLayers(subLayer, sceneObjectList (opt))

IncisorAPI.js, line 5742

Sets the SubLayer values of all of the GraphicObject descendants of this SceneObject to the supplied subLayer value.

Parameters:

Name	Type	Attributes	Default	Description
subLayer	Layer			The subLayer to change this SceneObject's descendants to.
sceneObjectList	Array.<SceneObject>	<optional>		Optional list designating exactly which decendants to set the layers for. If left undefined, all GraphicObject descendants' layers will be updated.

Inherited From:

• SceneObject.setSubLayers()

swoopGlobalPosition(endValues, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt)) returns {Swooper}

IncisorAPI.js, line 5599

Swoops this SceneObject's position using global coordinates.

Parameters:

Name	Type	Attributes	Default	Description
endValues	Array.<number>			The array of target global position values [x,y,z].
duration	number	<optional>	0	The duration for the interpolation in seconds. [DEFAULT: 0]
tweenType	TweenType	<optional>	nc.tweenTypes.Linear	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>	nc.defaultPauseImmunity	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>	nc.defaultSpeedControl	The SpeedControl or Array of SpeedControls that this Swooper is affected by. [DEFAULT: nc.defaultSpeedControl]

Returns:

Swooper

Inherited From:

• SceneObject.swoopGlobalPosition()

Example:

// Objective: "Swoop" the position of the white box.
// Expected Result: The white box moves up and to the right, 300 world units, over a duration of 10 seconds.
 
// Add a GraphicObject to the main scene using the GraphicObject constructor.  
let whiteBox = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "WhiteBox" );
// Call swoopGlobalPosition() giving it the array of x,y,z values to swoop to over a duration of 10 seconds.
whiteBox.swoopGlobalPosition( [300,300,0], 10 );

swoopGlobalScale(endValues, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt)) returns {Swooper}

IncisorAPI.js, line 5639

Swoops this SceneObject's scale using global coordinates.

Parameters:

Name	Type	Attributes	Default	Description
endValues	Array.<number>			The array of target global scale values [x,y,z].
duration	number	<optional>	0	The duration for the interpolation. [DEFAULT: 0]
tweenType	TweenType	<optional>	nc.tweenTypes.Linear	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>	nc.defaultPauseImmunity	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>	nc.defaultSpeedControl	The SpeedControl or Array of SpeedControls that this Swooper is affected by. [DEFAULT: nc.defaultSpeedControl]

Returns:

Swooper

Inherited From:

• SceneObject.swoopGlobalScale()

Example:

// Objective: "Swoop" the scale of the white box.
// Expected Result: The white box expands to 5 times its original size over a duration of 10 seconds.
  
// Add a GraphicObject to the main scene using the GraphicObject constructor.  
let whiteBox = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "WhiteBox" );
// Call swoopGlobalScale() giving it the array of x,y,z values to expand to over a duration of 10 seconds.
whiteBox.swoopGlobalScale( [5,5,0], 10 );