Packagestarling.display
Classpublic class Quad
InheritanceQuad Inheritance DisplayObject Inheritance EventDispatcher Inheritance 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
 PropertyDefined By
  alpha : Number
[override] The opacity of the object.
Quad
 Inheritedbase : DisplayObject
[read-only] The topmost object in the display tree the object is part of.
DisplayObject
 InheritedblendMode : String
The blend mode determines how the object is blended with the objects underneath.
DisplayObject
 Inheritedbounds : 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
 Inheritedfilter : FragmentFilter
The filter that is attached to the display object.
DisplayObject
 InheritedhasVisibleArea : Boolean
[read-only] Indicates if an object occupies any visible area.
DisplayObject
 Inheritedheight : Number
The height of the object in pixels.
DisplayObject
 Inheritedis3D : Boolean
[read-only] Indicates if this object or any of its parents is a 'Sprite3D' object.
DisplayObject
 Inheritedname : String
The name of the display object (default: null).
DisplayObject
 Inheritedparent : DisplayObjectContainer
[read-only] The display object container that contains this display object.
DisplayObject
 InheritedpivotX : Number
The x coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
 InheritedpivotY : 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
 Inheritedroot : DisplayObject
[read-only] The root object the display object is connected to (i.e.
DisplayObject
 Inheritedrotation : Number
The rotation of the object in radians.
DisplayObject
 InheritedscaleX : Number
The horizontal scale factor.
DisplayObject
 InheritedscaleY : Number
The vertical scale factor.
DisplayObject
 InheritedskewX : Number
The horizontal skew angle in radians.
DisplayObject
 InheritedskewY : Number
The vertical skew angle in radians.
DisplayObject
 Inheritedstage : 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
 Inheritedtouchable : Boolean
Indicates if this object (and its children) will receive touch events.
DisplayObject
 InheritedtransformationMatrix : Matrix
The transformation matrix of the object relative to its parent.
DisplayObject
 InheritedtransformationMatrix3D : Matrix3D
[read-only] The 3D transformation matrix of the object relative to its parent.
DisplayObject
 InheriteduseHandCursor : Boolean
Indicates if the mouse cursor should transform into a hand while it's over the sprite.
DisplayObject
 Inheritedvisible : Boolean
The visibility of the object.
DisplayObject
 Inheritedwidth : Number
The width of the object in pixels.
DisplayObject
 Inheritedx : Number
The x coordinate of the object relative to the local coordinates of the parent.
DisplayObject
 Inheritedy : Number
The y coordinate of the object relative to the local coordinates of the parent.
DisplayObject
Protected Properties
 PropertyDefined By
  mVertexData : VertexData
The raw vertex data of the quad.
Quad
Public Methods
 MethodDefined By
  
Quad(width:Number, height:Number, color:uint = 0xffffff, premultipliedAlpha:Boolean = true)
Creates a quad with a certain size and color.
Quad
 Inherited
addEventListener(type:String, listener:Function):void
[override] Registers an event listener at a certain object.
DisplayObject
 Inherited
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
 Inherited
dispatchEvent(event:Event):void
[override]
DisplayObject
 Inherited
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
 Inherited
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
 Inherited
getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix
Creates a matrix that represents the transformation from the local coordinate system to another.
DisplayObject
 Inherited
getTransformationMatrix3D(targetSpace:DisplayObject, resultMatrix:Matrix3D = null):Matrix3D
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
 Inherited
globalToLocal(globalPoint:Point, resultPoint:Point = null):Point
Transforms a point from global (stage) coordinates to the local coordinate system.
DisplayObject
 Inherited
globalToLocal3D(globalPoint:Point, resultPoint:Vector3D = null):Vector3D
Transforms a point from global (stage) coordinates to the 3D local coordinate system.
DisplayObject
 Inherited
hasEventListener(type:String):Boolean
Returns if there are listeners registered for a certain event type.
EventDispatcher
 Inherited
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
 Inherited
local3DToGlobal(localPoint:Vector3D, resultPoint:Point = null):Point
Transforms a 3D point from the local coordinate system to global (stage) coordinates.
DisplayObject
 Inherited
localToGlobal(localPoint:Point, resultPoint:Point = null):Point
Transforms a point from the local coordinate system to global (stage) coordinates.
DisplayObject
 Inherited
removeEventListener(type:String, listener:Function):void
[override] Removes an event listener from the object.
DisplayObject
 Inherited
removeEventListeners(type:String = null):void
[override] Removes all event listeners with a certain type, or all of them if type is null.
DisplayObject
 Inherited
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
 MethodDefined By
  
Call this method after manually changing the contents of 'mVertexData'.
Quad
Events
 Event Summary Defined By
 InheritedDispatched when an object is added to a parent.DisplayObject
 InheritedDispatched when an object is connected to the stage (directly or indirectly).DisplayObject
 InheritedDispatched once every frame on every object that is connected to the stage.DisplayObject
 InheritedDispatched when a key on the keyboard is pressed.DisplayObject
 InheritedDispatched when a key on the keyboard is released.DisplayObject
 InheritedDispatched when an object is removed from its parent.DisplayObject
 InheritedDispatched when an object is removed from the stage and won't be rendered any longer.DisplayObject
 InheritedDispatched when an object is touched.DisplayObject
Property Detail
alphaproperty
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
colorproperty 
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
mVertexDataproperty 
protected var mVertexData:VertexData

The raw vertex data of the quad.

premultipliedAlphaproperty 
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
tintedproperty 
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