C

CellEntrance

Show Usages
This class describes the location and the direction from which a given PartitionCell has been entered during a path search.
Inheritance Hierarchy

Remarks

The path that was followed in order to reach a given PartitionCell can be reconstructed by traversing all previousEntrances. The enterInterval and enterDirection determine how the PartitionCell was entered.

Default Values of Properties

NameDefault
costs0
heuristicCosts0

Members

No filters for this type

Constructors

CellEntrance

(cell: PartitionCell)
Creates a new CellEntrance instance for a given PartitionCell.

Parameters

cell: PartitionCell
The PartitionCell that is entered

CellEntrance

(other: CellEntrance)
Creates a new CellEntrance instance that is a copy of a given other CellEntrance.

Parameters

other: CellEntrance
The CellEntrance to be copied.

Properties

cell

: PartitionCell
readonly
Gets the PartitionCell of this CellEntrance instance.
readonlyfinal

Property Value

The PartitionCell of this CellEntrance instance.

costs

: number
Gets or sets the costs for the implicit path given by the previousEntrances.
The costs must be non-negative.
final

Property Value

the costs for the implicit path given by the previousEntrances

Throws

Exception ({ name: 'ArgumentError' })
if the costs are negative

Default Value

The default value is: 0

enterDirection

: Direction
Gets or sets the direction from which this cell was entered.
conversionfinal

Property Value

The direction from which this cell was entered or null if this cell is a start entrance.

enterInterval

: OrthogonalInterval
Gets or sets the OrthogonalInterval that was used for entering this cell.
final

Property Value

The OrthogonalInterval used for entering this cell or null if it is a start entrance.

heuristicCosts

: number
Gets or sets the heuristic costs for the implicit path given by the previousEntrances.
Heuristic costs must be non-negative.
final

Property Value

the heuristic costs for the implicit path given by the previousEntrances

Throws

Exception ({ name: 'ArgumentError' })
if the heuristic costs are negative

Default Value

The default value is: 0

previousEdgeCellInfo

: EdgeCellInfo
Gets or sets the EdgeCellInfo describing how the previous PartitionCell was traversed.
final

Property Value

The EdgeCellInfo describing how the previous cell was traversed or null if this cell is a start entrance.

previousEntrance

: CellEntrance
Gets or sets the previous CellEntrance along the path that was traversed in order to reach the cell.
final

Property Value

The previous CellEntrance or null if this cell is a start entrance

Methods

toString

(): string
Returns a string representation of this CellEntrance.
final

Return Value

string
A string representation of this CellEntrance