MEMBERS

completionCallbackArgs :Array|any

IncisorAPI.js, line 10543

Arguments for the optional callback function invoked when this Swooper completes.

Default Value:

• undefined

completionCallbackName :string

IncisorAPI.js, line 10536

The name of the optional callback function invoked when this Swooper completes.

Default Value:

• undefined

completionCallbackOwner :object

IncisorAPI.js, line 10529

The object owning the optional callback function invoked when this Swooper completes.

Default Value:

• undefined

controllers :TweenControllers

IncisorAPI.js, line 10496

Dictionary of dictionaries (per TweenType) of values that can be used to control this motion dynamically.

Default Value:

• {}

currentValues :Array.<number>

IncisorAPI.js, line 10516

Array containing the current value(s) for this Swooper. These are the values that the Tween function manipulates based its 'progress' property to create the desired movement.

endValues :Array.<number>

IncisorAPI.js, line 10510

Array containing the ending value or values for the Swooper. The length of this array depends on this Swoop's 'numProperties'. These values define the final target values for the swooped properties.

name :string

IncisorAPI.js, line 10466

Name of the Swooper.

numProperties :number

IncisorAPI.js, line 10472

The number of properties being interpolated by this Swooper.

pauseImmunity :PauseEvent|Array.<PauseEvent>

IncisorAPI.js, line 10565

The PauseEvent or Array of PauseEvents that this Swooper will be immune to. Set this parameter to [] for this Swooper to have no pause immunity.

Default Value:

• nc.defaultPauseImmunity

progress :number

IncisorAPI.js, line 10480

The number representing the progress of the interpolation of the value or values on where 0 corresponds to the startValues, and 1 corresponds to the endValues. This value is not meant to be manipulated as it is automatically changed over time via the internal fixedUpdate used by this Swooper.

Default Value:

• 0

speedControl :SpeedControl|Array.<SpeedControl>

IncisorAPI.js, line 10572

The SpeedControl or Array of SpeedControls that this Swooper is affected by.

Default Value:

• nc.defaultSpeedControl

startValues :Array.<number>

IncisorAPI.js, line 10503

Array containing the starting value or values for the Swooper. The length of this array depends on this Swoop's 'numProperties'. Upon initiating a Swooper for a given numeric property/properties, their current values are stored in this array and used as the initial conditions for the interpolation.

tweenType :TweenType

IncisorAPI.js, line 10489

The TweenType for this Swooper. A TweenType defines a method of interpolation between any two values or sets of values. The default TweenType is 'Linear', which defines a perfectly even interpolation between the startValues and endValues. TweenTypes can vary the timing of interpolation between two sets of values, as well as the path of the interpolation.

Default Value:

• nc.tweenTypes.Linear

type :string

IncisorAPI.js, line 10460

Type identifier.

updaterCallbackName :string

IncisorAPI.js, line 10557

The name of the optional callback function invoked continuously (every fixedUpdate) during the interpolation process.

Default Value:

• undefined

updaterCallbackOwner :object

IncisorAPI.js, line 10550

The object owning the optional callback function invoked continuously (every fixedUpdate) during the interpolation process.

Default Value:

• undefined

workspace :object

IncisorAPI.js, line 10522

An un-specified JS object of 'any' type to enable the user to stash persistant elements of their swooper within the tweenFunction.

METHODS

stop(setToEndValues (opt), performCompletionCallback (opt))

IncisorAPI.js, line 10580

Stops the Swooper if it is in progress.

Parameters:

Name	Type	Attributes	Default	Description
setToEndValues	boolean	<optional>		Determines if the target properties are set to the endValues. [DEFAULT: false]
performCompletionCallback	boolean	<optional>		Determines if the pre-determined completionCallback (if defined) is performed. [DEFAULT: false]