Class AbstractInterval`Abstract`

Represents common behaviour of bound intervals.

Hierarchy

Objects.GeometryObject<{
    end: number;
    endClosed: boolean;
    length: number;
    nonExistantState: boolean;
    start: number;
    startClosed: boolean;
}>
- AbstractInterval

Implements

Interfaces.Interval
Interfaces.Evaluatable<number, boolean>

Index

Constructors

constructor

new AbstractInterval(parameters): AbstractInterval
Parameters
- parameters: {
  dependencies: Iterable<Interfaces.DependencyNode>;
  plane: Interfaces.Plane;
  }
  - dependencies: Iterable<Interfaces.DependencyNode>
  - plane: Interfaces.Plane
Returns AbstractInterval
Overrides GeometryObject.constructor
- Defined in src/geometryObjects/interval/abstractInterval.ts:18

Properties

`Protected` `Readonly` cache

cache: Interfaces.IterableCache<{
    end: number;
    endClosed: boolean;
    length: number;
    nonExistantState: boolean;
    start: number;
    startClosed: boolean;
}, true>

Type declaration

end: number
endClosed: boolean
length: number
nonExistantState: boolean
start: number
startClosed: boolean

`Readonly` objectType

objectType: "interval" = "interval"

This object is of type interval.

`Readonly` plane

plane: Interfaces.Plane

Returns the plane this object is on.

`Readonly` virtual

virtual: true = true

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

end

get end(): number
The end of the interval.

Returns number
Implementation of Interval.end
- Defined in src/geometryObjects/interval/abstractInterval.ts:45

endIncluded

get endIncluded(): boolean
Whether the end of the interval is closed.

Returns boolean
Implementation of Interval.endIncluded
- Defined in src/geometryObjects/interval/abstractInterval.ts:57

info

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

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

length

get length(): number
The length of the interval.

Returns number
Implementation of Interval.length
- Defined in src/geometryObjects/interval/abstractInterval.ts:53

start

get start(): number
The start of the interval.

Returns number
Implementation of Interval.start
- Defined in src/geometryObjects/interval/abstractInterval.ts:49

startIncluded

get startIncluded(): boolean
Whether the start of the interval is closed.

Returns boolean
Implementation of Interval.startIncluded
- Defined in src/geometryObjects/interval/abstractInterval.ts:61

Methods

`Protected` addImplementedInterfaces

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

evaluate

evaluate(parameter): boolean
Performs the evaluation. Should be a pure function.
Parameters
- parameter: number
  
  The input data.
Returns boolean
The output data.
Implementation of Evaluatable.evaluate
- Defined in src/geometryObjects/interval/abstractInterval.ts:81

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/interval/abstractInterval.ts:65

`Protected` `Abstract` getEnd

getEnd(): number
Returns number
- Defined in src/geometryObjects/interval/abstractInterval.ts:13

`Protected` `Abstract` getEndIncluded

getEndIncluded(): boolean
Returns boolean
- Defined in src/geometryObjects/interval/abstractInterval.ts:15

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

getStart(): number
Returns number
- Defined in src/geometryObjects/interval/abstractInterval.ts:14

`Protected` `Abstract` getStartIncluded

getStartIncluded(): boolean
Returns boolean
- Defined in src/geometryObjects/interval/abstractInterval.ts:16

isInside

isInside(value): boolean
Checks whether the given value is inside the interval.
Parameters
- value: number
  
  The value to check.
Returns boolean
Implementation of Interval.isInside
- Defined in src/geometryObjects/interval/abstractInterval.ts:69

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 AbstractIntervalAbstract

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: { dependencies: Iterable<Interfaces.DependencyNode>; plane: Interfaces.Plane; }

dependencies: Iterable<Interfaces.DependencyNode>

plane: Interfaces.Plane

Returns AbstractInterval

Properties

Protected Readonly cache

Type declaration

end: number

endClosed: boolean

length: number

nonExistantState: boolean

start: number

startClosed: boolean

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>

end

Returns number

endIncluded

Returns boolean

info

Returns GeometryObjectInfo

length

Returns number

start

Returns number

startIncluded

Returns boolean

Methods

Protected addImplementedInterfaces

Parameters

interfaces: Iterable<Interface>

Returns void

evaluate

Parameters

parameter: number

Returns boolean

exists

Returns boolean

Protected Abstract getEnd

Returns number

Protected Abstract getEndIncluded

Returns boolean

getImplementedInterfaces

Returns Iterable<Interface>

Protected Abstract getStart

Returns number

Protected Abstract getStartIncluded

Returns boolean

isInside

Parameters

value: number

Returns boolean

registerDependant

Parameters

dependant: Interfaces.DependencyNode

Returns void

Protected registerDependency

Parameters

dependency: Interfaces.DependencyNode

Class AbstractInterval`Abstract`

parameters: {
dependencies: Iterable<Interfaces.DependencyNode>;
plane: Interfaces.Plane;
}

`Protected` `Readonly` cache

`Readonly` objectType

`Readonly` plane

`Readonly` virtual

`Protected` addImplementedInterfaces

`Protected` `Abstract` getEnd

`Protected` `Abstract` getEndIncluded

`Protected` `Abstract` getStart

`Protected` `Abstract` getStartIncluded

`Protected` registerDependency