Class AbstractEnum<States, CacheRecords>`Abstract`

An Enum represents a set of objects out of which only one can exist at a time.

Type Parameters

States extends Record<string, Interfaces.DependencyNodeObject>
CacheRecords extends Record<string, Some | null> = Record<string, Some | null>

Hierarchy

Objects.GeometryObject<CacheRecords>
- AbstractEnum
  - PointPointIntersection
  - Objects.LineLineIntersection

Implements

Interfaces.EnumObject<States>

Index

Constructors

constructor

new AbstractEnum<States, CacheRecords>(parameters): AbstractEnum<States, CacheRecords>
Type Parameters
- States extends Record<string, Interfaces.DependencyNodeObject>
- CacheRecords extends Record<string, null | Some> = Record<string, null | Some>
Parameters
- parameters: {
      cache: Interfaces.IterableCache<CacheRecords, true>;
      dependencies: Interfaces.DependencyNodeObject[];
      implementedInterfaces: Iterable<Interface>;
      plane: Interfaces.Plane;
  }
  - cache: Interfaces.IterableCache<CacheRecords, true>
  - dependencies: Interfaces.DependencyNodeObject[]
  - implementedInterfaces: Iterable<Interface>
  - plane: Interfaces.Plane
Returns AbstractEnum<States, CacheRecords>
Overrides GeometryObject.constructor
- Defined in src/geometryObjects/enum/abstractEnum.ts:13

Properties

`Protected` `Readonly` cache

cache: Interfaces.IterableCache<CacheRecords, true>

`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]
Implementation of EnumObject.currentState
- Defined in src/geometryObjects/enum/abstractEnum.ts:28

currentStateName

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

Returns keyof States
Implementation of EnumObject.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>
Implementation of EnumObject.deepDependants

Inherited from GeometryObject.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>
Implementation of EnumObject.deepDependencies

Inherited from GeometryObject.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>
Implementation of EnumObject.dependants

Inherited from GeometryObject.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>
Implementation of EnumObject.dependencies

Inherited from GeometryObject.dependencies
- Defined in src/geometryObjects/dependencyNode.ts:61

info

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

Returns GeometryObjectInfo
Implementation of EnumObject.info

Inherited from GeometryObject.info
- Defined in src/geometryObjects/geometryObject.ts:39

states

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

Returns States
Implementation of EnumObject.states
- Defined in src/geometryObjects/enum/abstractEnum.ts:20

Methods

`Protected` addImplementedInterfaces

addImplementedInterfaces(interfaces): void
Parameters
- interfaces: Iterable<Interface>
Returns void
Inherited from GeometryObject.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
Implementation of EnumObject.exists

Inherited from GeometryObject.exists
- Defined in src/geometryObjects/dependencyNode.ts:75

`Protected` getCurrentState

getCurrentState(): States[keyof States]
Returns States[keyof States]
- Defined in src/geometryObjects/enum/abstractEnum.ts:9

`Protected` `Abstract` getCurrentStateName

getCurrentStateName(): keyof States
Returns keyof States
- Defined in src/geometryObjects/enum/abstractEnum.ts:8

getImplementedInterfaces

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

Returns Iterable<Interface>
Implementation of EnumObject.getImplementedInterfaces

Inherited from GeometryObject.getImplementedInterfaces
- Defined in src/geometryObjects/geometryObject.ts:29

`Protected` `Abstract` getStates

getStates(): States
Returns States
- Defined in src/geometryObjects/enum/abstractEnum.ts:7

registerDependant

registerDependant(dependant): void
Registers a new dependant
Parameters
- dependant: Interfaces.DependencyNode
  
  The node that depends on this node.
Returns void
Implementation of EnumObject.registerDependant

Inherited from GeometryObject.registerDependant
- Defined in src/geometryObjects/dependencyNode.ts:57

`Protected` registerDependency

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

update

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

Returns void
Implementation of EnumObject.update

Inherited from GeometryObject.update
- Defined in src/geometryObjects/dependencyNode.ts:100

Class AbstractEnum<States, CacheRecords>Abstract

Type Parameters

States extends Record<string, Interfaces.DependencyNodeObject>

CacheRecords extends Record<string, Some | null> = Record<string, Some | null>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

States extends Record<string, Interfaces.DependencyNodeObject>

CacheRecords extends Record<string, null | Some> = Record<string, null | Some>

Parameters

parameters: { cache: Interfaces.IterableCache<CacheRecords, true>; dependencies: Interfaces.DependencyNodeObject[]; implementedInterfaces: Iterable<Interface>; plane: Interfaces.Plane; }

cache: Interfaces.IterableCache<CacheRecords, true>

dependencies: Interfaces.DependencyNodeObject[]

implementedInterfaces: Iterable<Interface>

plane: Interfaces.Plane

Returns AbstractEnum<States, CacheRecords>

Properties

Protected Readonly cache

Readonly objectType

Readonly plane

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 States[keyof States]

Protected Abstract getCurrentStateName

Returns keyof States

getImplementedInterfaces

Returns Iterable<Interface>

Protected Abstract getStates

Returns States

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

Class AbstractEnum<States, CacheRecords>`Abstract`

parameters: {
cache: Interfaces.IterableCache<CacheRecords, true>;
dependencies: Interfaces.DependencyNodeObject[];
implementedInterfaces: Iterable<Interface>;
plane: Interfaces.Plane;
}

`Protected` `Readonly` cache

`Readonly` objectType

`Readonly` plane

`Readonly` virtual

`Protected` addImplementedInterfaces

`Protected` getCurrentState

`Protected` `Abstract` getCurrentStateName

`Protected` `Abstract` getStates

`Protected` registerDependency