Packageisohill.starling
Classpublic class HitMovieClip
InheritanceHitMovieClip Inheritance MovieClip Inheritance Image Inheritance Quad Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object

MovieClip that is hitTest transparent aware



Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The opacity of the object.
DisplayObject
 Inheritedbounds : Rectangle
[read-only] The bounds of the object relative to the local coordinates of the parent.
DisplayObject
 Inheritedcolor : uint
Returns the color of the quad, or of vertex 0 if vertices have different colors.
Quad
 InheritedcurrentFrame : int
The index of the frame that is currently displayed.
MovieClip
 Inheritedfps : Number
The default number of frames per second.
MovieClip
 Inheritedheight : Number
The height of the object in pixels.
DisplayObject
  hitMap : Vector.<GridBool>
[write-only]
HitMovieClip
 InheritedisComplete : Boolean
[read-only] Always returns false.
MovieClip
 InheritedisPlaying : Boolean
[read-only] Indicates if the clip is still playing.
MovieClip
 Inheritedloop : Boolean
Indicates if the clip should loop.
MovieClip
 Inheritedname : String
The name of the display object (default: null).
DisplayObject
 InheritednumFrames : int
[read-only] The total number of frames.
MovieClip
 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
 Inheritedroot : DisplayObject
[read-only] The topmost object in the display tree the object is part of.
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
 Inheritedsmoothing : String
The smoothing filter that is used for the texture.
Image
 Inheritedstage : Stage
[read-only] The stage the display object is connected to, or null if it is not connected to a stage.
DisplayObject
 Inheritedtexture : Texture
The texture that is displayed on the quad.
Image
 InheritedtotalTime : Number
[read-only] The total duration of the clip in seconds.
MovieClip
 Inheritedtouchable : Boolean
Indicates if this object (and its children) will receive touch events.
DisplayObject
 InheritedtransformationMatrix : Matrix
[read-only] The transformation matrix of the object relative to its parent.
DisplayObject
 InheritedvertexData : VertexData
[override] [read-only] Returns a 'VertexData' object with the raw data of the object required for rendering.
Image
 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
 InheritedmIndexBuffer : IndexBuffer3D
The index buffer object used to render the quad.
Quad
 InheritedmVertexBuffer : VertexBuffer3D
The vertex buffer object containing the vertex data of the quad.
Quad
 InheritedmVertexData : VertexData
The raw vertex data of the quad.
Quad
Public Methods
 MethodDefined By
  
HitMovieClip(textures:Vector.<Texture>, fps:int = 12)
HitMovieClip
 Inherited
addEventListener(type:String, listener:Function):void
Registers an event listener at a certain object.
EventDispatcher
 Inherited
addFrame(texture:Texture, sound:Sound = null, duration:Number = -1):void
Adds an additional frame, optionally with a sound and a custom duration.
MovieClip
 Inherited
addFrameAt(frameID:int, texture:Texture, sound:Sound = null, duration:Number = -1):void
Adds a frame at a certain index, optionally with a sound and a custom duration.
MovieClip
 Inherited
advanceTime(passedTime:Number):void
Advance the time by a number of seconds.
MovieClip
 Inherited
dispatchEvent(event:Event):void
[override] Dispatches an event to all objects that have registered for events of the same type.
DisplayObject
 Inherited
dispose():void
[override] Disposes vertex- and index-buffer, but does NOT dispose the texture!
Image
 Inherited
fromBitmap(bitmap:Bitmap):Image
[static] Creates an Image with a texture that is created from a bitmap object.
Image
 Inherited
getBounds(targetSpace:DisplayObject):Rectangle
[override] Returns a rectangle that completely encloses the object as it appears in another coordinate system.
Quad
 Inherited
getFrameDuration(frameID:int):Number
Returns the duration of a certain frame (in seconds).
MovieClip
 Inherited
getFrameSound(frameID:int):Sound
Returns the sound of a certain frame.
MovieClip
 Inherited
Returns the texture of a certain frame.
MovieClip
 Inherited
getProgramName(mipMap:Boolean = true, repeat:Boolean = false, smoothing:String = bilinear):String
[static] Get the name of the Shader program that is used for rendering.
Image
 Inherited
getTexCoords(vertexID:int):Point
Gets the texture coordinates of a vertex.
Image
 Inherited
Creates a matrix that represents the transformation from the local coordinate system to another.
DisplayObject
 Inherited
getVertexAlpha(vertexID:int):Number
Returns the alpha value of a vertex at a certain index.
Quad
 Inherited
getVertexColor(vertexID:int):uint
Returns the color of a vertex at a certain index.
Quad
 Inherited
globalToLocal(globalPoint:Point):Point
Transforms a point from global (stage) coordinates to the local coordinate system.
DisplayObject
 Inherited
hasEventListener(type:String):Boolean
Returns if there are listeners registered for a certain event type.
EventDispatcher
  
hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject
[override]
HitMovieClip
 Inherited
localToGlobal(localPoint:Point):Point
Transforms a point from the local coordinate system to global (stage) coordinates.
DisplayObject
 Inherited
pause():void
Pauses playback.
MovieClip
 Inherited
play():void
Starts playback.
MovieClip
 Inherited
[static] Registers the vertex and fragment programs required in the 'render' method at a Starling object.
Image
 Inherited
removeEventListener(type:String, listener:Function):void
Removes an event listener from the object.
EventDispatcher
 Inherited
removeEventListeners(type:String = null):void
Removes all event listeners with a certain type, or all of them if type is null.
EventDispatcher
 Inherited
removeFrameAt(frameID:int):void
Removes the frame at a certain ID.
MovieClip
 Inherited
removeFromParent(dispose:Boolean = false):void
Removes the object from its parent, if it has one.
DisplayObject
 Inherited
render(support:RenderSupport, alpha:Number):void
[override] Renders the display object with the help of a support object.
Image
 Inherited
setFrameDuration(frameID:int, duration:Number):void
Sets the duration of a certain frame (in seconds).
MovieClip
 Inherited
setFrameSound(frameID:int, sound:Sound):void
Sets the sound of a certain frame.
MovieClip
 Inherited
setFrameTexture(frameID:int, texture:Texture):void
Sets the texture of a certain frame.
MovieClip
 Inherited
setTexCoords(vertexID:int, coords:Point):void
Sets the texture coordinates of a vertex.
Image
 Inherited
setVertexAlpha(vertexID:int, alpha:Number):void
Sets the alpha value of a vertex at a certain index.
Quad
 Inherited
setVertexColor(vertexID:int, color:uint):void
Sets the color of a vertex at a certain index.
Quad
 Inherited
stop():void
Stops playback, resetting "currentFrame" to zero.
MovieClip
Protected Methods
 MethodDefined By
 Inherited
Creates the index buffer at the current render context.
Quad
 Inherited
Creates the vertex buffer from the raw vertex data at the current render context.
Quad
 Inherited
setupVertexData(width:Number, height:Number, color:uint = 0xffffff):void
[override] PATCH: Sets up the vertex data on the Quad.
Image
 Inherited
Image
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 whenever the movie has displayed its last frame.MovieClip
 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
Public Constants
 ConstantDefined By
 InheritedPROGRAM_NAME : String = quad
[static] The name of the shader program used when a quad is rendered.
Quad
Property Detail
hitMapproperty
hitMap:Vector.<GridBool>  [write-only]


Implementation
    public function set hitMap(value:Vector.<GridBool>):void
Constructor Detail
HitMovieClip()Constructor
public function HitMovieClip(textures:Vector.<Texture>, fps:int = 12)



Parameters
textures:Vector.<Texture>
 
fps:int (default = 12)
Method Detail
hitTest()method
override public function hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject

Parameters

localPoint:Point
 
forTouch:Boolean (default = false)

Returns
DisplayObject