Packagecom.somerandomdude.coordy.layouts.threedee
Classpublic class Grid3d
InheritanceGrid3d Inheritance Layout3d Inheritance Layout Inheritance flash.events.EventDispatcher
ImplementsILayout3d


Public Properties
 PropertyDefined by
  cellHeight : Number
[read-only] Accessor for cell height property
Grid3d
  cellWidth : Number
[read-only] Accessor for cell width property
Grid3d
  columns : uint
[read-only] Accessor for columns property
Grid3d
 Inheriteddepth : Number
Mutator/accessor for layout depth property
Layout3d
 Inheritedheight : Number
Mutator/accessor for layout height property
Layout3d
 InheritedjitterX : Number
Mutator/accessor for the jitterX property.
Layout3d
 InheritedjitterY : Number
Mutator/accessor for the jitterY property.
Layout3d
 InheritedjitterZ : Number
Mutator/accessor for the jitterZ property.
Layout3d
  layers : uint
[read-only] Accessor for layers property
Grid3d
 Inheritednodes : Array
Returns an array of node objects
Layout
  paddingX : Number
Accessor for x padding property
Grid3d
  paddingY : Number
Accessor for y padding property
Grid3d
  paddingZ : Number
Accessor for z padding property
Grid3d
 InheritedproxyUpdater : IProxyUpdater
Sets a proxy update method for altering layouts as opposed to internal update methods such as update(), render() or updateAndRender() This allows more customization for the updating sequence.
Layout3d
 Inheritedrotation : Number
Accessor for rotation property
Layout3d
  rows : uint
[read-only] Accessor for rows property
Grid3d
 Inheritedsize : int
Returns the number of nodes currently stored and managed
Layout
 InheritedupdateMethod : String
Specifies whether layout properties (x, y, width, height, etc.) adjust the layout automatically without calling apply() method.
Layout3d
 Inheritedwidth : Number
Mutator/accessor for layout width property
Layout3d
 Inheritedx : Number
Mutator/accessor for layout x property
Layout3d
 Inheritedy : Number
Mutator/accessor for layout y property
Layout3d
 Inheritedz : Number
Mutator/accessor for layout z property
Layout3d
Protected Properties
 PropertyDefined by
 Inherited_depth : Number
Layout3d
 Inherited_height : Number
Layout3d
 Inherited_jitterX : Number
Layout3d
 Inherited_jitterY : Number
Layout3d
 Inherited_jitterZ : Number
Layout3d
 Inherited_nodes : Array
Layout
 Inherited_proxyUpdater : IProxyUpdater
Layout3d
 Inherited_rotation : Number = 0
Layout3d
 Inherited_size : int
Layout
 Inherited_updateFunction : Function
Layout3d
 Inherited_updateMethod : String = "updateAndRender"
Layout3d
 Inherited_width : Number
Layout3d
 Inherited_x : Number
Layout3d
 Inherited_y : Number
Layout3d
 Inherited_z : Number
Layout3d
Public Methods
 MethodDefined by
  
Grid3d(width:Number, height:Number, depth:Number, columns:uint, rows:uint, layers:uint, paddingX:Number = 0, paddingY:Number = 0, paddingZ:Number = 0, x:Number = 0, y:Number = 0, z:Number = 0, jitterX:Number = 0, jitterY:Number = 0, jitterZ:Number = 0)
Distributes nodes in a 3d grid.
Grid3d
 Inherited
addLinkAt(object:Object, index:uint):void
Adds a link between the specified display object to the node object at the specified index
Layout
  
addNode(object:Object = null, moveToCoordinates:Boolean = true):INode
Adds object to layout in next available position.
Grid3d
 Inherited
addNodes(count:int):void
Adds a specified number of empty nodes to the layout
Layout
  
addToLayout(object:Object, moveToCoordinates:Boolean = true):INode
Adds object to layout in next available position This method is depreceated.
Grid3d
  
clone():ILayout3d
Clones the current object's properties (does not include links to DisplayObjects)
Grid3d
 Inherited
executeUpdateMethod():void
Performs the update method defined by the updateMethod property.
Layout3d
  
getColumn(column:uint):Array
Get node objects by column index
Grid3d
  
getLayer(layer:uint):Array
Get node objects by layer index
Grid3d
 Inherited
getNodeAt(index:uint):INode
Returns node object at specified index of collection
Layout
 Inherited
getNodeByLink(link:Object):INode
Returns node object by specified display object
Layout
  
getNodeFromCoordinates(column:uint, row:uint):GridNode3d
Returns node at specified grid coordinates
Grid3d
 Inherited
getNodeIndex(node:INode):uint
Returns specified node object's index in the collection
Layout
  
getRow(row:uint):Array
Get node objects by row index
Grid3d
 Inherited
linkExists(link:Object):Boolean
Returns true if a link (DisplayObject owned by a layout's node) exists in the layout
Layout
 Inherited
removeAllNodes():void
Removes all nodes from the layout
Layout
  
removeItemAt(column:uint, row:uint):void
Removes node link of DisplayObject at specified grid coordinates
Grid3d
 Inherited
removeLinkAt(index:uint):void
Removed the link between the node and display object at the specified index
Layout
 Inherited
removeLinks():void
Removes all links between nodes and display objects
Layout
 Inherited
removeNode(node:INode):void
Removes specified cell and its link from layout organizer and adjusts layout appropriately
Layout3d
 Inherited
removeNodeByLink(link:Object):void
Removes the node that is linked to the specified object
Layout
 Inherited
render():void
Renders all layout property values to all objects in the collection
Layout3d
 Inherited
renderNode(node:INode3d):void
Renders all layout property values of a specified node
Layout3d
 Inherited
swapNodeLinks(nodeTo:INode, nodeFrom:INode):void
Swaps links of two node objects
Layout
 Inherited
toJSON():String
Serializes the layout data of each node as a JSON string.
Layout
  
toString():String
Returns the type of layout in a string format
Grid3d
 Inherited
toXML():XML
Generates XML for the layout's properties.
Layout
  
update():void
Updates the nodes' virtual coordinates.
Grid3d
 Inherited
updateAndRender():void
Performs an update on all the nodes' positions and renders each node's corresponding link
Layout3d
Protected Methods
 MethodDefined by
 Inherited
clearNodes():void
Layout
 Inherited
getNextAvailableNode():INode
Layout
 Inherited
storeNode(node:INode):int
Layout
 Inherited
storeNodeAt(node:INode, index:int):int
Layout
 Inherited
validateObject(object:Object):Boolean
Determines if an object added to the layout contains the properties/methods required from the layout.
Layout3d
Property detail
cellHeightproperty
cellHeight:Number  [read-only]

Accessor for cell height property

Implementation
    public function get cellHeight():Number
cellWidthproperty 
cellWidth:Number  [read-only]

Accessor for cell width property

Implementation
    public function get cellWidth():Number
columnsproperty 
columns:uint  [read-only]

Accessor for columns property

Implementation
    public function get columns():uint
layersproperty 
layers:uint  [read-only]

Accessor for layers property

Implementation
    public function get layers():uint
paddingXproperty 
paddingX:Number  [read-write]

Accessor for x padding property

Implementation
    public function get paddingX():Number
    public function set paddingX(value:Number):void
paddingYproperty 
paddingY:Number  [read-write]

Accessor for y padding property

Implementation
    public function get paddingY():Number
    public function set paddingY(value:Number):void
paddingZproperty 
paddingZ:Number  [read-write]

Accessor for z padding property

Implementation
    public function get paddingZ():Number
    public function set paddingZ(value:Number):void
rowsproperty 
rows:uint  [read-only]

Accessor for rows property

Implementation
    public function get rows():uint
Constructor detail
Grid3d()constructor
public function Grid3d(width:Number, height:Number, depth:Number, columns:uint, rows:uint, layers:uint, paddingX:Number = 0, paddingY:Number = 0, paddingZ:Number = 0, x:Number = 0, y:Number = 0, z:Number = 0, jitterX:Number = 0, jitterY:Number = 0, jitterZ:Number = 0)

Distributes nodes in a 3d grid.

Parameters
width:Number — Width of the grid
 
height:Number — Height of the grid
 
depth:Number — Depth of the grid
 
columns:uint — Total columns in the grid
 
rows:uint — Total rows in the grid
 
layers:uint — Total layers in the grid
 
paddingX:Number (default = 0) — Padding of each grid cell in the x-axis
 
paddingY:Number (default = 0) — Padding of each grid cell in the y-axis
 
paddingZ:Number (default = 0) — Padding of each grid cell in the z-axis
 
x:Number (default = 0) — x position of the grid
 
y:Number (default = 0) — y position of the grid
 
z:Number (default = 0) — z position of the grid
 
jitterX:Number (default = 0) — Jitter multiplier for the layout's nodes on the x axis
 
jitterY:Number (default = 0) — Jitter multiplier for the layout's nodes on the y axis
 
jitterZ:Number (default = 0) — Jitter multiplier for the layout's nodes on the z axis
Method detail
addNode()method
public override function addNode(object:Object = null, moveToCoordinates:Boolean = true):INode

Adds object to layout in next available position.

Parameters
object:Object (default = null) — object Object to add to layout
 
moveToCoordinates:Boolean (default = true) — moveToCoordinates automatically move DisplayObject to corresponding nodes's coordinates

Returns
INode — newly created node object containing a link to the object
addToLayout()method 
public override function addToLayout(object:Object, moveToCoordinates:Boolean = true):INode

Adds object to layout in next available position This method is depreceated.

Parameters
object:Object — object Object to add to layout
 
moveToCoordinates:Boolean (default = true) — moveToCoordinates automatically move DisplayObject to corresponding node's coordinates

Returns
INode — newly created node object containing a link to the object
clone()method 
public override function clone():ILayout3d

Clones the current object's properties (does not include links to DisplayObjects)

Returns
ILayout3d — Grid3d clone of object
getColumn()method 
public function getColumn(column:uint):Array

Get node objects by column index

Parameters
column:uint — column cell index of grid

Returns
Array — an array of node objects by column index
getLayer()method 
public function getLayer(layer:uint):Array

Get node objects by layer index

Parameters
layer:uint — layer layer index of grid

Returns
Array — an array of node objects by layer index
getNodeFromCoordinates()method 
public function getNodeFromCoordinates(column:uint, row:uint):GridNode3d

Returns node at specified grid coordinates

Parameters
column:uint — column column index of grid
 
row:uint — row row index of grid

Returns
GridNode3d — GridCell object from specified coordinates
getRow()method 
public function getRow(row:uint):Array

Get node objects by row index

Parameters
row:uint — row row index of grid

Returns
Array — an array of node objects by row index
removeItemAt()method 
public function removeItemAt(column:uint, row:uint):void

Removes node link of DisplayObject at specified grid coordinates

Parameters
column:uint — column column index of grid
 
row:uint — row row index of grid
toString()method 
public override function toString():String

Returns the type of layout in a string format

Returns
String — Layout's type

See also

com.somerandomdude.coordy.layouts.LayoutType
update()method 
public override function update():void

Updates the nodes' virtual coordinates. Note - this method does not update the actual objects linked to the layout.