Class Vec2

Hierarchy

Vec<2>
- Vec2

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Vec2(points: TPoints<2>): Vec2

Overrides Vec.constructor
- Defined in main.ts:172
Parameters
- points: TPoints<2>
Returns Vec2

Properties

length

length: 2

points

points: TPoints<2>

Accessors

_unit

get _unit(): TPoints<Length>

Inherited from Vec._unit
- Defined in main.ts:157
Returns TPoints<Length>

size

get size(): number

Inherited from Vec.size
- Defined in main.ts:146
Gives the magnitude of the vector

Returns number

sum

get sum(): number

Inherited from Vec.sum
- Defined in main.ts:153
Gives the values of the vector summed up

Returns number

unit

get unit(): Vec2

Overrides Vec.unit
- Defined in main.ts:212
Returns Vec2

x

get x(): number
set x(val: number): void

- Defined in main.ts:196
Returns number
- Defined in main.ts:200
Parameters
- val: number
Returns void

y

get y(): number
set y(val: number): void

- Defined in main.ts:204
Returns number
- Defined in main.ts:208
Parameters
- val: number
Returns void

Methods

Protected _add

_add(rhs: Vec<2>): TPoints<2>

Inherited from Vec._add
- Defined in main.ts:35
throws
MismatchedSizeError

Parameters
- rhs: Vec<2>
Returns TPoints<2>

Protected _div

_div(rhs: Vec<2>): TPoints<2>

Inherited from Vec._div
- Defined in main.ts:104
throws
MismatchedSizeError

Parameters
- rhs: Vec<2>
Returns TPoints<2>

Protected _mul

_mul(rhs: Vec<2>): TPoints<2>

Inherited from Vec._mul
- Defined in main.ts:81
throws
MismatchedSizeError

Parameters
- rhs: Vec<2>
Returns TPoints<2>

Protected _pow

_pow(power: number): TPoints<2>

Inherited from Vec._pow
- Defined in main.ts:112
Parameters
- power: number
Returns TPoints<2>

Protected _sub

_sub(rhs: Vec<2>): TPoints<2>

Inherited from Vec._sub
- Defined in main.ts:58
throws
MismatchedSizeError

Parameters
- rhs: Vec<2>
Returns TPoints<2>

add

add(rhs: Vec<2>): Vec2

Overrides Vec.add
- Defined in main.ts:176
Adds two vectors together

Parameters
- rhs: Vec<2>
Returns Vec2

div

div(rhs: Vec<2>): Vec2

Overrides Vec.div
- Defined in main.ts:188
Divides each value of two vectors together

Parameters
- rhs: Vec<2>
Returns Vec2

dot

dot(rhs: Vec<2>): number

Inherited from Vec.dot
- Defined in main.ts:139
Gives the dot product of two vectors

throws
MismatchedSizeError

Parameters
- rhs: Vec<2>
Returns number

mul

mul(rhs: Vec<2>): Vec2

Overrides Vec.mul
- Defined in main.ts:184
Multiples each value of two vectors together

Parameters
- rhs: Vec<2>
Returns Vec2

pow

pow(power: number): Vec2

Overrides Vec.pow
- Defined in main.ts:192
Raises each element to the power given

Parameters
- power: number
Returns Vec2

sub

sub(rhs: Vec<2>): Vec2

Overrides Vec.sub
- Defined in main.ts:180
Subtracts two vectors togethers

Parameters
- rhs: Vec<2>
Returns Vec2

Static fromScalar

fromScalar<Length>(value: number, length: Length): Vec<Length>

Inherited from Vec.fromScalar
- Defined in main.ts:25
This function creates a vector where each element is the same value

Type Parameters
- Length extends number
Parameters
- value: number
  
  The value for each element to be
- length: Length
  
  The length of the vector
Returns Vec<Length>

Generated using TypeDoc