GODPAPER | All Packages | All Classes | Index | Frames No Frames |
Quad

Package | starling.display
Class | public class Quad
Inheritance | Quad DisplayObject EventDispatcher Object
Subclasses | Image

A Quad represents a rectangle with a uniform color or a color gradient.

You can set one color per vertex. The colors will smoothly fade into each other over the area of the quad. To display a simple linear color gradient, assign one color to vertices 0 and 1 and another color to vertices 2 and 3.

The indices of the vertices are arranged like this:

          0 - 1
          | / |
          2 - 3

See also

Image

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alpha : Number [override] The opacity of the object. | Quad
|  | 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 Returns the color of the quad, or of vertex 0 if vertices have different colors. | Quad
|  | 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
|  | 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
|  | premultipliedAlpha : Boolean [read-only] Indicates if the rgb values are stored premultiplied with the alpha value; this can affect the rendering. | Quad
|  | 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
|  | tinted : Boolean [read-only] Returns true if the quad (or any of its vertices) is non-white or non-opaque. | Quad
|  | 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

Protected Properties

| Property | Defined By
--- | --- | ---
|  | mVertexData : VertexData The raw vertex data of the quad. | Quad

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | Quad(width:Number, height:Number, color:uint = 0xffffff, premultipliedAlpha:Boolean = true) Creates a quad with a certain size and color. | Quad
|  | 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
|  | copyVertexDataTo(targetData:VertexData, targetVertexID:int = 0):void Copies the raw vertex data to a VertexData instance. | Quad
|  | copyVertexDataTransformedTo(targetData:VertexData, targetVertexID:int = 0, matrix:Matrix = null):void Transforms the vertex positions of the raw vertex data by a certain matrix and copies the result to another VertexData instance. | Quad
|  | 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 Disposes all resources of the display object. | DisplayObject
|  | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another coordinate system. | Quad
|  | getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system to another. | DisplayObject
|  | getVertexAlpha(vertexID:int):Number Returns the alpha value of a vertex at a certain index. | Quad
|  | getVertexColor(vertexID:int):uint Returns the color of a vertex at a certain index. | Quad
|  | 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, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Quad
|  | setVertexAlpha(vertexID:int, alpha:Number):void Sets the alpha value of a vertex at a certain index. | Quad
|  | setVertexColor(vertexID:int, color:uint):void Sets the color of a vertex at a certain index. | Quad

Protected Methods

| Method | Defined By
--- | --- | ---
|  | onVertexDataChanged():void Call this method after manually changing the contents of 'mVertexData'. | Quad

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | added | Dispatched when an object is added to a parent. | DisplayObject
|  | addedToStage | Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject
|  | enterFrame | Dispatched once every frame on every object that is connected to the stage. | DisplayObject
|  | keyDown | Dispatched when a key on the keyboard is pressed. | DisplayObject
|  | keyUp | Dispatched when a key on the keyboard is released. | DisplayObject
|  | removed | Dispatched when an object is removed from its parent. | DisplayObject
|  | removedFromStage | Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject
|  | touch | Dispatched when an object is touched. | DisplayObject

Property Detail

alpha | property

`alpha:Number`[override]

The opacity of the object. 0 = transparent, 1 = opaque.

Implementation
`public function get alpha():Number`
`public function set alpha(value:Number):void`

color | property |

`color:uint`

Returns the color of the quad, or of vertex 0 if vertices have different colors.

Implementation
`public function get color():uint`
`public function set color(value:uint):void`

mVertexData | property |

`protected var mVertexData:VertexData`

The raw vertex data of the quad.

premultipliedAlpha | property |

`premultipliedAlpha:Boolean` [read-only]

Indicates if the rgb values are stored premultiplied with the alpha value; this can affect the rendering. (Most developers don't have to care, though.)

Implementation
`public function get premultipliedAlpha():Boolean`

tinted | property |

`tinted:Boolean` [read-only]

Returns true if the quad (or any of its vertices) is non-white or non-opaque.

Implementation
`public function get tinted():Boolean`
Constructor Detail

Quad | () | Constructor

`public function Quad(width:Number, height:Number, color:uint = 0xffffff, premultipliedAlpha:Boolean = true)`

Creates a quad with a certain size and color. The last parameter controls if the alpha value should be premultiplied into the color values on rendering, which can influence blending output. You can use the default value in most cases.

Parameters

| `width:Number`
| `height:Number`
| `color:uint` (default = `0xffffff`)``
| `premultipliedAlpha:Boolean` (default = `true`)``

Method Detail

copyVertexDataTo | () | method

`public function copyVertexDataTo(targetData:VertexData, targetVertexID:int = 0):void`

Copies the raw vertex data to a VertexData instance.

Parameters

| `targetData:VertexData`
| `targetVertexID:int` (default = `0`)``

copyVertexDataTransformedTo | () | method |

`public function copyVertexDataTransformedTo(targetData:VertexData, targetVertexID:int = 0, matrix:Matrix = null):void`

Transforms the vertex positions of the raw vertex data by a certain matrix and copies the result to another VertexData instance.

Parameters

| `targetData:VertexData`
| `targetVertexID:int` (default = `0`)``
| `matrix:Matrix` (default = `null`)``

getBounds | () | method |

`override public function getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle`

Returns a rectangle that completely encloses the object as it appears in another coordinate system. If you pass a 'resultRectangle', the result will be stored in this rectangle instead of creating a new object.

Parameters

| `targetSpace:DisplayObject`
| `resultRect:Rectangle` (default = `null`)``

Returns

| `Rectangle`

getVertexAlpha | () | method |

`public function getVertexAlpha(vertexID:int):Number`

Returns the alpha value of a vertex at a certain index.

Parameters

| `vertexID:int`

Returns

| `Number`

getVertexColor | () | method |

`public function getVertexColor(vertexID:int):uint`

Returns the color of a vertex at a certain index.

Parameters

| `vertexID:int`

Returns

| `uint`

onVertexDataChanged | () | method |

`protected function onVertexDataChanged():void`

Call this method after manually changing the contents of 'mVertexData'.

render | () | method |

`override public function render(support:RenderSupport, parentAlpha:Number):void`

Renders the display object with the help of a support object. Never call this method directly, except from within another render method.

Parameters

| `support:RenderSupport` — Provides utility functions for rendering.
| `parentAlpha:Number` — The accumulated alpha value from the object's parent up to the stage.

setVertexAlpha | () | method |

`public function setVertexAlpha(vertexID:int, alpha:Number):void`

Sets the alpha value of a vertex at a certain index.

Parameters

| `vertexID:int`
| `alpha:Number`

setVertexColor | () | method |

`public function setVertexColor(vertexID:int, color:uint):void`

Sets the color of a vertex at a certain index.

Parameters

| `vertexID:int`
| `color:uint`

Thu Jan 16 2014, 01:11 PM +08:00