What is Incisor?
Tutorials
Key Concepts
Reddit
Stack Overflow
Deprecation Schedule

Camera extends SceneObject

A Camera is a specialized SceneObject with the ability to render the Scene that contains it to a RenderTarget. [NON-INSTANTIABLE]

Camera
IncisorAPI.js, line 6983

Example: 
// Objective: Move a Scene's Camera up and down.
// Expected Result: You will see a red box with the phrase "Build It Once." moving up and down.

// Create a new Scene and add a TextBox to it.
let scene = new Scene( "Scene" );
let textBox = new TextBox( scene );
textBox.string = "Build It Once.";

// Create new RenderTarget.
let renderTarget = new RenderTarget( "RenderTarget", 400, 100 );

// Create a new Camera for the Scene.
let camera = new OrthographicCamera( scene, "camera" );
camera.coreViewWidth = 400;
camera.coreViewHeight = 100;
camera.renderTarget = renderTarget;
camera.backgroundColor.red = .5;
camera.backgroundColor.alpha = 1;

// Move the Camera up and down along the y axis.
camera.position.addMotion.y( 50, -50, .2 );

// Create a GraphicAsset from RenderTarget.
nc.defineGraphicAssetFromRenderTarget( "NewGraphicAsset", renderTarget );
// Create a GraphicObject using the new GraphicAsset.
this.go = new GraphicObject( nc.graphicAssets.NewGraphicAsset, nc.mainScene, "SceneViewerGraphicObject" );

MEMBERS

adaptiveCameraMode :string
IncisorAPI.js, line 7028

Property determining the 'adaptive camera mode' of this Camera. Adaptive camera modes can put a Camera into a state where it reacts to the shape it's RenderTarget, extending or contracting the view area of the Camera as the shape if it's RenderTarget changes. The adaptive camera modes are as follows: 'none' - the view width and height of the camera do not change, regardless of the size and shape of the Camera's RenderTarget. 'unitsMatchPixels' - the camera bounds will consistently be updated, matching the view width and height (in world units) of the Camera with the current render resolution of the Camera's RenderTarget. 'maximizeSafeZone' - the camera bounds will consistently be updated, ensuring that the core view area (as defined by coreViewWidth and coreViewHeight) is rendered as large as it can be on the Camera's RenderTarget. [DEFUALT: constants.adaptiveCameraModes.none]

autoRender :boolean
IncisorAPI.js, line 6991

Boolean determining if this Camera is automatically rendered with every screen update.

Default Value:
  • true

autoRenderOrder :number
IncisorAPI.js, line 6998

Number determining this Camera's order in the list of automatically rendered Cameras. Higher numbers correspond to earlier render order.

Default Value:
  • 0

backgroundColor :Color
IncisorAPI.js, line 7007

Color determining the background color (aka the 'clear color') of this Camera. Please note that the 'MainCamera' defaults to [0.1,0.08,0.08,1], while all other cameras default to [0,0,0,0]. These values can be changed at any time.

Default Value:
  • Color(0,0,0,0)

clearsColor :boolean
IncisorAPI.js, line 7035

Boolean determining if the color buffer is cleared in this Camera's RenderTarget prior to rendering. [DEFUALT: true]

clearsDepth :boolean
IncisorAPI.js, line 7042

Boolean determining if the depth buffer is cleared in this Camera's RenderTarget prior to rendering. [DEFUALT: true]

clearsStencil :boolean
IncisorAPI.js, line 7049

Boolean determining if the stencil buffer is cleared in this Camera's RenderTarget prior to rendering. [DEFUALT: true]

cursorInputOverride :function|CursorInputOverrideButton
IncisorAPI.js, line 7075

This property provides means to override the automated setting of this Camera's cursorViewPosition. This is most commonly deployed when a RenderTarget used within a primary Scene serves as a 'window' into a secondary Scene that requires cursor interaction - this property would be used to map the cursor interaction through the window into the secondary screen. This property can be used two ways:

  1. Define a CursorInputOverrideButton and set this property to that object. When you do this, the button serves as a 'cursor mapping surface', where the edges of the CursorInputOverrideButton correspond to the edges of the secondary Camera's view area.
  2. Set this property to a function that remaps the cursorViewPosition manually. This method can be used to further customize the setting of this Camera's cursorViewPosition. If implemented, the first parameter of the function should take the triggering browser-generated cursor event, and the second parameter will be a Vector2 holding the default-calculated cursorViewPosition. The function should use those parameters as input, generate the desired remapped values, and call 'setCursorViewPosition' on the camera accordingly. [DEFUALT: undefined]

cursorInteractive :boolean
IncisorAPI.js, line 7016

Boolean determining if this camera will be used in conjunction with a cursor for Buttons or other cursor activity. Cameras are responsible for relating the cursor's screen position to a position within the Scene and this flag informs the Camera of that requirement. To optimize your project, ensure that this property is only set to true when cursor interactivity (Buttons etc...) in the Scene that this Camera is rendering.

Default Value:
  • false

readonly isCurrentlyRenderging :boolean
IncisorAPI.js, line 7103

Boolean denoting if the Camera is currently in the process of rendering. This property can be queried prior to any potentially recursive 'Camera.render' calls to prevent an infinite self-invocation scenario.

mouseDragInitiationThreshold :number
IncisorAPI.js, line 7095

Proportion of the Camera's view area that a mouse-based cursor drag must travel in order to initiate a Button 'drag'. While using a mouse, clicking sometimes produces a tiny un-intentional cursor drag. This value creates a threshold; if the cursor moves less than this portion of the Camera's view area during a click, no Button 'drag' occurs.

Default Value:
  • 0.005

renderTarget :RenderTarget
IncisorAPI.js, line 7056

The RenderTarget this Camera will render to when Camera.render is invoked. [DEFUALT: undefined]

touchDragInitiationThreshold :number
IncisorAPI.js, line 7085

Proportion of the Camera's view area that a touch-based cursor drag must travel in order to initiate a Button 'drag'. While using a touch-based device, tapping the screen often produces a tiny unintentional cursor drag. This value creates a threshold; if the cursor moves less than this portion of the Camera's view area during a screen touch, no Button 'drag' occurs.

Default Value:
  • 0.05
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:

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:

readonly containingScene :Scene
IncisorAPI.js, line 5099

The Scene in which this SceneObject resides.

Inherited From:

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:

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:

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:

Default Value:
  • nc.defaultFocusFallback

readonly hierarchyDepth :number
IncisorAPI.js, line 5209

Number indicating how many ancesters this SceneObject has.

Inherited From:

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);

inheritedTypes :object
IncisorAPI.js, line 5004

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

Inherited From:

Example:
// Objective: Determine the inherited types of a Button.
// Expected Result: The console log should read "inherited types {"SceneObject":true,"GraphicObject":true,"Button":true}".

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
let mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );
// Add a Button named "MyButton" to the SceneObject.
let myButton = new Button( nc.graphicAssets.WhiteBox, mySceneObject, "MyButton" );
console.log("inherited types", JSON.stringify( myButton.inheritedTypes ) );

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:

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:

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:

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:

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:

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:

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:

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:

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:

Default Value:
  • false

type :string
IncisorAPI.js, line 4988

Type identifier.

Inherited From:

Example:
// Objective: Determine the type of a SceneObject
// Expected Result: The console should have 3 log messages as follows:
//   MySceneObject is of type SceneObject
//   MyGraphicObject is of type GraphicObject
//   MyButton is of type Button

// Create a SceneObject using the SceneObject constructor. This will add "MySceneObject" to the main scene.
let mySceneObject = new SceneObject( nc.mainScene, "MySceneObject" );
// Create a GraphicObject using the GraphicObject constructor adding it to "mySceneObject".
let myGraphicObject = new GraphicObject( nc.graphicAssets.WhiteBox, mySceneObject, "MyGraphicObject" );
// Create a Button using the Button constructor and adding it to myGraphicObject.
let myButton = new Button( nc.graphicAssets.WhiteTriangle, myGraphicObject, "MyButton" );

console.log(mySceneObject.name + ' is of type ' + mySceneObject.type);
console.log(myGraphicObject.name + ' is of type ' + myGraphicObject.type);
console.log(myButton.name + ' is of type ' + myButton.type);

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:

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:

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:

METHODS

clear(clearColor (opt), clearDepth (opt), clearStencil (opt))
IncisorAPI.js, line 7217

Clears the connected RenderTarget's buffers as specified.

Parameters:
Name Type Attributes Default Description
clearColor boolean <optional>
  

Boolean indicating if the color buffer should be cleared from the attached RenderTarget [DEFAULT: true].
clearDepth boolean <optional>
  

Boolean indicating if the depth buffer should be cleared from the attached RenderTarget [DEFAULT: true].
clearStencil boolean <optional>
  

Boolean indicating if the clearStencil buffer should be cleared from the attached RenderTarget [DEFAULT: true].

getCursorPosition(returnVector3 (opt)) returns {Vector3}
IncisorAPI.js, line 7147

Returns a Vector3 with the cursor position in terms of world coordinates. The cursor position is used to calculate cursor interaction with Buttons etc.

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

getCursorViewPosition(returnVector3 (opt)) returns {Vector3}
IncisorAPI.js, line 7129

Returns a Vector3 with the cursor position in terms of Camera view coordinates. Camera view coordinates operate with bounds from -.5 to .5, where -.5 is the left/bottom/far edge of the frustum, and .5 is the right/top/near edge.

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

getIntersections(viewPosition (opt), sceneObjects (opt), intersectionsArray (opt)) returns {Array.<Intersection>}
IncisorAPI.js, line 7209

The means to determine which SceneObject (if any) intersect with a given position within the Camera's view.

Parameters:
Name Type Attributes Default Description
viewPosition Vector2 <optional>
  

The position within the Camera's view space [-.5,.5]x[-.5,.5] to use when determining if any SceneObjects intersect. [DEFAULT: Camera.getViewPosition()]
sceneObjects Array.<SceneObject> <optional>
  

The list of SceneObjects to test for intersection. [DEFAULT: Scene.getDescendants()]
intersectionsArray Array <optional>
  

Optional array that can be provided as an optimization to avoid the creation of a new array.
Returns:
Array.<Intersection>

performManualCursorRolloverCheck()
IncisorAPI.js, line 7155

Manually checks this Camera's cursor position, triggering any appropriate 'cursorIn' or 'cursorOut' callbacks for the appropriate Buttons. This function can be used to ensure that 'cursorIn' or 'cursorOut' callbacks are triggered even when there is no originating cursor event; for example, if Buttons are moving themselves, and a new Button moves under the cursor, invoking this function would evaluate the cursor and button positions and ultimately trigger the 'cursorIn' callback for the new Button.

render(skipRenderPreparations (opt))
IncisorAPI.js, line 7110

Renders the contents of the Scene within the Camera's view area to the RenderTarget.

Parameters:
Name Type Attributes Default Description
skipRenderPreparations boolean <optional>
  

Boolean that, if true, tells the rendering process to skip render preparations for efficiency. This flag is best used with secondary Cameras that render Scenes that have already been rendered once in their current state (as the preparations would have already been completed). [DEFAULT: false]

setCursorPosition(x, y, z, simulateCursorMoveEvent)
IncisorAPI.js, line 7139

Updates the Camera's cursor position from a given world position. The cursor position is used to calculate cursor interaction with Buttons etc.

Parameters:
Name Type Attributes Default Description
x number    

The x position for the cursor in terms of world coordinates
y number    

The y position for the cursor in terms of world coordinates
z number    

The z position for the cursor in terms of world coordinates
simulateCursorMoveEvent boolean    

Boolean indicating if the 'simulateCursorMoveEvent' will automatically be called. If true it should be noted that the associated call to 'simulateCursorMoveEvent' will use the default param 'updateScene=true', which could result in an extra performance cost per invokation. [DEFAULT: false]

setCursorViewPosition(x, y, z, simulateCursorMoveEvent)
IncisorAPI.js, line 7121

Updates the Camera's cursor view position to the given x and y coordinates. Camera view coordinates operate with bounds from -.5 to .5, where -.5 is the left/bottom edge of the view plane, and .5 is the right/top edge. The cursor view position is used to calculate cursor interaction with Buttons etc.

Parameters:
Name Type Attributes Default Description
x number    

The x position for the cursor in terms of Camera view coordinates [-.5,.5]
y number    

The y position for the cursor in terms of Camera view coordinates [-.5,.5]
z number    

The z position for the cursor in terms of Camera view coordinates [-.5,.5] (where .5 is the near side of the frustum)
simulateCursorMoveEvent boolean    

Boolean indicating if the "simulateCursorMoveEvent" will automatically be called. If true it should be noted that the associated call to 'simulateCursorMoveEvent' will use the default param 'updateScene=true', which could result in an extra performance cost per invokation. [DEFAULT: false]

simulateContextMenuEvent(updateScene (opt))
IncisorAPI.js, line 7200

Simulates a 'contextMenu' AppEvent at the current cursor position. Call setCursorViewPosition or setCursorPosition prior to calling this function to change the cursor position if needed. Please note this Camera must render once before the cursorPosition will intersect with any Buttons. Also, it should be noted that this method is not capable of producing the browser's actual context menu, it is only a means to trigger the Incisor®-level AppEvents and callbacks that such an event would produce.

Parameters:
Name Type Attributes Default Description
updateScene boolean <optional>
  

Boolean determining if the Scene will be manually updated prior to the simulated AppEvent; this ensures that the most recent Scene changes (changes within the current screenUpdate) affecting Button detection are accounted for, but can result in an extra cost to performance per invokation, so should not be overly used. [DEFAULT: true]

simulateCursorMoveEvent(updateScene (opt))
IncisorAPI.js, line 7166

Simulates a 'cursorMove' AppEvent at the current cursor position. Please note that either setCursorViewPosition or setCursorPosition will need to called to actually change the position of the cursor, as this method is only responsible for triggering the cursorMove-related Button callbacks. You can reposition the cursor AND get cursorMove-related Button callbacks by calling setCursorViewPosition or setCursorPosition with paramater simulateCursorMoveEvent=true. Also, please note this Camera must render once before the cursorPosition will intersect with any Buttons.

Parameters:
Name Type Attributes Default Description
updateScene boolean <optional>
  

Boolean determining if the Scene will be manually updated prior to the simulated AppEvent; this ensures that the most recent Scene changes (changes within the current screenUpdate) affecting Button detection are accounted for, but can result in an extra cost to performance per invokation, so should not be overly used. [DEFAULT: true]

simulateCursorPressEvent(updateScene (opt))
IncisorAPI.js, line 7174

Simulates a 'cursorPress' AppEvent at the current cursor position. Call setCursorViewPosition or setCursorPosition prior to calling this function to change the cursor position if needed. Please note this Camera must render once before the cursorPosition will intersect with any Buttons.

Parameters:
Name Type Attributes Default Description
updateScene boolean <optional>
  

Boolean determining if the Scene will be manually updated prior to the simulated AppEvent; this ensures that the most recent Scene changes (changes within the current screenUpdate) affecting Button detection are accounted for, but can result in an extra cost to performance per invokation, so should not be overly used. [DEFAULT: true]

simulateCursorReleaseEvent(updateScene (opt))
IncisorAPI.js, line 7182

Simulates a 'cursorRelease' AppEvent at the current cursor position. Call setCursorViewPosition or setCursorPosition prior to calling this function to change the cursor position if needed. Please note this Camera must render once before the cursorPosition will intersect with any Buttons.

Parameters:
Name Type Attributes Default Description
updateScene boolean <optional>
  

Boolean determining if the Scene will be manually updated prior to the simulated AppEvent; this ensures that the most recent Scene changes (changes within the current screenUpdate) affecting Button detection are accounted for, but can result in an extra cost to performance per invokation, so should not be overly used. [DEFAULT: true]

simulateCursorScrollEvent(updateScene (opt))
IncisorAPI.js, line 7190

Simulates a 'cursorScroll' AppEvent at the current cursor position. Call setCursorViewPosition or setCursorPosition prior to calling this function to change the cursor position if needed. Please note this Camera must render once before the cursorPosition will intersect with any Buttons.

Parameters:
Name Type Attributes Default Description
updateScene boolean <optional>
  

Boolean determining if the Scene will be manually updated prior to the simulated AppEvent; this ensures that the most recent Scene changes (changes within the current screenUpdate) affecting Button detection are accounted for, but can result in an extra cost to performance per invokation, so should not be overly used. [DEFAULT: true]
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:

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:

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:

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:

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:

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:

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:

disable()
IncisorAPI.js, line 5355

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

Inherited From:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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 );