scaffold.libs_as.starling.utils.Pool.as Maven / Gradle / Ivy
// =================================================================================================
//
// Starling Framework
// Copyright 2011-2015 Gamua. All Rights Reserved.
//
// This program is free software. You can redistribute and/or modify it
// in accordance with the terms of the accompanying license agreement.
//
// =================================================================================================
package starling.utils
{
import flash.geom.Matrix;
import flash.geom.Matrix3D;
import flash.geom.Point;
import flash.geom.Rectangle;
import flash.geom.Vector3D;
import starling.errors.AbstractClassError;
/** A simple object pool supporting the most basic utility objects.
*
* If you want to retrieve an object, but the pool does not contain any more instances,
* it will silently create a new one.
*
* It's important that you use the pool in a balanced way, i.e. don't just "get" or "put"
* alone! Always make the calls in pairs; whenever you get an object, be sure to put it back
* later, and the other way round. Otherwise, the pool will empty or (even worse) grow
* in size uncontrolled.
*/
public class Pool
{
private static var sPoints:Vector. = new [];
private static var sPoints3D:Vector. = new [];
private static var sMatrices:Vector. = new [];
private static var sMatrices3D:Vector. = new [];
private static var sRectangles:Vector. = new [];
/** @private */
public function Pool() { throw new AbstractClassError(); }
/** Retrieves a Point instance from the pool. */
public static function getPoint(x:Number = 0, y:Number = 0):Point
{
if (sPoints.length == 0) return new Point(x, y);
else
{
var point:Point = sPoints.pop();
point.x = x; point.y = y;
return point;
}
}
/** Stores a Point instance in the pool.
* Don't keep any references to the object after moving it to the pool! */
public static function putPoint(point:Point):void
{
if (point) sPoints[sPoints.length] = point;
}
/** Retrieves a Vector3D instance from the pool. */
public static function getPoint3D(x:Number = 0, y:Number = 0, z:Number = 0):Vector3D
{
if (sPoints.length == 0) return new Vector3D(x, y, z);
else
{
var point:Vector3D = sPoints3D.pop();
point.x = x; point.y = y; point.z = z;
return point;
}
}
/** Stores a Vector3D instance in the pool.
* Don't keep any references to the object after moving it to the pool! */
public static function putPoint3D(point:Vector3D):void
{
if (point) sPoints3D[sPoints3D.length] = point;
}
/** Retrieves a Matrix instance from the pool. */
public static function getMatrix(a:Number = 1, b:Number = 0, c:Number = 0, d:Number = 1,
tx:Number = 0, ty:Number = 0):Matrix
{
if (sMatrices.length == 0) return new Matrix(a, b, c, d, tx, ty);
else
{
var matrix:Matrix = sMatrices.pop();
matrix.setTo(a, b, c, d, tx, ty);
return matrix;
}
}
/** Stores a Matrix instance in the pool.
* Don't keep any references to the object after moving it to the pool! */
public static function putMatrix(matrix:Matrix):void
{
if (matrix) sMatrices[sMatrices.length] = matrix;
}
/** Retrieves a Matrix3D instance from the pool.
*
* @param identity If enabled, the matrix will be reset to the identity.
* Otherwise, its contents is undefined.
*/
public static function getMatrix3D(identity:Boolean = true):Matrix3D
{
if (sMatrices3D.length == 0) return new Matrix3D();
else
{
var matrix:Matrix3D = sMatrices3D.pop();
if (identity) matrix.identity();
return matrix;
}
}
/** Stores a Matrix3D instance in the pool.
* Don't keep any references to the object after moving it to the pool! */
public static function putMatrix3D(matrix:Matrix3D):void
{
if (matrix) sMatrices3D[sMatrices3D.length] = matrix;
}
/** Retrieves a Rectangle instance from the pool. */
public static function getRectangle(x:Number = 0, y:Number = 0,
width:Number = 0, height:Number = 0):Rectangle
{
if (sRectangles.length == 0) return new Rectangle(x, y, width, height);
else
{
var rectangle:Rectangle = sRectangles.pop();
rectangle.setTo(x, y, width, height);
return rectangle;
}
}
/** Stores a Rectangle instance in the pool.
* Don't keep any references to the object after moving it to the pool! */
public static function putRectangle(rectangle:Rectangle):void
{
if (rectangle) sRectangles[sRectangles.length] = rectangle;
}
}
}