com.funzio.pure2D.containers

Class DisplayGroup

java.lang.Object

com.funzio.pure2D.BaseDisplayObject

com.funzio.pure2D.containers.DisplayGroup

All Implemented Interfaces:

Cacheable, Container, Displayable, DisplayObject, InvalidateFlags, Manipulatable, Parentable, Touchable

Direct Known Subclasses:

Button, GridGroup, LinearGroup, LineArray, MaskGroup, NovaGroup, Page, SparkGroup, Wheel3D

public class DisplayGroup
extends BaseDisplayObject
implements Container, Cacheable, Touchable

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ATT_CACHE_ENABLED
protected static java.lang.String	ATT_CLIPPING_ENABLED
protected static java.lang.String	ATT_TOUCHABLE
protected DummyDrawer	mCacheDrawer
protected boolean	mCacheEnabled
protected FrameBuffer	mCacheFrameBuffer
protected int	mCachePolicy
protected int	mCacheProjection
protected java.util.ArrayList<DisplayObject>	mChildren
protected java.util.ArrayList<DisplayObject>	mChildrenDisplayOrder
protected java.util.HashMap<java.lang.String,DisplayObject>	mChildrenIds
protected boolean	mClippingEnabled
protected RectF	mClipStageRect
protected int	mNumChildren
protected int[]	mOriginalScissor
protected boolean	mOriginalScissorEnabled
protected boolean	mTouchable
protected java.util.ArrayList<Touchable>	mVisibleTouchables
protected boolean	mWrapContentHeight
protected boolean	mWrapContentWidth

Fields inherited from class com.funzio.pure2D.BaseDisplayObject

ATT_ALPHA, ATT_ANIMATOR, ATT_BLEND_MODE, ATT_COLOR, ATT_DEBUG, ATT_ORIGIN_AT_CENTER, ATT_ROTATION, ATT_VISIBLE, mAlive, mAlpha, mAlphaTestEnabled, mAutoUpdateBounds, mBlendFunc, mBounds, mBypassCameraClipping, mColor, mDebugFlags, mFrameDuration, mHasTransformValues, mId, mInvalidateFlags, mManipulators, mMask, mMatrix, mNumManipulators, mOrigin, mParent, mPerspectiveEnabled, mPivot, mPosition, mRotation, mRotationVectorX, mRotationVectorY, mRotationVectorZ, mScale, mScene, mSceneSize, mSize, mSkew, mTransformMatrix, mTransformMatrixValues, mUIConstraint, mVisible, mZ, TAG

Fields inherited from interface com.funzio.pure2D.Cacheable

CACHE_WHEN_CHILDREN_CHANGED, CACHE_WHEN_CHILDREN_STABLE

Fields inherited from interface com.funzio.pure2D.Displayable

FLIP_X, FLIP_Y

Fields inherited from interface com.funzio.pure2D.InvalidateFlags

ALL, ALPHA, BLEND, BOUNDS, CACHE, CHILDREN, COLOR, DEPTH, FRAME, ORIGIN, PARENT, PARENT_BOUNDS, PERSPECTIVE, PIVOT, POSITION, ROTATION, SCALE, SIZE, SKEW, TEXTURE, TEXTURE_COORDS, TRANSFORM_MATRIX, VERTICES, VISIBILITY, VISUAL

Constructor Summary

Constructors

Constructor and Description
DisplayGroup()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addChild(DisplayObject child)
boolean	addChild(DisplayObject child, int index)
void	clearCache() Clear cache manually when it is no longer needed.
void	dispose()
boolean	draw(GLState glState)
protected boolean	drawChildren(GLState glState)
int	getCachePolicy()
int	getCacheProjection()
DisplayObject	getChildAt(int index)
DisplayObject	getChildById(java.lang.String id)
int	getChildIndex(DisplayObject child)
int	getNumChildren() Get the number of children, not including grand children
int	getNumGrandChildren() Get number of children including grand children
java.lang.String	getObjectTree(java.lang.String prefix) for Debugging
protected void	initCache(GLState glState, PointF size)
boolean	isCacheEnabled()
protected boolean	isChildInBounds(DisplayObject child) Test to see if a child can be seen in this container.
boolean	isClippingEnabled()
boolean	isTouchable()
boolean	isWrapContenHeight()
boolean	isWrapContentWidth()
protected void	onAddedChild(DisplayObject child)
void	onAddedToScene(Scene scene)
protected void	onRemovedChild(DisplayObject child)
void	onRemovedFromScene()
boolean	onTouchEvent(MotionEvent event) Note: This is called from UI-Thread
void	removeAllChildren()
boolean	removeChild(DisplayObject child)
boolean	removeChild(int index)
boolean	sendChildToBottom(DisplayObject child)
boolean	sendChildToTop(DisplayObject child)
void	setCacheEnabled(boolean cacheEnabled) Enable/disable cache.
void	setCachePolicy(int cachePolicy) Set how to you want to cache
void	setCacheProjection(int cacheProjection)
void	setChildrenDisplayOrder(java.util.ArrayList<DisplayObject> childrenDisplayOrder)
void	setClippingEnabled(boolean clippingEnabled) Enable/Disable Bound-clipping.
void	setTouchable(boolean touchable)
void	setWrapContentHeight(boolean wrapHeight)
void	setWrapContentWidth(boolean wrapWidth)
void	setXMLAttributes(XmlPullParser xmlParser, UIManager manager)
boolean	swapChildren(DisplayObject child1, DisplayObject child2) Swap the indeces of 2 children.
boolean	swapChildren(int index1, int index2) Swap the indeces of 2 children.
protected void	updateChildren(int deltaTime)

Methods inherited from class com.funzio.pure2D.BaseDisplayObject

addManipulator, drawBounds, drawEnd, drawStart, drawWireframe, getAlpha, getBlendFunc, getBounds, getColor, getDebugFlags, getFps, getGlobalPosition, getHeight, getId, getInheritedBlendFunc, getInheritedColor, getManipulator, getMask, getMatrix, getNumManipulators, getOrigin, getParent, getParentMatrix, getPivot, getPosition, getRotation, getScale, getScene, getSceneSize, getSize, getSkew, getUIConstraint, getWidth, getX, getY, getZ, globalToLocal, invalidate, invalidate, isAlive, isAlphaTestEnabled, isAutoUpdateBounds, isBypassCameraClipping, isOriginAtCenter, isPerspectiveEnabled, isVisible, localToGlobal, move, moveTo, onAdded, onCreateChildren, onPreConcatParentMatrix, onRemoved, queueEvent, removeAllManipulators, removeFromParent, removeManipulator, rotate, setAlive, setAlpha, setAlphaTestEnabled, setAutoUpdateBounds, setBlendFunc, setBypassCameraClipping, setColor, setDebugFlags, setFps, setId, setMask, setOrigin, setOrigin, setOriginAtCenter, setPerspectiveEnabled, setPivot, setPivot, setPivotAtCenter, setPosition, setPosition, setRotation, setRotationVector, setScale, setScale, setSize, setSize, setSkew, setUIConstraint, setVisible, setX, setY, setZ, shouldDraw, toString, update, updateBounds, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.funzio.pure2D.Parentable

getMatrix, getScene, getSize, globalToLocal, invalidate, invalidate, localToGlobal, queueEvent

Field Detail

ATT_TOUCHABLE

protected static final java.lang.String ATT_TOUCHABLE

See Also:

Constant Field Values

ATT_CLIPPING_ENABLED

protected static final java.lang.String ATT_CLIPPING_ENABLED

See Also:

Constant Field Values

ATT_CACHE_ENABLED

protected static final java.lang.String ATT_CACHE_ENABLED

See Also:

Constant Field Values

mChildren

protected java.util.ArrayList<DisplayObject> mChildren

mChildrenDisplayOrder

protected java.util.ArrayList<DisplayObject> mChildrenDisplayOrder

mChildrenIds

protected java.util.HashMap<java.lang.String,DisplayObject> mChildrenIds

mNumChildren

protected int mNumChildren

mVisibleTouchables

protected java.util.ArrayList<Touchable> mVisibleTouchables

mTouchable

protected boolean mTouchable

mCacheFrameBuffer

protected FrameBuffer mCacheFrameBuffer

mCacheDrawer

protected DummyDrawer mCacheDrawer

mCacheEnabled

protected boolean mCacheEnabled

mCacheProjection

protected int mCacheProjection

mCachePolicy

protected int mCachePolicy

mClippingEnabled

protected boolean mClippingEnabled

mOriginalScissorEnabled

protected boolean mOriginalScissorEnabled

mOriginalScissor

protected int[] mOriginalScissor

mClipStageRect

protected RectF mClipStageRect

mWrapContentWidth

protected boolean mWrapContentWidth

mWrapContentHeight

protected boolean mWrapContentHeight

Constructor Detail

DisplayGroup

public DisplayGroup()

Method Detail

updateChildren

protected void updateChildren(int deltaTime)

Overrides:

updateChildren in class BaseDisplayObject

draw

public boolean draw(GLState glState)

Specified by:

draw in interface DisplayObject

Overrides:

draw in class BaseDisplayObject

drawChildren

protected boolean drawChildren(GLState glState)

Specified by:

drawChildren in class BaseDisplayObject

isChildInBounds

protected boolean isChildInBounds(DisplayObject child)

Test to see if a child can be seen in this container.

Parameters:

child -

Returns:

true if at least one of the corners of the child is in this container's rect.

initCache

protected void initCache(GLState glState,
             PointF size)

clearCache

public void clearCache()

Clear cache manually when it is no longer needed.

Specified by:

clearCache in interface Cacheable

See Also:

#setCacheEnabled(boolean)}

dispose

public void dispose()

Specified by:

dispose in interface Displayable

Overrides:

dispose in class BaseDisplayObject

addChild

public boolean addChild(DisplayObject child)

Specified by:

addChild in interface Container

addChild

public boolean addChild(DisplayObject child,
               int index)

Specified by:

addChild in interface Container

removeChild

public boolean removeChild(DisplayObject child)

Specified by:

removeChild in interface Container

removeChild

public boolean removeChild(int index)

removeAllChildren

public void removeAllChildren()

Specified by:

removeAllChildren in interface Parentable

getChildAt

public DisplayObject getChildAt(int index)

Specified by:

getChildAt in interface Container

getChildIndex

public int getChildIndex(DisplayObject child)

Specified by:

getChildIndex in interface Container

getChildById

public DisplayObject getChildById(java.lang.String id)

Specified by:

getChildById in interface Container

swapChildren

public boolean swapChildren(DisplayObject child1,
                   DisplayObject child2)

Swap the indeces of 2 children. This can be used for display ordering.

Specified by:

swapChildren in interface Container

Parameters:

child1 -

child2 -

Returns:

swapChildren

public boolean swapChildren(int index1,
                   int index2)

Swap the indeces of 2 children. This can be used for display ordering.

Specified by:

swapChildren in interface Parentable

Parameters:

index1 -

index2 -

Returns:

sendChildToTop

public boolean sendChildToTop(DisplayObject child)

sendChildToBottom

public boolean sendChildToBottom(DisplayObject child)

getNumChildren

public int getNumChildren()

Get the number of children, not including grand children

Specified by:

getNumChildren in interface Parentable

See Also:

getNumGrandChildren()

getNumGrandChildren

public int getNumGrandChildren()

Get number of children including grand children

Specified by:

getNumGrandChildren in interface Parentable

See Also:

getNumChildren()

onTouchEvent

public boolean onTouchEvent(MotionEvent event)

Note: This is called from UI-Thread

Specified by:

onTouchEvent in interface Touchable

setTouchable

public void setTouchable(boolean touchable)

Specified by:

setTouchable in interface Touchable

isTouchable

public boolean isTouchable()

Specified by:

isTouchable in interface Touchable

isClippingEnabled

public boolean isClippingEnabled()

Specified by:

isClippingEnabled in interface Parentable

setClippingEnabled

public void setClippingEnabled(boolean clippingEnabled)

Enable/Disable Bound-clipping. Note this does not work for rotation.

Specified by:

setClippingEnabled in interface Parentable

Parameters:

clippingEnabled -

isCacheEnabled

public boolean isCacheEnabled()

Specified by:

isCacheEnabled in interface Cacheable

setCacheEnabled

public void setCacheEnabled(boolean cacheEnabled)

Enable/disable cache. Use this when there are many static children to improve performance. This also clips the children inside the bounds.

Specified by:

setCacheEnabled in interface Cacheable

Parameters:

cacheEnabled -

See Also:

#setCachePolicy(int)}, #setCacheProjection(int)}, #clearCache()}

getCachePolicy

public int getCachePolicy()

setCachePolicy

public void setCachePolicy(int cachePolicy)

Set how to you want to cache

Parameters:

cachePolicy -

See Also:

#setCacheEnabled(boolean)}, #setCacheProjection(int)}, #clearCache()}

getCacheProjection

public int getCacheProjection()

setCacheProjection

public void setCacheProjection(int cacheProjection)

Parameters:

cacheProjection -

See Also:

#setCacheEnabled(boolean)}, #setCachePolicy(int)}, #clearCache()}

setChildrenDisplayOrder

public void setChildrenDisplayOrder(java.util.ArrayList<DisplayObject> childrenDisplayOrder)

isWrapContentWidth

public boolean isWrapContentWidth()

setWrapContentWidth

public void setWrapContentWidth(boolean wrapWidth)

setWrapContentHeight

public void setWrapContentHeight(boolean wrapHeight)

isWrapContenHeight

public boolean isWrapContenHeight()

setXMLAttributes

public void setXMLAttributes(XmlPullParser xmlParser,
                    UIManager manager)

Specified by:

setXMLAttributes in interface DisplayObject

Overrides:

setXMLAttributes in class BaseDisplayObject

onAddedChild

protected void onAddedChild(DisplayObject child)

onRemovedChild

protected void onRemovedChild(DisplayObject child)

onAddedToScene

public void onAddedToScene(Scene scene)

Specified by:

onAddedToScene in interface Displayable

Overrides:

onAddedToScene in class BaseDisplayObject

onRemovedFromScene

public void onRemovedFromScene()

Specified by:

onRemovedFromScene in interface Displayable

Overrides:

onRemovedFromScene in class BaseDisplayObject

getObjectTree

public java.lang.String getObjectTree(java.lang.String prefix)

for Debugging

Specified by:

getObjectTree in interface Displayable

Overrides:

getObjectTree in class BaseDisplayObject

Returns:

a string that has all the children in Tree format