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

7.2 KiB
Raw Permalink Blame History

Planck.js API Doc › Globals › Vec3

Class: Vec3

Hierarchy

  • Vec3

Index

Constructors

Properties

  • (vec3.md#x)
  • y
  • z

Methods

Constructors

constructor

+ new Vec3(x: number, y: number, z: number): Vec3

Defined in src/common/Vec3.ts:36

Parameters:

Name Type
x number
y number
z number

Returns: Vec3

+ new Vec3(obj: object): Vec3

Defined in src/common/Vec3.ts:38

Parameters:

▪ obj: object

Name Type
x number
y number
z number

Returns: Vec3

+ new Vec3(): Vec3

Defined in src/common/Vec3.ts:39

Returns: Vec3

Properties

x

• x: number

Defined in src/common/Vec3.ts:34


y

• y: number

Defined in src/common/Vec3.ts:35


z

• z: number

Defined in src/common/Vec3.ts:36

Methods

add

▸ add(w: Vec3): Vec3

Defined in src/common/Vec3.ts:136

Parameters:

Name Type
w Vec3

Returns: Vec3


mul

▸ mul(m: number): Vec3

Defined in src/common/Vec3.ts:150

Parameters:

Name Type
m number

Returns: Vec3


neg

▸ neg(): Vec3

Defined in src/common/Vec3.ts:196

Returns: Vec3


set

▸ set(x: number, y: number, z: number): Vec3

Defined in src/common/Vec3.ts:129

Parameters:

Name Type
x number
y number
z number

Returns: Vec3


setZero

▸ setZero(): Vec3

Defined in src/common/Vec3.ts:122

Returns: Vec3


sub

▸ sub(w: Vec3): Vec3

Defined in src/common/Vec3.ts:143

Parameters:

Name Type
w Vec3

Returns: Vec3


toString

▸ toString(): string

Defined in src/common/Vec3.ts:103

Returns: string


Static add

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

Defined in src/common/Vec3.ts:184

Parameters:

Name Type
v Vec3
w Vec3

Returns: Vec3


Static areEqual

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

Defined in src/common/Vec3.ts:157

Parameters:

Name Type
v Vec3
w Vec3

Returns: boolean


Static assert

▸ assert(o: any): void

Defined in src/common/Vec3.ts:114

Parameters:

Name Type
o any

Returns: void


Static clone

▸ clone(v: Vec3): Vec3

Defined in src/common/Vec3.ts:98

Parameters:

Name Type
v Vec3

Returns: Vec3


Static cross

▸ cross(v: Vec3, w: Vec3): Vec3

Defined in src/common/Vec3.ts:176

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

Parameters:

Name Type
v Vec3
w Vec3

Returns: Vec3


Static dot

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

Defined in src/common/Vec3.ts:169

Perform the dot product on two vectors.

Parameters:

Name Type
v Vec3
w Vec3

Returns: number


Static isValid

▸ isValid(v: any): boolean

Defined in src/common/Vec3.ts:110

Does this vector contain finite coordinates?

Parameters:

Name Type
v any

Returns: boolean


Static mul

▸ mul(v: Vec3, m: number): Vec3

Defined in src/common/Vec3.ts:192

Parameters:

Name Type
v Vec3
m number

Returns: Vec3


Static neg

▸ neg(v: Vec3): Vec3

Defined in src/common/Vec3.ts:203

Parameters:

Name Type
v Vec3

Returns: Vec3


Static sub

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

Defined in src/common/Vec3.ts:188

Parameters:

Name Type
v Vec3
w Vec3

Returns: Vec3


Static zero

▸ zero(): Vec3

Defined in src/common/Vec3.ts:90

Returns: Vec3