DisplayObjectUtil
Kind of class: | public class |
---|---|
Package: | |
Inherits from: |
|
Version: | 10/09/11 |
Author: | Aaron Clinger, Jon Adams |
Classpath: | org.casalib.util.DisplayObjectUtil |
File last modified: | Monday, 10 October 2011, 16:40:40 |
► View source▼ Hide source
/* CASA Lib for ActionScript 3.0 Copyright (c) 2011, Aaron Clinger & Contributors of CASA Lib All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - Neither the name of the CASA Lib nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ package org.casalib.util { import flash.display.DisplayObject; import flash.display.DisplayObjectContainer; import flash.display.Loader; import flash.display.SimpleButton; import flash.geom.Point; import flash.geom.Rectangle; import org.casalib.core.IDestroyable; /** Provides utility functions for DisplayObjects/DisplayObjectContainers. @author Aaron Clinger @author Jon Adams @version 10/09/11 */ public class DisplayObjectUtil { /** Removes and optionally destroys children of aDisplayObjectContainer
or the states of aSimpleButton
. @param parent: TheDisplayObjectContainer
from which to remove children or aSimpleButton
from which to remove its states. @param destroyChildren: If a child implements {@link IDestroyable} call its {@link IDestroyable#destroy destroy} methodtrue
, or don't destroyfalse
; defaults tofalse
. @param recursive: Call this method with the same arguments on all of the children's children (all the way down the display list)true
, or leave the children's childrenfalse
; defaults tofalse
. */ public static function removeAllChildren(parent:DisplayObject, destroyChildren:Boolean = false, recursive:Boolean = false):void { if (parent is SimpleButton) { DisplayObjectUtil._removeButtonStates(parent as SimpleButton, destroyChildren, recursive); return; } else if (parent is Loader || !(parent is DisplayObjectContainer)) return; const container:DisplayObjectContainer = parent as DisplayObjectContainer; while (container.numChildren) DisplayObjectUtil._checkChild(container.removeChildAt(0), destroyChildren, recursive); } /** Returns the children of aDisplayObjectContainer
as anArray
. @param parent: TheDisplayObjectContainer
from which to get the children from. @return All the children of theDisplayObjectContainer
. */ public static function getChildren(parent:DisplayObjectContainer):Array { const children:Array = new Array(); var i:int = -1; while (++i < parent.numChildren) children.push(parent.getChildAt(i)); return children; } /** Returns the X and Y offset to the top left corner of theDisplayObject
. The offset can be used to positionDisplayObject
s whose alignment point is not at 0, 0 and/or is scaled. @param displayObject: TheDisplayObject
to align. @return The X and Y offset to the top left corner of theDisplayObject
. @examplevar box:CasaSprite = new CasaSprite(); box.scaleX = -2; box.scaleY = 1.5; box.graphics.beginFill(0xFF00FF); box.graphics.drawRect(-20, 100, 50, 50); box.graphics.endFill(); const offset:Point = DisplayObjectUtil.getOffsetPosition(box); trace(offset) box.x = 10 + offset.x; box.y = 10 + offset.y; this.addChild(box);
*/ public static function getOffsetPosition(displayObject:DisplayObject):Point { const bounds:Rectangle = displayObject.getBounds(displayObject); const offset:Point = new Point(); offset.x = (displayObject.scaleX > 0) ? bounds.left * displayObject.scaleX * -1 : bounds.right * displayObject.scaleX * -1; offset.y = (displayObject.scaleY > 0) ? bounds.top * displayObject.scaleY * -1 : bounds.bottom * displayObject.scaleY * -1; return offset; } /** Returns the first display object with the specified name that exists in the display tree of the providedDisplayObjectContainer
. @param parent: TheDisplayObjectContainer
in which to get the child from. @param name: The name of the child to return. @return The first child display object with the specified name, ornull
if no display object was found. */ public static function getChildByNameRecursive(parent:DisplayObjectContainer, name:String):DisplayObject { var child:DisplayObject = parent.getChildByName(name); if (child != null) return child; var i:int = -1; while (++i < parent.numChildren) { child = parent.getChildAt(i); if (child is DisplayObjectContainer) { child = DisplayObjectUtil.getChildByNameRecursive(child as DisplayObjectContainer, name); if (child != null) return child; } } return null; } protected static function _removeButtonStates(parent:SimpleButton, destroyStates:Boolean, recursive:Boolean):void { if (parent.downState != null) { DisplayObjectUtil._checkChild(parent.downState, destroyStates, recursive); parent.downState = null; } if (parent.hitTestState != null) { DisplayObjectUtil._checkChild(parent.hitTestState, destroyStates, recursive); parent.hitTestState = null; } if (parent.overState != null) { DisplayObjectUtil._checkChild(parent.overState, destroyStates, recursive); parent.overState = null; } if (parent.upState != null) { DisplayObjectUtil._checkChild(parent.upState, destroyStates, recursive); parent.upState = null; } } protected static function _checkChild(child:DisplayObject, destroy:Boolean, recursive:Boolean):void { if (destroy && child is IDestroyable) { const dest:IDestroyable = child as IDestroyable; if (!dest.destroyed) dest.destroy(); } if (recursive) DisplayObjectUtil.removeAllChildren(child, destroy, recursive); } } }
Provides utility functions for DisplayObjects/DisplayObjectContainers.
Summary
Class methods
-
removeAllChildren
(parent:DisplayObject, destroyChildren:Boolean = false, recursive:Boolean = false) : void
- Removes and optionally destroys children of a DisplayObjectContainer or the states of a SimpleButton.
-
getChildren
(parent:DisplayObjectContainer) : Array
- Returns the children of a DisplayObjectContainer as an Array.
-
getOffsetPosition
(displayObject:DisplayObject) : Point
- Returns the X and Y offset to the top left corner of the DisplayObject.
-
getChildByNameRecursive
(parent:DisplayObjectContainer, name:String) : DisplayObject
- Returns the first display object with the specified name that exists in the display tree of the provided DisplayObjectContainer.
Class methods
getChildByNameRecursive
static function getChildByNameRecursive(parent:DisplayObjectContainer,
name:String) : DisplayObject
Returns the first display object with the specified name that exists in the display tree of the provided DisplayObjectContainer
.
Parameters
parent:The
DisplayObjectContainer
in which to get the child from.
name :The name of the child to return.
Returns
-
The first child display object with the specified name, or
null
if no display object was found.
getChildren
static function getChildren(parent:DisplayObjectContainer) : Array
Returns the children of a DisplayObjectContainer
as an Array
.
Parameters
parent:The
DisplayObjectContainer
from which to get the children from.
Returns
-
All the children of the
DisplayObjectContainer
.
getOffsetPosition
static function getOffsetPosition(displayObject:DisplayObject) : Point
Returns the X and Y offset to the top left corner of the DisplayObject
. The offset can be used to position DisplayObject
s whose alignment point is not at 0, 0 and/or is scaled.
Parameters
displayObject:The
DisplayObject
to align.
Example
-
var box:CasaSprite = new CasaSprite(); box.scaleX = -2; box.scaleY = 1.5; box.graphics.beginFill(0xFF00FF); box.graphics.drawRect(-20, 100, 50, 50); box.graphics.endFill(); const offset:Point = DisplayObjectUtil.getOffsetPosition(box); trace(offset) box.x = 10 + offset.x; box.y = 10 + offset.y; this.addChild(box);
Returns
-
The X and Y offset to the top left corner of the
DisplayObject
.
removeAllChildren
static function removeAllChildren(parent:DisplayObject,
destroyChildren:Boolean = false,
recursive:Boolean = false) : void
Removes and optionally destroys children of a DisplayObjectContainer
or the states of a SimpleButton
.
Parameters
parent :The
DisplayObjectContainer
from which to remove children or a SimpleButton
from which to remove its states.
destroyChildren:If a child implements IDestroyable call its destroy method
true
, or don't destroy false
; defaults to false
.
recursive :Call this method with the same arguments on all of the children's children (all the way down the display list)
true
, or leave the children's children false
; defaults to false
.