| Package | com.gestureworks.cml.element |
| Class | public class Frame |
| Inheritance | Frame  GraphicFactory TouchContainer TouchContainerFactory TouchSprite flash.display.Sprite |
| Subclasses | FrameElement |
var frame:Frame = new Frame();
frame.width = 300;
frame.height = 300;
frame.x = 700;
frame.y = 200;
frame.frameAlpha = .7;
frame.frameColor = 0xAAAABB;
frame.frameThickness = 20;
frame.init();
addChild(frame);
| 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 | |
| anchorX : Number
Sets the anchor X of curve. | GraphicFactory | |
| anchorY : Number
Sets the anchor Y of curve. | GraphicFactory | |
| autoShuffle : Boolean
autoshuffles
| TouchContainerFactory | |
| bottomLeftRadius : Number
sets the bottom left radius of the graphic object
| GraphicFactory | |
| bottomRightRadius : Number
sets the bottom right radius of the graphic object
| GraphicFactory | |
| 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 | |
| color : uint
Sets fill color when fill type is color
| GraphicFactory | |
| controlX : Number
Sets the control X of curve. | GraphicFactory | |
| controlY : Number
Sets the control y value of curve. | GraphicFactory | |
| cornerHeight : Number
Sets the height of the ellipse that is used to round the rectangle. | GraphicFactory | |
| cornerWidth : Number
Sets the width of the ellipse that is used to round the rectangle. | GraphicFactory | |
| 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 | |
| dropShadow : Boolean
Sets the drop shadow effect
| TouchContainerFactory | |
| fill : String
Sets fill type, choose: color, gradient
todo: implement shader and bitmap fills
| GraphicFactory | |
| fillAlpha : Number
Sets fill alpha when fill type is color
| GraphicFactory | |
| frameAlpha : Number
Sets frame thickness
| Frame | ||
| frameColor : Number
Sets frame thickness
| Frame | ||
| frameShape : String
Sets frame shape
| Frame | ||
| frameThickness : Number
Sets frame thickness
| Frame | ||
| 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 | |
| gradientAlphas : String
Sets gradient alphas when fill type is gradient
Alpha values corespond to the colors in the gradientColors array
Ordered list, max 12 (ex: 1, 1, 1)
| GraphicFactory | |
| gradientColors : String
Sets gradient colors when fill type is gradient
Ordered list, max 12 (ex: 0x000000, 0x555555, 0xFFFFFF)
| GraphicFactory | |
| gradientFocalPointRatio : Number
A number that controls the location of the focal point of the gradient. | GraphicFactory | |
| gradientHeight : Number
The height (in pixels) to which the gradient will spread. | GraphicFactory | |
| gradientInterpolation : String
Specifies which interpolation value to use: RGB or linearRGB
| GraphicFactory | |
| gradientRatios : String
Color distribution ratios; valid values are 0-255. | GraphicFactory | |
| gradientRotation : Number
Sets the rotation (in degrees) that will be applied to the gradient. | GraphicFactory | |
| gradientSpread : String
Specifies which gradient spread method to use. | GraphicFactory | |
| gradientType : String
Sets gradient type when fill type is gradient. | GraphicFactory | |
| gradientWidth : Number
Sets the width (in pixels) to which the gradient will spread. | GraphicFactory | |
| gradientX : Number
Sets how far (in pixels) the gradient is shifted horizontally. | GraphicFactory | |
| gradientY : Number
Sets how far (in pixels) the gradient is shifted vertically. | GraphicFactory | |
| group : String | TouchContainerFactory | |
| height : Number [override]
Sets graphics with
| GraphicFactory | |
| 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 | |
| line : String
Sets line type, choose: color, gradient
todo: implement shader and bitmap lines
| GraphicFactory | |
| lineAlpha : Number
Sets the alpha of the line
| GraphicFactory | |
| lineCaps : String
Specifies the type of cap on the line ends
Choose: none, round, or square
| GraphicFactory | |
| lineColor : uint
Sets the color of the line
Line type must be color
| GraphicFactory | |
| lineGradientAlphas : String
Sets lineGradient alphas when line type is gradient
Alpha values corespond to the colors in the gradient color list
Ordered list, max 12 (ex: 1, 1, 1)
| GraphicFactory | |
| lineGradientColors : String
Sets lineGradient colors when line type is gradient
Ordered list, max 12 (ex: 0x000000, 0x555555, 0xFFFFFF)
| GraphicFactory | |
| lineGradientFocalPointRatio : Number
A number that controls the location of the focal point of the lineGradient. | GraphicFactory | |
| lineGradientHeight : Number
The height (in pixels) to which the gradient will spread. | GraphicFactory | |
| lineGradientInterpolation : String
Specifies which interpolation value to use: RGB or linearRGB
| GraphicFactory | |
| lineGradientRatios : String
Color distribution ratios; valid values are 0-255. | GraphicFactory | |
| lineGradientRotation : Number
Sets the rotation (in degrees) that will be applied to the gradient. | GraphicFactory | |
| lineGradientSpread : String
Specifies which gradient spread method to use. | GraphicFactory | |
| lineGradientType : String
Sets lineGradient type when line type is gradient. | GraphicFactory | |
| lineGradientWidth : Number
Sets the width (in pixels) to which the gradient will spread. | GraphicFactory | |
| lineGradientX : Number
Sets how far (in pixels) the gradient is shifted horizontally. | GraphicFactory | |
| lineGradientY : Number
Sets how far (in pixels) the gradient is shifted vertically. | GraphicFactory | |
| lineJoints : String
Specifies the type of joint on the line ends
Choose: miter, round, or bevel
| GraphicFactory | |
| lineMiterLimit : Number
Specifies the limit at which the miter is cut off
| GraphicFactory | |
| linePixelHinting : Boolean
Specifies whether to hint strokes to full pixels. | GraphicFactory | |
| lineScaleMode : String
Specifies how the line stroke size changes when graphic is scaled
Choose: normal, none, or vertical
normal - Always scale the line thickness when the object is scaled (the default). | GraphicFactory | |
| lineStroke : Number
Sets the width of the line stroke (in pixels)
| GraphicFactory | |
| 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 | |
| pathCommands : String
Sets the path moveTo and lineTo values
| GraphicFactory | |
| pathCommandsVector : Vector.<int> | GraphicFactory | |
| pathCoordinates : String
Sets the path coordinates
| GraphicFactory | |
| pathCoordinatesVector : Vector.<Number> | GraphicFactory | |
| pointArray : Vector.<PointObject> [read-only] | TouchSprite | |
| pointCount : int | TouchSprite | |
| propertyStates : Array Deprecated: Please Use state | TouchContainerFactory | |
| radius : Number
Sets radius (in pixels) of circle. | GraphicFactory | |
| scale : Number
Scales display object
| TouchContainer | |
| shape : String
Sets predefined shape type. | GraphicFactory | |
| sO : StrokeObject | TouchSprite | |
| startX : Number
Sets starting X position for curve
| GraphicFactory | |
| startY : Number
Sets starting Y position for curve
| GraphicFactory | |
| 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 | |
| topLeftRadius : Number
sets the top left radius of the graphic object
| GraphicFactory | |
| topRightRadius : Number
sets the top right radius of the grpahic object
| GraphicFactory | |
| 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 graphics with
| GraphicFactory | |
| x_lock : Boolean | TouchSprite | |
| y_lock : Boolean | TouchSprite | |
| Method | Defined By | ||
|---|---|---|---|
Frame()
Constructor
| Frame | ||
| 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 | |
| clear():void
Clears the graphics that were drawn to this Graphics object,
and resets fill and line style settings. | GraphicFactory | |
clone():* [override]
Returns a clone of self
| Frame | ||
| copyFrom(source:GraphicFactory):void
Copies all of drawing commands from the source Graphics object
into the calling Graphics object. | GraphicFactory | |
displayComplete():void [override]
CML display callback
| Frame | ||
dispose():void [override]
Dispose method
| Frame | ||
| hideIndex(index:int):void
hides child list index
| TouchContainer | |
| hideKey(key:String):void
hides childlist key visibility
| TouchContainer | |
init():void [override]
Initialization method
| Frame | ||
| 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 | |
| updateGesturePipeline():void | TouchSprite | |
updateGraphic():void [override]
Update frame graphics
| Frame | ||
| 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 | |
| frameAlpha | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesframeAlpha:NumberSets frame thickness
The default value is 100.
public function get frameAlpha():Number public function set frameAlpha(value:Number):void| frameColor | property |
frameColor:NumberSets frame thickness
The default value is 100.
public function get frameColor():Number public function set frameColor(value:Number):void| frameShape | property |
frameShape:StringSets frame shape
The default value is "rectangle".
public function get frameShape():String public function set frameShape(value:String):void| frameThickness | property |
frameThickness:NumberSets frame thickness
The default value is 100.
public function get frameThickness():Number public function set frameThickness(value:Number):void| Frame | () | Constructor |
public function Frame()Constructor
| clone | () | method |
override public function clone():*Returns a clone of self
Returns* —
|
| displayComplete | () | method |
override public function displayComplete():voidCML display callback
| dispose | () | method |
override public function dispose():voidDispose method
| init | () | method |
override public function init():voidInitialization method
| updateGraphic | () | method |
override public function updateGraphic():voidUpdate frame graphics