| Package | starling.utils |
| Class | public class Polygon |
| Inheritance | Polygon  DisplayObject EventDispatcher Object |
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number The opacity of the object. | DisplayObject | |
| base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| color : uint The color of the regular polygon. | Polygon | ||
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
| height : Number The height of the object in pixels. | DisplayObject | |
| name : String The name of the display object (default: null). | DisplayObject | |
| numEdges : int The number of edges of the regular polygon. | Polygon | ||
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| radius : Number The radius of the polygon in points. | Polygon | ||
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number The width of the object in pixels. | DisplayObject | |
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| Method | Defined By | ||
|---|---|---|---|
Polygon(radius:Number, numEdges:int = 6, color:uint = 0xffffff) Creates a regular polygon with the specified redius, number of edges, and color. | Polygon | ||
| addEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
dispose():void [override] Disposes all resources of the display object. | Polygon | ||
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Polygon | ||
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
| hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject Returns the object that is found topmost beneath a point in local coordinates, or nil if
the test fails. | DisplayObject | |
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| removeEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| removeEventListeners(type:String = null):void [override] | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
render(support:RenderSupport, alpha:Number):void [override] Renders the object with the help of a 'support' object and with the accumulated alpha
of its parent object. | Polygon | ||
| color | property |
Hide Inherited Public Properties
Show Inherited Public Propertiescolor:uintThe color of the regular polygon.
public function get color():uint public function set color(value:uint):void| numEdges | property |
numEdges:intThe number of edges of the regular polygon.
public function get numEdges():int public function set numEdges(value:int):void| radius | property |
radius:NumberThe radius of the polygon in points.
public function get radius():Number public function set radius(value:Number):void| Polygon | () | Constructor |
public function Polygon(radius:Number, numEdges:int = 6, color:uint = 0xffffff)Creates a regular polygon with the specified redius, number of edges, and color.
Parametersradius:Number | |
numEdges:int (default = 6) | |
color:uint (default = 0xffffff) |
| dispose | () | method |
override public function dispose():voidDisposes all resources of the display object.
| getBounds | () | method |
override public function getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):RectangleReturns a rectangle that completely encloses the object as it appears in another coordinate system.
Parameters
targetSpace:DisplayObject | |
resultRect:Rectangle (default = null) |
Rectangle |
| render | () | method |
override public function render(support:RenderSupport, alpha:Number):voidRenders the object with the help of a 'support' object and with the accumulated alpha of its parent object.
Parameters
support:RenderSupport | |
alpha:Number |