METHODS

globalDeathTime(lowerBound, upperBound, motionSpeed (opt), motionType (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Motion}

IncisorAPI.js, line 2518

Adds a motion to the 'globalDeathTime' 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

localTime(lowerBound, upperBound, motionSpeed (opt), motionType (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Motion}

IncisorAPI.js, line 2482

Adds a motion to the 'localTime' 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

localTimeDelta(lowerBound, upperBound, motionSpeed (opt), motionType (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Motion}

IncisorAPI.js, line 2494

Adds a motion to the 'localTimeDelta' 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

randomSeed(lowerBound, upperBound, motionSpeed (opt), motionType (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Motion}

IncisorAPI.js, line 2506

Adds a motion to the 'randomSeed' 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