SparkAR Community Scripting Docs

Searchâ€¦

Point4DSignal

`abs`

`abs(): ScalarSignal`

Returns a signal with the value that is the absolute value of the given signal.

`ReactiveModule.abs`

`add`

`add(other: ScalarSignal): ScalarSignal add(other: VectorSignal): PointSignal add(other: VectorSignal): VectorSignal add(other: PointSignal): PointSignal`

Returns a signal with the value that is the sum of the values of the given signals.

`add`

and `sum`

functions are synonyms, the behavior they provide is equivalent.`ScalarSignal.sum`

, ReactiveModule.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.

`ReactiveModule.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.

`ReactiveModule.ceil`

`cross`

`cross(other: VectorSignal): VectorSignal`

Returns a vector signal with the value that is the cross product of the given signals.

`VectorSignal.dot`

, `ScalarSignal.mul`

, `VectorSignal.mul`

`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.

`ReactiveModule.div`

`dot`

`dot(other: VectorSignal): ScalarSignal`

Returns a scalar signal with the value that is the dot product of the given signals.

`VectorSignal.cross`

, `ScalarSignal.mul`

, `VectorSignal.mul`

`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.

`ReactiveModule.floor`

`fromRange`

`fromRange(x: ScalarSignal, min: ScalarSignal, max: ScalarSignal): ScalarSignal`

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

`magnitude`

`magnitude(): ScalarSignal`

Returns the magnitude of the vector as a

`ScalarSignal`

.`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.

`ReactiveModule.mod`

`mul`

`mul(other: ScalarSignal): ScalarSignal mul(other: VectorSignal): VectorSignal mul(other: ScalarSignal): VectorSignal mul(other: ScalarSignal): VectorSignal`

Returns a signal with the value that is the product of the values of the given signals.

`ReactiveModule.mul`

, `ScalarSignal.mul`

, `VectorSignal.mul`

`neg`

`neg(): ScalarSignal neg(): VectorSignal`

Returns a signal with the negated value of the given signal.

`ReactiveModule.neg`

, `ScalarSignal.neg`

, `VectorSignal.neg`

`normalize`

`normalize(v: VectorSignal): VectorSignal normalize(): VectorSignal`

Returns the normalized (unit) vector in the direction of the original vector as a

`VectorSignal`

.`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.

`ReactiveModule.pow`

`reflect`

`reflect(incident: VectorSignal, normal: VectorSignal): VectorSignal reflect(normal: VectorSignal): VectorSignal`

Calculates the reflection direction for an incident vector and a normal as a

`VectorSignal`

.`round`

`round(): ScalarSignal`

Returns a signal with the value that is the rounded value of the given signal.

`Math.round`

utility.`ReactiveModule.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.

`Math.sign`

utility.`ReactiveModule.sign`

`smoothStep`

`smoothStep(x: ScalarSignal, 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.

`ReactiveModule.sqrt`

`sub`

`sub(other: ScalarSignal): ScalarSignal sub(other: PointSignal): VectorSignal sub(other: VectorSignal): PointSignal sub(other: VectorSignal): VectorSignal`

Returns a signal with the value that is the difference of the values of the given signals.

`ReactiveModule.sub`

, `ScalarSignal.sub`

, `VectorSignal.sub`

, `PointSignal.sub`

`sum`

`sum(other: ScalarSignal): ScalarSignal sum(other: VectorSignal): PointSignal sum(other: VectorSignal): VectorSignal sum(other: PointSignal): PointSignal`

Returns a signal with the value that is the sum of the values of the given signals.

`add`

and `sum`

functions are synonyms, the behavior they provide is equivalent.`ScalarSignal.sum`

, ReactiveModule.add``toRange`

`toRange(x: ScalarSignal, min: ScalarSignal, max: ScalarSignal): ScalarSignal`

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

Last modified 2yr ago

Copy link