Class AbstractUnion<Objects, CacheRecords>`Abstract`

Abstract base class for unions.

Type Parameters

Objects extends NonVirtualGeometryObject[]
CacheRecords extends Record<string, Some | null> = Record<string, Some | null>

Hierarchy

Objects.GeometryObject<CacheRecords>
- AbstractUnion

Implements

Interfaces.Union<Objects>

Index

Constructors

constructor

new AbstractUnion<Objects, CacheRecords>(parameters): AbstractUnion<Objects, CacheRecords>
Type Parameters
- Objects extends NonVirtualGeometryObject<NonVirtualObjectType>[]
- 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 AbstractUnion<Objects, CacheRecords>
Overrides GeometryObject.constructor
- Defined in src/geometryObjects/union/abstractUnion.ts:13

Properties

`Protected` `Readonly` cache

cache: Interfaces.IterableCache<CacheRecords, true>

`Readonly` objectType

objectType: "union" = "union"

The type of the union.

`Readonly` plane

plane: Interfaces.Plane

Returns the plane this object is on.

`Readonly` virtual

virtual: false = false

Whether this object is virtual.

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

info

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

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

objects

get objects(): Objects
The objects that make up the union.

Returns Objects
Implementation of Union.objects
- Defined in src/geometryObjects/union/abstractUnion.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

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
Implementation of Union.equals
- Defined in src/geometryObjects/union/abstractUnion.ts:27

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

getImplementedInterfaces

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

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

`Protected` `Abstract` getObjects

getObjects(): Objects
Returns Objects
- Defined in src/geometryObjects/union/abstractUnion.ts:11

registerDependant

registerDependant(dependant): void
Registers a new dependant
Parameters
- dependant: Interfaces.DependencyNode
  
  The node that depends on this node.
Returns void
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
Inherited from GeometryObject.update
- Defined in src/geometryObjects/dependencyNode.ts:100

Class AbstractUnion<Objects, CacheRecords>Abstract

Type Parameters

Objects extends NonVirtualGeometryObject[]

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

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Objects extends NonVirtualGeometryObject<NonVirtualObjectType>[]

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 AbstractUnion<Objects, CacheRecords>

Properties

Protected Readonly cache

Readonly objectType

Readonly plane

Readonly virtual

Accessors

deepDependants

Returns Iterable<Interfaces.DependencyNode>

deepDependencies

Returns Iterable<Interfaces.DependencyNode>

dependants

Returns Iterable<Interfaces.DependencyNode>

dependencies

Returns Iterable<Interfaces.DependencyNode>

info

Returns GeometryObjectInfo

objects

Returns Objects

Methods

Protected addImplementedInterfaces

Parameters

interfaces: Iterable<Interface>

Returns void

equals

Parameters

other: Interfaces.NonVirtualObject

Returns boolean

exists

Returns boolean

getImplementedInterfaces

Returns Iterable<Interface>

Protected Abstract getObjects

Returns Objects

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 AbstractUnion<Objects, 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` `Abstract` getObjects

`Protected` registerDependency