Class UnboundVector

Class, that represents an unbound vector. This means, that the vector is not bound to a plane, nor is it a part of the dependency graph.

Hierarchy

UnboundVector

Implements

Interfaces.Vector

Index

Constructors

Properties

objectType virtual x y

Accessors

0 1

Methods

[iterator] add dotProduct multiplyByScalar normalize subtract toBare fromBare fromCoordinates fromVector

Constructors

constructor

new UnboundVector(parameters): UnboundVector
Parameters
- parameters: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
Returns UnboundVector
- Defined in src/geometryObjects/vector/unbound.ts:13

Properties

`Readonly` objectType

objectType: "vector" = "vector"

This object is of type vector.

`Readonly` virtual

virtual: true = true

Whether this object is virtual.

`Readonly` x

x: number

The x component of the vector.

`Readonly` y

y: number

The y component of the vector.

Accessors

0

get 0(): number
The x component of the vector.

Returns number
Implementation of Vector.0
- Defined in src/geometryObjects/vector/unbound.ts:54

1

get 1(): number
The y component of the vector.

Returns number
Implementation of Vector.1
- Defined in src/geometryObjects/vector/unbound.ts:58

Methods

[iterator]

[iterator](): IterableIterator<number>
Provides iteration over the vector.

Returns IterableIterator<number>
Implementation of Vector.[iterator]
- Defined in src/geometryObjects/vector/unbound.ts:22

add

add(vector): Interfaces.Vector
Adds to vectors to create a new vector.
Parameters
- vector: Interfaces.Vector
  
  Another vector.
Returns Interfaces.Vector
Implementation of Vector.add
- Defined in src/geometryObjects/vector/unbound.ts:27

dotProduct

dotProduct(vector): number
Calculates the dot product of this vector and another vector.
Parameters
- vector: Interfaces.Vector
  
  Another vector.
Returns number
Implementation of Vector.dotProduct
- Defined in src/geometryObjects/vector/unbound.ts:62

multiplyByScalar

multiplyByScalar(scalar): Interfaces.Vector
Multiplies the vector by a scalar to create a new vector.
Parameters
- scalar: number
  
  A scalar.
Returns Interfaces.Vector
Implementation of Vector.multiplyByScalar
- Defined in src/geometryObjects/vector/unbound.ts:40

normalize

normalize(length?): Interfaces.Vector
Normalizes the vector to a length, defaulting to 1, to create a new vector.
Parameters
- length: number = 1
  
  The length to normalize to.
Returns Interfaces.Vector
A new vector with the same direction as this vector and the given length.
Implementation of Vector.normalize
- Defined in src/geometryObjects/vector/unbound.ts:47

subtract

subtract(vector): Interfaces.Vector
Subtracts another vector from this vector to create a new vector.
Parameters
- vector: Interfaces.Vector
  
  Another vector.
Returns Interfaces.Vector
Implementation of Vector.subtract
- Defined in src/geometryObjects/vector/unbound.ts:33

toBare

toBare(): Interfaces.BareReadonlyVector
Returns the vector as a BareVector.

Returns Interfaces.BareReadonlyVector
Implementation of Vector.toBare
- Defined in src/geometryObjects/vector/unbound.ts:18

`Static` fromBare

fromBare(bareVector): Interfaces.Vector
Parameters
- bareVector: Interfaces.BareReadonlyVector
Returns Interfaces.Vector
- Defined in src/geometryObjects/vector/unbound.ts:72

`Static` fromCoordinates

fromCoordinates(x, y): Interfaces.Vector
Parameters
- x: number
- y: number
Returns Interfaces.Vector
- Defined in src/geometryObjects/vector/unbound.ts:83

`Static` fromVector

fromVector(vector): Interfaces.Vector
Parameters
- vector: Interfaces.Vector
Returns Interfaces.Vector
- Defined in src/geometryObjects/vector/unbound.ts:79

Generated using TypeDoc