Packagecom.gestureworks.cml.elements
Classpublic class Gigapixel
InheritanceGigapixel Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The Gigapixel element loads a gigapixel image. Gigapixel images are extremely high resolution images that can be navigated made by tiling smaller images in a seamless, pyramid structured fashion. It has following parameters:minScaleConstraint, src, loaded, image,smoothPanning.
        
        var gpElement:Gigapixel = new Gigapixel();
        gpElement.src = "space.xml";
        gpElement.x = 500;
        gpElement.width = 600;
        gpElement.height = 600;
        gpElement.mouseChildren = true;
        addChild(gpElement);
        gpElement.init();
        
     

See also

Panoramic


Public Properties
 PropertyDefined By
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedgroup : String
TouchContainer
 Inheritedheight : Number
[override] sets the height of the container
TouchContainer
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
  hotspots : Array
Gigapixel
 Inheritedid : String
Returns the object's id.
TouchContainer
  image : MultiScaleImage
Gigapixel
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
  loaded : Boolean
[read-only] Indicated whether the gigaPixel image is loaded
Gigapixel
  minScaleConstraint : Number
sets the scaling
Gigapixel
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
 Inheritedposition : *
Sets the position
TouchContainer
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : Boolean
When set true this containers children's y position will be laid out relatively to each other.
TouchContainer
  sceneHeight : Number
[read-only]
Gigapixel
  sceneWidth : Number
[read-only]
Gigapixel
  smoothPanning : Boolean = true
Gigapixel
 Inheritedsound : String
TouchContainer
  src : String
Sets the src xml file
Gigapixel
  srcXML : String
Deprecated: Please Use src
Sets the src xml file
Gigapixel
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtoBitmap : Boolean
TouchContainer
  toggleHotspots : Boolean
Set the visibility of hotspots.
Gigapixel
  viewportHeight : Number
[read-only]
Gigapixel
  viewportWidth : Number
[read-only]
Gigapixel
  viewportX : Number
Gigapixel
  viewportY : Number
Gigapixel
  visibilityRatio : Number
Sets how much of the gigapixel must be seen.
Gigapixel
 Inheritedwidth : Number
[override] sets the width of the container
TouchContainer
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
  zoom : Number
Gigapixel
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
Constructor
Gigapixel
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
Clone method
TouchContainer
  
dispose():void
[override] Destructor
Gigapixel
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class.
TouchContainer
  
init():void
[override] Initialisation method
Gigapixel
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
  
localToScene(p:Point):Point
Gigapixel
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
  
panTo(x:Number, y:Number, immediately:Boolean = false):void
Gigapixel
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
 Inherited
method sets the dimensions of each child
TouchContainer
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
Property Detail
hotspotsproperty
hotspots:Array


Implementation
    public function get hotspots():Array
    public function set hotspots(value:Array):void
imageproperty 
public var image:MultiScaleImage

loadedproperty 
loaded:Boolean  [read-only]

Indicated whether the gigaPixel image is loaded


Implementation
    public function get loaded():Boolean
minScaleConstraintproperty 
minScaleConstraint:Number

sets the scaling

The default value is = 0.001;.


Implementation
    public function get minScaleConstraint():Number
    public function set minScaleConstraint(value:Number):void
sceneHeightproperty 
sceneHeight:Number  [read-only]


Implementation
    public function get sceneHeight():Number
sceneWidthproperty 
sceneWidth:Number  [read-only]


Implementation
    public function get sceneWidth():Number
smoothPanningproperty 
public var smoothPanning:Boolean = true

srcproperty 
src:String

Sets the src xml file


Implementation
    public function get src():String
    public function set src(value:String):void
srcXMLproperty 
srcXML:String
Deprecated: Please Use src

Sets the src xml file

The default value is .


Implementation
    public function get srcXML():String
    public function set srcXML(value:String):void
toggleHotspotsproperty 
toggleHotspots:Boolean

Set the visibility of hotspots.


Implementation
    public function get toggleHotspots():Boolean
    public function set toggleHotspots(value:Boolean):void
viewportHeightproperty 
viewportHeight:Number  [read-only]


Implementation
    public function get viewportHeight():Number
viewportWidthproperty 
viewportWidth:Number  [read-only]


Implementation
    public function get viewportWidth():Number
viewportXproperty 
viewportX:Number


Implementation
    public function get viewportX():Number
    public function set viewportX(value:Number):void
viewportYproperty 
viewportY:Number


Implementation
    public function get viewportY():Number
    public function set viewportY(value:Number):void
visibilityRatioproperty 
visibilityRatio:Number

Sets how much of the gigapixel must be seen. Setting it to 1 will ensure no border is ever seen within the viewer.

The default value is 0.6.


Implementation
    public function get visibilityRatio():Number
    public function set visibilityRatio(value:Number):void
zoomproperty 
zoom:Number


Implementation
    public function get zoom():Number
    public function set zoom(value:Number):void
Constructor Detail
Gigapixel()Constructor
public function Gigapixel()

Constructor

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

Destructor

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

Initialisation method

localToScene()method 
public function localToScene(p:Point):Point

Parameters

p:Point

Returns
Point
panTo()method 
public function panTo(x:Number, y:Number, immediately:Boolean = false):void

Parameters

x:Number
 
y:Number
 
immediately:Boolean (default = false)