Class PointFromTwoValues

Represents a point that is defined by two values - x and y.

Hierarchy

AbstractPoint
- PointFromTwoValues

Index

Constructors

Properties

cache objectType plane virtual xValue yValue

Accessors

deepDependants deepDependencies dependants dependencies distanceFromOrigin info x y

Methods

addImplementedInterfaces equals exists getImplementedInterfaces getX getY registerDependant registerDependency toVector update

Constructors

constructor

new PointFromTwoValues(parameters): PointFromTwoValues
Parameters
- parameters: {
      plane: Interfaces.Plane;
      x: Interfaces.ValueObject;
      y: Interfaces.ValueObject;
  }
  - Readonly plane: Interfaces.Plane
  - Readonly x: Interfaces.ValueObject
  - Readonly y: Interfaces.ValueObject
Returns PointFromTwoValues
Overrides AbstractPoint.constructor
- Defined in src/geometryObjects/point/pointFromTwoValues.ts:14

Properties

`Protected` `Readonly` cache

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

Type declaration

dist: number
nonExistantState: boolean
x: number
y: number

`Readonly` objectType

objectType: "point" = "point"

This object is of type point.

`Readonly` plane

plane: Interfaces.Plane

Returns the plane this object is on.

`Readonly` virtual

virtual: false = false

Whether this object is virtual.

`Private` `Readonly` xValue

xValue: Interfaces.Value

`Private` `Readonly` yValue

yValue: Interfaces.Value

Accessors

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 AbstractPoint.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 AbstractPoint.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 AbstractPoint.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 AbstractPoint.dependencies
- Defined in src/geometryObjects/dependencyNode.ts:61

distanceFromOrigin

get distanceFromOrigin(): number
Returns the distance from the origin.

Returns number
Inherited from AbstractPoint.distanceFromOrigin
- Defined in src/geometryObjects/point/abstractPoint.ts:47

info

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

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

x

get x(): number
X coordinate of the point.

Returns number
Inherited from AbstractPoint.x
- Defined in src/geometryObjects/point/abstractPoint.ts:39

y

get y(): number
Y coordinate of the point.

Returns number
Inherited from AbstractPoint.y
- Defined in src/geometryObjects/point/abstractPoint.ts:43

Methods

`Protected` addImplementedInterfaces

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

equals

equals(other): boolean
Whether this object is equal to another object.
If the objects are of a different type, this method should return false.
If the objects are of the same type, this method should return true if the objects are equal, and false if they are not.
Parameters
- other: Interfaces.NonVirtualObject
  
  The object to compare to.
Returns boolean
Inherited from AbstractPoint.equals
- Defined in src/geometryObjects/point/abstractPoint.ts:58

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 AbstractPoint.exists
- Defined in src/geometryObjects/point/abstractPoint.ts:51

getImplementedInterfaces

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

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

`Protected` getX

getX(): number
Returns number
Overrides AbstractPoint.getX
- Defined in src/geometryObjects/point/pointFromTwoValues.ts:21

`Protected` getY

getY(): number
Returns number
Overrides AbstractPoint.getY
- Defined in src/geometryObjects/point/pointFromTwoValues.ts:25

registerDependant

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

`Protected` registerDependency

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

toVector

toVector(): Interfaces.Vector
Returns the point as a Vector.

Returns Interfaces.Vector
Inherited from AbstractPoint.toVector
- Defined in src/geometryObjects/point/abstractPoint.ts:54

update

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

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

Generated using TypeDoc