Packagecom.somerandomdude.coordy.layouts.threedee
Classpublic class Wave3d
InheritanceWave3d Inheritance Layout3d Inheritance Layout Inheritance flash.events.EventDispatcher
ImplementsILayout3d


Public Properties
 PropertyDefined by
  alignAngleOffset : Number
The additional angle offset of each node from it's original path-aligned angle (in degrees)
Wave3d
  alignType : String
The type of path alignment each node executes (parallel or perpendicular)
Wave3d
 Inheriteddepth : Number
Mutator/accessor for layout depth property
Layout3d
  depthMultiplier : Number
Accessor for depthMultiplier property
Wave3d
  frequency : Number
Accessor for frequency property
Wave3d
 Inheritedheight : Number
Mutator/accessor for layout height property
Layout3d
  heightMultiplier : Number
Accessor for heightMultiplier property
Wave3d
 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
 Inheritednodes : Array
Returns an array of node objects
Layout
 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
 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
  waveFunctionY : String
Mutator/accessor for waveFunctionY property
Wave3d
  waveFunctionZ : String
Mutator/accessor for waveFunctionZ property
Wave3d
 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
  
Wave3d(width:Number, height:Number, depth:Number, x:Number = 0, y:Number = 0, z:Number = 0, frequency:Number = 1, waveFunctionY:String, waveFunctionZ:String, jitterX:Number = 0, jitterY:Number = 0, jitterZ:Number = 0, alignType:String, alignOffset:Number = 0)
Distributes nodes in a 3d wave.
Wave3d
 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.
Wave3d
 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.
Wave3d
  
clone():ILayout3d
Clones the current object's properties (does not include links to DisplayObjects)
Wave3d
 Inherited
executeUpdateMethod():void
Performs the update method defined by the updateMethod property.
Layout3d
 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
 Inherited
getNodeIndex(node:INode):uint
Returns specified node object's index in the collection
Layout
 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
 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
  
render():void
Applies all layout property values to all cells/display objects in the collection
Wave3d
 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
Wave3d
 Inherited
toXML():XML
Generates XML for the layout's properties.
Layout
  
update():void
Updates the nodes' virtual coordinates.
Wave3d
 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
alignAngleOffsetproperty
alignAngleOffset:Number  [read-write]

The additional angle offset of each node from it's original path-aligned angle (in degrees)

Implementation
    public function get alignAngleOffset():Number
    public function set alignAngleOffset(value:Number):void
alignTypeproperty 
alignType:String  [read-write]

The type of path alignment each node executes (parallel or perpendicular)

Implementation
    public function get alignType():String
    public function set alignType(value:String):void

See also

com.somerandomdude.coordy.layouts.PathAlignType
depthMultiplierproperty 
depthMultiplier:Number  [read-write]

Accessor for depthMultiplier property

Implementation
    public function get depthMultiplier():Number
    public function set depthMultiplier(value:Number):void
frequencyproperty 
frequency:Number  [read-write]

Accessor for frequency property

Implementation
    public function get frequency():Number
    public function set frequency(value:Number):void
heightMultiplierproperty 
heightMultiplier:Number  [read-write]

Accessor for heightMultiplier property

Implementation
    public function get heightMultiplier():Number
    public function set heightMultiplier(value:Number):void
waveFunctionYproperty 
waveFunctionY:String  [read-write]

Mutator/accessor for waveFunctionY property

Implementation
    public function get waveFunctionY():String
    public function set waveFunctionY(value:String):void
waveFunctionZproperty 
waveFunctionZ:String  [read-write]

Mutator/accessor for waveFunctionZ property

Implementation
    public function get waveFunctionZ():String
    public function set waveFunctionZ(value:String):void
Constructor detail
Wave3d()constructor
public function Wave3d(width:Number, height:Number, depth:Number, x:Number = 0, y:Number = 0, z:Number = 0, frequency:Number = 1, waveFunctionY:String, waveFunctionZ:String, jitterX:Number = 0, jitterY:Number = 0, jitterZ:Number = 0, alignType:String, alignOffset:Number = 0)

Distributes nodes in a 3d wave.

Parameters
width:Number — Width of the wave
 
height:Number — Height of the wave
 
depth:Number — Depth of the wave
 
x:Number (default = 0) — x position of the wave
 
y:Number (default = 0) — y position of the wave
 
z:Number (default = 0) — z position of the wave
 
frequency:Number (default = 1) — Frequency of the wave
 
waveFunctionY:String — Wave function (sin,cos,tan,etc.) applied along the y-axis
 
waveFunctionZ:String — Wave function (sin,cos,tan,etc.) applied along the z-axis
 
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
 
alignType:String
 
alignOffset:Number (default = 0)
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 — Wave3d clone of object
render()method 
public override function render():void

Applies all layout property values to all cells/display objects in the collection

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.