Packagecom.afcomponents.umap.interfaces
Interfacepublic interface IGridSegment extends IMapObject, flash.events.IEventDispatcher
ImplementorsGridSegment

Desribes basic functions that should be implemented in a Grid Segment.



Public Properties
 PropertyDefined by
 InheritedasDisplayObject : DisplayObject
Returns reference to the object as a DisplayObject instance.
IMapObject
 Inheritedcore : UMap
Returns reference to the core UMap object.
IMapObject
 Inheritedid : uint
Gets or sets the ID of the object.
IMapObject
 Inheritedname : String
Gets or sets the name of the object.
IMapObject
 Inheritedowner : IMapObjectContainer
Returns reference to the owner container object.
IMapObject
  point : Point
[read-only] Returns segment's point.
IGridSegment
  priority : uint
[read-only] Returns segment's priority.
IGridSegment
  zoom : uint
[read-only] Returns segment's zoom level.
IGridSegment
Public Methods
 MethodDefined by
 Inherited
dispose():void
Releases all the resources accuired by the object.
IMapObject
  
equals(other:IGridSegment):Boolean
Compares the position of this segment to the other.
IGridSegment
  
init(point:Point, zoom:uint, priority:uint = 0):void
Sets segements options, and starts loading the image(s) for this segment.
IGridSegment
 Inherited
remove():void
Removes the object from the owner container object.
IMapObject
 Inherited
Adds the object to the specified IMapObjectContainer.
IMapObject
 Inherited
toString():String
Returns a textual representation of the object.
IMapObject
Property detail
pointproperty
point:Point  [read-only]

Returns segment's point.

Implementation
    public function get point():Point
priorityproperty 
priority:uint  [read-only]

Returns segment's priority.

Implementation
    public function get priority():uint
zoomproperty 
zoom:uint  [read-only]

Returns segment's zoom level.

Implementation
    public function get zoom():uint
Method detail
equals()method
public function equals(other:IGridSegment):Boolean

Compares the position of this segment to the other.

Parameters
other:IGridSegment

Returns
Boolean — A value of true if point and zoom level of the segments are equal; false if they are not.
init()method 
public function init(point:Point, zoom:uint, priority:uint = 0):void

Sets segements options, and starts loading the image(s) for this segment.

Parameters
point:Point — Object wich specifies the position of the segement in tile coordinates.
 
zoom:uint — Zoom level of segment.
 
priority:uint (default = 0) — Loading priority of the segement.