Packagecom.gestureworks.cml.element
Classpublic class Magnifier
InheritanceMagnifier Inheritance TouchContainer Inheritance TouchContainerFactory Inheritance TouchSprite Inheritance flash.display.Sprite

The Magnifier element provides a touch enabled element with an optional graphical lens that will increase the magnification when placed over any display object on the stage.

Note that if the stage does not have a background image or display object of some sort, the MagnifierElement will simply retain visual data from the last object it was held over until brought to another display object.

The MagnifierElement has an optional fish-eye effect that can be altered using distortionRadius. The magnifier has two optional graphics, or can be left on its own with "default", "notch", or "none".

Rotation gestures on the magnifier will zoom it in.

     
        var magnifier:MagnifierElement = new MagnifierElement();
        magnifier.x = 550;
        magnifier.y = 150;
        magnifier.radius = 100;
        magnifier.magnification = 2;
        magnifier.distortionRadius = 40;
        magnifier.graphic = "default";
        
        addChild(magnifier);
        
        magnifier.init();
     
     



Public Properties
 PropertyDefined By
 Inherited_$height : Number = 0
TouchSprite
 Inherited_$rotation : Number = 0
TouchSprite
 Inherited$rotation : Number
TouchSprite
 Inherited_$scaleX : Number = 1
TouchSprite
 Inherited$scaleX : Number
TouchSprite
 Inherited_$scaleY : Number = 1
TouchSprite
 Inherited$scaleY : Number
TouchSprite
 Inherited$transformPoint : Point
TouchSprite
 Inherited_$width : Number = 0
TouchSprite
 Inherited_$x : Number = 0
TouchSprite
 Inherited$x : Number
TouchSprite
 Inherited_$y : Number = 0
TouchSprite
 Inherited$y : Number
TouchSprite
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainerFactory
  bitmapData : BitmapData
Magnifier
 InheritedbroadcastTarget : Boolean
TouchSprite
 InheritedchildList : ChildList
[read-only] returns the childlist
TouchContainerFactory
 Inheritedclass_ : String
Object's css class;
TouchContainerFactory
 InheritedclassName : String
sets the class name of displayobject
TouchContainerFactory
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedclusterBubbling : Boolean
Allows touch points from a childclusters to copy into container touch objects in the local parent child display list stack.
TouchSprite
 InheritedclusterEvents : Boolean
Determins whether clusterEvents are processed and dispatched on the touchSprite.
TouchSprite
 InheritedclusterID : int
TouchSprite
 InheritedcmlIndex : int
sets the cml index
TouchContainerFactory
 Inheritedcml_item : Boolean
TouchSprite
 InheritedcO : ClusterObject
TouchSprite
 InheriteddebugDisplay : Boolean
TouchSprite
 InheriteddeltaFilterOn : Boolean
Determins whether filtering is applied to the delta values.
TouchSprite
 InheriteddimensionsTo : String
sets the dimensions of touchcontainer
TouchContainerFactory
 InheriteddisableAffineTransform : Boolean
Determins whether internal (native) transformations are affine (dynamically centered) on the touchSprite.
TouchSprite
 InheriteddisableNativeTransform : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite.
TouchSprite
  distortionRadius : Number
Set the amount of distortion or "fish-eye" effect the lens goes through before focusing cleanly.
Magnifier
 InheriteddN : Number
TouchSprite
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainerFactory
 InheritedGESTRELIST_UPDATE : String = gestureList update
[static]
TouchSprite
 InheritedgestureEventComplete : Boolean
Indicates weather all gestureEvents have been completed on the touchSprite.
TouchSprite
 InheritedgestureEventRelease : Boolean
Indicates whether all touch points have been released on the touchSprite.
TouchSprite
 InheritedgestureEvents : Boolean
Determins whether gestureEvents are processed and dispatched on the touchSprite.
TouchSprite
 InheritedgestureEventStart : Boolean
Indicates whether any gestureEvents have been started on the touchSprite.
TouchSprite
 InheritedgestureFilters : Boolean
TouchSprite
 InheritedgestureList : Object
TouchSprite
 InheritedgestureReleaseInertia : Boolean
Determins whether release inertia is given to gestureEvents on the touchSprite.
TouchSprite
 InheritedgestureTouchInertia : Boolean
Determins whether touch inertia is processed on the touchSprite.
TouchSprite
 Inherited_gestureTweenOn : Boolean = false
TouchSprite
 InheritedgestureTweenOn : Boolean
TouchSprite
 InheritedgO : GestureListObject
TouchSprite
  graphic : String
Sets the graphic type: default, notch, or none.
Magnifier
 Inheritedgroup : String
TouchContainerFactory
 Inheritedheight : Number
[override] sets the height of the container
TouchContainerFactory
 Inheritedid : String
sets childlist id
TouchContainerFactory
 Inheritedlayout : *
speciffies the type of layout
TouchContainerFactory
 InheritedlayoutComplete : Function
Sets the function to call when the layout is complete
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
 InheritedlayoutUpdate : Function
Sets the function to call when the layout updates
TouchContainer
  magnification : Number
The value of magnification of the lens, this can be increased or decreasted by performing a rotation gesture on the lens, and its starting value can be set in CML.
Magnifier
 InheritedmaxScale : Number
This method is called after class initialization.
TouchContainerFactory
 InheritedminScale : Number
This method is called after class initialization.
TouchContainerFactory
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainerFactory
 InheritedN : int
TouchSprite
 InheritednestedTransform : Boolean
TouchSprite
 Inheritedoutline_alpha : Number
sets the alpha of outline
TouchContainerFactory
 Inheritedoutline_color : Number
sets the color of outline
TouchContainerFactory
 Inheritedoutline_joint : String
TODO
TouchContainerFactory
 InheritedoutlineOn : String
specifies the outline of container to true or false
TouchContainerFactory
 Inheritedoutline_stroke : int
sets the line stroke of outline
TouchContainerFactory
 InheritedpointArray : Vector.<PointObject>
[read-only]
TouchSprite
 InheritedpointCount : int
TouchSprite
 InheritedpropertyStates : Array
Deprecated: Please Use state
TouchContainerFactory
  radius : Number
Radius of the total area of the lens, including distortion effects if any.
Magnifier
 Inheritedscale : Number
Scales display object
TouchContainer
 InheritedsO : StrokeObject
TouchSprite
 Inheritedstate : Array
property states array
TouchContainerFactory
 Inheritedtargeting : Boolean
Turns off manual ALL targeting control, defaults to a simple hit test targeting model with exclusive target clustering
TouchSprite
 InheritedtargetList : 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
 InheritedtargetObject : Object
Allows touch and gesture events to explicitly target a touch object this can be outside the local parent child display list stack
TouchSprite
 InheritedtargetParent : Boolean
Allows touch and gesture events to explicitly target the parent touch object
TouchSprite
 Inheritedtc : TouchCluster
TouchSprite
 Inheritedtd : TouchDebugDisplay
TouchSprite
 Inheritedtg : TouchGesture
TouchSprite
 InheritedtiO : TimelineObject
TouchSprite
 InheritedtouchChildren : Boolean
TouchSprite
 InheritedtouchObjectID : int
[read-only]
TouchSprite
 Inheritedtp : TouchPipeline
TouchSprite
 InheritedtraceDebugModeOn : Boolean
TouchSprite
 InheritedtransformComplete : Boolean
TouchSprite
 InheritedtransformEventComplete : Boolean
TouchSprite
 InheritedtransformEvents : Boolean
Determins whether transformEvents are processed and dispatched on the touchSprite.
TouchSprite
 InheritedtransformEventStart : Boolean
TouchSprite
 InheritedtransformGestureVectors : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite.
TouchSprite
 InheritedtransformStart : Boolean
TouchSprite
 InheritedtrO : TransformObject
TouchSprite
 Inheritedtt : TouchTransform
TouchSprite
 Inheritedwidth : Number
[override] sets the width of the container
TouchContainerFactory
 Inheritedx_lock : Boolean
TouchSprite
 Inheritedy_lock : Boolean
TouchSprite
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainerFactory
Public Methods
 MethodDefined By
  
Constructor
Magnifier
 Inherited
TODO
TouchContainerFactory
 Inherited
method searches the child and adds to the list
TouchContainerFactory
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override] Registers event listeners.
TouchSprite
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainerFactory
 Inherited
clone():*
Clone method
TouchContainer
  
[override] CML call back Initialisation
Magnifier
  
dispose():void
[override] Dispose method to nullify the children
Magnifier
 Inherited
hideIndex(index:int):void
hides child list index
TouchContainer
 Inherited
hideKey(key:String):void
hides childlist key visibility
TouchContainer
  
init():void
[override]
Magnifier
 Inherited
makeGestureList(value:XMLList):Object
TODO
TouchContainerFactory
 Inherited
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
 Inherited
parseCML(cml:XMLList):XMLList
[override] Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
postparse method
TouchContainerFactory
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
 Inherited
method sets the dimensions of each child
TouchContainerFactory
 Inherited
showIndex(index:int):void
shows index of the child list
TouchContainer
 Inherited
showKey(key:String):void
shows the child list key visibility
TouchContainer
 Inherited
TouchSprite
 Inherited
TouchSprite
  
Magnifier
 Inherited
TouchSprite
 Inherited
Registers/unregisters event handlers depending on the active modes
TouchSprite
 Inherited
TouchSprite
 Inherited
updateProperties(state:Number = 0):void
update properties of child
TouchContainerFactory
 Inherited
TouchSprite
 Inherited
TouchSprite
Protected Methods
 MethodDefined By
 Inherited
This method is called after class initialization.
TouchContainerFactory
 Inherited
This method is called after class initialization.
TouchContainerFactory
 Inherited
randomMinMax(min:Number, max:Number):Number
This method is called after class initialization.
TouchContainerFactory
 Inherited
This method is called after class initialization.
TouchContainerFactory
 Inherited
thumbUpdate(event:Event):void
This method is called after class initialization.
TouchContainerFactory
Property Detail
bitmapDataproperty
public var bitmapData:BitmapData

distortionRadiusproperty 
distortionRadius:Number

Set the amount of distortion or "fish-eye" effect the lens goes through before focusing cleanly. This amount is subtracted from the radius to create the focal area, so if the radius is 100, and the distortionRadius is 30, then the "focused" area will have a radius of 70. If the distortion and radius are equal, there will be no in-focus area. The maximum is whatever the radius is, the minimum is 0. Setting a graphic will hide the distortion unless it is made fairly large.

The default value is 30.


Implementation
    public function get distortionRadius():Number
    public function set distortionRadius(value:Number):void
graphicproperty 
graphic:String

Sets the graphic type: default, notch, or none.


Implementation
    public function get graphic():String
    public function set graphic(value:String):void
magnificationproperty 
magnification:Number

The value of magnification of the lens, this can be increased or decreasted by performing a rotation gesture on the lens, and its starting value can be set in CML. The max magnification is 50, the minimum is 1.

The default value is 5;.


Implementation
    public function get magnification():Number
    public function set magnification(value:Number):void
radiusproperty 
radius:Number

Radius of the total area of the lens, including distortion effects if any.

The default value is 100.


Implementation
    public function get radius():Number
    public function set radius(value:Number):void
Constructor Detail
Magnifier()Constructor
public function Magnifier()

Constructor

Method Detail
displayComplete()method
override public function displayComplete():void

CML call back Initialisation

dispose()method 
override public function dispose():void

Dispose method to nullify the children

init()method 
override public function init():void

updateFilter()method 
public function updateFilter():void