openglobus

Class: Vec2

og/math/Vec2.Vec2

Class represents a 3d vector.

new module:og/math/Vec2.Vec2(x, y)

og/math/Vec2.js, line 15
Name Type Description
x number optional First value.
y number optional Second value.

Members

xnumber

ynumber

static,constantmodule:og/math/Vec2.Vec2.DOWN

static,constantmodule:og/math/Vec2.Vec2.LEFT

static,constantmodule:og/math/Vec2.Vec2.RIGHT

static,constantmodule:og/math/Vec2.Vec2.UP

static,constantmodule:og/math/Vec2.Vec2.ZERO

Methods

add(v){math.Vec2}

og/math/Vec2.js, line 225
Summarize two vectors.
Name Type Description
v math.Vec2
Returns:
Type Description
math.Vec2

addA(v){math.Vec2}

og/math/Vec2.js, line 213
Adds vector to the current.
Name Type Description
v math.Vec2
Returns:
Type Description
math.Vec2

angle(a){number}

og/math/Vec2.js, line 450
Gets angle between two vectors.
Name Type Description
a math.Vec2 Another vector.
Returns:
Type Description
number

clear(){math.Vec2}

og/math/Vec2.js, line 342
Sets vector to zero.
Returns:
Type Description
math.Vec2

clone(){math.Vec2}

og/math/Vec2.js, line 164
Returns clone vector.
Returns:
Type Description
math.Vec2

copy(point2){math.Vec2}

og/math/Vec2.js, line 183
Copy input vector's values.
Name Type Description
point2 math.Vec2 Vector to copy.
Returns:
Type Description
math.Vec2

cross(v){math.Vec2}

og/math/Vec2.js, line 333
Gets vectors cross production.
Name Type Description
v math.Vec2 Another vector.
Returns:
Type Description
math.Vec2

distance(p){number}

og/math/Vec2.js, line 393
Gets distance to point.
Name Type Description
p math.Vec2 Distant point.
Returns:
Type Description
number

divA(vec){math.Vec2}

og/math/Vec2.js, line 301
Divide current vector's components to another. Results stores in the current vector object.
Name Type Description
vec math.Vec2
Returns:
Type Description
math.Vec2

dot(v){number}

og/math/Vec2.js, line 313
Gets vectors dot production.
Name Type Description
v math.Vec2 Another vector.
Returns:
Type Description
number

dotArr(arr){number}

og/math/Vec2.js, line 323
Gets vectors dot production.
Name Type Description
arr Array.<number> Array vector. (exactly 2 entries)
Returns:
Type Description
number

equal(p){boolean}

og/math/Vec2.js, line 174
Compares with vector. Returns true if it equals another.
Name Type Description
p math.Vec2 Vector to compare.
Returns:
Type Description
boolean

length(){number}

og/math/Vec2.js, line 194
Gets vector's length.
Returns:
Type Description
number

length2(){number}

og/math/Vec2.js, line 203
Returns squared vector's length.
Returns:
Type Description
number

lerp(v2, l){math.Vec2}

og/math/Vec2.js, line 461
Returns two vectors linear interpolation.
Name Type Description
v2 math.Vec2 End vector.
l number Interpolate value.
Returns:
Type Description
math.Vec2

mul(vec){math.Vec2}

og/math/Vec2.js, line 291
Multiply current vector object to another and returns new vector instance.
Name Type Description
vec math.Vec2 Multiply vector.
Returns:
Type Description
math.Vec2

mulA(vec){math.Vec2}

og/math/Vec2.js, line 279
Multiply current vector object to another and store result in the current instance.
Name Type Description
vec math.Vec2 Multiply vector.
Returns:
Type Description
math.Vec2

negate(){math.Vec2}

og/math/Vec2.js, line 416
Negate current vector.
Returns:
Type Description
math.Vec2

negateTo(){math.Vec2}

og/math/Vec2.js, line 427
Negate current vector to another instance.
Returns:
Type Description
math.Vec2

normal(){math.Vec2}

og/math/Vec2.js, line 352
Returns normalized vector.
Returns:
Type Description
math.Vec2

normalize(){math.Vec2}

og/math/Vec2.js, line 369
Normalize current vector.
Returns:
Type Description
math.Vec2

projToRay(pos, direction){math.Vec2}

og/math/Vec2.js, line 438
Gets projected point coordinates of the current vector on the ray.
Name Type Description
pos math.Vec2 Ray position.
direction math.Vec2 Ray direction.
Returns:
Type Description
math.Vec2

scale(scale){math.Vec2}

og/math/Vec2.js, line 257
Scale current vector.
Name Type Description
scale number Scale value.
Returns:
Type Description
math.Vec2

scaleTo(scale){math.Vec2}

og/math/Vec2.js, line 269
Scale current vector to another instance.
Name Type Description
scale number Scale value.
Returns:
Type Description
math.Vec2

set(x, y){math.Vec2}

og/math/Vec2.js, line 405
Sets vector's values.
Name Type Description
x number Value X.
y number Value Y.
Returns:
Type Description
math.Vec2

slerp(v2, t){math.Vec2}

og/math/Vec2.js, line 487
Spherically interpolates between two vectors. Interpolates between current and v2 vector by amount t. The difference between this and linear interpolation (aka, "lerp") is that the vectors are treated as directions rather than points in space. The direction of the returned vector is interpolated by the angle and its magnitude is interpolated between the magnitudes of from and to.
Name Type Description
v2 math.Vec2 -
t number The parameter t is clamped to the range [0, 1].
Returns:
Type Description
math.Vec2

sub(v){math.Vec2}

og/math/Vec2.js, line 247
Subtract vector from the current.
Name Type Description
v math.Vec2 Subtract vector.
Returns:
Type Description
math.Vec2

subA(v){math.Vec2}

og/math/Vec2.js, line 235
Subtract vector from the current where results saved on the current instance.
Name Type Description
v math.Vec2 Subtract vector.
Returns:
Type Description
math.Vec2

toVec(){Array.<number>}

og/math/Vec2.js, line 383
Converts vector to a number array.
Returns:
Type Description
Array.<number> - (exactly 2 entries)

toVector3(){Vec3}

og/math/Vec2.js, line 155
Converts to 3d vector, third value is 0.0.
Returns:
Type Description
Vec3

staticmodule:og/math/Vec2.Vec2.add(a, b){math.Vec2}

og/math/Vec2.js, line 57
Returns summary vector.
Name Type Description
a math.Vec2 First vector.
b math.Vec2 Second vector.
Returns:
Type Description
math.Vec2 - Summary vector.

staticmodule:og/math/Vec2.Vec2.angle(a, b){number}

og/math/Vec2.js, line 133
Gets angle between two vectors.
Name Type Description
a math.Vec2 First vector.
b math.Vec2 Second vector.
Returns:
Type Description
number

staticmodule:og/math/Vec2.Vec2.div(a, b){math.Vec2}

og/math/Vec2.js, line 109
Returns vector components division product one to another.
Name Type Description
a math.Vec2 First vector.
b math.Vec2 Second vector.
Returns:
Type Description
math.Vec2

staticmodule:og/math/Vec2.Vec2.mul(a, b){math.Vec2}

og/math/Vec2.js, line 96
Returns two vectors production.
Name Type Description
a math.Vec2 First vector.
b math.Vec2 Second vector.
Returns:
Type Description
math.Vec2

staticmodule:og/math/Vec2.Vec2.orthoNormalize(normal, tangent){math.Vec2}

og/math/Vec2.js, line 144
Makes vectors normalized and orthogonal to each other.
Name Type Description
normal math.Vec2 Normal vector.
tangent math.Vec2 Tangent vector.
Returns:
Type Description
math.Vec2

staticmodule:og/math/Vec2.Vec2.proj_b_to_a(b, a){math.Vec2}

og/math/Vec2.js, line 122
Get projection of the first vector to the second.
Name Type Description
b math.Vec2 First vector.
a math.Vec2 Second vector.
Returns:
Type Description
math.Vec2

staticmodule:og/math/Vec2.Vec2.scale(a, scale){math.Vec2}

og/math/Vec2.js, line 83
Returns scaled vector.
Name Type Description
a math.Vec2 Input vector.
scale number Scale value.
Returns:
Type Description
math.Vec2

staticmodule:og/math/Vec2.Vec2.sub(a, b){math.Vec2}

og/math/Vec2.js, line 70
Returns two vectors subtraction.
Name Type Description
a math.Vec2 First vector.
b math.Vec2 Second vector.
Returns:
Type Description
math.Vec2 - Vectors subtraction.