Packageardisia.layouts
Classpublic class TimeMachineLayout
InheritanceTimeMachineLayout Inheritance spark.layouts.supportClasses.LayoutBase

Lays out elements in a TimeMachine layout pattern.

View the technical documentation on the Ardisia Labs website for more information.


Public Properties
 PropertyDefined By
  alphaFrom : Number
The alpha value for the centered, lowest z value element.
TimeMachineLayout
  alphaTo : Number
The alpha value for elements at the highest possible z value.
TimeMachineLayout
  centerOffsetX : Number
The horizontal offset from the center at which the elements are displayed.
TimeMachineLayout
  centerOffsetY : Number
The vertical offset from the center at which the elements are displayed.
TimeMachineLayout
  fieldOfView : Number
The field of view to apply to the perspective projection on the target.
TimeMachineLayout
  maxDisplayedElements : int
The maximum number of elements to display.
TimeMachineLayout
  perspectiveProjectionCenterOffsetX : Number
The x offset from the center to apply the perspective projection.
TimeMachineLayout
  perspectiveProjectionCenterOffsetY : Number
The y offset from the center to apply the perspective projection.
TimeMachineLayout
  rotationX : Number
The x rotation to apply to the elements.
TimeMachineLayout
  rotationY : Number
The y rotation to apply to the elements.
TimeMachineLayout
  rotationZ : Number
The z rotation to apply to all of the elements.
TimeMachineLayout
  zScrollPosition : Number
The current z offset distance.
TimeMachineLayout
  zSeparation : Number
The separation between elements on the z axis.
TimeMachineLayout
Public Methods
 MethodDefined By
  
getScrollPositionToElement(index:int):Number
Return the zScrollPosition to display the passed element index.
TimeMachineLayout
Property Detail
alphaFromproperty
alphaFrom:Number

The alpha value for the centered, lowest z value element.

The default value is 1.


Implementation
    public function get alphaFrom():Number
    public function set alphaFrom(value:Number):void
alphaToproperty 
alphaTo:Number

The alpha value for elements at the highest possible z value.

The default value is 1.


Implementation
    public function get alphaTo():Number
    public function set alphaTo(value:Number):void
centerOffsetXproperty 
centerOffsetX:Number

The horizontal offset from the center at which the elements are displayed.

The default value is 0.


Implementation
    public function get centerOffsetX():Number
    public function set centerOffsetX(value:Number):void
centerOffsetYproperty 
centerOffsetY:Number

The vertical offset from the center at which the elements are displayed.

The default value is 0.


Implementation
    public function get centerOffsetY():Number
    public function set centerOffsetY(value:Number):void
fieldOfViewproperty 
fieldOfView:Number

The field of view to apply to the perspective projection on the target.

The default value is 55.


Implementation
    public function get fieldOfView():Number
    public function set fieldOfView(value:Number):void
maxDisplayedElementsproperty 
maxDisplayedElements:int

The maximum number of elements to display.

The default value is 10.


Implementation
    public function get maxDisplayedElements():int
    public function set maxDisplayedElements(value:int):void
perspectiveProjectionCenterOffsetXproperty 
perspectiveProjectionCenterOffsetX:Number

The x offset from the center to apply the perspective projection.

The default value is 0.


Implementation
    public function get perspectiveProjectionCenterOffsetX():Number
    public function set perspectiveProjectionCenterOffsetX(value:Number):void
perspectiveProjectionCenterOffsetYproperty 
perspectiveProjectionCenterOffsetY:Number

The y offset from the center to apply the perspective projection.

The default value is 0.


Implementation
    public function get perspectiveProjectionCenterOffsetY():Number
    public function set perspectiveProjectionCenterOffsetY(value:Number):void
rotationXproperty 
rotationX:Number

The x rotation to apply to the elements.

The default value is 0.


Implementation
    public function get rotationX():Number
    public function set rotationX(value:Number):void
rotationYproperty 
rotationY:Number

The y rotation to apply to the elements.

The default value is 0.


Implementation
    public function get rotationY():Number
    public function set rotationY(value:Number):void
rotationZproperty 
rotationZ:Number

The z rotation to apply to all of the elements.

The default value is 0.


Implementation
    public function get rotationZ():Number
    public function set rotationZ(value:Number):void
zScrollPositionproperty 
zScrollPosition:Number

The current z offset distance.

Think of this property as the scrollable property and this property is iterated during animations.

The default value is 0.


Implementation
    public function get zScrollPosition():Number
    public function set zScrollPosition(value:Number):void
zSeparationproperty 
zSeparation:Number

The separation between elements on the z axis. Must be greater than 0.

The default value is 100.


Implementation
    public function get zSeparation():Number
    public function set zSeparation(value:Number):void
Method Detail
getScrollPositionToElement()method
public function getScrollPositionToElement(index:int):Number

Return the zScrollPosition to display the passed element index.

Parameters

index:int — the int of the element to return the zScrollPosition for

Returns
Number — a Number for the zScrollPosition




Mon Sep 15 2014, 01:55 AM -06:00