Class: Vector4f

Defined in: math/vector4f.ts:7

Constructors

Constructor

new Vector4f(
   x?: number, 
   y?: number, 
   z?: number, 
   w?: number
): Vector4f;

Defined in: math/vector4f.ts:13

Parameters

Parameter	Type	Default value
`x`	`number`	`0`
`y`	`number`	`x`
`z`	`number`	`x`
`w`	`number`	`x`

Returns

Vector4f

Properties

Property	Type	Defined in
`w`	`number`	math/vector4f.ts:11
`x`	`number`	math/vector4f.ts:8
`y`	`number`	math/vector4f.ts:9
`z`	`number`	math/vector4f.ts:10

Methods

get()

get(i: number): number;

Defined in: math/vector4f.ts:42

Get an axis from the vector.

Parameters

Parameter	Type	Description
`i`	`number`	Axis index in range [0, 3].

Returns

number

set()

set(i: number, v: number): void;

Defined in: math/vector4f.ts:51

Set an axis value to the vector.

Parameters

Parameter	Type	Description
`i`	`number`	Axis index in range [0, 3].
`v`	`number`	Axis value.

Returns

void

toString()

toString(): string;

Defined in: math/vector4f.ts:20

Returns

string

xy()

xy(): Vector2f;

Defined in: math/vector4f.ts:27

Returns a vector containing the x and y components of this vector.

Returns

Vector2f

xyz()

xyz(): Vector3f;

Defined in: math/vector4f.ts:34

Returns a vector containing the x, y and z components of this vector.

Returns

Vector3f

abs()

static abs(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:185

Returns x if x >= 0; otherwise, it returns -x.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

acos()

static acos(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:634

Arc cosine. Returns an angle whose sine is x. The range of values returned by this function is [0, PI]. Results are undefined if |x| > 1.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

acosh()

static acosh(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:642

Arc hyperbolic cosine; returns the non-negative inverse of cosh. Results are undefined if x < 1.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

add()

static add(a: Vector4f, b: Vector4f): Vector4f;

Defined in: math/vector4f.ts:129

Returns addition of two vectors.

Parameters

Parameter	Type
`a`	`Vector4f`
`b`	`Vector4f`

Returns

Vector4f

asin()

static asin(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:652

Arc sine. Returns an angle whose sine is x. The range of values returned by this function is [-PI/2, PI/2]. Results are undefined if |x| > 1.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

asinh()

static asinh(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:660

Arc hyperbolic sine Returns the inverse of sinh.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

atan()

static atan(y: Vector4f, x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:671

Arc tangent. Returns an angle whose tangent is y/x. The signs of x and y are used to determine what quadrant the angle is in. The range of values returned by this function is [-PI, PI]. Results are undefined if x and y are both 0.

Parameters

Parameter	Type
`y`	`Vector4f`
`x`	`Vector4f`

Returns

Vector4f

atan2()

static atan2(y: Vector4f, x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:612

Parameters

Parameter	Type
`y`	`Vector4f`
`x`	`Vector4f`

Returns

Vector4f

atanh()

static atanh(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:679

Arc hyperbolic tangent; returns the inverse of tanh. Results are undefined if abs(x) >= 1.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

ceil()

static ceil(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:205

Returns a value equal to the nearest integer that is greater than or equal to x.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

clamp()

static clamp(
   x: Vector4f, 
   minVal: Vector4f, 
   maxVal: Vector4f
): Vector4f;

Defined in: math/vector4f.ts:456

Returns min(max(x, minVal), maxVal) for each component in x using the floating-point values minVal and maxVal.

Parameters

Parameter	Type
`x`	`Vector4f`
`minVal`	`Vector4f`
`maxVal`	`Vector4f`

Returns

Vector4f

cmpEqual()

static cmpEqual(a: Vector4f, b: Vector4f): Vector4b;

Defined in: math/vector4f.ts:171

Component-wise comparison of two vectors.

Parameters

Parameter	Type
`a`	`Vector4f`
`b`	`Vector4f`

Returns

Vector4b

cmpNotEqual()

static cmpNotEqual(a: Vector4f, b: Vector4f): Vector4b;

Defined in: math/vector4f.ts:178

Component-wise comparison of two vectors.

Parameters

Parameter	Type
`a`	`Vector4f`
`b`	`Vector4f`

Returns

Vector4b

cos()

static cos(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:687

The standard trigonometric cosine function. The values returned by this function will range from [-1, 1].

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

cosh()

static cosh(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:694

Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

degrees()

static degrees(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:701

Converts radians to degrees and returns the result.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

distance()

static distance(p0: Vector4f, p1: Vector4f): number;

Defined in: math/vector4f.ts:468

Returns the distance between p0 and p1, i.e., length(p0 - p1).

Parameters

Parameter	Type
`p0`	`Vector4f`
`p1`	`Vector4f`

Returns

number

distance2()

static distance2(p0: Vector4f, p1: Vector4f): number;

Defined in: math/vector4f.ts:479

Returns the sqquared distance between p0 and p1, i.e., length2(p0 - p1).

Parameters

Parameter	Type
`p0`	`Vector4f`
`p1`	`Vector4f`

Returns

number

div()

static div(a: Vector4f, b: Vector4f): Vector4f;

Defined in: math/vector4f.ts:150

Returns division of two vectors.

Parameters

Parameter	Type
`a`	`Vector4f`
`b`	`Vector4f`

Returns

Vector4f

eq()

static eq(a: Vector4f, b: Vector4f): boolean;

Defined in: math/vector4f.ts:157

Returns true if two vectors are equal.

Parameters

Parameter	Type
`a`	`Vector4f`
`b`	`Vector4f`

Returns

boolean

exp()

static exp(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:349

Returns the natural exponentiation of x, i.e., e^x.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

exp2()

static exp2(v: Vector4f): Vector4f;

Defined in: math/vector4f.ts:356

Returns 2 raised to the v power.

Parameters

Parameter	Type
`v`	`Vector4f`

Returns

Vector4f

faceforward()

static faceforward(
   N: Vector4f, 
   I: Vector4f, 
   Nref: Vector4f
): Vector4f;

Defined in: math/vector4f.ts:520

If dot(Nref, I) < 0.0, return N, otherwise, return -N.

Parameters

Parameter	Type
`N`	`Vector4f`
`I`	`Vector4f`
`Nref`	`Vector4f`

Returns

Vector4f

floor()

static floor(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:213

Returns a value equal to the nearest integer that is less then or equal to x.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

fract()

static fract(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:242

Return x - floor(x).

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

fromInt()

static fromInt(v: Vector4i): Vector4f;

Defined in: math/vector4f.ts:115

Convert a Vector4i to a Vector4f, losing precision.

Parameters

Parameter	Type
`v`	`Vector4i`

Returns

Vector4f

inversesqrt()

static inversesqrt(v: Vector4f): Vector4f;

Defined in: math/vector4f.ts:364

Returns the reciprocal of the positive square root of v.

Parameters

Parameter	Type
`v`	`Vector4f`

Returns

Vector4f

isinf()

static isinf(x: Vector4f): Vector4b;

Defined in: math/vector4f.ts:416

Returns true if x holds a positive infinity or negative infinity representation in the underlying implementation's set of floating point representations. Returns false otherwise, including for implementations with no infinity representations.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4b

isnan()

static isnan(x: Vector4f): Vector4b;

Defined in: math/vector4f.ts:432

Returns true if x holds a NaN (not a number) representation in the underlying implementation's set of floating point representations. Returns false otherwise, including for implementations with no NaN representations.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4b

length()

static length(x: Vector4f): number;

Defined in: math/vector4f.ts:220

Returns the length of x, i.e., sqrt(x * x).

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

number

length2()

static length2(x: Vector4f): number;

Defined in: math/vector4f.ts:227

Returns the squared length of x.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

number

log()

static log(v: Vector4f): Vector4f;

Defined in: math/vector4f.ts:378

Returns the natural logarithm of v, i.e., returns the value y which satisfies the equation x = e^y. Results are undefined if v <= 0.

Parameters

Parameter	Type
`v`	`Vector4f`

Returns

Vector4f

log2()

static log2(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:386

Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

max()

static max(x: Vector4f, y: Vector4f): Vector4f;

Defined in: math/vector4f.ts:539

Returns y if x < y; otherwise, it returns x.

Parameters

Parameter	Type
`x`	`Vector4f`
`y`	`Vector4f`

Returns

Vector4f

min()

static min(x: Vector4f, y: Vector4f): Vector4f;

Defined in: math/vector4f.ts:527

Returns y if y < x; otherwise, it returns x.

Parameters

Parameter	Type
`x`	`Vector4f`
`y`	`Vector4f`

Returns

Vector4f

mix()

static mix(
   x: Vector4f, 
   y: Vector4f, 
   a: Vector4f
): Vector4f;

Defined in: math/vector4f.ts:443

If genTypeU is a floating scalar or vector: Returns x * (1.0 - a) + y * a, i.e., the linear blend of x and y using the floating-point value a. The value for a is not restricted to the range [0, 1].

Parameters

Parameter	Type
`x`	`Vector4f`
`y`	`Vector4f`
`a`	`Vector4f`

Returns

Vector4f

mod()

static mod(x: Vector4f, y: Vector4f): Vector4f;

Defined in: math/vector4f.ts:323

Modulus.

Parameters

Parameter	Type
`x`	`Vector4f`
`y`	`Vector4f`

Returns

Vector4f

modf()

static modf(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:337

Returns the fractional part of x. The integer part is not returned, as AssemblyScript has no output parameters. The return value will have the same sign as x.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

mul()

static mul(a: Vector4f, b: Vector4f): Vector4f;

Defined in: math/vector4f.ts:143

Returns multiplication of two vectors.

Parameters

Parameter	Type
`a`	`Vector4f`
`b`	`Vector4f`

Returns

Vector4f

ne()

static ne(a: Vector4f, b: Vector4f): boolean;

Defined in: math/vector4f.ts:164

Returns true if two vectors are not equal.

Parameters

Parameter	Type
`a`	`Vector4f`
`b`	`Vector4f`

Returns

boolean

normalize()

static normalize(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:234

Returns a vector in the same direction as x but with length of 1.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

pow()

static pow(base: Vector4f, exponent: Vector4f): Vector4f;

Defined in: math/vector4f.ts:393

Returns 'base' raised to the power 'exponent'.

Parameters

Parameter	Type
`base`	`Vector4f`
`exponent`	`Vector4f`

Returns

Vector4f

radians()

static radians(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:713

Converts degrees to radians and returns the result.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

reflect()

static reflect(I: Vector4f, N: Vector4f): Vector4f;

Defined in: math/vector4f.ts:491

For the incident vector I and surface orientation N, returns the reflection direction : result = I - 2.0 * dot(N, I) * N.

Parameters

Parameter	Type
`I`	`Vector4f`
`N`	`Vector4f`

Returns

Vector4f

refract()

static refract(
   I: Vector4f, 
   N: Vector4f, 
   eta: number
): Vector4f;

Defined in: math/vector4f.ts:506

For the incident vector I and surface normal N, and the ratio of indices of refraction eta, return the refraction vector.

Parameters

Parameter	Type
`I`	`Vector4f`
`N`	`Vector4f`
`eta`	`number`

Returns

Vector4f

rotate()

static rotate(
   v: Vector4f, 
   angle: number, 
   axis: Vector3f
): Vector4f;

Defined in: math/vector4f.ts:551

Rotate a vector around an axis.

Parameters

Parameter	Type
`v`	`Vector4f`
`angle`	`number`
`axis`	`Vector3f`

Returns

Vector4f

rotateX()

static rotateX(v: Vector4f, angle: number): Vector4f;

Defined in: math/vector4f.ts:579

Rotate a vector around the X axis.

Parameters

Parameter	Type
`v`	`Vector4f`
`angle`	`number`

Returns

Vector4f

rotateY()

static rotateY(v: Vector4f, angle: number): Vector4f;

Defined in: math/vector4f.ts:589

Rotate a vector around the Y axis.

Parameters

Parameter	Type
`v`	`Vector4f`
`angle`	`number`

Returns

Vector4f

rotateZ()

static rotateZ(v: Vector4f, angle: number): Vector4f;

Defined in: math/vector4f.ts:599

Rotate a vector around the Z axis.

Parameters

Parameter	Type
`v`	`Vector4f`
`angle`	`number`

Returns

Vector4f

round()

static round(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:254

Returns a value equal to the nearest integer to x.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

roundEven()

static roundEven(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:268

Returns a value equal to the nearest integer to x. A fractional part of 0.5 will round toward the nearest even integer. (Both 3.5 and 4.5 for x will return 4.0.)

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

saturate()

static saturate(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:619

Returns clamp(x, 0, 1) for each component in x.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

sign()

static sign(a: Vector4f): Vector4f;

Defined in: math/vector4f.ts:192

Returns 1.0 if x > 0, 0.0 if x == 0, or -1.0 if x < 0.

Parameters

Parameter	Type
`a`	`Vector4f`

Returns

Vector4f

sin()

static sin(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:726

The standard trigonometric sine function. The values returned by this function will range from [-1, 1].

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

sinh()

static sinh(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:733

Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

smoothstep()

static smoothstep(
   edge0: Vector4f, 
   edge1: Vector4f, 
   x: Vector4f
): Vector4f;

Defined in: math/vector4f.ts:287

Returns 0.0 if x <= edge0 and 1.0 if x >= edge1 and performs smooth Hermite interpolation between 0 and 1 when edge0 < x < edge1.

This is useful in cases where you would want a threshold function with a smooth transition. This is equivalent to: genType t; t = clamp ((x - edge0) / (edge1 - edge0), 0, 1); return t * t * (3 - 2 * t); Results are undefined if edge0 >= edge1.

Parameters

Parameter	Type
`edge0`	`Vector4f`
`edge1`	`Vector4f`
`x`	`Vector4f`

Returns

Vector4f

sqrt()

static sqrt(v: Vector4f): Vector4f;

Defined in: math/vector4f.ts:405

Returns the positive square root of v.

Parameters

Parameter	Type
`v`	`Vector4f`

Returns

Vector4f

step()

static step(edge: Vector4f, x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:303

Returns 0.0 if x < edge, otherwise it returns 1.0 for each component of a genType.

Parameters

Parameter	Type
`edge`	`Vector4f`
`x`	`Vector4f`

Returns

Vector4f

sub()

static sub(a: Vector4f, b: Vector4f): Vector4f;

Defined in: math/vector4f.ts:136

Returns subtraction of two vectors.

Parameters

Parameter	Type
`a`	`Vector4f`
`b`	`Vector4f`

Returns

Vector4f

tan()

static tan(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:740

The standard trigonometric tangent function.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

tanh()

static tanh(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:747

Returns the hyperbolic tangent function, sinh(angle) / cosh(angle)

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

trunc()

static trunc(x: Vector4f): Vector4f;

Defined in: math/vector4f.ts:316

Returns a value equal to the nearest integer to x whose absolute value is not larger than the absolute value of x.

Parameters

Parameter	Type
`x`	`Vector4f`

Returns

Vector4f

unm()

static unm(a: Vector4f): Vector4f;

Defined in: math/vector4f.ts:122

Returns the negation of the vector.

Parameters

Parameter	Type
`a`	`Vector4f`

Returns

Vector4f

Class: Vector4f ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Properties ​

Methods ​

get() ​

Parameters ​

Returns ​

set() ​

Parameters ​

Returns ​

toString() ​

Returns ​

xy() ​

Returns ​

xyz() ​

Returns ​

abs() ​

Parameters ​

Returns ​

acos() ​

Parameters ​

Returns ​

acosh() ​

Parameters ​

Returns ​

add() ​

Parameters ​

Returns ​

asin() ​

Parameters ​

Returns ​

asinh() ​

Parameters ​

Returns ​

atan() ​

Parameters ​

Returns ​

atan2() ​

Parameters ​

Returns ​

atanh() ​

Parameters ​

Returns ​

ceil() ​

Parameters ​

Returns ​

clamp() ​

Parameters ​

Returns ​

cmpEqual() ​

Parameters ​

Returns ​

cmpNotEqual() ​

Parameters ​

Returns ​

cos() ​

Parameters ​

Returns ​

cosh() ​

Parameters ​

Returns ​

degrees() ​

Parameters ​

Returns ​

distance() ​

Parameters ​

Returns ​

distance2() ​

Parameters ​

Returns ​

div() ​

Parameters ​

Returns ​

eq() ​

Parameters ​

Returns ​

exp() ​

Class: Vector4f

Constructors

Constructor

Parameters

Returns

Properties

Methods

get()

Parameters

Returns

set()

Parameters

Returns

toString()

Returns

xy()

Returns

xyz()

Returns

abs()

Parameters

Returns

acos()

Parameters

Returns

acosh()

Parameters

Returns

add()

Parameters

Returns

asin()

Parameters

Returns

asinh()

Parameters

Returns

atan()

Parameters

Returns

atan2()

Parameters

Returns

atanh()

Parameters

Returns

ceil()

Parameters

Returns

clamp()

Parameters

Returns

cmpEqual()

Parameters

Returns

cmpNotEqual()

Parameters

Returns

cos()

Parameters

Returns

cosh()

Parameters

Returns

degrees()

Parameters

Returns

distance()

Parameters

Returns

distance2()

Parameters

Returns

div()

Parameters

Returns

eq()

Parameters

Returns

exp()