com.gestureworks.cml.element.Magnifier

Package	com.gestureworks.cml.element
Class	public class Magnifier
Inheritance	Magnifier TouchContainer TouchContainerFactory TouchSprite 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

Hide Inherited Public Properties

Show Inherited Public Properties

	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
		bitmapData : BitmapData	Magnifier
		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
		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
		distortionRadius : Number Set the amount of distortion or "fish-eye" effect the lens goes through before focusing cleanly.	Magnifier
		dN : Number	TouchSprite
		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
		graphic : String Sets the graphic type: default, notch, or none.	Magnifier
		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
		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
		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
		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
		radius : Number Radius of the total area of the lens, including distortion effects if any.	Magnifier
		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
		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

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		cmlGestureList : Object	TouchContainerFactory

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Magnifier() Constructor	Magnifier
		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
		applyLayout(value:* = null):void Apply the containers layout	TouchContainer
		childToList(id:String, child:*):void child appended to the childlist	TouchContainerFactory
		clone():* Clone method	TouchContainer
		displayComplete():void [override] CML call back Initialisation	Magnifier
		dispose():void [override] Dispose method to nullify the children	Magnifier
		hideIndex(index:int):void hides child list index	TouchContainer
		hideKey(key:String):void hides childlist key visibility	TouchContainer
		init():void [override]	Magnifier
		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
		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
		updateFilter():void	Magnifier
		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

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		childrenHaveUpdated():void This method is called after class initialization.	TouchContainerFactory
		displayHandler(event:DisplayEvent):void This method is called after class initialization.	TouchContainerFactory
		randomMinMax(min:Number, max:Number):Number This method is called after class initialization.	TouchContainerFactory
		scaleTransformHandler(event:GWTransformEvent):void This method is called after class initialization.	TouchContainerFactory
		thumbUpdate(event:Event):void This method is called after class initialization.	TouchContainerFactory

Property Detail

bitmapData

property

public var bitmapData:BitmapData

distortionRadius

property

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

graphic

property

graphic:String

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

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

magnification

property

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

radius

property

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

Tue Apr 16 2013, 03:24 PM -06:00

Gestureworks Flash 3.6	All Packages \| All Classes \| Index \| Frames No Frames
Magnifier	Properties \| Methods