Packagecom.yworks.yfiles.layout.router.polyline
Classpublic class CellEntrance
InheritanceCellEntrance Inheritance YObject Inheritance Object

Describes where and from which direction a com.yworks.yfiles.layout.router.polyline.PartitionCell has been entered during a path search. The path to reach the cell can be reconstructed by traversing the previous entrances (previousEntrance). The enter interval (enterInterval) and enter direction (enterDirection) determine how the cell was entered.

See also

com.yworks.yfiles.layout.router.polyline.PartitionCell
previous entrances
enter interval
enter direction


Public Properties
 PropertyDefined By
  cell : PartitionCell
[read-only] Returns this entrance's partition cell.
CellEntrance
  costs : Number
Specifies the costs for the implicit path given by the previous entrances (previousEntrance).
CellEntrance
  enterDirection : Direction
Specifies the direction from which this cell was entered.
CellEntrance
  enterInterval : OrthogonalInterval
Specifies the com.yworks.yfiles.layout.router.polyline.OrthogonalInterval that was used to enter this cell.
CellEntrance
  heuristicCosts : Number
CellEntrance
  previousEdgeCellInfo : EdgeCellInfo
Specifies the com.yworks.yfiles.layout.router.polyline.EdgeCellInfo describing how the previous cell was crossed.
CellEntrance
  previousEntrance : CellEntrance
Specifies the previous com.yworks.yfiles.layout.router.polyline.CellEntrance in the path that reached this cell.
CellEntrance
Public Methods
 MethodDefined By
  
CellEntrance(other:CellEntrance, init:Boolean = true)
Creates a copy of the given CellEntrance.
CellEntrance
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
CellEntrance
 Inherited
hashCode():int
YObject
  
[static] Creates a copy of the given CellEntrance.
CellEntrance
  
[static] Creates a new instance.
CellEntrance
  
toString():String
CellEntrance
Protected Methods
 MethodDefined By
  
Initializes this object.
CellEntrance
  
Initializes this object.
CellEntrance
Property Detail
cellproperty
cell:PartitionCell  [read-only]

Returns this entrance's partition cell.


Implementation
    public function get cell():PartitionCell
costsproperty 
costs:Number

Specifies the costs for the implicit path given by the previous entrances (previousEntrance).


Implementation
    public function get costs():Number
    public function set costs(value:Number):void

See also

enterDirectionproperty 
enterDirection:Direction

Specifies the direction from which this cell was entered.


Implementation
    public function get enterDirection():Direction
    public function set enterDirection(value:Direction):void
enterIntervalproperty 
enterInterval:OrthogonalInterval

Specifies the com.yworks.yfiles.layout.router.polyline.OrthogonalInterval that was used to enter this cell.


Implementation
    public function get enterInterval():OrthogonalInterval
    public function set enterInterval(value:OrthogonalInterval):void

See also

heuristicCostsproperty 
heuristicCosts:Number


Implementation
    public function get heuristicCosts():Number
    public function set heuristicCosts(value:Number):void
previousEdgeCellInfoproperty 
previousEdgeCellInfo:EdgeCellInfo

Specifies the com.yworks.yfiles.layout.router.polyline.EdgeCellInfo describing how the previous cell was crossed.


Implementation
    public function get previousEdgeCellInfo():EdgeCellInfo
    public function set previousEdgeCellInfo(value:EdgeCellInfo):void

See also

previousEntranceproperty 
previousEntrance:CellEntrance

Specifies the previous com.yworks.yfiles.layout.router.polyline.CellEntrance in the path that reached this cell.


Implementation
    public function get previousEntrance():CellEntrance
    public function set previousEntrance(value:CellEntrance):void

See also

Constructor Detail
CellEntrance()Constructor
public function CellEntrance(other:CellEntrance, init:Boolean = true)

Creates a copy of the given CellEntrance.

Parameters
other:CellEntrance — the CellEntrance, of which a copy is to be made
 
init:Boolean (default = true) — An internally used switch to help handle proper instance initialization in inheritance chains where classes can have multiple constructor-like factory methods. This parameter can safely be ignored/omitted when calling the constructor.
Method Detail
getClass()method
override public function getClass():Class

Returns
Class
initCellEntrance1()method 
protected final function initCellEntrance1(other:CellEntrance):void

Initializes this object. See the documentation of the corresponding factory method newCellEntrance1() for details.

Parameters

other:CellEntrance

See also

initCellEntrance2()method 
protected final function initCellEntrance2(cell:PartitionCell):void

Initializes this object. See the documentation of the corresponding factory method newCellEntrance2() for details.

Parameters

cell:PartitionCell

See also

newCellEntrance1()method 
public static function newCellEntrance1(other:CellEntrance):CellEntrance

Creates a copy of the given CellEntrance.

Parameters

other:CellEntrance — the CellEntrance, of which a copy is to be made

Returns
CellEntrance
newCellEntrance2()method 
public static function newCellEntrance2(cell:PartitionCell):CellEntrance

Creates a new instance.

Parameters

cell:PartitionCell — The entered partition cell.

Returns
CellEntrance
toString()method 
public function toString():String

Returns
String