Packagecom.yworks.yfiles.layout.router.polyline
Classpublic class Obstacle
InheritanceObstacle Inheritance YObject Inheritance Object

Obstacles are used by implementations of com.yworks.yfiles.layout.router.polyline.ObstaclePartition to subdivide an area into com.yworks.yfiles.layout.router.polyline.PartitionCell s.

See also

com.yworks.yfiles.layout.router.polyline.ObstaclePartition
com.yworks.yfiles.layout.router.polyline.PartitionCell


Public Properties
 PropertyDefined By
  bounds : YRectangle
[read-only] Returns the bounds of the obstacle.
Obstacle
  data : Object
[read-only] Returns the additional data related to the obstacle.
Obstacle
Public Methods
 MethodDefined By
  
Obstacle(bounds:YRectangle, data:Object, init:Boolean = true)
Creates a new instance.
Obstacle
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
Obstacle
 Inherited
hashCode():int
YObject
  
newObstacle(bounds:YRectangle, data:Object):Obstacle
[static] Creates a new instance.
Obstacle
Protected Methods
 MethodDefined By
  
initObstacle(bounds:YRectangle, data:Object):void
Initializes this object.
Obstacle
Property Detail
boundsproperty
bounds:YRectangle  [read-only]

Returns the bounds of the obstacle.


Implementation
    public function get bounds():YRectangle
dataproperty 
data:Object  [read-only]

Returns the additional data related to the obstacle.


Implementation
    public function get data():Object
Constructor Detail
Obstacle()Constructor
public function Obstacle(bounds:YRectangle, data:Object, init:Boolean = true)

Creates a new instance.

Parameters
bounds:YRectangle — The bounds of the obstacle.
 
data:Object — The additional data related to the obstacle.
 
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
initObstacle()method 
protected final function initObstacle(bounds:YRectangle, data:Object):void

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

Parameters

bounds:YRectangle
 
data:Object

See also

newObstacle()method 
public static function newObstacle(bounds:YRectangle, data:Object):Obstacle

Creates a new instance.

Parameters

bounds:YRectangle — The bounds of the obstacle.
 
data:Object — The additional data related to the obstacle.

Returns
Obstacle