Packagecom.gestureworks.interfaces
Interfacepublic interface ITouchObject extends flash.events.IEventDispatcher
Implementors TouchMovieClip, TouchSprite

Implements touch object base classes (TouchSprite and TouchMovieClip)



Public Properties
 PropertyDefined By
  active : Boolean
Lazy gesture activation (objects will not be registered until gestureList assignment).
ITouchObject
  affineTransform : Boolean
Determines whether gesture event driven transformations are affine on the touchSprite.
ITouchObject
  away3d : Boolean
Sets whether this is representing an Away3D object.
ITouchObject
  clusterBubbling : Boolean
Allows touch points from a childclusters to copy into container touch objects in the local parent child display list stack.
ITouchObject
  clusterEvents : Boolean
Determines whether clusterEvents are processed and dispatched on the touchSprite.
ITouchObject
  clusterID : int
ITouchObject
  cO : ClusterObject
ITouchObject
  debugDisplay : Boolean
Enables/Disables touch visualizer
ITouchObject
  deltaFilterOn : Boolean
Determines whether filtering is applied to the delta values.
ITouchObject
  dN : Number
ITouchObject
  eventListeners : Array
[read-only] Returns an array registered events
ITouchObject
  gestureEventComplete : Boolean
Indicates weather all gestureEvents have been completed on the touchSprite.
ITouchObject
  gestureEventRelease : Boolean
Indicates whether all touch points have been released on the touchSprite.
ITouchObject
  gestureEvents : Boolean
Determines whether gestureEvents are processed and dispatched on the touchSprite.
ITouchObject
  gestureEventStart : Boolean
Indicates whether any gestureEvents have been started on the touchSprite.
ITouchObject
  gestureFilters : Boolean
ITouchObject
  gestureList : Object
ITouchObject
  gestureReleaseInertia : Boolean
Determines whether release inertia is applied on the touchSprite.
ITouchObject
  gestureTouchInertia : Boolean
Determines whether touch inertia is processed on the touchSprite.
ITouchObject
  gestureTweenOn : Boolean
ITouchObject
  gO : GestureListObject
ITouchObject
  interactionPointCount : int
ITouchObject
  ipn : int
ITouchObject
  leap2D : Boolean
Local override to enable/disable leap2D input.
ITouchObject
  length : Number
length of object
ITouchObject
  localModes : Boolean
Flag indicating the application of local modes over the global settings.
ITouchObject
  maxRotation : Number
Maximum rotation in degrees.
ITouchObject
  maxRotationX : Number
Maximum x rotation
ITouchObject
  maxRotationY : Number
Maximum y rotation
ITouchObject
  maxRotationZ : Number
Maximum z rotation
ITouchObject
  maxScale : Number
Maximum scale.
ITouchObject
  maxScaleX : Number
Maximum x scale
ITouchObject
  maxScaleY : Number
Maximum y scale
ITouchObject
  maxScaleZ : Number
Maximum z scale
ITouchObject
  maxX : Number
Maximum x translation
ITouchObject
  maxY : Number
Maximum y translation
ITouchObject
  maxZ : Number
Maximum z translation
ITouchObject
  minRotation : Number
Minimum rotation in degrees.
ITouchObject
  minRotationX : Number
Minimum x rotation
ITouchObject
  minRotationY : Number
Minimum y rotation
ITouchObject
  minRotationZ : Number
Minimum z rotation
ITouchObject
  minScale : Number
Minimum scale.
ITouchObject
  minScaleX : Number
Minimum x scale
ITouchObject
  minScaleY : Number
Minimum y scale
ITouchObject
  minScaleZ : Number
Minimum z scale
ITouchObject
  minX : Number
Minimum x translation
ITouchObject
  minY : Number
Minimum y translation
ITouchObject
  minZ : Number
Minimum z translation
ITouchObject
  motionPointCount : int
ITouchObject
  N : int
ITouchObject
  nativeTouch : Boolean
Local override to enable/disable native touch input.
ITouchObject
  nativeTransform : Boolean
Determines whether transformations are handled internally (natively) on the touchSprite.
ITouchObject
  nestedTransform : Boolean
ITouchObject
  parent : DisplayObjectContainer
[read-only]
ITouchObject
  pointArray : Vector.<PointObject>
ITouchObject
  pointCount : int
ITouchObject
  registerPoints : Boolean
Determines if the touch points are registered to the TouchManager.
ITouchObject
  releaseInertia : Boolean
Determines whether release inertia is applied on the touchSprite.
ITouchObject
  scale : Number
Scales the transformation.
ITouchObject
  simulator : Boolean
Local override to enable/disable mouse input.
ITouchObject
  sO : StrokeObject
ITouchObject
  targetParent : Boolean
Allows touch and gesture events to explicitly target the parent touch object
ITouchObject
  tc : TouchCluster
ITouchObject
  tg : TouchGesture
ITouchObject
  tiO : TimelineObject
ITouchObject
  touchChildren : Boolean
Allows touch events to be passed down to child display object.
ITouchObject
  touchEnabled : Boolean
Enables/Disables all GWTouchEvent and GWGestureEvent listeners
ITouchObject
  touchObjectID : int
Unique id of the touch object
ITouchObject
  tp : TouchPipeline
ITouchObject
  tpn : int
ITouchObject
  traceDebugMode : Boolean
Debug trace statements
ITouchObject
  transform3d : Boolean
ITouchObject
  transformComplete : Boolean
ITouchObject
  transformEventComplete : Boolean
ITouchObject
  transformEvents : Boolean
Determines whether transformEvents are processed and dispatched on the touchSprite.
ITouchObject
  transformEventStart : Boolean
ITouchObject
  transformGestureVectors : Boolean
Determines whether transformations are handled internally (natively) on the touchSprite.
ITouchObject
  transformStart : Boolean
ITouchObject
  trO : TransformObject
ITouchObject
  tt : TouchTransform
ITouchObject
  tuio : Boolean
Local override to enable/disable tuio input.
ITouchObject
  view : DisplayObjectContainer
view container used for Away3D
ITouchObject
  visualizer : TouchVisualizer
ITouchObject
  vto : Object
Virtual transform object (non-TouchSprite) to transfer the transformations to
ITouchObject
  x_lock : Boolean
ITouchObject
  y_lock : Boolean
ITouchObject
Public Methods
 MethodDefined By
  
Unregisters all event listeners
ITouchObject
  
Re-registers event listeners with updated mode settings
ITouchObject
  
updateVTO():void
Updates target's transform
ITouchObject
Property Detail
activeproperty
active:Boolean

Lazy gesture activation (objects will not be registered until gestureList assignment).

The default value is false.


Implementation
    public function get active():Boolean
    public function set active(value:Boolean):void
affineTransformproperty 
affineTransform:Boolean

Determines whether gesture event driven transformations are affine on the touchSprite.

The default value is false.


Implementation
    public function get affineTransform():Boolean
    public function set affineTransform(value:Boolean):void
away3dproperty 
away3d:Boolean

Sets whether this is representing an Away3D object.

The default value is true.


Implementation
    public function get away3d():Boolean
    public function set away3d(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.

The default value is false.


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

Determines whether clusterEvents are processed and dispatched on the touchSprite.

The default value is false.


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
cOproperty 
cO:ClusterObject


Implementation
    public function get cO():ClusterObject
    public function set cO(value:ClusterObject):void
debugDisplayproperty 
debugDisplay:Boolean

Enables/Disables touch visualizer

The default value is false.


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

Determines whether filtering is applied to the delta values.

The default value is false.


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


Implementation
    public function get dN():Number
    public function set dN(value:Number):void
eventListenersproperty 
eventListeners:Array  [read-only]

Returns an array registered events


Implementation
    public function get eventListeners():Array
gestureEventCompleteproperty 
gestureEventComplete:Boolean

Indicates weather all gestureEvents have been completed on the touchSprite.

The default value is true.


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.

The default value is true.


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

Determines whether gestureEvents are processed and dispatched on the touchSprite.

The default value is true.


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.

The default value is true.


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

The default value is true.


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

Determines whether release inertia is applied on the touchSprite. Same as releaseInertia()

The default value is false.


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

Determines whether touch inertia is processed on the touchSprite.

The default value is false.


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

The default value is false.


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


Implementation
    public function get gO():GestureListObject
    public function set gO(value:GestureListObject):void
interactionPointCountproperty 
interactionPointCount:int


Implementation
    public function get interactionPointCount():int
    public function set interactionPointCount(value:int):void
ipnproperty 
ipn:int


Implementation
    public function get ipn():int
    public function set ipn(value:int):void
leap2Dproperty 
leap2D:Boolean

Local override to enable/disable leap2D input.

The default value is false.


Implementation
    public function get leap2D():Boolean
    public function set leap2D(value:Boolean):void

See also

localModes
lengthproperty 
length:Number

length of object

The default value is true.


Implementation
    public function get length():Number
    public function set length(value:Number):void
localModesproperty 
localModes:Boolean

Flag indicating the application of local modes over the global settings. By default, all objects are enabled for input processing based on the application level mode settings (i.e. nativeTouch, simulator, tuio, etc.). This flag allows the inclusion/exclusion of specific input interaction according to local overrides. Note that the corresponding global setting must be enabled in order to locally enable the input.

The default value is false.


Implementation
    public function get localModes():Boolean
    public function set localModes(value:Boolean):void
maxRotationproperty 
maxRotation:Number

Maximum rotation in degrees. Applies setting to both maximum x and y rotations.


Implementation
    public function get maxRotation():Number
    public function set maxRotation(value:Number):void

See also

maxRotationX
maxRotationY
maxRotationXproperty 
maxRotationX:Number

Maximum x rotation


Implementation
    public function get maxRotationX():Number
    public function set maxRotationX(value:Number):void
maxRotationYproperty 
maxRotationY:Number

Maximum y rotation


Implementation
    public function get maxRotationY():Number
    public function set maxRotationY(value:Number):void
maxRotationZproperty 
maxRotationZ:Number

Maximum z rotation


Implementation
    public function get maxRotationZ():Number
    public function set maxRotationZ(value:Number):void
maxScaleproperty 
maxScale:Number

Maximum scale. Applies settings to both maximum x and y scales.


Implementation
    public function get maxScale():Number
    public function set maxScale(value:Number):void

See also

maxScaleX
maxScaleY
maxScaleXproperty 
maxScaleX:Number

Maximum x scale


Implementation
    public function get maxScaleX():Number
    public function set maxScaleX(value:Number):void
maxScaleYproperty 
maxScaleY:Number

Maximum y scale


Implementation
    public function get maxScaleY():Number
    public function set maxScaleY(value:Number):void
maxScaleZproperty 
maxScaleZ:Number

Maximum z scale


Implementation
    public function get maxScaleZ():Number
    public function set maxScaleZ(value:Number):void
maxXproperty 
maxX:Number

Maximum x translation


Implementation
    public function get maxX():Number
    public function set maxX(value:Number):void
maxYproperty 
maxY:Number

Maximum y translation


Implementation
    public function get maxY():Number
    public function set maxY(value:Number):void
maxZproperty 
maxZ:Number

Maximum z translation


Implementation
    public function get maxZ():Number
    public function set maxZ(value:Number):void
minRotationproperty 
minRotation:Number

Minimum rotation in degrees. Applies setting to both minimum x and y rotations.


Implementation
    public function get minRotation():Number
    public function set minRotation(value:Number):void

See also

minRotationX
minRotationY
minRotationXproperty 
minRotationX:Number

Minimum x rotation


Implementation
    public function get minRotationX():Number
    public function set minRotationX(value:Number):void
minRotationYproperty 
minRotationY:Number

Minimum y rotation


Implementation
    public function get minRotationY():Number
    public function set minRotationY(value:Number):void
minRotationZproperty 
minRotationZ:Number

Minimum z rotation


Implementation
    public function get minRotationZ():Number
    public function set minRotationZ(value:Number):void
minScaleproperty 
minScale:Number

Minimum scale. Applies setting to both minimum x and y scales.


Implementation
    public function get minScale():Number
    public function set minScale(value:Number):void

See also

minScaleX
minScaleY
minScaleXproperty 
minScaleX:Number

Minimum x scale


Implementation
    public function get minScaleX():Number
    public function set minScaleX(value:Number):void
minScaleYproperty 
minScaleY:Number

Minimum y scale


Implementation
    public function get minScaleY():Number
    public function set minScaleY(value:Number):void
minScaleZproperty 
minScaleZ:Number

Minimum z scale


Implementation
    public function get minScaleZ():Number
    public function set minScaleZ(value:Number):void
minXproperty 
minX:Number

Minimum x translation


Implementation
    public function get minX():Number
    public function set minX(value:Number):void
minYproperty 
minY:Number

Minimum y translation


Implementation
    public function get minY():Number
    public function set minY(value:Number):void
minZproperty 
minZ:Number

Minimum z translation


Implementation
    public function get minZ():Number
    public function set minZ(value:Number):void
motionPointCountproperty 
motionPointCount:int


Implementation
    public function get motionPointCount():int
    public function set motionPointCount(value:int):void
Nproperty 
N:int


Implementation
    public function get N():int
    public function set N(value:int):void
nativeTouchproperty 
nativeTouch:Boolean

Local override to enable/disable native touch input.

The default value is false.


Implementation
    public function get nativeTouch():Boolean
    public function set nativeTouch(value:Boolean):void

See also

localModes
nativeTransformproperty 
nativeTransform:Boolean

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

The default value is false.


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

The default value is false.


Implementation
    public function get nestedTransform():Boolean
    public function set nestedTransform(value:Boolean):void
parentproperty 
parent:DisplayObjectContainer  [read-only]


Implementation
    public function get parent():DisplayObjectContainer
pointArrayproperty 
pointArray:Vector.<PointObject>


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


Implementation
    public function get pointCount():int
    public function set pointCount(value:int):void
registerPointsproperty 
registerPoints:Boolean

Determines if the touch points are registered to the TouchManager. One can override this behaivor by setting the value to false. This is useful when creating custom TouchSprite extensions and external framework bindings.

The default value is true.


Implementation
    public function get registerPoints():Boolean
    public function set registerPoints(value:Boolean):void
releaseInertiaproperty 
releaseInertia:Boolean

Determines whether release inertia is applied on the touchSprite. Same as gestureReleaseInertia()

The default value is false.


Implementation
    public function get releaseInertia():Boolean
    public function set releaseInertia(value:Boolean):void
scaleproperty 
scale:Number

Scales the transformation. Applies setting to both x and y scales.

The default value is 1.


Implementation
    public function get scale():Number
    public function set scale(value:Number):void
simulatorproperty 
simulator:Boolean

Local override to enable/disable mouse input.

The default value is false.


Implementation
    public function get simulator():Boolean
    public function set simulator(value:Boolean):void

See also

localModes
sOproperty 
sO:StrokeObject


Implementation
    public function get sO():StrokeObject
    public function set sO(value:StrokeObject):void
targetParentproperty 
targetParent:Boolean

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

The default value is false.


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


Implementation
    public function get tc():TouchCluster
    public function set tc(value:TouchCluster):void
tgproperty 
tg:TouchGesture


Implementation
    public function get tg():TouchGesture
    public function set tg(value:TouchGesture):void
tiOproperty 
tiO:TimelineObject


Implementation
    public function get tiO():TimelineObject
    public function set tiO(value:TimelineObject):void
touchChildrenproperty 
touchChildren:Boolean

Allows touch events to be passed down to child display object. Has the same function as MouseChildren.

The default value is false.


Implementation
    public function get touchChildren():Boolean
    public function set touchChildren(value:Boolean):void
touchEnabledproperty 
touchEnabled:Boolean

Enables/Disables all GWTouchEvent and GWGestureEvent listeners

The default value is true.


Implementation
    public function get touchEnabled():Boolean
    public function set touchEnabled(value:Boolean):void
touchObjectIDproperty 
touchObjectID:int

Unique id of the touch object


Implementation
    public function get touchObjectID():int
    public function set touchObjectID(value:int):void
tpproperty 
tp:TouchPipeline


Implementation
    public function get tp():TouchPipeline
    public function set tp(value:TouchPipeline):void
tpnproperty 
tpn:int


Implementation
    public function get tpn():int
    public function set tpn(value:int):void
traceDebugModeproperty 
traceDebugMode:Boolean

Debug trace statements

The default value is false.


Implementation
    public function get traceDebugMode():Boolean
    public function set traceDebugMode(value:Boolean):void
transform3dproperty 
transform3d:Boolean

The default value is false.


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

The default value is false.


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

The default value is true.


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

Determines whether transformEvents are processed and dispatched on the touchSprite.

The default value is false.


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

The default value is true.


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

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

The default value is true.


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

The default value is false.


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


Implementation
    public function get trO():TransformObject
    public function set trO(value:TransformObject):void
ttproperty 
tt:TouchTransform


Implementation
    public function get tt():TouchTransform
    public function set tt(value:TouchTransform):void
tuioproperty 
tuio:Boolean

Local override to enable/disable tuio input.

The default value is false.


Implementation
    public function get tuio():Boolean
    public function set tuio(value:Boolean):void

See also

localModes
viewproperty 
view:DisplayObjectContainer

view container used for Away3D


Implementation
    public function get view():DisplayObjectContainer
    public function set view(value:DisplayObjectContainer):void
visualizerproperty 
visualizer:TouchVisualizer


Implementation
    public function get visualizer():TouchVisualizer
    public function set visualizer(value:TouchVisualizer):void
vtoproperty 
vto:Object

Virtual transform object (non-TouchSprite) to transfer the transformations to


Implementation
    public function get vto():Object
    public function set vto(value:Object):void
x_lockproperty 
x_lock:Boolean

The default value is false.


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

The default value is false.


Implementation
    public function get y_lock():Boolean
    public function set y_lock(value:Boolean):void
Method Detail
removeAllListeners()method
public function removeAllListeners():void

Unregisters all event listeners

updateListeners()method 
public function updateListeners():void

Re-registers event listeners with updated mode settings

updateVTO()method 
public function updateVTO():void

Updates target's transform