Class: Vector2f

Defined in: math/vector2f.ts:5

Constructors

Constructor

new Vector2f(x?: number, y?: number): Vector2f;

Defined in: math/vector2f.ts:9

Parameters

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

Returns

Vector2f

Properties

Property	Type	Defined in
`x`	`number`	math/vector2f.ts:6
`y`	`number`	math/vector2f.ts:7

Methods

get()

get(i: number): number;

Defined in: math/vector2f.ts:22

Get an axis from the vector.

Parameters

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

Returns

number

set()

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

Defined in: math/vector2f.ts:31

Set an axis value to the vector.

Parameters

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

Returns

void

toString()

toString(): string;

Defined in: math/vector2f.ts:14

Returns

string

abs()

static abs(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:161

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

acos()

static acos(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:474

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

Returns

Vector2f

acosh()

static acosh(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:482

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

add()

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

Defined in: math/vector2f.ts:105

Returns addition of two vectors.

Parameters

Parameter	Type
`a`	`Vector2f`
`b`	`Vector2f`

Returns

Vector2f

asin()

static asin(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:492

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

Returns

Vector2f

asinh()

static asinh(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:500

Arc hyperbolic sine Returns the inverse of sinh.

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

atan()

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

Defined in: math/vector2f.ts:511

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`	`Vector2f`
`x`	`Vector2f`

Returns

Vector2f

atan2()

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

Defined in: math/vector2f.ts:457

Parameters

Parameter	Type
`y`	`Vector2f`
`x`	`Vector2f`

Returns

Vector2f

atanh()

static atanh(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:519

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

ceil()

static ceil(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:176

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

clamp()

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

Defined in: math/vector2f.ts:370

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

Parameters

Parameter	Type
`x`	`Vector2f`
`minVal`	`Vector2f`
`maxVal`	`Vector2f`

Returns

Vector2f

cmpEqual()

static cmpEqual(a: Vector2f, b: Vector2f): Vector2b;

Defined in: math/vector2f.ts:147

Component-wise comparison of two vectors.

Parameters

Parameter	Type
`a`	`Vector2f`
`b`	`Vector2f`

Returns

Vector2b

cmpNotEqual()

static cmpNotEqual(a: Vector2f, b: Vector2f): Vector2b;

Defined in: math/vector2f.ts:154

Component-wise comparison of two vectors.

Parameters

Parameter	Type
`a`	`Vector2f`
`b`	`Vector2f`

Returns

Vector2b

cos()

static cos(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:527

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

cosh()

static cosh(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:534

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

degrees()

static degrees(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:541

Converts radians to degrees and returns the result.

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

distance()

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

Defined in: math/vector2f.ts:380

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

Parameters

Parameter	Type
`p0`	`Vector2f`
`p1`	`Vector2f`

Returns

number

distance2()

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

Defined in: math/vector2f.ts:389

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

Parameters

Parameter	Type
`p0`	`Vector2f`
`p1`	`Vector2f`

Returns

number

div()

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

Defined in: math/vector2f.ts:126

Returns division of two vectors.

Parameters

Parameter	Type
`a`	`Vector2f`
`b`	`Vector2f`

Returns

Vector2f

eq()

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

Defined in: math/vector2f.ts:133

Returns true if two vectors are equal.

Parameters

Parameter	Type
`a`	`Vector2f`
`b`	`Vector2f`

Returns

boolean

exp()

static exp(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:283

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

exp2()

static exp2(v: Vector2f): Vector2f;

Defined in: math/vector2f.ts:290

Returns 2 raised to the v power.

Parameters

Parameter	Type
`v`	`Vector2f`

Returns

Vector2f

faceforward()

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

Defined in: math/vector2f.ts:423

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

Parameters

Parameter	Type
`N`	`Vector2f`
`I`	`Vector2f`
`Nref`	`Vector2f`

Returns

Vector2f

floor()

static floor(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:184

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

fract()

static fract(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:213

Return x - floor(x).

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

fromInt()

static fromInt(v: Vector2i): Vector2f;

Defined in: math/vector2f.ts:91

Convert a Vector2i to a Vector2f, losing precision.

Parameters

Parameter	Type
`v`	`Vector2i`

Returns

Vector2f

inversesqrt()

static inversesqrt(v: Vector2f): Vector2f;

Defined in: math/vector2f.ts:298

Returns the reciprocal of the positive square root of v.

Parameters

Parameter	Type
`v`	`Vector2f`

Returns

Vector2f

isinf()

static isinf(x: Vector2f): Vector2b;

Defined in: math/vector2f.ts:340

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

Returns

Vector2b

isnan()

static isnan(x: Vector2f): Vector2b;

Defined in: math/vector2f.ts:351

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

Returns

Vector2b

length()

static length(x: Vector2f): number;

Defined in: math/vector2f.ts:191

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

number

length2()

static length2(x: Vector2f): number;

Defined in: math/vector2f.ts:198

Returns the squared length of x.

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

number

log()

static log(v: Vector2f): Vector2f;

Defined in: math/vector2f.ts:307

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

Returns

Vector2f

log2()

static log2(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:315

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

max()

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

Defined in: math/vector2f.ts:437

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

Parameters

Parameter	Type
`x`	`Vector2f`
`y`	`Vector2f`

Returns

Vector2f

min()

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

Defined in: math/vector2f.ts:430

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

Parameters

Parameter	Type
`x`	`Vector2f`
`y`	`Vector2f`

Returns

Vector2f

mix()

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

Defined in: math/vector2f.ts:362

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`	`Vector2f`
`y`	`Vector2f`
`a`	`Vector2f`

Returns

Vector2f

mod()

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

Defined in: math/vector2f.ts:267

Modulus.

Parameters

Parameter	Type
`x`	`Vector2f`
`y`	`Vector2f`

Returns

Vector2f

modf()

static modf(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:276

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

Returns

Vector2f

mul()

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

Defined in: math/vector2f.ts:119

Returns multiplication of two vectors.

Parameters

Parameter	Type
`a`	`Vector2f`
`b`	`Vector2f`

Returns

Vector2f

ne()

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

Defined in: math/vector2f.ts:140

Returns true if two vectors are not equal.

Parameters

Parameter	Type
`a`	`Vector2f`
`b`	`Vector2f`

Returns

boolean

normalize()

static normalize(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:205

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

pow()

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

Defined in: math/vector2f.ts:322

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

Parameters

Parameter	Type
`base`	`Vector2f`
`exponent`	`Vector2f`

Returns

Vector2f

radians()

static radians(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:548

Converts degrees to radians and returns the result.

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

reflect()

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

Defined in: math/vector2f.ts:399

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`	`Vector2f`
`N`	`Vector2f`

Returns

Vector2f

refract()

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

Defined in: math/vector2f.ts:409

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`	`Vector2f`
`N`	`Vector2f`
`eta`	`number`

Returns

Vector2f

rotate()

static rotate(v: Vector2f, angle: number): Vector2f;

Defined in: math/vector2f.ts:444

Rotate a vector.

Parameters

Parameter	Type
`v`	`Vector2f`
`angle`	`number`

Returns

Vector2f

round()

static round(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:220

Returns a value equal to the nearest integer to x.

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

roundEven()

static roundEven(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:229

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

Returns

Vector2f

saturate()

static saturate(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:464

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

sign()

static sign(a: Vector2f): Vector2f;

Defined in: math/vector2f.ts:168

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

Parameters

Parameter	Type
`a`	`Vector2f`

Returns

Vector2f

sin()

static sin(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:559

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

sinh()

static sinh(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:566

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

smoothstep()

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

Defined in: math/vector2f.ts:243

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`	`Vector2f`
`edge1`	`Vector2f`
`x`	`Vector2f`

Returns

Vector2f

sqrt()

static sqrt(v: Vector2f): Vector2f;

Defined in: math/vector2f.ts:329

Returns the positive square root of v.

Parameters

Parameter	Type
`v`	`Vector2f`

Returns

Vector2f

step()

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

Defined in: math/vector2f.ts:252

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

Parameters

Parameter	Type
`edge`	`Vector2f`
`x`	`Vector2f`

Returns

Vector2f

sub()

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

Defined in: math/vector2f.ts:112

Returns subtraction of two vectors.

Parameters

Parameter	Type
`a`	`Vector2f`
`b`	`Vector2f`

Returns

Vector2f

tan()

static tan(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:573

The standard trigonometric tangent function.

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

tanh()

static tanh(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:580

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

Parameters

Parameter	Type
`x`	`Vector2f`

Returns

Vector2f

trunc()

static trunc(x: Vector2f): Vector2f;

Defined in: math/vector2f.ts:260

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

Returns

Vector2f

unm()

static unm(a: Vector2f): Vector2f;

Defined in: math/vector2f.ts:98

Returns the negation of the vector.

Parameters

Parameter	Type
`a`	`Vector2f`

Returns

Vector2f

Class: Vector2f ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Properties ​

Methods ​

get() ​

Parameters ​

Returns ​

set() ​

Parameters ​

Returns ​

toString() ​

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() ​

Parameters ​

Returns ​

exp2() ​

Parameters ​

Class: Vector2f

Constructors

Constructor

Parameters

Returns

Properties

Methods

get()

Parameters

Returns

set()

Parameters

Returns

toString()

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()

Parameters

Returns

exp2()

Parameters