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

ColorSwoop extends Vector4Swoop

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

ColorSwoop
IncisorAPI.js, line 10836

METHODS

alpha(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
IncisorAPI.js, line 10947

Swoops (interpolates) given component from its current value to the given end value over the duration.

Parameters:
Name Type Attributes Default Description
endValue number  

The ending value for the numeric property being swooped.
duration number <optional>
  

The duration for the interpolation. [DEFAULT: 0]
tweenType TweenType <optional>
  

The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner object <optional>
  

The object owning the callback function that is called when the Swooper completes.
completionCallbackName string <optional>
  

The name of the function that is called when the Swooper completes.
completionCallbackArgs Array | any <optional>
  

Arguments for the function that is called when the Swooper completes.
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

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

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

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

The name of the function that is called with each fixedUpdate during the swooping process.
Returns:
Swooper
Example: 
// Objective: Swoop the alpha (transparency) of a GraphicObject.
// Expected Result: You will see a white box gradually disappear over a period of 10 seconds, then reappear back to white over a period of 5 seconds.

// Create a Color using the Color constructor. By default, it will be white.
let color = new Color();
// Create a GraphicObject using the GraphicObject constructor. Use the white box GraphicAsset and add it to the main Scene.
let myGraphicObject = new GraphicObject(nc.graphicAssets.whiteBox, nc.mainScene, "WhiteBox");
// Set the GraphicObject's fillColor property to the new Color (initially white).
myGraphicObject.fillColor = color;
// Swoop the alpha value down to zero over 10 seconds then swoop it back to 1 over 5 seconds.
color.swoop.alpha(0, 10, undefined, color.swoop, "alpha", [1, 5]);

blue(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
IncisorAPI.js, line 10919

Swoops (interpolates) given component from its current value to the given end value over the duration.

Parameters:
Name Type Attributes Default Description
endValue number  

The ending value for the numeric property being swooped.
duration number <optional>
  

The duration for the interpolation. [DEFAULT: 0]
tweenType TweenType <optional>
  

The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner object <optional>
  

The object owning the callback function that is called when the Swooper completes.
completionCallbackName string <optional>
  

The name of the function that is called when the Swooper completes.
completionCallbackArgs Array | any <optional>
  

Arguments for the function that is called when the Swooper completes.
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

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

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

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

The name of the function that is called with each fixedUpdate during the swooping process.
Returns:
Swooper
Example: 
// Objective: Swoop the blue Color of a GraphicObject.
// Expected Result: You will see a blue box fade to black over a period of 10 seconds, then fade back to blue over a period of 5 seconds.

// Create a Color using the Color constructor. Initially, make it blue.
let color = new Color( 0, 0, 1, 1 );
// Create a GraphicObject using the GraphicObject constructor. Use the white box GraphicAsset and add it to the main Scene.
let myGraphicObject = new GraphicObject( nc.graphicAssets.whiteBox, nc.mainScene, "BlueBox" );
// Set the GraphicObject's fillColor property to the new Color (initially blue).
myGraphicObject.fillColor = color;
// Swoop the blue color down to zero over 10 seconds then swoop it back to 1 over 5 seconds.
color.swoop.blue( 0, 10, undefined, color.swoop, "blue", [1,5] );

green(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
IncisorAPI.js, line 10891

Swoops (interpolates) given component from its current value to the given end value over the duration.

Parameters:
Name Type Attributes Default Description
endValue number  

The ending value for the numeric property being swooped.
duration number <optional>
  

The duration for the interpolation. [DEFAULT: 0]
tweenType TweenType <optional>
  

The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner object <optional>
  

The object owning the callback function that is called when the Swooper completes.
completionCallbackName string <optional>
  

The name of the function that is called when the Swooper completes.
completionCallbackArgs Array | any <optional>
  

Arguments for the function that is called when the Swooper completes.
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

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

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

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

The name of the function that is called with each fixedUpdate during the swooping process.
Returns:
Swooper
Example: 
// Objective: Swoop the green Color of a GraphicObject.
// Expected Result: You will see a green box fade to black over a period of 10 seconds, then fade back to green over a period of 5 seconds.

// Create a Color using the Color constructor. Initially, make it green.
let color = new Color( 0, 1, 0, 1 );
// Create a GraphicObject using the GraphicObject constructor. Use the white box GraphicAsset and add it to the main Scene.
let myGraphicObject = new GraphicObject( nc.graphicAssets.whiteBox, nc.mainScene, "GreenBox" );
// Set the GraphicObject's fillColor property to the new Color (initially green).
myGraphicObject.fillColor = color;
// Swoop the green color down to zero over 10 seconds then swoop it back to 1 over 5 seconds.
color.swoop.green( 0, 10, undefined, color.swoop, "green", [1,5] );

red(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
IncisorAPI.js, line 10863

Swoops (interpolates) given component from its current value to the given end value over the duration.

Parameters:
Name Type Attributes Default Description
endValue number  

The ending value for the numeric property being swooped.
duration number <optional>
  

The duration for the interpolation. [DEFAULT: 0]
tweenType TweenType <optional>
  

The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner object <optional>
  

The object owning the callback function that is called when the Swooper completes.
completionCallbackName string <optional>
  

The name of the function that is called when the Swooper completes.
completionCallbackArgs Array | any <optional>
  

Arguments for the function that is called when the Swooper completes.
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

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

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

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

The name of the function that is called with each fixedUpdate during the swooping process.
Returns:
Swooper
Example: 
// Objective: Swoop the red Color of a GraphicObject.
// Expected Result: You will see a red box fade to black over a period of 10 seconds, then fade back to red over a period of 5 seconds.

// Create a Color using the Color constructor. Initially, make it red.
let color = new Color( 1, 0, 0, 1 );
// Create a GraphicObject using the GraphicObject constructor. Use the white box GraphicAsset and add it to the main Scene.
let myGraphicObject = new GraphicObject( nc.graphicAssets.whiteBox, nc.mainScene, "RedBox" );
// Set the GraphicObject's fillColor property to the new Color (initially red).
myGraphicObject.fillColor = color;
// Swoop the red color down to zero over 10 seconds then swoop it back to 1 over 5 seconds.
color.swoop.red( 0, 10, undefined, color.swoop, "red", [1,5] );
Methods below are inherited from the parent class.

all(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
IncisorAPI.js, line 10740

Swoops (interpolates) all of the Vector components from their current values to the given end value over the duration.

Parameters:
Name Type Attributes Default Description
endValue number  

The ending value for the numeric properties being swooped.
duration number <optional>
  

The duration for the interpolation. [DEFAULT: 0]
tweenType TweenType <optional>
  

The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner object <optional>
  

The object owning the callback function that is called when the Swooper completes.
completionCallbackName string <optional>
  

The name of the function that is called when the Swooper completes.
completionCallbackArgs Array | any <optional>
  

Arguments for the function that is called when the Swooper completes.
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

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

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

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

The name of the function that is called with each fixedUpdate during the swooping process.
Returns:
Swooper
Inherited From:

each(endValues, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
IncisorAPI.js, line 10724

Swoops (interpolates) each of the Vector components from their current values to the given end values over the duration.

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

The ending values for the numeric properties being swooped.
duration number <optional>
  

The duration for the interpolation. [DEFAULT: 0]
tweenType TweenType <optional>
  

The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner object <optional>
  

The object owning the callback function that is called when the Swooper completes.
completionCallbackName string <optional>
  

The name of the function that is called when the Swooper completes.
completionCallbackArgs Array | any <optional>
  

Arguments for the function that is called when the Swooper completes.
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

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

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

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

The name of the function that is called with each fixedUpdate during the swooping process.
Returns:
Swooper
Inherited From:

w(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
IncisorAPI.js, line 10827

Swoops (interpolates) given component from its current value to the given end value over the duration.

Parameters:
Name Type Attributes Default Description
endValue number  

The ending value for the numeric property being swooped.
duration number <optional>
  

The duration for the interpolation. [DEFAULT: 0]
tweenType TweenType <optional>
  

The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner object <optional>
  

The object owning the callback function that is called when the Swooper completes.
completionCallbackName string <optional>
  

The name of the function that is called when the Swooper completes.
completionCallbackArgs Array | any <optional>
  

Arguments for the function that is called when the Swooper completes.
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

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

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

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

The name of the function that is called with each fixedUpdate during the swooping process.
Returns:
Swooper
Inherited From:

x(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
IncisorAPI.js, line 10756

Swoops (interpolates) given component from its current value to the given end value over the duration.

Parameters:
Name Type Attributes Default Description
endValue number  

The ending value for the numeric property being swooped.
duration number <optional>
  

The duration for the interpolation. [DEFAULT: 0]
tweenType TweenType <optional>
  

The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner object <optional>
  

The object owning the callback function that is called when the Swooper completes.
completionCallbackName string <optional>
  

The name of the function that is called when the Swooper completes.
completionCallbackArgs Array | any <optional>
  

Arguments for the function that is called when the Swooper completes.
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

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

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

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

The name of the function that is called with each fixedUpdate during the swooping process.
Returns:
Swooper
Inherited From:

y(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
IncisorAPI.js, line 10780

Swoops (interpolates) given component from its current value to the given end value over the duration.

Parameters:
Name Type Attributes Default Description
endValue number  

The ending value for the numeric property being swooped.
duration number <optional>
  

The duration for the interpolation. [DEFAULT: 0]
tweenType TweenType <optional>
  

The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner object <optional>
  

The object owning the callback function that is called when the Swooper completes.
completionCallbackName string <optional>
  

The name of the function that is called when the Swooper completes.
completionCallbackArgs Array | any <optional>
  

Arguments for the function that is called when the Swooper completes.
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

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

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

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

The name of the function that is called with each fixedUpdate during the swooping process.
Returns:
Swooper
Inherited From:

z(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
IncisorAPI.js, line 10803

Swoops (interpolates) given component from its current value to the given end value over the duration.

Parameters:
Name Type Attributes Default Description
endValue number  

The ending value for the numeric property being swooped.
duration number <optional>
  

The duration for the interpolation. [DEFAULT: 0]
tweenType TweenType <optional>
  

The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner object <optional>
  

The object owning the callback function that is called when the Swooper completes.
completionCallbackName string <optional>
  

The name of the function that is called when the Swooper completes.
completionCallbackArgs Array | any <optional>
  

Arguments for the function that is called when the Swooper completes.
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

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

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

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

The name of the function that is called with each fixedUpdate during the swooping process.
Returns:
Swooper
Inherited From: