Packagecom.gestureworks.core
Classpublic class TouchSprite
InheritanceTouchSprite Inheritance flash.display.Sprite
Subclasses TouchContainerFactory

The TouchSpriteBase class is the base class for all touch and gestures enabled Sprites that require additional display list management.
	 		              Properties
	 		mouseChildren="false"
	 	touchChildren="false"
	 	targetParent = "false"
	 	disableNativeTransform = "true"
	 	disableAffineTransform = "true"
	 	gestureEvents = "true"
	 	clusterEvents = "false"
	 	transformEvents = "false"
	 



Public Properties
 PropertyDefined 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
  broadcastTarget : Boolean
TouchSprite
  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
  cml_item : Boolean
TouchSprite
  cO : ClusterObject
TouchSprite
  debugDisplay : Boolean
TouchSprite
  deltaFilterOn : Boolean
Determins whether filtering is applied to the delta values.
TouchSprite
  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
  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
  N : int
TouchSprite
  nestedTransform : Boolean
TouchSprite
  pointArray : Vector.<PointObject>
[read-only]
TouchSprite
  pointCount : int
TouchSprite
  sO : StrokeObject
TouchSprite
  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
  x_lock : Boolean
TouchSprite
  y_lock : Boolean
TouchSprite
Public Methods
 MethodDefined By
  
TouchSprite
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override] Registers event listeners.
TouchSprite
  
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
  
TouchSprite
  
TouchSprite
  
TouchSprite
  
Registers/unregisters event handlers depending on the active modes
TouchSprite
  
TouchSprite
  
TouchSprite
  
TouchSprite
Property Detail
_$heightproperty
public var _$height:Number = 0

_$rotationproperty 
public var _$rotation:Number = 0

_$scaleXproperty 
public var _$scaleX:Number = 1

_$scaleYproperty 
public var _$scaleY:Number = 1

_$widthproperty 
public var _$width:Number = 0

_$xproperty 
public var _$x:Number = 0

_$yproperty 
public var _$y:Number = 0

_gestureTweenOnproperty 
public var _gestureTweenOn:Boolean = false

$rotationproperty 
$rotation:Number


Implementation
    public function get $rotation():Number
    public function set $rotation(value:Number):void
$scaleXproperty 
$scaleX:Number


Implementation
    public function get $scaleX():Number
    public function set $scaleX(value:Number):void
$scaleYproperty 
$scaleY:Number


Implementation
    public function get $scaleY():Number
    public function set $scaleY(value:Number):void
$transformPointproperty 
$transformPoint:Point


Implementation
    public function get $transformPoint():Point
    public function set $transformPoint(value:Point):void
$xproperty 
$x:Number


Implementation
    public function get $x():Number
    public function set $x(value:Number):void
$yproperty 
$y:Number


Implementation
    public function get $y():Number
    public function set $y(value:Number):void
broadcastTargetproperty 
broadcastTarget:Boolean


Implementation
    public function get broadcastTarget():Boolean
    public function set broadcastTarget(value:Boolean):void
clusterBubblingproperty 
clusterBubbling:Boolean

Allows touch points from a childclusters to copy into container touch objects in the local parent child display list stack. This allows the for the concept of parallel clustering of touch point. Where a single touch point can simultaniuosly be a member of multiple touch point clusters. This allows multiple gestures to be dispatched from multiple touch objects from a set of touch points.


Implementation
    public function get clusterBubbling():Boolean
    public function set clusterBubbling(value:Boolean):void
clusterEventsproperty 
clusterEvents:Boolean

Determins whether clusterEvents are processed and dispatched on the touchSprite.


Implementation
    public function get clusterEvents():Boolean
    public function set clusterEvents(value:Boolean):void
clusterIDproperty 
clusterID:int


Implementation
    public function get clusterID():int
    public function set clusterID(value:int):void
cml_itemproperty 
cml_item:Boolean


Implementation
    public function get cml_item():Boolean
    public function set cml_item(value:Boolean):void
cOproperty 
public var cO:ClusterObject

debugDisplayproperty 
debugDisplay:Boolean


Implementation
    public function get debugDisplay():Boolean
    public function set debugDisplay(value:Boolean):void
deltaFilterOnproperty 
deltaFilterOn:Boolean

Determins whether filtering is applied to the delta values.


Implementation
    public function get deltaFilterOn():Boolean
    public function set deltaFilterOn(value:Boolean):void
disableAffineTransformproperty 
disableAffineTransform:Boolean

Determins whether internal (native) transformations are affine (dynamically centered) on the touchSprite.


Implementation
    public function get disableAffineTransform():Boolean
    public function set disableAffineTransform(value:Boolean):void
disableNativeTransformproperty 
disableNativeTransform:Boolean

Determins whether transformations are handled internally (natively) on the touchSprite.


Implementation
    public function get disableNativeTransform():Boolean
    public function set disableNativeTransform(value:Boolean):void
dNproperty 
dN:Number


Implementation
    public function get dN():Number
    public function set dN(value:Number):void
GESTRELIST_UPDATEproperty 
public static var GESTRELIST_UPDATE:String = gestureList update

gestureEventCompleteproperty 
gestureEventComplete:Boolean

Indicates weather all gestureEvents have been completed on the touchSprite.


Implementation
    public function get gestureEventComplete():Boolean
    public function set gestureEventComplete(value:Boolean):void
gestureEventReleaseproperty 
gestureEventRelease:Boolean

Indicates whether all touch points have been released on the touchSprite.


Implementation
    public function get gestureEventRelease():Boolean
    public function set gestureEventRelease(value:Boolean):void
gestureEventsproperty 
gestureEvents:Boolean

Determins whether gestureEvents are processed and dispatched on the touchSprite.


Implementation
    public function get gestureEvents():Boolean
    public function set gestureEvents(value:Boolean):void
gestureEventStartproperty 
gestureEventStart:Boolean

Indicates whether any gestureEvents have been started on the touchSprite.


Implementation
    public function get gestureEventStart():Boolean
    public function set gestureEventStart(value:Boolean):void
gestureFiltersproperty 
gestureFilters:Boolean


Implementation
    public function get gestureFilters():Boolean
    public function set gestureFilters(value:Boolean):void
gestureListproperty 
gestureList:Object


Implementation
    public function get gestureList():Object
    public function set gestureList(value:Object):void
gestureReleaseInertiaproperty 
gestureReleaseInertia:Boolean

Determins whether release inertia is given to gestureEvents on the touchSprite.


Implementation
    public function get gestureReleaseInertia():Boolean
    public function set gestureReleaseInertia(value:Boolean):void
gestureTouchInertiaproperty 
gestureTouchInertia:Boolean

Determins whether touch inertia is processed on the touchSprite.


Implementation
    public function get gestureTouchInertia():Boolean
    public function set gestureTouchInertia(value:Boolean):void
gestureTweenOnproperty 
gestureTweenOn:Boolean


Implementation
    public function get gestureTweenOn():Boolean
    public function set gestureTweenOn(value:Boolean):void
gOproperty 
public var gO:GestureListObject

Nproperty 
N:int


Implementation
    public function get N():int
    public function set N(value:int):void
nestedTransformproperty 
nestedTransform:Boolean


Implementation
    public function get nestedTransform():Boolean
    public function set nestedTransform(value:Boolean):void
pointArrayproperty 
pointArray:Vector.<PointObject>  [read-only]


Implementation
    public function get pointArray():Vector.<PointObject>
pointCountproperty 
pointCount:int


Implementation
    public function get pointCount():int
    public function set pointCount(value:int):void
sOproperty 
public var sO:StrokeObject

targetingproperty 
targeting:Boolean

Turns off manual ALL targeting control, defaults to a simple hit test targeting model with exclusive target clustering


Implementation
    public function get targeting():Boolean
    public function set targeting(value:Boolean):void
targetListproperty 
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


Implementation
    public function get targetList():Array
    public function set targetList(value:Array):void
targetObjectproperty 
targetObject:Object

Allows touch and gesture events to explicitly target a touch object this can be outside the local parent child display list stack


Implementation
    public function get targetObject():Object
    public function set targetObject(value:Object):void
targetParentproperty 
targetParent:Boolean

Allows touch and gesture events to explicitly target the parent touch object


Implementation
    public function get targetParent():Boolean
    public function set targetParent(value:Boolean):void
tcproperty 
public var tc:TouchCluster

tdproperty 
public var td:TouchDebugDisplay

tgproperty 
public var tg:TouchGesture

tiOproperty 
public var tiO:TimelineObject

touchChildrenproperty 
touchChildren:Boolean


Implementation
    public function get touchChildren():Boolean
    public function set touchChildren(value:Boolean):void
touchObjectIDproperty 
touchObjectID:int  [read-only]


Implementation
    public function get touchObjectID():int
tpproperty 
public var tp:TouchPipeline

traceDebugModeOnproperty 
traceDebugModeOn:Boolean


Implementation
    public function get traceDebugModeOn():Boolean
    public function set traceDebugModeOn(value:Boolean):void
transformCompleteproperty 
transformComplete:Boolean


Implementation
    public function get transformComplete():Boolean
    public function set transformComplete(value:Boolean):void
transformEventCompleteproperty 
transformEventComplete:Boolean


Implementation
    public function get transformEventComplete():Boolean
    public function set transformEventComplete(value:Boolean):void
transformEventsproperty 
transformEvents:Boolean

Determins whether transformEvents are processed and dispatched on the touchSprite.


Implementation
    public function get transformEvents():Boolean
    public function set transformEvents(value:Boolean):void
transformEventStartproperty 
transformEventStart:Boolean


Implementation
    public function get transformEventStart():Boolean
    public function set transformEventStart(value:Boolean):void
transformGestureVectorsproperty 
transformGestureVectors:Boolean

Determins whether transformations are handled internally (natively) on the touchSprite.


Implementation
    public function get transformGestureVectors():Boolean
    public function set transformGestureVectors(value:Boolean):void
transformStartproperty 
transformStart:Boolean


Implementation
    public function get transformStart():Boolean
    public function set transformStart(value:Boolean):void
trOproperty 
public var trO:TransformObject

ttproperty 
public var tt:TouchTransform

x_lockproperty 
x_lock:Boolean


Implementation
    public function get x_lock():Boolean
    public function set x_lock(value:Boolean):void
y_lockproperty 
y_lock:Boolean


Implementation
    public function get y_lock():Boolean
    public function set y_lock(value:Boolean):void
Constructor Detail
TouchSprite()Constructor
public function TouchSprite()



Method Detail
addEventListener()method
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Registers event listeners. Also processes GWTouchEvents by evaluating which types of touch events (TUIO, native touch, and mouse) are active then registers and dispatches appropriate events.

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
useWeakReference:Boolean (default = false)

onTouchDown()method 
public function 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.

Parameters

event:TouchEvent
 
target:* (default = null)

updateClusterAnalysis()method 
public function updateClusterAnalysis():void

updateDebugDisplay()method 
public function updateDebugDisplay():void

updateGesturePipeline()method 
public function updateGesturePipeline():void

updateListeners()method 
public function updateListeners():void

Registers/unregisters event handlers depending on the active modes

updateMotionClusterAnalysis()method 
public function updateMotionClusterAnalysis():void

updateSensorClusterAnalysis()method 
public function updateSensorClusterAnalysis():void

updateTObjProcessing()method 
public function updateTObjProcessing():void