Class VectorFromCoordinates

Defines all the common functionality of a vector.

Hierarchy

AbstractVector
- VectorFromCoordinates

Index

Constructors

constructor

new VectorFromCoordinates(parameters): VectorFromCoordinates
Parameters
- parameters: {
      plane: Interfaces.Plane;
      x: number;
      y: number;
  }
  - plane: Interfaces.Plane
  - x: number
  - y: number
Returns VectorFromCoordinates
Overrides AbstractVector.constructor
- Defined in src/geometryObjects/vector/vectorFromCoordinates.ts:9

Properties

`Protected` `Readonly` cache

cache: Interfaces.IterableCache<{
    nonExistantState: boolean;
    x: number;
    y: number;
}, true>

Type declaration

nonExistantState: boolean
x: number
y: number

`Readonly` lenght

lenght: 2 = 2

`Readonly` objectType

objectType: "vector" = "vector"

This object is of type vector.

`Readonly` plane

plane: Interfaces.Plane

Returns the plane this object is on.

`Readonly` virtual

virtual: true = true

Whether this object is virtual.

`Private` xValue

xValue: number

`Private` yValue

yValue: number

Accessors

0

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

Returns number
Inherited from AbstractVector.0
- Defined in src/geometryObjects/vector/abstractVector.ts:45

1

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

Returns number
Inherited from AbstractVector.1
- Defined in src/geometryObjects/vector/abstractVector.ts:49

deepDependants

get deepDependants(): Iterable<Interfaces.DependencyNode>
All the nodes that depend on this node, and all the nodes that those nodes depend on, and so on. Uses a depth-first search.

Returns Iterable<Interfaces.DependencyNode>
Inherited from AbstractVector.deepDependants
- Defined in src/geometryObjects/dependencyNode.ts:71

deepDependencies

get deepDependencies(): Iterable<Interfaces.DependencyNode>
All the nodes that this node depends on, and all the nodes that depend on those nodes, and so on. Uses a depth-first search.

Returns Iterable<Interfaces.DependencyNode>
Inherited from AbstractVector.deepDependencies
- Defined in src/geometryObjects/dependencyNode.ts:68

dependants

get dependants(): Iterable<Interfaces.DependencyNode>
All the nodes that depend on this node.

Returns Iterable<Interfaces.DependencyNode>
Inherited from AbstractVector.dependants
- Defined in src/geometryObjects/dependencyNode.ts:64

dependencies

get dependencies(): Iterable<Interfaces.DependencyNode>
All the nodes that this node depends on.

Returns Iterable<Interfaces.DependencyNode>
Inherited from AbstractVector.dependencies
- Defined in src/geometryObjects/dependencyNode.ts:61

info

get info(): GeometryObjectInfo
Returns information about this object.

Returns GeometryObjectInfo
Inherited from AbstractVector.info
- Defined in src/geometryObjects/geometryObject.ts:39

x

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

Returns number
Overrides AbstractVector.x
- Defined in src/geometryObjects/vector/vectorFromCoordinates.ts:21
set x(value): void
Parameters
- value: number
Returns void
Overrides AbstractVector.x
- Defined in src/geometryObjects/vector/vectorFromCoordinates.ts:24

y

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

Returns number
Overrides AbstractVector.y
- Defined in src/geometryObjects/vector/vectorFromCoordinates.ts:28
set y(value): void
Parameters
- value: number
Returns void
Overrides AbstractVector.y
- Defined in src/geometryObjects/vector/vectorFromCoordinates.ts:31

Methods

[iterator]

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

Returns IterableIterator<number>
Inherited from AbstractVector.[iterator]
- Defined in src/geometryObjects/vector/abstractVector.ts:53

add

add(vector): Interfaces.Vector
Adds to vectors to create a new vector.
Parameters
- vector: Interfaces.Vector
  
  Another vector.
Returns Interfaces.Vector
Inherited from AbstractVector.add
- Defined in src/geometryObjects/vector/abstractVector.ts:66

`Protected` addImplementedInterfaces

addImplementedInterfaces(interfaces): void
Parameters
- interfaces: Iterable<Interface>
Returns void
Inherited from AbstractVector.addImplementedInterfaces
- Defined in src/geometryObjects/geometryObject.ts:33

dotProduct

dotProduct(vector): number
Calculates the dot product of this vector and another vector.
Parameters
- vector: Interfaces.Vector
  
  Another vector.
Returns number
Inherited from AbstractVector.dotProduct
- Defined in src/geometryObjects/vector/abstractVector.ts:93

exists

exists(): boolean
Returns true if the node exists, false otherwise.
false is returned when a node, that normally exists, encounters a special case where it does not exist.

Returns boolean
Inherited from AbstractVector.exists
- Defined in src/geometryObjects/vector/abstractVector.ts:62

getImplementedInterfaces

getImplementedInterfaces(): Iterable<Interface>
Returns the runtime representationinterfaces implemented by this object.

Returns Iterable<Interface>
Inherited from AbstractVector.getImplementedInterfaces
- Defined in src/geometryObjects/geometryObject.ts:29

getX

getX(): number
Returns number
Overrides AbstractVector.getX
- Defined in src/geometryObjects/vector/vectorFromCoordinates.ts:14

getY

getY(): number
Returns number
Overrides AbstractVector.getY
- Defined in src/geometryObjects/vector/vectorFromCoordinates.ts:17

multiplyByScalar

multiplyByScalar(scalar): Interfaces.Vector
Multiplies the vector by a scalar to create a new vector.
Parameters
- scalar: number
  
  A scalar.
Returns Interfaces.Vector
Inherited from AbstractVector.multiplyByScalar
- Defined in src/geometryObjects/vector/abstractVector.ts:79

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.
Inherited from AbstractVector.normalize
- Defined in src/geometryObjects/vector/abstractVector.ts:86

registerDependant

registerDependant(dependant): void
Registers a new dependant
Parameters
- dependant: Interfaces.DependencyNode
  
  The node that depends on this node.
Returns void
Inherited from AbstractVector.registerDependant
- Defined in src/geometryObjects/dependencyNode.ts:57

`Protected` registerDependency

registerDependency(dependency): void
Parameters
- dependency: Interfaces.DependencyNode
Returns void
Inherited from AbstractVector.registerDependency
- Defined in src/geometryObjects/dependencyNode.ts:20

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
Inherited from AbstractVector.subtract
- Defined in src/geometryObjects/vector/abstractVector.ts:72

toBare

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

Returns Interfaces.BareReadonlyVector
Inherited from AbstractVector.toBare
- Defined in src/geometryObjects/vector/abstractVector.ts:58

update

update(): void
Updates the node and all the nodes that depend on it.

Returns void
Inherited from AbstractVector.update
- Defined in src/geometryObjects/dependencyNode.ts:100

Class VectorFromCoordinates

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: { plane: Interfaces.Plane; x: number; y: number; }

plane: Interfaces.Plane

x: number

y: number

Returns VectorFromCoordinates

Properties

Protected Readonly cache

Type declaration

nonExistantState: boolean

x: number

y: number

Readonly lenght

Readonly objectType

Readonly plane

Readonly virtual

Private xValue

Private yValue

Accessors

0

Returns number

1

Returns number

deepDependants

Returns Iterable<Interfaces.DependencyNode>

deepDependencies

Returns Iterable<Interfaces.DependencyNode>

dependants

Returns Iterable<Interfaces.DependencyNode>

dependencies

Returns Iterable<Interfaces.DependencyNode>

info

Returns GeometryObjectInfo

x

Returns number

Parameters

value: number

Returns void

y

Returns number

Parameters

value: number

Returns void

Methods

[iterator]

Returns IterableIterator<number>

add

Parameters

vector: Interfaces.Vector

Returns Interfaces.Vector

Protected addImplementedInterfaces

Parameters

interfaces: Iterable<Interface>

Returns void

dotProduct

Parameters

vector: Interfaces.Vector

Returns number

exists

Returns boolean

getImplementedInterfaces

Returns Iterable<Interface>

getX

Returns number

getY

Returns number

multiplyByScalar

Parameters

scalar: number

Returns Interfaces.Vector

normalize

parameters: {
plane: Interfaces.Plane;
x: number;
y: number;
}

`Protected` `Readonly` cache

`Readonly` lenght

`Readonly` objectType

`Readonly` plane

`Readonly` virtual

`Private` xValue

`Private` yValue

`Protected` addImplementedInterfaces

`Protected` registerDependency