Class GeometryObject<CacheRecords>`Abstract`

Represents a generic geometry object.

Type Parameters

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

The records the object caches.

Hierarchy

DependencyNodeWithCache<CacheRecords, true>
- GeometryObject

Implements

Index

Constructors

constructor

new GeometryObject<CacheRecords>(parameters): Objects.GeometryObject<CacheRecords>
Type Parameters
- CacheRecords extends Record<string, null | Some> = Record<string, null | Some>
Parameters
- parameters: {
      cache: Interfaces.IterableCache<CacheRecords, true>;
      dependencies: Iterable<Interfaces.DependencyNode>;
      implementedInterfaces: Iterable<Interface>;
      plane: Interfaces.Plane;
  }
  - Readonly cache: Interfaces.IterableCache<CacheRecords, true>
  - Readonly dependencies: Iterable<Interfaces.DependencyNode>
  - Readonly implementedInterfaces: Iterable<Interface>
  - Readonly plane: Interfaces.Plane
Returns Objects.GeometryObject<CacheRecords>
Overrides DependencyNodeWithCache.constructor
- Defined in src/geometryObjects/geometryObject.ts:17

Properties

`Protected` `Readonly` cache

cache: Interfaces.IterableCache<CacheRecords, true>

`Private` `Readonly` implementedInterfaces

implementedInterfaces: Set<Interface> = ...

`Readonly` `Abstract` objectType

objectType: ObjectType

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` `Abstract` virtual

virtual: boolean

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

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>
Implementation of DependencyNode.deepDependants

Inherited from DependencyNodeWithCache.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 DependencyNode.deepDependencies

Inherited from DependencyNodeWithCache.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 DependencyNode.dependants

Inherited from DependencyNodeWithCache.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 DependencyNode.dependencies

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

info

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

Returns GeometryObjectInfo
Implementation of GeometryObject.info
- Defined in src/geometryObjects/geometryObject.ts:39

Methods

`Protected` addImplementedInterfaces

addImplementedInterfaces(interfaces): void
Parameters
- interfaces: Iterable<Interface>
Returns void
- 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 DependencyNode.exists

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

getImplementedInterfaces

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

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

registerDependant

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

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

`Protected` registerDependency

registerDependency(dependency): void
Parameters
- dependency: Interfaces.DependencyNode
Returns void
Inherited from DependencyNodeWithCache.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 DependencyNode.update

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

Class GeometryObject<CacheRecords>Abstract

Type Parameters

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

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

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

Parameters

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

Readonly cache: Interfaces.IterableCache<CacheRecords, true>

Readonly dependencies: Iterable<Interfaces.DependencyNode>

Readonly implementedInterfaces: Iterable<Interface>

Readonly plane: Interfaces.Plane

Returns Objects.GeometryObject<CacheRecords>

Properties

Protected Readonly cache

Private Readonly implementedInterfaces

Readonly Abstract objectType

Readonly plane

Readonly Abstract 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

Methods

Protected addImplementedInterfaces

Parameters

interfaces: Iterable<Interface>

Returns void

exists

Returns boolean

getImplementedInterfaces

Returns Iterable<Interface>

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 GeometryObject<CacheRecords>`Abstract`

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

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

`Readonly` dependencies: Iterable<Interfaces.DependencyNode>

`Readonly` implementedInterfaces: Iterable<Interface>

`Readonly` plane: Interfaces.Plane

`Protected` `Readonly` cache

`Private` `Readonly` implementedInterfaces

`Readonly` `Abstract` objectType

`Readonly` plane

`Readonly` `Abstract` virtual

`Protected` addImplementedInterfaces

`Protected` registerDependency