Class PointPointIntersection

Intersection of two points.

Hierarchy

AbstractEnum<{
    none: Interfaces.NullObjectDependencyNode<false>;
    point: Interfaces.PointObject;
}, {
    equal: boolean;
}>
- PointPointIntersection

Index

Constructors

constructor

new PointPointIntersection(parameters): PointPointIntersection
Parameters
- parameters: {
      plane: Interfaces.Plane;
      point1: Interfaces.PointObject;
      point2: Interfaces.PointObject;
  }
  - plane: Interfaces.Plane
  - point1: Interfaces.PointObject
  - point2: Interfaces.PointObject
Returns PointPointIntersection
Overrides AbstractEnum.constructor
- Defined in src/geometryObjects/intersections/bound/pointPoint/index.ts:24

Properties

`Protected` `Readonly` cache

cache: Interfaces.IterableCache<{
equal: boolean;
}, true>

Type declaration

equal: boolean

`Protected` `Readonly` nullObjectIntersection

nullObjectIntersection: PointPointIntersectionNull

`Readonly` objectType

objectType: "enum" = "enum"

Describes the type of this object.
This type is used when generic objects are used for calculations, and the type of the object is not known.
Example of this can be an intersection calculation.

`Readonly` plane

plane: Interfaces.Plane

Returns the plane this object is on.

`Readonly` virtual

virtual: false = false

Whether this object is virtual.
This is dependant on from what calculation this object is the result of.

Accessors

currentState

get currentState(): States[keyof States]
The current state of the enum.

Returns States[keyof States]
Inherited from AbstractEnum.currentState
- Defined in src/geometryObjects/enum/abstractEnum.ts:28

currentStateName

get currentStateName(): keyof States
The name of the current state.

Returns keyof States
Inherited from AbstractEnum.currentStateName
- Defined in src/geometryObjects/enum/abstractEnum.ts:24

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

info

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

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

states

get states(): States
The states of the enum.

Returns States
Inherited from AbstractEnum.states
- Defined in src/geometryObjects/enum/abstractEnum.ts:20

Methods

`Protected` addImplementedInterfaces

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

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 AbstractEnum.exists
- Defined in src/geometryObjects/dependencyNode.ts:75

`Protected` getCurrentState

getCurrentState(): Interfaces.PointObject | Interfaces.NullObjectDependencyNode<false>
Returns Interfaces.PointObject | Interfaces.NullObjectDependencyNode<false>
Inherited from AbstractEnum.getCurrentState
- Defined in src/geometryObjects/enum/abstractEnum.ts:9

`Protected` getCurrentStateName

getCurrentStateName(): "point" | "none"
Returns "point" | "none"
Overrides AbstractEnum.getCurrentStateName
- Defined in src/geometryObjects/intersections/bound/pointPoint/index.ts:69

getImplementedInterfaces

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

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

`Protected` getStates

getStates(): {
none: PointPointIntersectionNull;
point: PointPointIntersectionPoint;
}
Returns {
none: PointPointIntersectionNull;
point: PointPointIntersectionPoint;
}
- none: PointPointIntersectionNull
- point: PointPointIntersectionPoint
Overrides AbstractEnum.getStates
- Defined in src/geometryObjects/intersections/bound/pointPoint/index.ts:63

registerDependant

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

`Protected` registerDependency

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

update

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

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

Class PointPointIntersection

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: { plane: Interfaces.Plane; point1: Interfaces.PointObject; point2: Interfaces.PointObject; }

plane: Interfaces.Plane

point1: Interfaces.PointObject

point2: Interfaces.PointObject

Returns PointPointIntersection

Properties

Protected Readonly cache

Type declaration

equal: boolean

Protected Readonly nullObjectIntersection

Readonly objectType

Readonly plane

Protected Readonly point1

Protected Readonly point2

Protected Readonly pointIntersection

Readonly virtual

Accessors

currentState

Returns States[keyof States]

currentStateName

Returns keyof States

deepDependants

Returns Iterable<Interfaces.DependencyNode>

deepDependencies

Returns Iterable<Interfaces.DependencyNode>

dependants

Returns Iterable<Interfaces.DependencyNode>

dependencies

Returns Iterable<Interfaces.DependencyNode>

info

Returns GeometryObjectInfo

states

Returns States

Methods

Protected addImplementedInterfaces

Parameters

interfaces: Iterable<Interface>

Returns void

exists

Returns boolean

Protected getCurrentState

Returns Interfaces.PointObject | Interfaces.NullObjectDependencyNode<false>

Protected getCurrentStateName

Returns "point" | "none"

getImplementedInterfaces

Returns Iterable<Interface>

Protected getStates

Returns { none: PointPointIntersectionNull; point: PointPointIntersectionPoint; }

none: PointPointIntersectionNull

point: PointPointIntersectionPoint

registerDependant

Parameters

dependant: Interfaces.DependencyNode

Returns void

Protected registerDependency

Parameters

dependency: Interfaces.DependencyNode

Returns void

update

Returns void

Settings

Member Visibility

Theme

On This Page

parameters: {
plane: Interfaces.Plane;
point1: Interfaces.PointObject;
point2: Interfaces.PointObject;
}

`Protected` `Readonly` cache

`Protected` `Readonly` nullObjectIntersection

`Readonly` objectType

`Readonly` plane

`Protected` `Readonly` point1

`Protected` `Readonly` point2

`Protected` `Readonly` pointIntersection

`Readonly` virtual

`Protected` addImplementedInterfaces

`Protected` getCurrentState

`Protected` getCurrentStateName

`Protected` getStates

Returns {
none: PointPointIntersectionNull;
point: PointPointIntersectionPoint;
}

`Protected` registerDependency