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

Vector3AddMotion extends Vector2AddMotion

Object housing the 'addMotion' functions for this Vector's components [NON-INSTANTIABLE]

Vector3AddMotion
IncisorAPI.js, line 11059

METHODS

z(lowerBound, upperBound, motionSpeed (opt), motionType (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Motion}
IncisorAPI.js, line 11072

Adds a motion to the given component and returns a Motion object, which can be used to control the motion dynamically.

Parameters:
Name Type Attributes Default Description
lowerBound number  

The lower bound for the motion being added.
upperBound number  

The upper bound for the motion being added.
motionSpeed number <optional>
  

The speed factor for the added motion. [DEFAULT: 1]
motionType MotionType <optional>
  

The MotionType, determining the nature of the motion being added. [DEFAULT: nc.motionTypes.Pendulum]
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

The PauseEvent or Array of PauseEvents that this Motion will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
speedControl SpeedControl | Array.<SpeedControl> <optional>
  

The SpeedControl or Array of SpeedControls that this Motion is affected by. [DEFAULT: nc.defaultSpeedControl]
eventCallbackOwner object <optional>
  

The object owning the callback function that is called with each fixedUpdate during the motion.
eventCallbackName string <optional>
  

The name of the function that is called with each fixedUpdate during the motion.
Returns:
Motion
Methods below are inherited from the parent class.

all(lowerBound, upperBound, motionSpeed (opt), motionType (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Motion}
IncisorAPI.js, line 10998

Adds the a motion to all of the components of this Vector (using the same set of bounds), and returns a Motion object, which can be used to control the motion dynamically.

Parameters:
Name Type Attributes Default Description
lowerBound number  

The lower bound for the motion being added.
upperBound number  

The upper bound for the motion being added.
motionSpeed number <optional>
  

The speed factor for the added motion. [DEFAULT: 1]
motionType MotionType <optional>
  

The MotionType, determining the nature of the motion being added. [DEFAULT: nc.motionTypes.Pendulum]
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

The PauseEvent or Array of PauseEvents that this Motion will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
speedControl SpeedControl | Array.<SpeedControl> <optional>
  

The SpeedControl or Array of SpeedControls that this Motion is affected by. [DEFAULT: nc.defaultSpeedControl]
eventCallbackOwner object <optional>
  

The object owning the callback function that is called with each fixedUpdate during the motion.
eventCallbackName string <optional>
  

The name of the function that is called with each fixedUpdate during the motion.
Returns:
Motion
Inherited From:
Example: 
// Objective: Use the all() function to add motion to the scale of a box.
// Expected Result: You will see a white box continuously expanding and contracting.

// create a GraphicObject using the WhiteBox asset
let box = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "Box" );
// set the upper and lower bounds of the scale of the box and slow the motion speed to .2
box.scale.addMotion.all(  0, 3, .2 );

each(lowerBounds, upperBounds, motionSpeed (opt), motionType (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Motion}
IncisorAPI.js, line 10976

Adds a motion to each of the components of this Vector (bounds to be supplied individually), and returns a Motion object, which can be used to control the motion dynamically.

Parameters:
Name Type Attributes Default Description
lowerBounds Array.<number>  

The lower bound(s) for the motion being added.
upperBounds Array.<number>  

The upper bound(s) for the motion being added.
motionSpeed number <optional>
  

The speed factor for the added motion. [DEFAULT: 1]
motionType MotionType <optional>
  

The MotionType, determining the nature of the motion being added. [DEFAULT: nc.motionTypes.Pendulum]
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

The PauseEvent or Array of PauseEvents that this Motion will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
speedControl SpeedControl | Array.<SpeedControl> <optional>
  

The SpeedControl or Array of SpeedControls that this Motion is affected by. [DEFAULT: nc.defaultSpeedControl]
eventCallbackOwner object <optional>
  

The object owning the callback function that is called with each fixedUpdate during the motion.
eventCallbackName string <optional>
  

The name of the function that is called with each fixedUpdate during the motion.
Returns:
Motion
Inherited From:
Example: 
// Objective: Use the each() function to add motion to the color of the box.
// Expected Result: You will see a box continuously fading in and out from bright white to a dark, semi-transparent blue.

// create a GraphicObject using the WhiteBox asset
let box = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "Box" );
// set the lower and upper color bounds as arrays and slow the motion speed to .2
box.colorMultiply.addMotion.each( [0, .1, .6, .4], [.7, 1, .8, 2], .2 );

x(lowerBound, upperBound, motionSpeed (opt), motionType (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Motion}
IncisorAPI.js, line 11020

Adds a motion to the given component and returns a Motion object, which can be used to control the motion dynamically.

Parameters:
Name Type Attributes Default Description
lowerBound number  

The lower bound for the motion being added.
upperBound number  

The upper bound for the motion being added.
motionSpeed number <optional>
  

The speed factor for the added motion. [DEFAULT: 1]
motionType MotionType <optional>
  

The MotionType, determining the nature of the motion being added. [DEFAULT: nc.motionTypes.Pendulum]
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

The PauseEvent or Array of PauseEvents that this Motion will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
speedControl SpeedControl | Array.<SpeedControl> <optional>
  

The SpeedControl or Array of SpeedControls that this Motion is affected by. [DEFAULT: nc.defaultSpeedControl]
eventCallbackOwner object <optional>
  

The object owning the callback function that is called with each fixedUpdate during the motion.
eventCallbackName string <optional>
  

The name of the function that is called with each fixedUpdate during the motion.
Returns:
Motion
Inherited From:
Example: 
// Objective: Use the x() function to add motion along the x axis.
// Expected Result: You will see a white box continuously moving back and forth along the x axis.

// create a GraphicObject using the WhiteBox asset
let box = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "Box" );
// set the upper and lower bounds of the x position of the box and slow the motion speed to .2
box.position.addMotion.x(  -500, 500, .2 );

y(lowerBound, upperBound, motionSpeed (opt), motionType (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Motion}
IncisorAPI.js, line 11050

Adds a motion to the given component and returns a Motion object, which can be used to control the motion dynamically.

Parameters:
Name Type Attributes Default Description
lowerBound number  

The lower bound for the motion being added.
upperBound number  

The upper bound for the motion being added.
motionSpeed number <optional>
  

The speed factor for the added motion. [DEFAULT: 1]
motionType MotionType <optional>
  

The MotionType, determining the nature of the motion being added. [DEFAULT: nc.motionTypes.Pendulum]
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

The PauseEvent or Array of PauseEvents that this Motion will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
speedControl SpeedControl | Array.<SpeedControl> <optional>
  

The SpeedControl or Array of SpeedControls that this Motion is affected by. [DEFAULT: nc.defaultSpeedControl]
eventCallbackOwner object <optional>
  

The object owning the callback function that is called with each fixedUpdate during the motion.
eventCallbackName string <optional>
  

The name of the function that is called with each fixedUpdate during the motion.
Returns:
Motion
Inherited From:
Example: 
// Objective: Use the y() function to add motion along the y axis.
// Expected Result: You will see a white box continuously moving back and forth along the y axis.

// create a GraphicObject using the WhiteBox asset
let box = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "Box" );
// set the upper and lower bounds of the y position of the box and slow the motion speed to .2
box.position.addMotion.y(  -500, 500, .2 );