| Package | feathers.display |
| Class | public class Image |
| Inheritance | Image  Image Quad DisplayObject EventDispatcher Object |
| Implements | IDisplayObjectWithScrollRect |
Image class, including
scrollRect and pixel snapping.
| 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 | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | Image | ||
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| smoothing : String The smoothing filter that is used for the texture. | Image | |
| snapToPixels : Boolean
Determines if the image should be snapped to the nearest global whole
pixel when rendered. | Image | ||
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| texture : Texture The texture that is displayed on the quad. | Image | |
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | Image | ||
| 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 [override] Copies the raw vertex data to a VertexData instance. | Image | |
| copyVertexDataTransformedTo(targetData:VertexData, targetVertexID:int = 0, matrix:Matrix = null):void [override] Transforms the vertex positions of the raw vertex data by a certain matrix
and copies the result to another VertexData instance. | Image | |
| 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 | |
| fromBitmap(bitmap:Bitmap, generateMipMaps:Boolean = true, scale:Number = 1):Image [static] Creates an Image with a texture that is created from a bitmap object. | Image | |
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override]
Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Image | ||
| getTexCoords(vertexID:int, resultPoint:Point = null):Point Gets the texture coordinates of a vertex. | Image | |
| 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 | |
| readjustSize():void Readjusts the dimensions of the image according to its current texture. | Image | |
| 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 display object with the help of a support object. | Image | ||
| setTexCoords(vertexID:int, coords:Point):void Sets the texture coordinates of a vertex. | Image | |
| setTexCoordsTo(vertexID:int, u:Number, v:Number):void Sets the texture coordinates of a vertex. | Image | |
| 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 | |
| scrollRect | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesscrollRect:RectangleThe scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.
public function get scrollRect():Rectangle public function set scrollRect(value:Rectangle):void| snapToPixels | property |
snapToPixels:BooleanDetermines if the image should be snapped to the nearest global whole pixel when rendered.
public function get snapToPixels():Boolean public function set snapToPixels(value:Boolean):void| Image | () | Constructor |
| 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. 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) |
Rectangle |
| render | () | method |
override public function render(support:RenderSupport, alpha:Number):voidRenders 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.
| |
alpha:Number — The accumulated alpha value from the object's parent up to the stage. |