Class DependencyNodeWithCache<CacheRecords, CacheNonEmpty>

Represents a node in the dependency tree. Node has a cache that is cleared when the node is updated.

Type Parameters

CacheRecords extends Record<string, Some | null> = Record<string, Some | null>
CacheNonEmpty extends boolean = false

Hierarchy

Objects.DependencyNode
- DependencyNodeWithCache
  - Objects.GeometryObject
  - Objects.Plane

Index

Constructors

constructor

new DependencyNodeWithCache<CacheRecords, CacheNonEmpty>(prameters): DependencyNodeWithCache<CacheRecords, CacheNonEmpty>
Type Parameters
- CacheRecords extends Record<string, null | Some> = Record<string, null | Some>
- CacheNonEmpty extends boolean = false
Parameters
- prameters: {
  cache: Interfaces.IterableCache<CacheRecords, CacheNonEmpty>;
  dependencies: Iterable<Interfaces.DependencyNode>;
  }
  - Readonly cache: Interfaces.IterableCache<CacheRecords, CacheNonEmpty>
  - Readonly dependencies: Iterable<Interfaces.DependencyNode>
Returns DependencyNodeWithCache<CacheRecords, CacheNonEmpty>
Overrides DependencyNode.constructor
- Defined in src/geometryObjects/dependencyNode.ts:93

Properties

`Protected` `Readonly` cache

cache: Interfaces.IterableCache<CacheRecords, CacheNonEmpty>

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

Methods

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

registerDependant

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

`Protected` registerDependency

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

update

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

Returns void
Overrides DependencyNode.update
- Defined in src/geometryObjects/dependencyNode.ts:100

Class DependencyNodeWithCache<CacheRecords, CacheNonEmpty>

Type Parameters

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

CacheNonEmpty extends boolean = false

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

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

CacheNonEmpty extends boolean = false

Parameters

prameters: { cache: Interfaces.IterableCache<CacheRecords, CacheNonEmpty>; dependencies: Iterable<Interfaces.DependencyNode>; }

Readonly cache: Interfaces.IterableCache<CacheRecords, CacheNonEmpty>

Readonly dependencies: Iterable<Interfaces.DependencyNode>

Returns DependencyNodeWithCache<CacheRecords, CacheNonEmpty>

Properties

Protected Readonly cache

Accessors

deepDependants

Returns Iterable<Interfaces.DependencyNode>

deepDependencies

Returns Iterable<Interfaces.DependencyNode>

dependants

Returns Iterable<Interfaces.DependencyNode>

dependencies

Returns Iterable<Interfaces.DependencyNode>

Methods

exists

Returns boolean

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

prameters: {
cache: Interfaces.IterableCache<CacheRecords, CacheNonEmpty>;
dependencies: Iterable<Interfaces.DependencyNode>;
}

`Readonly` cache: Interfaces.IterableCache<CacheRecords, CacheNonEmpty>

`Readonly` dependencies: Iterable<Interfaces.DependencyNode>

`Protected` `Readonly` cache

`Protected` registerDependency