API Reference / Vector
# Class: Vector
# Table of contents
# Constructors
# Properties
# Accessors
# Methods
- add
- distance
- dotProduct
- equal
- negate
- normalize
- release
- rotate
- scale
- set
- subtract
- transform
- create
- recycle
# Constructors
# constructor
• Protected
new Vector(x?
, y?
)
# Parameters
Name | Type |
---|---|
x? | number |
y? | number |
# Defined in
geom/Vector.ts:8 (opens new window)
# Properties
# x
• x: number
# Defined in
geom/Vector.ts:5 (opens new window)
# y
• y: number
# Defined in
geom/Vector.ts:6 (opens new window)
# $pool
▪ Static
Protected
Readonly
$pool: Vector
[] = []
# Defined in
geom/Vector.ts:110 (opens new window)
# Accessors
# angle
• get
angle(): number
# Returns
number
# Defined in
geom/Vector.ts:16 (opens new window)
# length
• get
length(): number
# Returns
number
# Defined in
geom/Vector.ts:12 (opens new window)
# Methods
# add
▸ add(v
): Vector
# Parameters
Name | Type |
---|---|
v | Vector |
# Returns
# Defined in
geom/Vector.ts:26 (opens new window)
▸ add(x
, y
): Vector
# Parameters
Name | Type |
---|---|
x | number |
y | number |
# Returns
# Defined in
geom/Vector.ts:27 (opens new window)
# distance
▸ distance(v
): number
# Parameters
Name | Type |
---|---|
v | Vector |
# Returns
number
# Defined in
geom/Vector.ts:97 (opens new window)
# dotProduct
▸ dotProduct(v
): number
# Parameters
Name | Type |
---|---|
v | Vector |
# Returns
number
# Defined in
geom/Vector.ts:52 (opens new window)
▸ dotProduct(x
, y
): number
# Parameters
Name | Type |
---|---|
x | number |
y | number |
# Returns
number
# Defined in
geom/Vector.ts:53 (opens new window)
# equal
▸ equal(v
): boolean
# Parameters
Name | Type |
---|---|
v | Vector |
# Returns
boolean
# Defined in
geom/Vector.ts:101 (opens new window)
# negate
▸ negate(): Vector
# Returns
# Defined in
geom/Vector.ts:69 (opens new window)
# normalize
▸ normalize(): Vector
# Returns
# Defined in
geom/Vector.ts:62 (opens new window)
# release
▸ release(): Vector
# Returns
# Defined in
geom/Vector.ts:105 (opens new window)
# rotate
▸ rotate(angle
): Vector
# Parameters
Name | Type |
---|---|
angle | number |
# Returns
# Defined in
geom/Vector.ts:81 (opens new window)
# scale
▸ scale(x
, y?
): Vector
# Parameters
Name | Type |
---|---|
x | number |
y? | number |
# Returns
# Defined in
geom/Vector.ts:75 (opens new window)
# set
▸ set(x
, y
): Vector
# Parameters
Name | Type |
---|---|
x | number |
y | number |
# Returns
# Defined in
geom/Vector.ts:20 (opens new window)
# subtract
▸ subtract(v
): Vector
# Parameters
Name | Type |
---|---|
v | Vector |
# Returns
# Defined in
geom/Vector.ts:39 (opens new window)
▸ subtract(x
, y
): Vector
# Parameters
Name | Type |
---|---|
x | number |
y | number |
# Returns
# Defined in
geom/Vector.ts:40 (opens new window)
# transform
▸ transform(m
): Vector
# Parameters
Name | Type |
---|---|
m | Matrix |
# Returns
# Defined in
geom/Vector.ts:89 (opens new window)
# create
▸ Static
create(x?
, y?
): Vector
# Parameters
Name | Type |
---|---|
x? | number |
y? | number |
# Returns
# Defined in
geom/Vector.ts:112 (opens new window)
# recycle
▸ Static
recycle(v
): void
# Parameters
Name | Type |
---|---|
v | Vector |
# Returns
void