2021-05-11 18:30:36 -07:00

18 KiB
Raw Permalink Blame History

Planck.js API Doc › Globals › Vec2

Class: Vec2

Hierarchy

  • Vec2

Index

Constructors

Properties

  • (vec2.md#x)
  • y

Methods

Constructors

constructor

+ new Vec2(x: number, y: number): Vec2

Defined in src/common/Vec2.ts:35

Parameters:

Name Type
x number
y number

Returns: Vec2

+ new Vec2(obj: object): Vec2

Defined in src/common/Vec2.ts:37

Parameters:

▪ obj: object

Name Type
x number
y number

Returns: Vec2

+ new Vec2(): Vec2

Defined in src/common/Vec2.ts:38

Returns: Vec2

Properties

x

• x: number

Defined in src/common/Vec2.ts:34


y

• y: number

Defined in src/common/Vec2.ts:35

Methods

add

▸ add(w: Vec2): Vec2

Defined in src/common/Vec2.ts:196

Add a vector to this vector.

Parameters:

Name Type
w Vec2

Returns: Vec2

this


addCombine

▸ addCombine(a: number, v: Vec2, b: number, w: Vec2): Vec2

Defined in src/common/Vec2.ts:218

Add linear combination of v and w: a * v + b * w

Parameters:

Name Type
a number
v Vec2
b number
w Vec2

Returns: Vec2


addMul

▸ addMul(a: number, v: Vec2): Vec2

Defined in src/common/Vec2.ts:233

Parameters:

Name Type
a number
v Vec2

Returns: Vec2


clamp

▸ clamp(max: number): Vec2

Defined in src/common/Vec2.ts:519

Parameters:

Name Type
max number

Returns: Vec2


clone

▸ clone(): Vec2

Defined in src/common/Vec2.ts:114

Returns: Vec2


length

▸ length(): number

Defined in src/common/Vec2.ts:311

Get the length of this vector (the norm).

For performance, use this instead of lengthSquared (if possible).

Returns: number


lengthSquared

▸ lengthSquared(): number

Defined in src/common/Vec2.ts:318

Get the length squared.

Returns: number


mul

▸ mul(m: number): Vec2

Defined in src/common/Vec2.ts:299

Multiply this vector by a scalar.

Parameters:

Name Type
m number

Returns: Vec2

this


neg

▸ neg(): Vec2

Defined in src/common/Vec2.ts:485

Returns: Vec2


normalize

▸ normalize(): number

Defined in src/common/Vec2.ts:327

Convert this vector into a unit vector.

Returns: number

old length


set

▸ set(x: number, y: number): Vec2

Defined in src/common/Vec2.ts:129

Set this vector to some specified coordinates.

Parameters:

Name Type
x number
y number

Returns: Vec2

this

▸ set(value: Vec2): Vec2

Defined in src/common/Vec2.ts:130

Set this vector to some specified coordinates.

Parameters:

Name Type
value Vec2

Returns: Vec2

this


setCombine

▸ setCombine(a: number, v: Vec2, b: number, w: Vec2): Vec2

Defined in src/common/Vec2.ts:166

Set linear combination of v and w: a * v + b * w

Parameters:

Name Type
a number
v Vec2
b number
w Vec2

Returns: Vec2


setMul

▸ setMul(a: number, v: Vec2): Vec2

Defined in src/common/Vec2.ts:180

Parameters:

Name Type
a number
v Vec2

Returns: Vec2


setZero

▸ setZero(): Vec2

Defined in src/common/Vec2.ts:123

Set this vector to all zeros.

Returns: Vec2

this


sub

▸ sub(w: Vec2): Vec2

Defined in src/common/Vec2.ts:287

Subtract a vector from this vector

Parameters:

Name Type
w Vec2

Returns: Vec2

this


subCombine

▸ subCombine(a: number, v: Vec2, b: number, w: Vec2): Vec2

Defined in src/common/Vec2.ts:257

Subtract linear combination of v and w: a * v + b * w

Parameters:

Name Type
a number
v Vec2
b number
w Vec2

Returns: Vec2


subMul

▸ subMul(a: number, v: Vec2): Vec2

Defined in src/common/Vec2.ts:271

Parameters:

Name Type
a number
v Vec2

Returns: Vec2


toString

▸ toString(): string

Defined in src/common/Vec2.ts:95

Returns: string


wSub

▸ wSub(a: number, v: Vec2, b?: number, w?: Vec2): Vec2

Defined in src/common/Vec2.ts:247

deprecated Use subCombine or subMul

Parameters:

Name Type
a number
v Vec2
b? number
w? Vec2

Returns: Vec2


Static abs

▸ abs(v: Vec2): Vec2

Defined in src/common/Vec2.ts:496

Parameters:

Name Type
v Vec2

Returns: Vec2


Static add

▸ add(v: Vec2, w: Vec2): Vec2

Defined in src/common/Vec2.ts:444

Parameters:

Name Type
v Vec2
w Vec2

Returns: Vec2


Static addCross

▸ addCross(a: Vec2, v: Vec2, w: number): Vec2

Defined in src/common/Vec2.ts:423

Returns a + (v x w)

Parameters:

Name Type
a Vec2
v Vec2
w number

Returns: Vec2

▸ addCross(a: Vec2, v: number, w: Vec2): Vec2

Defined in src/common/Vec2.ts:424

Returns a + (v x w)

Parameters:

Name Type
a Vec2
v number
w Vec2

Returns: Vec2


Static areEqual

▸ areEqual(v: Vec2, w: Vec2): boolean

Defined in src/common/Vec2.ts:372

Parameters:

Name Type
v Vec2
w Vec2

Returns: boolean


Static assert

▸ assert(o: any): void

Defined in src/common/Vec2.ts:106

Parameters:

Name Type
o any

Returns: void


Static clamp

▸ clamp(v: Vec2, max: number): Vec2

Defined in src/common/Vec2.ts:529

Parameters:

Name Type
v Vec2
max number

Returns: Vec2


Static clone

▸ clone(v: Vec2): Vec2

Defined in src/common/Vec2.ts:90

Parameters:

Name Type
v Vec2

Returns: Vec2


Static combine

▸ combine(a: number, v: Vec2, b: number, w: Vec2): Vec2

Defined in src/common/Vec2.ts:459

Parameters:

Name Type
a number
v Vec2
b number
w Vec2

Returns: Vec2


Static cross

▸ cross(v: Vec2, w: Vec2): number

Defined in src/common/Vec2.ts:395

Perform the cross product on two vectors. In 2D this produces a scalar.

Perform the cross product on a vector and a scalar. In 2D this produces a vector.

Parameters:

Name Type
v Vec2
w Vec2

Returns: number

▸ cross(v: Vec2, w: number): Vec2

Defined in src/common/Vec2.ts:396

Perform the cross product on two vectors. In 2D this produces a scalar.

Perform the cross product on a vector and a scalar. In 2D this produces a vector.

Parameters:

Name Type
v Vec2
w number

Returns: Vec2

▸ cross(v: number, w: Vec2): Vec2

Defined in src/common/Vec2.ts:397

Perform the cross product on two vectors. In 2D this produces a scalar.

Perform the cross product on a vector and a scalar. In 2D this produces a vector.

Parameters:

Name Type
v number
w Vec2

Returns: Vec2


Static distance

▸ distance(v: Vec2, w: Vec2): number

Defined in src/common/Vec2.ts:356

Parameters:

Name Type
v Vec2
w Vec2

Returns: number


Static distanceSquared

▸ distanceSquared(v: Vec2, w: Vec2): number

Defined in src/common/Vec2.ts:364

Parameters:

Name Type
v Vec2
w Vec2

Returns: number


Static dot

▸ dot(v: Vec2, w: Vec2): number

Defined in src/common/Vec2.ts:389

Perform the dot product on two vectors.

Parameters:

Name Type
v Vec2
w Vec2

Returns: number


Static isValid

▸ isValid(v: any): boolean

Defined in src/common/Vec2.ts:102

Does this vector contain finite coordinates?

Parameters:

Name Type
v any

Returns: boolean


Static lengthOf

▸ lengthOf(v: Vec2): number

Defined in src/common/Vec2.ts:343

Get the length of this vector (the norm).

For performance, use this instead of lengthSquared (if possible).

Parameters:

Name Type
v Vec2

Returns: number


Static lengthSquared

▸ lengthSquared(v: Vec2): number

Defined in src/common/Vec2.ts:351

Get the length squared.

Parameters:

Name Type
v Vec2

Returns: number


Static lower

▸ lower(v: Vec2, w: Vec2): Vec2

Defined in src/common/Vec2.ts:513

Parameters:

Name Type
v Vec2
w Vec2

Returns: Vec2


Static mid

▸ mid(v: Vec2, w: Vec2): Vec2

Defined in src/common/Vec2.ts:501

Parameters:

Name Type
v Vec2
w Vec2

Returns: Vec2


Static mul

▸ mul(a: Vec2, b: number): Vec2

Defined in src/common/Vec2.ts:469

Parameters:

Name Type
a Vec2
b number

Returns: Vec2

▸ mul(a: number, b: Vec2): Vec2

Defined in src/common/Vec2.ts:470

Parameters:

Name Type
a number
b Vec2

Returns: Vec2


Static neg

▸ neg(v: Vec2): Vec2

Defined in src/common/Vec2.ts:491

Parameters:

Name Type
v Vec2

Returns: Vec2


Static skew

▸ skew(v: Vec2): Vec2

Defined in src/common/Vec2.ts:381

Get the skew vector such that dot(skew_vec, other) == cross(vec, other)

Parameters:

Name Type
v Vec2

Returns: Vec2


Static sub

▸ sub(v: Vec2, w: Vec2): Vec2

Defined in src/common/Vec2.ts:463

Parameters:

Name Type
v Vec2
w Vec2

Returns: Vec2


Static upper

▸ upper(v: Vec2, w: Vec2): Vec2

Defined in src/common/Vec2.ts:507

Parameters:

Name Type
v Vec2
w Vec2

Returns: Vec2


Static zero

▸ zero(): Vec2

Defined in src/common/Vec2.ts:75

Returns: Vec2