Interface EnumObject<States>

An Enum represents a set of objects out of which only one can exist at a time.

Type Parameters

Hierarchy

Implemented by

Properties

currentState: States[keyof States]

The current state of the enum.

currentStateName: keyof States

The name of the current state.

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.

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.

dependants: Iterable<Interfaces.DependencyNode>

All the nodes that depend on this node.

dependencies: Iterable<Interfaces.DependencyNode>

All the nodes that this node depends on.

Returns information about this object.

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.

Returns the plane this object is on.

states: States

The states of the enum.

virtual: boolean

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

Methods

Generated using TypeDoc