   Scripting API
ReactiveModule
VectorSignal

# VectorSignal

### Contents

The `VectorSignal` class monitors a vector.

## Example

```//============================================================================
// Rotates a vector of (1, 1, 1) by 45 degrees along the X-axis.
//
//============================================================================

// Load in the required modules
const Reactive = require('Reactive');

(async function() { // Enable async/await in JS [part 1]

// Create a new vector and rotation
const vector = Reactive.vector(1, 1, 1);
const eulerRotation = Reactive.vector(45, 0, 0);

// Calculate the quaternion rotation
let eulerAngles = eulerRotation.mul(Math.PI / 180);
let quatRot = Reactive.quaternionFromEuler(eulerAngles.x, eulerAngles.y, eulerAngles.z);

// Rotate the original vector by the specified quaternion rotation
const rotatedVector = vector.rotate(quatRot);

})(); // Enable async/await in JS [part 2]```

## Properties

PropertyDescription
`x`
`(get) x: ScalarSignal(set) (Not Available)`

Represents the X component of the vector.
`y`
`(get) y: ScalarSignal(set) (Not Available)`

Represents the Y component of the vector.
`z`
`(get) z: ScalarSignal(set) (Not Available)`

Represents the Z component of the vector.

## Methods

MethodDescription
` abs `
`abs(): ScalarSignal`

Returns a signal with the value that is the absolute value of the given signal.
See Also: `ReactiveModule.abs`
` add `
`add(other: ScalarSignal): ScalarSignaladd(other: VectorSignal): PointSignaladd(other: PointSignal): PointSignaladd(other: VectorSignal): VectorSignal`

Returns a signal with the value that is the sum of the values of the given signals.
Note: `add` and `sum` functions are synonyms, the behavior they provide is equivalent.

See Also: `ReactiveModule.sum`, `ScalarSignal.add`, `PointSignal.add`, `VectorSignal.add`
` atan2 `
`atan2(other: ScalarSignal): ScalarSignal`

Returns a signal with the value that is the angle in radians between the x-axis and the ray from (0, 0) to (x, y) where x and y are the values of the specified signals. The range is -PI to +PI.
See Also: `ScalarSignal.atan2`
` ceil `
`ceil(): ScalarSignal`

Returns a signal with the value that is the smallest integer that is greater than or equal to the value of the given signal.
See Also: `ScalarSignal.ceil`
` clamp `
`clamp(min: ScalarSignal, max: ScalarSignal): ScalarSignal`

Returns a signal with the value that is the value of the given `x` signal constrained to lie between the values of the given `min` and `max` signals.
Note: The behavior is undefined if `min` is greater than `max`.
` cross `
`cross(other: VectorSignal): PointSignal`

Returns a vector signal with the value that is the cross product of the given signals.
See Also: `VectorSignal.dot`, `ScalarSignal.mul`, `VectorSignal.mul`
` delayBy `
`delayBy(timeSpan: {milliseconds: number}): ISignal`

Delays a signal. The argument is an object with a "milliseconds" property specifying the delay duration in milliseconds.
` distance `
`distance(other: PointSignal): ScalarSignal`

Returns the distance from the point to another point as a `ScalarSignal`.
` div `
`div(other: ScalarSignal): ScalarSignal`

Returns a signal with the value that is the value of the first signal divided by the value of the second signal.
See Also: `ScalarSignal.div`
` dot `
`dot(other: VectorSignal): ScalarSignal`

Returns a scalar signal with the value that is the dot product of the given signals.
See Also: `VectorSignal.cross`, `ScalarSignal.mul`, `VectorSignal.mul`
` expSmooth `
`expSmooth(dampFactor: number): VectorSignal`

Smoothes a variable signal using exponential averaging over time. The argument specifies the dampening time constant in milliseconds.
Note: See also `ReactiveModule.expSmooth`.
` floor `
`floor(): ScalarSignal`

Returns a signal with the value that is the largest integer that is less than or equal to the value of the given signal.
See Also: `ScalarSignal.floor`
` fromRange `
`fromRange(min: ScalarSignal, max: ScalarSignal): ScalarSignal`

Maps x from [min, max] range to [0.0, 1.0] range.
` history `
`history(framesCount: number): SignalHistory<Vec3>`

Returns an object used to access signal values from past frames.
Historical signal values are going to be initialized with signal value at call time or using `initialValues` if provided.

* `framesCount` - the number of frames to track.
` magnitude `
`magnitude(): ScalarSignal`

Returns the magnitude of the vector as a `ScalarSignal`.
` magnitudeSquared `
`magnitudeSquared(): ScalarSignal`

Returns the squared length (magnitude) of a given signal.
Calculating the squared magnitude instead of the magnitude is much faster.
Often if you are comparing magnitudes of two vectors you can just compare their squared magnitudes.
` max `
`max(other: ScalarSignal): ScalarSignal`

Returns a signal with the value that is the greater of the values of the given signals.
` min `
`min(other: ScalarSignal): ScalarSignal`

Returns a signal with the value that is the lesser of the values of the given signals.
` mix `
`mix(signal: ScalarSignal, factor: ScalarSignal): ScalarSignalmix(signal: PointSignal, factor: ScalarSignal): PointSignalmix(signal: VectorSignal, factor: ScalarSignal): VectorSignalmix(signal: TransformSignal, factor: ScalarSignal): TransformSignal`

Returns a signal with the value that is the linear interpolation between this and another signal by a given factor.
` mod `
`mod(other: ScalarSignal): ScalarSignal`

Returns a signal with the value that is the floating-point remainder of the division of the value of the first signal by the value of the second signal.
See Also: `ScalarSignal.mod`
` mul `
`mul(other: ScalarSignal): ScalarSignalmul(other: ScalarSignal): VectorSignalmul(other: VectorSignal): VectorSignalmul(other: VectorSignal): VectorSignal`

Returns a signal with the value that is the product of the values of the given signals.
See Also: `ScalarSignal.mul`, `VectorSignal.mul`
` neg `
`neg(): ScalarSignal`

Returns a signal with the negated value of the given signal.
See Also: `ScalarSignal.neg`, `VectorSignal.neg`
` normalize `
`normalize(): VectorSignal`

Returns the normalized (unit) vector in the direction of the original vector as a `VectorSignal`.
` pinLastValue `
`pinLastValue(): VectorSignal`

Returns a new `VectorSignal` containing a constant value which is the last value of the specified signal before `pinLastValue` is called.
` pow `
`pow(exponent: ScalarSignal): ScalarSignal`

Returns a signal with the value that is the base signal raised to the power of the exponent signal.
The result is undefined if the base is negative, or if the base is zero and the exponent is not positive.

See Also: `ScalarSignal.pow`
` reflect `
`reflect(normal: VectorSignal): VectorSignal`

Calculates the reflection direction for an incident vector and a normal as a `VectorSignal`.
` rotate `
`rotate(rotation: QuaternionSignal): VectorSignal`

Rotates the vector using the specified `quaternion` value and returns the new vector as a `VectorSignal`.

See the main example at the top of this page or for the Patch Editor equivalent, see the Rotate Vector Patch article.
` round `
`round(): ScalarSignal`

Returns a signal with the value that is the rounded value of the given signal.
Note: When the fractional part is 0.5, it rounds the number away from zero, which is at odds with JavaScript standard behavior of rounding it always up in such cases. Therefore, this function is NOT exactly the reactive counterpart of the standard JavaScript `Math.round` utility.

See Also: `ScalarSignal.round`
` sign `
`sign(): ScalarSignal`

Returns a signal with the value that is the sign of the given signal. Possible sign values: NaN, -0.0, 0.0, -1.0, 1.0.
Note: this function is the reactive counterpart of the standard JavaScript `Math.sign` utility.

See Also: `ScalarSignal.sign`
` smoothStep `
`smoothStep(edge0: ScalarSignal, edge1: ScalarSignal): ScalarSignal`

Returns 0.0 if x is less than edge0, and 1.0 if x is greater than edge1.
If x is between edge0 and edge1, smooth Hermite interpolation is performed.
` sqrt `
`sqrt(): ScalarSignal`

Returns a signal with the value that is the square root of the value of the given signal.
See Also: `ScalarSignal.sqrt`
` sub `
`sub(other: ScalarSignal): ScalarSignalsub(other: VectorSignal): PointSignalsub(other: VectorSignal): VectorSignalsub(other: PointSignal): VectorSignal`

Returns a signal with the value that is the difference of the values of the given signals.
See Also: `ScalarSignal.sub`, `VectorSignal.sub`, `PointSignal.sub`
` sum `
`sum(other: ScalarSignal): ScalarSignalsum(other: VectorSignal): PointSignalsum(other: PointSignal): PointSignalsum(other: VectorSignal): VectorSignal`

Returns a signal with the value that is the sum of the values of the given signals.
Note: `add` and `sum` functions are synonyms, the behavior they provide is equivalent.

See Also: `ReactiveModule.sum`, `ScalarSignal.add`, `PointSignal.add`, `VectorSignal.add`
` toRange `
`toRange(min: ScalarSignal, max: ScalarSignal): ScalarSignal`

Maps x from [0.0, 1.0] range to [min, max] range.