new Motion()
MEMBERS
-
baseValues :Array.<number>
-
Array containing the base values for this Motion. These are the values that the properties being manipulated will return to if the 'influence' of this Motion is set to 0. Upon initiating a Motion for a given set numeric properties, their current values are stored in this array and used as 'home base' values and blended with the defined motion according to 'influence'.
-
controllers :MotionControllers
-
Dictionary of dictionaries (per MotionType) of values that can be used to control this motion dynamically.
-
currentValues :Array.<number>
-
Array containing the current values for this Motion. These are the values that the MotionType motion function manipulate based its 'progress' property to create the desired movement.
-
influence :number
-
Number determining the influence of this Motion over the associated numeric properties where a value of 0 corresponds to the property remaining at its baseValue with no change, and a value of 1 corresponds to the value of the property being entirely determined by the Motion.
- Default Value:
- 1
-
lowerBounds :Array.<number>
-
Array containing the lower bound or bounds for the Motion. The length of this array depends on this Motion's 'numProperties'. While MotionType definitions are not all required to adhere to bounds, it is a common practice for MotionTypes result in property motion that is confined to these bounds.
-
motionSpeed :number
-
Number informing the Motion's rate of increase on its 'progress' value, affecting the overall speed of the motion experienced by the associated properties.
- Default Value:
- 1
-
motionType :MotionType
-
The MotionType for this Motion. A MotionType defines a method of continuous change for a given set of numeric properties within a set of bounds over time. The default MotionType is 'Pendulum', which defines a smooth sinusoidal oscillation between the lower and upper bounds. MotionTypes can define any set of continuous motions for a set of numeric properties.
- Default Value:
- nc.motionTypes.Pendulum
-
name :string
-
Name of the Motion.
-
numProperties :number
-
The number of properties being affected by this Motion.
-
pauseImmunity :PauseEvent|Array.<PauseEvent>
-
The PauseEvent or Array of PauseEvents that this Motion will be immune to. Set this parameter to [] for this Motion to have no pause immunity.
- Default Value:
- nc.defaultPauseImmunity
-
progress :number
-
The number driving the motionFunction for this motion. In a defined motion over time, this number is equivalent to time. This value is not meant to be manipulated as it is automatically changed over time via the internal fixedUpdate used by this Motion.
- Default Value:
- 0
-
speedControl :SpeedControl|Array.<SpeedControl>
-
The SpeedControl or Array of SpeedControls that this Motion is affected by.
- Default Value:
- nc.defaultSpeedControl
-
type :string
-
Type identifier.
-
updaterCallbackName :string
-
The name of the optional callback function invoked continuously (every fixedUpdate) during the motion process. This callback is only performed while the influence value is larger than 0.
- Default Value:
- undefined
-
updaterCallbackOwner :object
-
The object owning the optional callback function invoked continuously (every fixedUpdate) during the motion process. This callback is only performed while the influence value is larger than 0.
- Default Value:
- undefined
-
upperBounds :Array.<number>
-
Array containing the upper bound or bounds for the Motion. The length of this array depends on this Motion's 'numProperties'. While MotionType definitions are not all required to adhere to bounds, it is a common practice for MotionTypes result in property motion that is confined to these bounds.
-
workspace :object
-
An un-specified JS object of 'any' type to enable the user to stash persistant elements of their Motion within the motionFunction.
METHODS
-
swoopInfluence(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}
-
Swoops (interpolates) the Motion's influence from its current value to the given end value over the duration.
Parameters:
Name Type Attributes Default Description endValuenumber The ending value for the numeric property being swooped.
durationnumber <optional>
The duration for the interpolation. [DEFAULT: 0]
tweenTypeTweenType <optional>
The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwnerobject <optional>
The object owning the callback function that is called when the Swooper completes.
completionCallbackNamestring <optional>
The name of the function that is called when the Swooper completes.
completionCallbackArgsArray | any <optional>
Arguments for the function that is called when the Swooper completes.
pauseImmunityPauseEvent | 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]
speedControlSpeedControl | Array.<SpeedControl> <optional>
The SpeedControl or Array of SpeedControls that this Swooper is affected by. [DEFAULT: nc.defaultSpeedControl]
eventCallbackOwnerobject <optional>
The object owning the callback function that is called with each fixedUpdate during the swooping process.
eventCallbackNamestring <optional>
The name of the function that is called with each fixedUpdate during the swooping process.
Returns:
Swooper