Class AbstractNullObject<Virtual>`Abstract`

Represents a null object.
A null object can be the result of a calculation that has no result.

Type Parameters

Virtual extends boolean = boolean

Hierarchy

Objects.GeometryObject<{}>
- AbstractNullObject
  - PointPointIntersectionNull
  - LineLineIntersectionNull

Implements

Interfaces.NullObject<Virtual>

Index

Constructors

constructor

new AbstractNullObject<Virtual>(parameters): AbstractNullObject<Virtual>
Type Parameters
- Virtual extends boolean = boolean
Parameters
- parameters: {
  dependencies: Interfaces.DependencyNodeObject[];
  plane: Interfaces.Plane;
  }
  - dependencies: Interfaces.DependencyNodeObject[]
  - plane: Interfaces.Plane
Returns AbstractNullObject<Virtual>
Overrides GeometryObject.constructor
- Defined in src/geometryObjects/nullObject/abstractNullObject.ts:7

Properties

`Protected` `Readonly` cache

cache: Interfaces.IterableCache<{}, true>

Type declaration

`Readonly` objectType

objectType: "null" = "null"

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.

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

virtual

get virtual(): Virtual
Whether this object is virtual.
This is dependant on from what calculation this object is the result of.

Returns Virtual
Implementation of NullObject.virtual

Overrides GeometryObject.virtual
- Defined in src/geometryObjects/nullObject/abstractNullObject.ts:16

Methods

`Protected` addImplementedInterfaces

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

`Protected` `Abstract` doesExist

doesExist(): boolean
Returns boolean
- Defined in src/geometryObjects/nullObject/abstractNullObject.ts:15

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
Overrides GeometryObject.exists
- Defined in src/geometryObjects/nullObject/abstractNullObject.ts:20

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` isVirtual

isVirtual(): Virtual
Returns Virtual
- Defined in src/geometryObjects/nullObject/abstractNullObject.ts:14

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 AbstractNullObject<Virtual>Abstract

Type Parameters

Virtual extends boolean = boolean

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Virtual extends boolean = boolean

Parameters

parameters: { dependencies: Interfaces.DependencyNodeObject[]; plane: Interfaces.Plane; }

dependencies: Interfaces.DependencyNodeObject[]

plane: Interfaces.Plane

Returns AbstractNullObject<Virtual>

Properties

Protected Readonly cache

Type declaration

Readonly objectType

Readonly plane

Accessors

deepDependants

Returns Iterable<Interfaces.DependencyNode>

deepDependencies

Returns Iterable<Interfaces.DependencyNode>

dependants

Returns Iterable<Interfaces.DependencyNode>

dependencies

Returns Iterable<Interfaces.DependencyNode>

info

Returns GeometryObjectInfo

virtual

Returns Virtual

Methods

Protected addImplementedInterfaces

Parameters

interfaces: Iterable<Interface>

Returns void

Protected Abstract doesExist

Returns boolean

exists

Returns boolean

getImplementedInterfaces

Returns Iterable<Interface>

Protected Abstract isVirtual

Returns Virtual

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 AbstractNullObject<Virtual>`Abstract`

parameters: {
dependencies: Interfaces.DependencyNodeObject[];
plane: Interfaces.Plane;
}

`Protected` `Readonly` cache

`Readonly` objectType

`Readonly` plane

`Protected` addImplementedInterfaces

`Protected` `Abstract` doesExist

`Protected` `Abstract` isVirtual

`Protected` registerDependency