Class com.sekati.geom.Sort

Description

Sort an array of Objects positions into various shapes and patterns.

Method Index

new Sort()
circle(), flower(), grid(), hedron(), hexagon(), sine(), square(), star(), triangle(), unsort()

Inherited from CoreObject

Constructor Detail

Sort

public function Sort(items:Array)

Sort Constructor

Parameters

items(Array)

Throws

Erroron invalid items argument array
 Usage:
 	var sort:Sort = new Sort([mc0, mc1, mc2, mc3]);
 

Method Detail

grid

public function grid(start:Point, numPerRow:Number, offset:Number):Array

Sort items in grid.

Parameters

start(Point)
numPerRow(Number)
offset(Number)

Return

Array

 Usage:
 	var positions:Array = new Sort(itemArr).grid(new Point(100,100), 10, 1);
 

circle

public function circle(center:Point, radius:Number):Array

Sort items in circle.

Parameters

center(Point)
radius(Number)

Return

Array

 Usage:
 	var positions:Array = new Sort(itemArr).circle(new Point(250,250), 255);
 

sine

public function sine(waves:Number, width:Number, yPos:Number, widthCap:Number, heightCap:Number):Array

Sort items in sine wave.

Parameters

waves(Number)
width(Number) sine wave width
widthCap(Number) use max 90% of the width
heightCap(Number) use max 60% of the height

Return

Array

 Usage:
 	var positions:Array = new Sort(itemArr).sine(1.5, Stage.width, Stage.height/2, 0.95, 0.5);
 

triangle

public function triangle(center:Point, sideLength:Number):Array

Sort items in triangle.

Parameters

center(Point)
sideLength(Number)

Return

Array

 Usage:
 	var positions:Array = new Sort(itemArr).triangle(new Point(250,250), 500);
 

flower

public function flower(center:Point, radius:Number):Array

Sort items in flower.

Parameters

center(Point)
radius(Number)

Return

Array

 Usage:
 	var positions:Array = new Sort(itemArr).flower(new Point(250,250), 250);
 

hedron

public function hedron(center:Point, heightCap:Number, corners:Number, rotate:Number, isIntraRadial:Boolean):Array

Sort items in hedron (star,square,triangle,hexagon,octagon,etc)

Parameters

center(Point)
heightCap(Number) use max 90% of the height [default: 0.8]
corners(Number)
rotate(Number)
isIntraRadial(Boolean) if true star shapes will be drawn else closed hedrons [default: false]

Return

Array

 Usage:
 	var positions:Array = new Sort(itemArr).hedron(new Point(250,250), 0.6, 8, 90); // create a octagon and rotate 90 degrees.
 

star

public function star(center:Point, heightCap:Number, corners:Number, rotate:Number):Array

Sort items in Star shapes, special com.sekati.geom.Sort.hedon wrapper.

Parameters

center(Point)
heightCap(Number) use max 90% of the height [default: 0.8]
corners(Number) of start points
rotate(Number)

Return

Array

 Usage:
 	var positions:Array = new Sort(itemArr).star(new Point(250,250), 0.6, 5, 180);
 

square

public function square(center:Point, heightCap:Number):Array

Sort items in square, com.sekati.geom.Sort.hedon wrapper.

Parameters

center(Point)
heightCap(Number) use max 90% of the height [default: 0.8]

Return

Array

 Usage:
 	var positions:Array = new Sort(itemArr).square(new Point(250,250), 0.8);
 

hexagon

public function hexagon(center:Point, heightCap:Number):Array

Sort items in hexagon, com.sekati.geom.Sort.hedon wrapper.

Parameters

center(Point)
heightCap(Number) use max 90% of the height [default: 0.8]

Return

Array

 Usage:
 	var positions:Array = new Sort(itemArr).hexagon(new Point(250,250));
 

unsort

public function unsort(topLeft:Point, bottomRight:Point):Array

Unsort items in random arrangement.

Parameters

topLeft(Point)

Return

Array

 Usage:
 	var positions:Array = new Sort(itemArr).unsort(new Point(0,0), new Point(Stage.width, Stage.height));