| Package | starling.display |
| Class | public class Stage |
| Inheritance | Stage  DisplayObjectContainer DisplayObject EventDispatcher Object |
This class represents the Starling version of the stage. Don't confuse it with its
Flash equivalent: while the latter contains objects of the type
flash.display.DisplayObject, the Starling stage contains only objects of the
type starling.display.DisplayObject. Those classes are not compatible, and
you cannot exchange one type with the other.
A stage object is created automatically by the Starling class. Don't
create a Stage instance manually.
In Starling, keyboard events are only dispatched at the stage. Add an event listener directly to the stage to be notified of keyboard events.
Resize EventsWhen the Flash player is resized, the stage dispatches a ResizeEvent. The
event contains properties containing the updated width and height of the Flash player.
See also
| 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 | |
| cameraPosition : Vector3D [read-only] The global position of the camera. | Stage | ||
| color : uint The background color of the stage. | Stage | ||
| fieldOfView : Number Specifies an angle (radian, between zero and PI) for the field of view. | Stage | ||
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focalLength : Number The distance between the stage and the camera. | Stage | ||
| height : Number The height of the object in pixels. | DisplayObject | |
| is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object. | DisplayObject | |
| mask : DisplayObject The display object that acts as a mask for the current object. | DisplayObject | |
| maskInverted : Boolean Indicates if the masked region of this object is set to be inverted. | DisplayObject | |
| name : String The name of the display object (default: null). | DisplayObject | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| 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 | |
| projectionOffset : Point A vector that moves the camera away from its default position in the center of the
stage. | Stage | ||
| requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e. | DisplayObject | |
| 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 | |
| scale : Number Sets both 'scaleX' and 'scaleY' to the same value. | 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 | |
| stageHeight : int The height of the stage coordinate system. | Stage | ||
| stageWidth : int The width of the stage coordinate system. | Stage | ||
| starling : Starling [read-only] The Starling instance this stage belongs to. | Stage | ||
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object. | DisplayObjectContainer | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| transformationMatrix3D : Matrix3D [read-only] The 3D 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 | ||
|---|---|---|---|
| Adds a child to the container. | DisplayObjectContainer | |
| Adds a child to the container at a certain index. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object. | DisplayObject | |
advanceTime(passedTime:Number):void | Stage | ||
| alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
| broadcastEventWith(eventType:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
| contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
| 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 the resources of all children. | DisplayObjectContainer | |
| drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object. | DisplayObject | |
| getBounds(targetSpace:DisplayObject, out:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | DisplayObjectContainer | |
getCameraPosition(space:DisplayObject = null, out:Vector3D = null):Vector3D Returns the position of the camera within the local coordinate system of a certain
display object. | Stage | ||
| getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
| getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
| getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
getScreenBounds(targetSpace:DisplayObject, out:Rectangle = null):Rectangle Returns the bounds of the screen (or application window, on Desktop) relative to
a certain coordinate system. | Stage | ||
getStageBounds(targetSpace:DisplayObject, out:Rectangle = null):Rectangle Returns the stage bounds (i.e. | Stage | ||
| getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system. | DisplayObject | |
| hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | |
hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in stage coordinates, or
the stage itself if nothing else is found. | Stage | ||
| hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask. | DisplayObject | |
| local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| Removes a child from the container. | DisplayObjectContainer | |
| removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
| removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
| removeEventListener(type:String, listener:Function):void [override] Removes an event listener from the object. | DisplayObject | |
| removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null. | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| [override] Renders the display object with the help of a painter object. | DisplayObjectContainer | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setRequiresRedraw():void Forces the object to be redrawn in the next frame. | DisplayObject | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an object is added to a parent. | DisplayObject | ||
| Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject | ||
| Dispatched once every frame on every object that is connected to the stage. | DisplayObject | ||
| Dispatched when a key on the keyboard is pressed. | DisplayObject | ||
| Dispatched when a key on the keyboard is released. | DisplayObject | ||
| Dispatched when an object is removed from its parent. | DisplayObject | ||
| Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject | ||
| Dispatched when the Flash container is resized. | Stage | |||
| Dispatched when an object is touched. | DisplayObject | ||
| cameraPosition | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescameraPosition:Vector3D [read-only] The global position of the camera. This property can only be used to find out the current position, but not to modify it. For that, use the 'projectionOffset', 'fieldOfView' and 'focalLength' properties. If you need the camera position in a certain coordinate space, use 'getCameraPosition' instead.
CAUTION: not a copy, but the actual object!
public function get cameraPosition():Vector3D| color | property |
color:uintThe background color of the stage. When Starling clears the render context (which happens automatically once per frame), it will use this this color. Note that it's actually an 'ARGB' value: if you need the context to be cleared with a specific alpha value, include it in the color.
public function get color():uint public function set color(value:uint):void| fieldOfView | property |
fieldOfView:NumberSpecifies an angle (radian, between zero and PI) for the field of view. This value determines how strong the perspective transformation and distortion apply to a Sprite3D object.
A value close to zero will look similar to an orthographic projection; a value close to PI results in a fisheye lens effect. If the field of view is set to 0 or PI, nothing is seen on the screen.
The default value is 1.0.
public function get fieldOfView():Number public function set fieldOfView(value:Number):void| focalLength | property |
focalLength:NumberThe distance between the stage and the camera. Changing this value will update the field of view accordingly.
public function get focalLength():Number public function set focalLength(value:Number):void| projectionOffset | property |
projectionOffset:PointA vector that moves the camera away from its default position in the center of the stage. Use this property to change the center of projection, i.e. the vanishing point for 3D display objects.
CAUTION: not a copy, but the actual object!
public function get projectionOffset():Point public function set projectionOffset(value:Point):void| stageHeight | property |
stageHeight:int The height of the stage coordinate system. Change it to scale its contents relative
to the viewPort property of the Starling object.
public function get stageHeight():int public function set stageHeight(value:int):void| stageWidth | property |
stageWidth:int The width of the stage coordinate system. Change it to scale its contents relative
to the viewPort property of the Starling object.
public function get stageWidth():int public function set stageWidth(value:int):void| starling | property |
starling:Starling [read-only] The Starling instance this stage belongs to.
public function get starling():Starling| advanceTime | () | method |
public function advanceTime(passedTime:Number):void
Parameters
passedTime:Number |
| getCameraPosition | () | method |
public function getCameraPosition(space:DisplayObject = null, out:Vector3D = null):Vector3DReturns the position of the camera within the local coordinate system of a certain display object. If you do not pass a space, the method returns the global position. To change the position of the camera, you can modify the properties 'fieldOfView', 'focalDistance' and 'projectionOffset'.
Parameters
space:DisplayObject (default = null) | |
out:Vector3D (default = null) |
Vector3D |
| getScreenBounds | () | method |
public function getScreenBounds(targetSpace:DisplayObject, out:Rectangle = null):RectangleReturns the bounds of the screen (or application window, on Desktop) relative to a certain coordinate system. In most cases, that's identical to the stage bounds; however, this changes if the viewPort is customized.
Parameters
targetSpace:DisplayObject | |
out:Rectangle (default = null) |
Rectangle |
| getStageBounds | () | method |
public function getStageBounds(targetSpace:DisplayObject, out:Rectangle = null):RectangleReturns the stage bounds (i.e. not the bounds of its contents, but the rectangle spawned up by 'stageWidth' and 'stageHeight') in another coordinate system.
Parameters
targetSpace:DisplayObject | |
out:Rectangle (default = null) |
Rectangle |
| hitTest | () | method |
override public function hitTest(localPoint:Point):DisplayObjectReturns the object that is found topmost beneath a point in stage coordinates, or the stage itself if nothing else is found.
Parameters
localPoint:Point |
DisplayObject |
| resize | Event |