Class: Vector3f

Defined in: math/vector3f.ts:6

Constructors

Constructor

new Vector3f(
   x?: number, 
   y?: number, 
   z?: number
): Vector3f;

Defined in: math/vector3f.ts:11

Parameters

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

Returns

Vector3f

Properties

Property	Type	Defined in
`x`	`number`	math/vector3f.ts:7
`y`	`number`	math/vector3f.ts:8
`z`	`number`	math/vector3f.ts:9

Accessors

UP

Get Signature

get static UP(): Vector3f;

Defined in: math/vector3f.ts:54

Up direction vector (0, 1, 0).

Returns

Vector3f

Methods

get()

get(i: number): number;

Defined in: math/vector3f.ts:32

Get an axis from the vector.

Parameters

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

Returns

number

set()

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

Defined in: math/vector3f.ts:41

Set an axis value to the vector.

Parameters

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

Returns

void

toString()

toString(): string;

Defined in: math/vector3f.ts:17

Returns

string

xy()

xy(): Vector2f;

Defined in: math/vector3f.ts:24

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

Returns

Vector2f

abs()

static abs(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:180

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

acos()

static acos(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:596

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

Returns

Vector3f

acosh()

static acosh(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:604

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

add()

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

Defined in: math/vector3f.ts:124

Returns addition of two vectors.

Parameters

Parameter	Type
`a`	`Vector3f`
`b`	`Vector3f`

Returns

Vector3f

asin()

static asin(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:614

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

Returns

Vector3f

asinh()

static asinh(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:622

Arc hyperbolic sine Returns the inverse of sinh.

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

atan()

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

Defined in: math/vector3f.ts:633

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

Returns

Vector3f

atan2()

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

Defined in: math/vector3f.ts:575

Parameters

Parameter	Type
`y`	`Vector3f`
`x`	`Vector3f`

Returns

Vector3f

atanh()

static atanh(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:641

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

ceil()

static ceil(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:195

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

clamp()

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

Defined in: math/vector3f.ts:418

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

Parameters

Parameter	Type
`x`	`Vector3f`
`minVal`	`Vector3f`
`maxVal`	`Vector3f`

Returns

Vector3f

cmpEqual()

static cmpEqual(a: Vector3f, b: Vector3f): Vector3b;

Defined in: math/vector3f.ts:166

Component-wise comparison of two vectors.

Parameters

Parameter	Type
`a`	`Vector3f`
`b`	`Vector3f`

Returns

Vector3b

cmpNotEqual()

static cmpNotEqual(a: Vector3f, b: Vector3f): Vector3b;

Defined in: math/vector3f.ts:173

Component-wise comparison of two vectors.

Parameters

Parameter	Type
`a`	`Vector3f`
`b`	`Vector3f`

Returns

Vector3b

cos()

static cos(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:649

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

cosh()

static cosh(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:656

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

cross()

static cross(x: Vector3f, y: Vector3f): Vector3f;

Defined in: math/vector3f.ts:429

Returns the cross product of x and y.

Parameters

Parameter	Type
`x`	`Vector3f`
`y`	`Vector3f`

Returns

Vector3f

degrees()

static degrees(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:663

Converts radians to degrees and returns the result.

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

distance()

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

Defined in: math/vector3f.ts:436

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

Parameters

Parameter	Type
`p0`	`Vector3f`
`p1`	`Vector3f`

Returns

number

distance2()

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

Defined in: math/vector3f.ts:446

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

Parameters

Parameter	Type
`p0`	`Vector3f`
`p1`	`Vector3f`

Returns

number

div()

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

Defined in: math/vector3f.ts:145

Returns division of two vectors.

Parameters

Parameter	Type
`a`	`Vector3f`
`b`	`Vector3f`

Returns

Vector3f

eq()

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

Defined in: math/vector3f.ts:152

Returns true if two vectors are equal.

Parameters

Parameter	Type
`a`	`Vector3f`
`b`	`Vector3f`

Returns

boolean

exp()

static exp(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:319

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

exp2()

static exp2(v: Vector3f): Vector3f;

Defined in: math/vector3f.ts:326

Returns 2 raised to the v power.

Parameters

Parameter	Type
`v`	`Vector3f`

Returns

Vector3f

faceforward()

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

Defined in: math/vector3f.ts:481

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

Parameters

Parameter	Type
`N`	`Vector3f`
`I`	`Vector3f`
`Nref`	`Vector3f`

Returns

Vector3f

floor()

static floor(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:203

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

fract()

static fract(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:232

Return x - floor(x).

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

fromInt()

static fromInt(v: Vector3i): Vector3f;

Defined in: math/vector3f.ts:110

Convert a Vector3i to a Vector3f, losing precision.

Parameters

Parameter	Type
`v`	`Vector3i`

Returns

Vector3f

inversesqrt()

static inversesqrt(v: Vector3f): Vector3f;

Defined in: math/vector3f.ts:334

Returns the reciprocal of the positive square root of v.

Parameters

Parameter	Type
`v`	`Vector3f`

Returns

Vector3f

isinf()

static isinf(x: Vector3f): Vector3b;

Defined in: math/vector3f.ts:380

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

Returns

Vector3b

isnan()

static isnan(x: Vector3f): Vector3b;

Defined in: math/vector3f.ts:395

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

Returns

Vector3b

length()

static length(x: Vector3f): number;

Defined in: math/vector3f.ts:210

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

number

length2()

static length2(x: Vector3f): number;

Defined in: math/vector3f.ts:217

Returns the squared length of x.

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

number

log()

static log(v: Vector3f): Vector3f;

Defined in: math/vector3f.ts:343

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

Returns

Vector3f

log2()

static log2(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:351

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

max()

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

Defined in: math/vector3f.ts:495

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

Parameters

Parameter	Type
`x`	`Vector3f`
`y`	`Vector3f`

Returns

Vector3f

min()

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

Defined in: math/vector3f.ts:488

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

Parameters

Parameter	Type
`x`	`Vector3f`
`y`	`Vector3f`

Returns

Vector3f

mix()

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

Defined in: math/vector3f.ts:406

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

Returns

Vector3f

mod()

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

Defined in: math/vector3f.ts:299

Modulus.

Parameters

Parameter	Type
`x`	`Vector3f`
`y`	`Vector3f`

Returns

Vector3f

modf()

static modf(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:312

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

Returns

Vector3f

mul()

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

Defined in: math/vector3f.ts:138

Returns multiplication of two vectors.

Parameters

Parameter	Type
`a`	`Vector3f`
`b`	`Vector3f`

Returns

Vector3f

ne()

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

Defined in: math/vector3f.ts:159

Returns true if two vectors are not equal.

Parameters

Parameter	Type
`a`	`Vector3f`
`b`	`Vector3f`

Returns

boolean

normalize()

static normalize(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:224

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

pow()

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

Defined in: math/vector3f.ts:358

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

Parameters

Parameter	Type
`base`	`Vector3f`
`exponent`	`Vector3f`

Returns

Vector3f

radians()

static radians(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:674

Converts degrees to radians and returns the result.

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

reflect()

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

Defined in: math/vector3f.ts:457

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

Returns

Vector3f

refract()

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

Defined in: math/vector3f.ts:467

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

Returns

Vector3f

rotate()

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

Defined in: math/vector3f.ts:502

Rotate a vector around an axis.

Parameters

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

Returns

Vector3f

rotateX()

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

Defined in: math/vector3f.ts:529

Rotate a vector around the X axis.

Parameters

Parameter	Type
`v`	`Vector3f`
`angle`	`number`

Returns

Vector3f

rotateY()

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

Defined in: math/vector3f.ts:539

Rotate a vector around the Y axis.

Parameters

Parameter	Type
`v`	`Vector3f`
`angle`	`number`

Returns

Vector3f

rotateZ()

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

Defined in: math/vector3f.ts:549

Rotate a vector around the Z axis.

Parameters

Parameter	Type
`v`	`Vector3f`
`angle`	`number`

Returns

Vector3f

round()

static round(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:239

Returns a value equal to the nearest integer to x.

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

roundEven()

static roundEven(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:248

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

Returns

Vector3f

saturate()

static saturate(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:582

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

sign()

static sign(a: Vector3f): Vector3f;

Defined in: math/vector3f.ts:187

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

Parameters

Parameter	Type
`a`	`Vector3f`

Returns

Vector3f

sin()

static sin(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:686

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

sinh()

static sinh(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:693

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

slerp()

static slerp(
   x: Vector3f, 
   y: Vector3f, 
   a: number
): Vector3f;

Defined in: math/vector3f.ts:559

Returns Spherical interpolation between two vectors.

Parameters

Parameter	Type
`x`	`Vector3f`
`y`	`Vector3f`
`a`	`number`

Returns

Vector3f

smoothstep()

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

Defined in: math/vector3f.ts:266

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

Returns

Vector3f

sqrt()

static sqrt(v: Vector3f): Vector3f;

Defined in: math/vector3f.ts:369

Returns the positive square root of v.

Parameters

Parameter	Type
`v`	`Vector3f`

Returns

Vector3f

step()

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

Defined in: math/vector3f.ts:280

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

Parameters

Parameter	Type
`edge`	`Vector3f`
`x`	`Vector3f`

Returns

Vector3f

sub()

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

Defined in: math/vector3f.ts:131

Returns subtraction of two vectors.

Parameters

Parameter	Type
`a`	`Vector3f`
`b`	`Vector3f`

Returns

Vector3f

tan()

static tan(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:700

The standard trigonometric tangent function.

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

tanh()

static tanh(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:707

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

Parameters

Parameter	Type
`x`	`Vector3f`

Returns

Vector3f

trunc()

static trunc(x: Vector3f): Vector3f;

Defined in: math/vector3f.ts:292

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

Returns

Vector3f

unm()

static unm(a: Vector3f): Vector3f;

Defined in: math/vector3f.ts:117

Returns the negation of the vector.

Parameters

Parameter	Type
`a`	`Vector3f`

Returns

Vector3f

Class: Vector3f ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Properties ​

Accessors ​

UP ​

Get Signature ​

Returns ​

Methods ​

get() ​

Parameters ​

Returns ​

set() ​

Parameters ​

Returns ​

toString() ​

Returns ​

xy() ​

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 ​

cross() ​

Parameters ​

Returns ​

degrees() ​

Parameters ​

Returns ​

distance() ​

Parameters ​

Returns ​

distance2() ​

Parameters ​

Returns ​

div() ​

Parameters ​

Class: Vector3f

Constructors

Constructor

Parameters

Returns

Properties

Accessors

UP

Get Signature

Returns

Methods

get()

Parameters

Returns

set()

Parameters

Returns

toString()

Returns

xy()

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

cross()

Parameters

Returns

degrees()

Parameters

Returns

distance()

Parameters

Returns

distance2()

Parameters

Returns

div()

Parameters