| Package | com.gestureworks.cml.element |
| Class | public class MaskContainer |
| Inheritance | MaskContainer  TouchContainer TouchContainerFactory TouchSprite flash.display.Sprite |
var maskContainer:MaskContainer = new MaskContainer();
maskContainer.maskShape = "rectangle";
maskContainer.maskWidth = 100;
maskContainer.maskHeight = 64;
maskContainer.maskBorderColor = 0xff0000;
maskContainer.maskBorderStroke = 2;
maskContainer.maskBorderAlpha = 0.75;
maskContainer.addChild(img);
maskContainer.childToList("image", img);
maskContainer.init();
See also
| Property | Defined By | ||
|---|---|---|---|
 | _$height : Number = 0 | TouchSprite | |
| _$rotation : Number = 0 | TouchSprite | |
| $rotation : Number | TouchSprite | |
| _$scaleX : Number = 1 | TouchSprite | |
| $scaleX : Number | TouchSprite | |
| _$scaleY : Number = 1 | TouchSprite | |
| $scaleY : Number | TouchSprite | |
| $transformPoint : Point | TouchSprite | |
| _$width : Number = 0 | TouchSprite | |
| _$x : Number = 0 | TouchSprite | |
| $x : Number | TouchSprite | |
| _$y : Number = 0 | TouchSprite | |
| $y : Number | TouchSprite | |
| autoShuffle : Boolean
autoshuffles
| TouchContainerFactory | |
| broadcastTarget : Boolean | TouchSprite | |
| childList : ChildList [read-only]
returns the childlist
| TouchContainerFactory | |
| class_ : String
Object's css class;
| TouchContainerFactory | |
| className : String
sets the class name of displayobject
| TouchContainerFactory | |
| cloneExclusions : Vector.<String> [read-only]
Returns a list of properties to exclude when cloning this object
| TouchContainer | |
| clusterBubbling : Boolean
Allows touch points from a childclusters to copy into container touch objects
in the local parent child display list stack. | TouchSprite | |
| clusterEvents : Boolean
Determins whether clusterEvents are processed and dispatched on the touchSprite. | TouchSprite | |
| clusterID : int | TouchSprite | |
| cmlIndex : int
sets the cml index
| TouchContainerFactory | |
| cml_item : Boolean | TouchSprite | |
| cO : ClusterObject | TouchSprite | |
| counter : Number [read-only] | MaskContainer | ||
| debugDisplay : Boolean | TouchSprite | |
| deltaFilterOn : Boolean
Determins whether filtering is applied to the delta values. | TouchSprite | |
| dimensionsTo : String
sets the dimensions of touchcontainer
| TouchContainerFactory | |
| disableAffineTransform : Boolean
Determins whether internal (native) transformations are affine (dynamically centered) on the touchSprite. | TouchSprite | |
| disableNativeTransform : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite. | TouchSprite | |
| dN : Number | TouchSprite | |
| dragAngle : Number | MaskContainer | ||
| dropShadow : Boolean
Sets the drop shadow effect
| TouchContainerFactory | |
| GESTRELIST_UPDATE : String = gestureList update [static] | TouchSprite | |
| gestureEventComplete : Boolean
Indicates weather all gestureEvents have been completed on the touchSprite. | TouchSprite | |
| gestureEventRelease : Boolean
Indicates whether all touch points have been released on the touchSprite. | TouchSprite | |
| gestureEvents : Boolean
Determins whether gestureEvents are processed and dispatched on the touchSprite. | TouchSprite | |
| gestureEventStart : Boolean
Indicates whether any gestureEvents have been started on the touchSprite. | TouchSprite | |
| gestureFilters : Boolean | TouchSprite | |
| gestureList : Object | TouchSprite | |
| gestureReleaseInertia : Boolean
Determins whether release inertia is given to gestureEvents on the touchSprite. | TouchSprite | |
| gestureTouchInertia : Boolean
Determins whether touch inertia is processed on the touchSprite. | TouchSprite | |
| _gestureTweenOn : Boolean = false | TouchSprite | |
| gestureTweenOn : Boolean | TouchSprite | |
| gO : GestureListObject | TouchSprite | |
| group : String | TouchContainerFactory | |
| height : Number [override]
sets the height of the container
| TouchContainerFactory | |
| id : String
sets childlist id
| TouchContainerFactory | |
| layout : *
speciffies the type of layout
| TouchContainerFactory | |
| layoutComplete : Function
Sets the function to call when the layout is complete
| TouchContainer | |
| layoutList : Dictionary | TouchContainer | |
| layoutUpdate : Function
Sets the function to call when the layout updates
| TouchContainer | |
| maskBorderAlpha : Number
Alpha for the border of the mask if desired. | MaskContainer | ||
| maskBorderColor : uint
Mask border color, if a border is desired around the mask element. | MaskContainer | ||
| maskBorderStroke : Number
The thickness of the border in pixels. | MaskContainer | ||
| maskHeight : Number
Mask height for rectangles. | MaskContainer | ||
| maskRadius : Number
The property for the mask radius if the shape is a circle. | MaskContainer | ||
| maskRotation : Number
Set the starting rotation of the mask. | MaskContainer | ||
| maskShape : String
The string property to designate the shape the mask will be. | MaskContainer | ||
| maskWidth : Number
Mask width for rectangles. | MaskContainer | ||
| maskX : Number
Set the mask's starting X position. | MaskContainer | ||
| maskY : Number
Set the mask's starting Y position. | MaskContainer | ||
| maxScale : Number
This method is called after class initialization. | TouchContainerFactory | |
| minScale : Number
This method is called after class initialization. | TouchContainerFactory | |
| mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainerFactory | |
| mShape : Graphic [read-only] | MaskContainer | ||
| N : int | TouchSprite | |
| nestedTransform : Boolean | TouchSprite | |
| outline_alpha : Number
sets the alpha of outline
| TouchContainerFactory | |
| outline_color : Number
sets the color of outline
| TouchContainerFactory | |
| outline_joint : String
TODO
| TouchContainerFactory | |
| outlineOn : String
specifies the outline of container to true or false
| TouchContainerFactory | |
| outline_stroke : int
sets the line stroke of outline
| TouchContainerFactory | |
| pointArray : Vector.<PointObject> [read-only] | TouchSprite | |
| pointCount : int | TouchSprite | |
| propertyStates : Array Deprecated: Please Use state | TouchContainerFactory | |
| scale : Number
Scales display object
| TouchContainer | |
| sO : StrokeObject | TouchSprite | |
| state : Array
property states array
| TouchContainerFactory | |
| targeting : Boolean
Turns off manual ALL targeting control, defaults to a simple hit test
targeting model with exclusive target clustering
| TouchSprite | |
| targetList : Array
Allows touch and gesture events to explicitly target a group of defined
touch objects which can be outside of the local parent child display list stack
| TouchSprite | |
| targetObject : Object
Allows touch and gesture events to explicitly target a touch object
this can be outside the local parent child display list stack
| TouchSprite | |
| targetParent : Boolean
Allows touch and gesture events to explicitly target the parent touch object
| TouchSprite | |
| tc : TouchCluster | TouchSprite | |
| td : TouchDebugDisplay | TouchSprite | |
| tg : TouchGesture | TouchSprite | |
| tiO : TimelineObject | TouchSprite | |
| touchChildren : Boolean | TouchSprite | |
| touchObjectID : int [read-only] | TouchSprite | |
| touchScreen : TouchContainer [read-only] | MaskContainer | ||
| tp : TouchPipeline | TouchSprite | |
| traceDebugModeOn : Boolean | TouchSprite | |
| transformComplete : Boolean | TouchSprite | |
| transformEventComplete : Boolean | TouchSprite | |
| transformEvents : Boolean
Determins whether transformEvents are processed and dispatched on the touchSprite. | TouchSprite | |
| transformEventStart : Boolean | TouchSprite | |
| transformGestureVectors : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite. | TouchSprite | |
| transformStart : Boolean | TouchSprite | |
| trO : TransformObject | TouchSprite | |
| tt : TouchTransform | TouchSprite | |
| width : Number [override]
sets the width of the container
| TouchContainerFactory | |
| x_lock : Boolean | TouchSprite | |
| y_lock : Boolean | TouchSprite | |
| Property | Defined By | ||
|---|---|---|---|
| borderShape : Graphic | MaskContainer | ||
| cmlGestureList : Object | TouchContainerFactory | |
| graphicArray : List | MaskContainer | ||
| hitShape : Graphic | MaskContainer | ||
| _mShape : Graphic | MaskContainer | ||
| overallMask : Graphic | MaskContainer | ||
| _touchScreen : TouchContainer | MaskContainer | ||
| wShape : Graphic | MaskContainer | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor
| MaskContainer | ||
| activateTouch():void
TODO
| TouchContainerFactory | |
| addAllChildren():void
method searches the child and adds to the list
| TouchContainerFactory | |
| addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]
Registers event listeners. | TouchSprite | |
alphaHandler(e:GWGestureEvent):void | MaskContainer | ||
alphaShift(n:Number):void | MaskContainer | ||
| applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
| childToList(id:String, child:*):void
child appended to the childlist
| TouchContainerFactory | |
| clone():*
Clone method
| TouchContainer | |
cycleMasks(e:GWGestureEvent = null):void
cycles through multiple images
| MaskContainer | ||
displayComplete():void [override]
CML call back Initialisation
| MaskContainer | ||
dispose():void [override]
Dispose method to nullify listeners
| MaskContainer | ||
| hideIndex(index:int):void
hides child list index
| TouchContainer | |
| hideKey(key:String):void
hides childlist key visibility
| TouchContainer | |
init():void [override]
Initialisation method
| MaskContainer | ||
| makeGestureList(value:XMLList):Object
TODO
| TouchContainerFactory | |
| onTouchDown(event:TouchEvent, target:* = null):void
decides how to assign the captured touch point to a cluster
can pass to parent, an explicit target, an explicit list or
targets or a passed to any touch object in the local display stack. | TouchSprite | |
| parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | TouchContainer | |
| postparseCML(cml:XMLList):void
postparse method
| TouchContainerFactory | |
reset():void | MaskContainer | ||
| searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | TouchContainer | |
| setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainerFactory | |
| showIndex(index:int):void
shows index of the child list
| TouchContainer | |
| showKey(key:String):void
shows the child list key visibility
| TouchContainer | |
| updateClusterAnalysis():void | TouchSprite | |
| updateDebugDisplay():void | TouchSprite | |
| updateGesturePipeline():void | TouchSprite | |
| updateListeners():void
Registers/unregisters event handlers depending on the active modes
| TouchSprite | |
| updateMotionClusterAnalysis():void | TouchSprite | |
| updateProperties(state:Number = 0):void
update properties of child
| TouchContainerFactory | |
| updateSensorClusterAnalysis():void | TouchSprite | |
| updateTObjProcessing():void | TouchSprite | |
| _mShape | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _mShape:Graphic| _touchScreen | property |
protected var _touchScreen:TouchContainer| borderShape | property |
protected var borderShape:Graphic| counter | property |
counter:Number [read-only] public function get counter():Number| dragAngle | property |
dragAngle:Number public function get dragAngle():Number public function set dragAngle(value:Number):void| graphicArray | property |
protected var graphicArray:List| hitShape | property |
protected var hitShape:Graphic| maskBorderAlpha | property |
maskBorderAlpha:NumberAlpha for the border of the mask if desired. Must be set between 0 and 1 to be visible.
The default value is 0;.
public function get maskBorderAlpha():Number public function set maskBorderAlpha(value:Number):void| maskBorderColor | property |
maskBorderColor:uintMask border color, if a border is desired around the mask element.
The default value is 0x000000;.
public function get maskBorderColor():uint public function set maskBorderColor(value:uint):void| maskBorderStroke | property |
maskBorderStroke:NumberThe thickness of the border in pixels.
The default value is 0;.
public function get maskBorderStroke():Number public function set maskBorderStroke(value:Number):void| maskHeight | property |
maskHeight:NumberMask height for rectangles.
public function get maskHeight():Number public function set maskHeight(value:Number):void| maskRadius | property |
maskRadius:NumberThe property for the mask radius if the shape is a circle.
public function get maskRadius():Number public function set maskRadius(value:Number):void| maskRotation | property |
maskRotation:NumberSet the starting rotation of the mask.
public function get maskRotation():Number public function set maskRotation(value:Number):void| maskShape | property |
maskShape:StringThe string property to designate the shape the mask will be. "rectangle" or "circle" are options.
public function get maskShape():String public function set maskShape(value:String):void| maskWidth | property |
maskWidth:NumberMask width for rectangles.
public function get maskWidth():Number public function set maskWidth(value:Number):void| maskX | property |
maskX:NumberSet the mask's starting X position.
public function get maskX():Number public function set maskX(value:Number):void| maskY | property |
maskY:NumberSet the mask's starting Y position.
public function get maskY():Number public function set maskY(value:Number):void| mShape | property |
| overallMask | property |
protected var overallMask:Graphic| touchScreen | property |
touchScreen:TouchContainer [read-only] public function get touchScreen():TouchContainer| wShape | property |
protected var wShape:Graphic| MaskContainer | () | Constructor |
public function MaskContainer()Constructor
| alphaHandler | () | method |
| alphaShift | () | method |
public function alphaShift(n:Number):voidParameters
n:Number |
| cycleMasks | () | method |
public function cycleMasks(e:GWGestureEvent = null):voidcycles through multiple images
Parameters
e:GWGestureEvent (default = null) |
| displayComplete | () | method |
override public function displayComplete():voidCML call back Initialisation
| dispose | () | method |
override public function dispose():voidDispose method to nullify listeners
| init | () | method |
override public function init():voidInitialisation method
| reset | () | method |
public function reset():void