Class Vector2

Immutable 2D(x,y) Vector class with 32bit float components

Hierarchy

Vector2_<Float32ArrayConstructor>
- Vector2

Implements

Constructors

constructor

new Vector2(x: TypedArray): Vector2

Overrides Vector2_.constructor
- Defined in foundation/math/Vector2.ts:402
Parameters
- x: TypedArray
Returns Vector2

Properties

_v

_v: TypedArray = ...

Accessors

bytesPerComponent

get bytesPerComponent(): number

Implementation of IVector2.bytesPerComponent
Inherited from Vector2_.bytesPerComponent
- Defined in foundation/math/Vector2.ts:390
Returns number

className

get className(): string

Implementation of IVector2.className
Overrides Vector2_.className
- Defined in foundation/math/Vector2.ts:466
Returns string

glslStrAsFloat

get glslStrAsFloat(): string

Implementation of IVector2.glslStrAsFloat
Inherited from Vector2_.glslStrAsFloat
- Defined in foundation/math/Vector2.ts:36
Returns string

glslStrAsInt

get glslStrAsInt(): string

Implementation of IVector2.glslStrAsInt
Inherited from Vector2_.glslStrAsInt
- Defined in foundation/math/Vector2.ts:42
Returns string

x

get x(): number

Implementation of IVector2.x
Inherited from Vector2_.x
- Defined in foundation/math/Vector2.ts:28
Returns number

y

get y(): number

Implementation of IVector2.y
Inherited from Vector2_.y
- Defined in foundation/math/Vector2.ts:32
Returns number

Static compositionType

get compositionType(): CompositionTypeEnum

Inherited from Vector2_.compositionType
- Defined in foundation/math/Vector2.ts:46
Returns CompositionTypeEnum

Methods

at

at(i: number): number

Implementation of IVector2.at
Inherited from Vector2_.at
- Defined in foundation/math/Vector2.ts:313
Parameters
- i: number
Returns number

clone

clone(): Vector2

Implementation of IVector2.clone
Overrides Vector2_.clone
- Defined in foundation/math/Vector2.ts:470
Returns Vector2

dot

dot(vec: IVector2): number

Implementation of IVector2.dot
Inherited from Vector2_.dot
- Defined in foundation/math/Vector2.ts:334
dot product

Parameters
- vec: IVector2
Returns number

flattenAsArray

flattenAsArray(): number[]

Implementation of IVector2.flattenAsArray
Inherited from Vector2_.flattenAsArray
- Defined in foundation/math/Vector2.ts:282
Returns number[]

isDummy

isDummy(): boolean

Implementation of IVector2.isDummy
Inherited from Vector2_.isDummy
- Defined in foundation/math/Vector2.ts:286
Returns boolean

isEqual

isEqual(vec: IVector2, delta?: number): boolean

Implementation of IVector2.isEqual
Inherited from Vector2_.isEqual
- Defined in foundation/math/Vector2.ts:294
Parameters
- vec: IVector2
- delta: number = Number.EPSILON
Returns boolean

isStrictEqual

isStrictEqual(vec: IVector2): boolean

Implementation of IVector2.isStrictEqual
Inherited from Vector2_.isStrictEqual
- Defined in foundation/math/Vector2.ts:305
Parameters
- vec: IVector2
Returns boolean

isTheSourceSame

isTheSourceSame(arrayBuffer: ArrayBuffer): boolean

Implementation of IVector2.isTheSourceSame
Inherited from Vector2_.isTheSourceSame
- Defined in foundation/math/AbstractVector.ts:57
Parameters
- arrayBuffer: ArrayBuffer
Returns boolean

length

length(): number

Implementation of IVector2.length
Inherited from Vector2_.length
- Defined in foundation/math/Vector2.ts:317
Returns number

lengthSquared

lengthSquared(): number

Implementation of IVector2.lengthSquared
Inherited from Vector2_.lengthSquared
- Defined in foundation/math/Vector2.ts:321
Returns number

lengthTo

lengthTo(vec: IVector2): number

Implementation of IVector2.lengthTo
Inherited from Vector2_.lengthTo
- Defined in foundation/math/Vector2.ts:325
Parameters
- vec: IVector2
Returns number

toString

toString(): string

Implementation of IVector2.toString
Inherited from Vector2_.toString
- Defined in foundation/math/Vector2.ts:269
change to string

Returns string

toStringApproximately

toStringApproximately(): string

Implementation of IVector2.toStringApproximately
Inherited from Vector2_.toStringApproximately
- Defined in foundation/math/Vector2.ts:273
Returns string

v

v(i: number): number

Implementation of IVector2.v
Inherited from Vector2_.v
- Defined in foundation/math/AbstractVector.ts:53
Parameters
- i: number
Returns number

Static _add

_add(l_vec: IVector2, r_vec: IVector2, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._add
- Defined in foundation/math/Vector2.ts:94
add value（static version）

Parameters
- l_vec: IVector2
- r_vec: IVector2
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _divide

_divide(vec: IVector2, value: number, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._divide
- Defined in foundation/math/Vector2.ts:186
divide by value(static version)

Parameters
- vec: IVector2
- value: number
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _divideVector

_divideVector(l_vec: IVector2, r_vec: IVector2, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._divideVector
- Defined in foundation/math/Vector2.ts:222
divide by vector(static version)

Parameters
- l_vec: IVector2
- r_vec: IVector2
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _dummy

_dummy(type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._dummy
- Defined in foundation/math/Vector2.ts:79
Parameters
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _fromCopy2

_fromCopy2(x: number, y: number, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._fromCopy2
- Defined in foundation/math/Vector2.ts:351
Parameters
- x: number
- y: number
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _fromCopyArray

_fromCopyArray(array: number[], type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._fromCopyArray
- Defined in foundation/math/Vector2.ts:355
Parameters
- array: number[]
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _fromCopyArray2

_fromCopyArray2(array: Array2<number>, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._fromCopyArray2
- Defined in foundation/math/Vector2.ts:344
Parameters
- array: Array2<number>
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _fromCopyVector2

_fromCopyVector2(vec2: IVector2, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._fromCopyVector2
- Defined in foundation/math/Vector2.ts:369
Parameters
- vec2: IVector2
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _fromCopyVector3

_fromCopyVector3(vec3: IVector3, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._fromCopyVector3
- Defined in foundation/math/Vector2.ts:376
Parameters
- vec3: IVector3
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _fromCopyVector4

_fromCopyVector4(vec4: IVector4, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._fromCopyVector4
- Defined in foundation/math/Vector2.ts:383
Parameters
- vec4: IVector4
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _fromVector2

_fromVector2(vec2: IVector2, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._fromVector2
- Defined in foundation/math/Vector2.ts:362
Parameters
- vec2: IVector2
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _multiply

_multiply(vec: IVector2, value: number, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._multiply
- Defined in foundation/math/Vector2.ts:138
multiply value(static version)

Parameters
- vec: IVector2
- value: number
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _multiplyVector

_multiplyVector(l_vec: IVector2, r_vec: IVector2, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._multiplyVector
- Defined in foundation/math/Vector2.ts:160
multiply vector(static version)

Parameters
- l_vec: IVector2
- r_vec: IVector2
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _normalize

_normalize(vec: IVector2, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._normalize
- Defined in foundation/math/Vector2.ts:86
normalize(static version)

Parameters
- vec: IVector2
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _one

_one(type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._one
- Defined in foundation/math/Vector2.ts:75
Parameters
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _subtract

_subtract(l_vec: IVector2, r_vec: IVector2, type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._subtract
- Defined in foundation/math/Vector2.ts:116
subtract value(static version)

Parameters
- l_vec: IVector2
- r_vec: IVector2
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static _zero

_zero(type: FloatTypedArrayConstructor): Vector2_<FloatTypedArrayConstructor>

Inherited from Vector2_._zero
- Defined in foundation/math/Vector2.ts:71
Parameters
- type: FloatTypedArrayConstructor
Returns Vector2_<FloatTypedArrayConstructor>

Static add

add(l_vec: IVector2, r_vec: IVector2): Vector2

- Defined in foundation/math/Vector2.ts:442
Parameters
- l_vec: IVector2
- r_vec: IVector2
Returns Vector2

Static addTo

addTo(l_vec: IVector2, r_vec: IVector2, out: IMutableVector2): IMutableVector2

Inherited from Vector2_.addTo
- Defined in foundation/math/Vector2.ts:107
add value（static version）

Parameters
- l_vec: IVector2
- r_vec: IVector2
- out: IMutableVector2
Returns IMutableVector2

Static angleOfVectors

angleOfVectors(l_vec: IVector2, r_vec: IVector2): number

Inherited from Vector2_.angleOfVectors
- Defined in foundation/math/Vector2.ts:61
Parameters
- l_vec: IVector2
- r_vec: IVector2
Returns number

Static divide

divide(vec: IVector2, value: number): Vector2

- Defined in foundation/math/Vector2.ts:458
Parameters
- vec: IVector2
- value: number
Returns Vector2

Static divideTo

divideTo(vec: IVector2, value: number, out: IMutableVector2): IMutableVector2

Inherited from Vector2_.divideTo
- Defined in foundation/math/Vector2.ts:207
divide by value(static version)

Parameters
- vec: IVector2
- value: number
- out: IMutableVector2
Returns IMutableVector2

Static divideVector

divideVector(l_vec: IVector2, r_vec: IVector2): Vector2

- Defined in foundation/math/Vector2.ts:462
Parameters
- l_vec: IVector2
- r_vec: IVector2
Returns Vector2

Static divideVectorTo

divideVectorTo(l_vec: IVector2, r_vec: IVector2, out: IMutableVector2): IMutableVector2

Inherited from Vector2_.divideVectorTo
- Defined in foundation/math/Vector2.ts:243
divide by vector(static version)

Parameters
- l_vec: IVector2
- r_vec: IVector2
- out: IMutableVector2
Returns IMutableVector2

Static dot

dot(l_vec: IVector2, r_vec: IVector2): number

Inherited from Vector2_.dot
- Defined in foundation/math/Vector2.ts:262
dot product(static version)

Parameters
- l_vec: IVector2
- r_vec: IVector2
Returns number

Static dummy

dummy(): Vector2

- Defined in foundation/math/Vector2.ts:434
Returns Vector2

Static fromCopy2

fromCopy2(x: number, y: number): Vector2

- Defined in foundation/math/Vector2.ts:410
Parameters
- x: number
- y: number
Returns Vector2

Static fromCopyArray

fromCopyArray(array: number[]): Vector2

- Defined in foundation/math/Vector2.ts:414
Parameters
- array: number[]
Returns Vector2

Static fromCopyArray2

fromCopyArray2(array: Array2<number>): Vector2

- Defined in foundation/math/Vector2.ts:406
Parameters
- array: Array2<number>
Returns Vector2

Static fromCopyVector2

fromCopyVector2(vec2: IVector2): Vector2

- Defined in foundation/math/Vector2.ts:418
Parameters
- vec2: IVector2
Returns Vector2

Static fromCopyVector4

fromCopyVector4(vec4: IVector4): Vector2

- Defined in foundation/math/Vector2.ts:422
Parameters
- vec4: IVector4
Returns Vector2

Static lengthBtw

lengthBtw(l_vec: IVector2, r_vec: IVector2): number

Inherited from Vector2_.lengthBtw
- Defined in foundation/math/Vector2.ts:57
Parameters
- l_vec: IVector2
- r_vec: IVector2
Returns number

Static lengthSquared

lengthSquared(vec: IVector2): number

Inherited from Vector2_.lengthSquared
- Defined in foundation/math/Vector2.ts:53
to square length(static version)

Parameters
- vec: IVector2
Returns number

Static multiply

multiply(vec: IVector2, value: number): Vector2

- Defined in foundation/math/Vector2.ts:450
Parameters
- vec: IVector2
- value: number
Returns Vector2

Static multiplyTo

multiplyTo(vec: IVector2, value: number, out: IMutableVector2): IMutableVector2

Inherited from Vector2_.multiplyTo
- Defined in foundation/math/Vector2.ts:151
multiply value(static version)

Parameters
- vec: IVector2
- value: number
- out: IMutableVector2
Returns IMutableVector2

Static multiplyVector

multiplyVector(l_vec: IVector2, r_vec: IVector2): Vector2

- Defined in foundation/math/Vector2.ts:454
Parameters
- l_vec: IVector2
- r_vec: IVector2
Returns Vector2

Static multiplyVectorTo

multiplyVectorTo(l_vec: IVector2, r_vec: IVector2, out: IMutableVector2): IMutableVector2

Inherited from Vector2_.multiplyVectorTo
- Defined in foundation/math/Vector2.ts:173
multiply vector(static version)

Parameters
- l_vec: IVector2
- r_vec: IVector2
- out: IMutableVector2
Returns IMutableVector2

Static normalize

normalize(vec: IVector2): Vector2

- Defined in foundation/math/Vector2.ts:438
Parameters
- vec: IVector2
Returns Vector2

Static one

one(): Vector2

- Defined in foundation/math/Vector2.ts:430
Returns Vector2

Static subtract

subtract(l_vec: IVector2, r_vec: IVector2): Vector2

- Defined in foundation/math/Vector2.ts:446
Parameters
- l_vec: IVector2
- r_vec: IVector2
Returns Vector2

Static subtractTo

subtractTo(l_vec: IVector2, r_vec: IVector2, out: IMutableVector2): IMutableVector2

Inherited from Vector2_.subtractTo
- Defined in foundation/math/Vector2.ts:129
subtract value(static version)

Parameters
- l_vec: IVector2
- r_vec: IVector2
- out: IMutableVector2
Returns IMutableVector2

Static zero

zero(): Vector2

- Defined in foundation/math/Vector2.ts:426
Returns Vector2

Generated using TypeDoc