Class ReadonlyValue

Represents a readonly value.

Hierarchy

AbstractValue
- ReadonlyValue

Index

Constructors

Properties

cache internalValue objectType plane virtual

Accessors

deepDependants deepDependencies dependants dependencies info value

Methods

addImplementedInterfaces exists getImplementedInterfaces getValue registerDependant registerDependency update

Constructors

constructor

new ReadonlyValue(parameters): ReadonlyValue
Parameters
- parameters: {
  plane: Interfaces.Plane;
  value: number;
  }
  - plane: Interfaces.Plane
  - value: number
Returns ReadonlyValue
Overrides AbstractValue.constructor
- Defined in src/geometryObjects/value/readonlyValue.ts:12

Properties

`Protected` `Readonly` cache

cache: Interfaces.IterableCache<{
nonExistantState: boolean;
value: number;
}, true>

Type declaration

nonExistantState: boolean
value: number

`Private` `Readonly` internalValue

internalValue: number

`Readonly` objectType

objectType: "value" = "value"

This object is of type value.

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

info

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

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

value

get value(): number
Returns the value of this object.

Returns number
Inherited from AbstractValue.value
- Defined in src/geometryObjects/value/abstractValue.ts:29

Methods

`Protected` addImplementedInterfaces

addImplementedInterfaces(interfaces): void
Parameters
- interfaces: Iterable<Interface>
Returns void
Inherited from AbstractValue.addImplementedInterfaces
- 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
Inherited from AbstractValue.exists
- Defined in src/geometryObjects/value/abstractValue.ts:33

getImplementedInterfaces

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

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

`Protected` getValue

getValue(): number
Returns number
Overrides AbstractValue.getValue
- Defined in src/geometryObjects/value/readonlyValue.ts:18

registerDependant

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

`Protected` registerDependency

registerDependency(dependency): void
Parameters
- dependency: Interfaces.DependencyNode
Returns void
Inherited from AbstractValue.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 AbstractValue.update
- Defined in src/geometryObjects/dependencyNode.ts:100

Generated using TypeDoc