IEntity (library API)

All Superinterfaces:

IDisposable, IDrawHandler, IUpdateHandler

All Known Subinterfaces:

IAreaShape, IMenuItem, IShape

All Known Implementing Classes:

AnalogOnScreenControl, AnimatedSprite, AnimatedSpriteMenuItem, BaseMenuItemDecorator, BaseOnScreenControl, BatchedPseudoSpriteParticleSystem, BatchedSpriteParticleSystem, BlendFunctionParticleSystem, ButtonSprite, CameraScene, ColorMenuItemDecorator, DiamondSprite, DigitalOnScreenControl, DynamicSpriteBatch, Entity, HUD, Line, MenuScene, Mesh, ParticleSystem, Rectangle, RectangularShape, ScaleMenuItemDecorator, Scene, ScreenCapture, ScreenGrabber, Shape, Sprite, SpriteBatch, SpriteGroup, SpriteMenuItem, SpriteParticleSystem, Text, TextMenuItem, TickerText, TiledSprite, UncoloredSprite, UniformColorSprite
```
public interface IEntity
extends IDrawHandler, IUpdateHandler, IDisposable
```
(c) 2010 Nicolas Gramlich (c) 2011 Zynga Inc.

Since:

11:20:25 - 08.03.2010

Nested Class Summary
- Nested classes/interfaces inherited from interface org.andengine.engine.handler.IUpdateHandler
  IUpdateHandler.IUpdateHandlerMatcher
- Nested classes/interfaces inherited from interface org.andengine.util.IDisposable
  IDisposable.AlreadyDisposedException

Field Summary

Fields
Modifier and Type Field and Description

static int TAG_INVALID

Fields
Modifier and Type	Field and Description
`static int`	`TAG_INVALID`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`attachChild(IEntity pEntity)`
`void`	`callOnChildren(IEntityParameterCallable pEntityParameterCallable)`
`void`	`callOnChildren(IEntityParameterCallable pEntityParameterCallable, IEntityMatcher pEntityMatcher)`
`void`	`clearEntityModifiers()`
`void`	`clearUpdateHandlers()`
`float[]`	`convertLocalToSceneCoordinates(float[] pCoordinates)`
`float[]`	`convertLocalToSceneCoordinates(float[] pCoordinates, float[] pReuse)`
`float[]`	`convertLocalToSceneCoordinates(float pX, float pY)`
`float[]`	`convertLocalToSceneCoordinates(float pX, float pY, float[] pReuse)`
`float[]`	`convertSceneToLocalCoordinates(float[] pCoordinates)`
`float[]`	`convertSceneToLocalCoordinates(float[] pCoordinates, float[] pReuse)`
`float[]`	`convertSceneToLocalCoordinates(float pX, float pY)`
`float[]`	`convertSceneToLocalCoordinates(float pX, float pY, float[] pReuse)`
`boolean`	`detachChild(IEntity pEntity)` WARNING: This function should be called from within `RunnableHandler.postRunnable(Runnable)` which is registered to a `Scene` or the `Engine` itself, because otherwise it may throw an `IndexOutOfBoundsException` in the Update-Thread or the GL-Thread!
`IEntity`	`detachChild(IEntityMatcher pEntityMatcher)` WARNING: This function should be called from within `RunnableHandler.postRunnable(Runnable)` which is registered to a `Scene` or the `Engine` itself, because otherwise it may throw an `IndexOutOfBoundsException` in the Update-Thread or the GL-Thread!
`IEntity`	`detachChild(int pTag)` WARNING: This function should be called from within `RunnableHandler.postRunnable(Runnable)` which is registered to a `Scene` or the `Engine` itself, because otherwise it may throw an `IndexOutOfBoundsException` in the Update-Thread or the GL-Thread!
`void`	`detachChildren()`
`boolean`	`detachChildren(IEntityMatcher pEntityMatcher)` WARNING: This function should be called from within `RunnableHandler.postRunnable(Runnable)` which is registered to a `Scene` or the `Engine` itself, because otherwise it may throw an `IndexOutOfBoundsException` in the Update-Thread or the GL-Thread!
`boolean`	`detachSelf()`
`float`	`getAlpha()`
`float`	`getBlue()`
`IEntity`	`getChildByIndex(int pIndex)`
`IEntity`	`getChildByMatcher(IEntityMatcher pEntityMatcher)`
`IEntity`	`getChildByTag(int pTag)`
`int`	`getChildCount()`
`Color`	`getColor()`
`int`	`getEntityModifierCount()`
`IEntity`	`getFirstChild()`
`float`	`getGreen()`
`IEntity`	`getLastChild()`
`Transformation`	`getLocalToParentTransformation()`
`Transformation`	`getLocalToSceneTransformation()`
`IEntity`	`getParent()`
`Transformation`	`getParentToLocalTransformation()`
`float`	`getRed()`
`float`	`getRotation()`
`float`	`getRotationCenterX()`
`float`	`getRotationCenterY()`
`float`	`getScaleCenterX()`
`float`	`getScaleCenterY()`
`float`	`getScaleX()`
`float`	`getScaleY()`
`float[]`	`getSceneCenterCoordinates()`
`float[]`	`getSceneCenterCoordinates(float[] pReuse)`
`Transformation`	`getSceneToLocalTransformation()`
`float`	`getSkewCenterX()`
`float`	`getSkewCenterY()`
`float`	`getSkewX()`
`float`	`getSkewY()`
`int`	`getTag()`
`int`	`getUpdateHandlerCount()`
`java.lang.Object`	`getUserData()`
`float`	`getX()`
`float`	`getY()`
`int`	`getZIndex()`
`boolean`	`hasParent()`
`boolean`	`isChildrenIgnoreUpdate()`
`boolean`	`isChildrenVisible()`
`boolean`	`isCulled(Camera pCamera)` Will only be performed if `isCullingEnabled()` is true.
`boolean`	`isCullingEnabled()`
`boolean`	`isIgnoreUpdate()`
`boolean`	`isRotated()`
`boolean`	`isRotatedOrScaledOrSkewed()`
`boolean`	`isScaled()`
`boolean`	`isSkewed()`
`boolean`	`isVisible()`
`void`	`onAttached()`
`void`	`onDetached()`
`java.util.ArrayList<IEntity>`	`query(IEntityMatcher pEntityMatcher)`
`<L extends java.util.List<IEntity>> L`	`query(IEntityMatcher pEntityMatcher, L pResult)`
`IEntity`	`queryFirst(IEntityMatcher pEntityMatcher)`
`<S extends IEntity> S`	`queryFirstForSubclass(IEntityMatcher pEntityMatcher)`
`<S extends IEntity> java.util.ArrayList<S>`	`queryForSubclass(IEntityMatcher pEntityMatcher)`
`<L extends java.util.List<S>,S extends IEntity> L`	`queryForSubclass(IEntityMatcher pEntityMatcher, L pResult)`
`void`	`registerEntityModifier(IEntityModifier pEntityModifier)`
`void`	`registerUpdateHandler(IUpdateHandler pUpdateHandler)`
`void`	`setAlpha(float pAlpha)`
`void`	`setBlue(float pBlue)`
`void`	`setChildrenIgnoreUpdate(boolean pChildrenIgnoreUpdate)`
`void`	`setChildrenVisible(boolean pChildrenVisible)`
`void`	`setColor(Color pColor)`
`void`	`setColor(float pRed, float pGreen, float pBlue)`
`void`	`setColor(float pRed, float pGreen, float pBlue, float pAlpha)`
`void`	`setCullingEnabled(boolean pCullingEnabled)`
`void`	`setGreen(float pGreen)`
`void`	`setIgnoreUpdate(boolean pIgnoreUpdate)`
`void`	`setParent(IEntity pEntity)`
`void`	`setPosition(float pX, float pY)`
`void`	`setPosition(IEntity pOtherEntity)`
`void`	`setRed(float pRed)`
`void`	`setRotation(float pRotation)`
`void`	`setRotationCenter(float pRotationCenterX, float pRotationCenterY)`
`void`	`setRotationCenterX(float pRotationCenterX)`
`void`	`setRotationCenterY(float pRotationCenterY)`
`void`	`setScale(float pScale)`
`void`	`setScale(float pScaleX, float pScaleY)`
`void`	`setScaleCenter(float pScaleCenterX, float pScaleCenterY)`
`void`	`setScaleCenterX(float pScaleCenterX)`
`void`	`setScaleCenterY(float pScaleCenterY)`
`void`	`setScaleX(float pScaleX)`
`void`	`setScaleY(float pScaleY)`
`void`	`setSkew(float pSkew)`
`void`	`setSkew(float pSkewX, float pSkewY)`
`void`	`setSkewCenter(float pSkewCenterX, float pSkewCenterY)`
`void`	`setSkewCenterX(float pSkewCenterX)`
`void`	`setSkewCenterY(float pSkewCenterY)`
`void`	`setSkewX(float pSkewX)`
`void`	`setSkewY(float pSkewY)`
`void`	`setTag(int pTag)`
`void`	`setUserData(java.lang.Object pUserData)`
`void`	`setVisible(boolean pVisible)`
`void`	`setX(float pX)`
`void`	`setY(float pY)`
`void`	`setZIndex(int pZIndex)`
`void`	`sortChildren()` Immediately sorts the `IEntity`s based on their ZIndex.
`void`	`sortChildren(boolean pImmediate)` Sorts the `IEntity`s based on their ZIndex.
`void`	`sortChildren(IEntityComparator pEntityComparator)` Sorts the `IEntity`s based on the `Comparator` supplied.
`void`	`toString(java.lang.StringBuilder pStringBuilder)`
`boolean`	`unregisterEntityModifier(IEntityModifier pEntityModifier)`
`boolean`	`unregisterEntityModifiers(IEntityModifier.IEntityModifierMatcher pEntityModifierMatcher)`
`boolean`	`unregisterUpdateHandler(IUpdateHandler pUpdateHandler)`
`boolean`	`unregisterUpdateHandlers(IUpdateHandler.IUpdateHandlerMatcher pUpdateHandlerMatcher)`

Methods inherited from interface org.andengine.engine.handler.IDrawHandler
onDraw

Methods inherited from interface org.andengine.engine.handler.IUpdateHandler
onUpdate, reset

Methods inherited from interface org.andengine.util.IDisposable
dispose, isDisposed

Field Detail
- TAG_INVALID
```
static final int TAG_INVALID
```
  See Also:
  
  Constant Field Values

Method Detail

isVisible
```
boolean isVisible()
```

setVisible
```
void setVisible(boolean pVisible)
```

isIgnoreUpdate
```
boolean isIgnoreUpdate()
```

setIgnoreUpdate

void setIgnoreUpdate(boolean pIgnoreUpdate)

isChildrenVisible
```
boolean isChildrenVisible()
```

setChildrenVisible

void setChildrenVisible(boolean pChildrenVisible)

isChildrenIgnoreUpdate
```
boolean isChildrenIgnoreUpdate()
```

setChildrenIgnoreUpdate

void setChildrenIgnoreUpdate(boolean pChildrenIgnoreUpdate)

getTag
```
int getTag()
```

setTag
```
void setTag(int pTag)
```

getZIndex
```
int getZIndex()
```

setZIndex
```
void setZIndex(int pZIndex)
```

hasParent
```
boolean hasParent()
```

getParent
```
IEntity getParent()
```

setParent
```
void setParent(IEntity pEntity)
```

getX
```
float getX()
```

getY
```
float getY()
```

setX
```
void setX(float pX)
```

setY
```
void setY(float pY)
```

setPosition

void setPosition(IEntity pOtherEntity)

setPosition

void setPosition(float pX,
                 float pY)

isRotated
```
boolean isRotated()
```

getRotation
```
float getRotation()
```

setRotation
```
void setRotation(float pRotation)
```

getRotationCenterX
```
float getRotationCenterX()
```

getRotationCenterY
```
float getRotationCenterY()
```

setRotationCenterX

void setRotationCenterX(float pRotationCenterX)

setRotationCenterY

void setRotationCenterY(float pRotationCenterY)

setRotationCenter

void setRotationCenter(float pRotationCenterX,
                       float pRotationCenterY)

isScaled
```
boolean isScaled()
```

getScaleX
```
float getScaleX()
```

getScaleY
```
float getScaleY()
```

setScaleX
```
void setScaleX(float pScaleX)
```

setScaleY
```
void setScaleY(float pScaleY)
```

setScale
```
void setScale(float pScale)
```

setScale

void setScale(float pScaleX,
              float pScaleY)

getScaleCenterX
```
float getScaleCenterX()
```

getScaleCenterY
```
float getScaleCenterY()
```

setScaleCenterX

void setScaleCenterX(float pScaleCenterX)

setScaleCenterY

void setScaleCenterY(float pScaleCenterY)

setScaleCenter

void setScaleCenter(float pScaleCenterX,
                    float pScaleCenterY)

isSkewed
```
boolean isSkewed()
```

getSkewX
```
float getSkewX()
```

getSkewY
```
float getSkewY()
```

setSkewX
```
void setSkewX(float pSkewX)
```

setSkewY
```
void setSkewY(float pSkewY)
```

setSkew
```
void setSkew(float pSkew)
```

setSkew

void setSkew(float pSkewX,
             float pSkewY)

getSkewCenterX
```
float getSkewCenterX()
```

getSkewCenterY
```
float getSkewCenterY()
```

setSkewCenterX

void setSkewCenterX(float pSkewCenterX)

setSkewCenterY

void setSkewCenterY(float pSkewCenterY)

setSkewCenter

void setSkewCenter(float pSkewCenterX,
                   float pSkewCenterY)

isRotatedOrScaledOrSkewed
```
boolean isRotatedOrScaledOrSkewed()
```

getRed
```
float getRed()
```

getGreen
```
float getGreen()
```

getBlue
```
float getBlue()
```

getAlpha
```
float getAlpha()
```

getColor
```
Color getColor()
```

setRed
```
void setRed(float pRed)
```

setGreen
```
void setGreen(float pGreen)
```

setBlue
```
void setBlue(float pBlue)
```

setAlpha
```
void setAlpha(float pAlpha)
```

setColor
```
void setColor(Color pColor)
```

setColor

void setColor(float pRed,
              float pGreen,
              float pBlue)

setColor

void setColor(float pRed,
              float pGreen,
              float pBlue,
              float pAlpha)

getSceneCenterCoordinates
```
float[] getSceneCenterCoordinates()
```
Returns:

a shared(!) float[] of length 2.

getSceneCenterCoordinates
```
float[] getSceneCenterCoordinates(float[] pReuse)
```
Parameters:

pReuse - must be of length 2.

Returns:

pReuse as a convenience.

convertLocalToSceneCoordinates

float[] convertLocalToSceneCoordinates(float pX,
                                       float pY)

Parameters:: pX -; pY -
Returns:: a shared(!) float[] of length 2.

convertLocalToSceneCoordinates

float[] convertLocalToSceneCoordinates(float pX,
                                       float pY,
                                       float[] pReuse)

Parameters:: pX -; pY -; pReuse - must be of length 2.
Returns:: pReuse as a convenience.

convertLocalToSceneCoordinates
```
float[] convertLocalToSceneCoordinates(float[] pCoordinates)
```
Parameters:

pCoordinates - must be of length 2.

Returns:

a shared(!) float[] of length 2.

convertLocalToSceneCoordinates
```
float[] convertLocalToSceneCoordinates(float[] pCoordinates,
                                       float[] pReuse)
```
Parameters:

pCoordinates - must be of length 2.

pReuse - must be of length 2.

Returns:

pReuse as a convenience.

convertSceneToLocalCoordinates

float[] convertSceneToLocalCoordinates(float pX,
                                       float pY)

Parameters:: pX -; pY -
Returns:: a shared(!) float[] of length 2.

convertSceneToLocalCoordinates

float[] convertSceneToLocalCoordinates(float pX,
                                       float pY,
                                       float[] pReuse)

Parameters:: pX -; pY -; pReuse - must be of length 2.
Returns:: pReuse as a convenience.

convertSceneToLocalCoordinates
```
float[] convertSceneToLocalCoordinates(float[] pCoordinates)
```
Parameters:

pCoordinates - must be of length 2.

Returns:

a shared(!) float[] of length 2.

convertSceneToLocalCoordinates
```
float[] convertSceneToLocalCoordinates(float[] pCoordinates,
                                       float[] pReuse)
```
Parameters:

pCoordinates - must be of length 2.

pReuse - must be of length 2.

Returns:

pReuse as a convenience.

getLocalToSceneTransformation

Transformation getLocalToSceneTransformation()

getSceneToLocalTransformation

Transformation getSceneToLocalTransformation()

getLocalToParentTransformation

Transformation getLocalToParentTransformation()

getParentToLocalTransformation

Transformation getParentToLocalTransformation()

getChildCount
```
int getChildCount()
```

onAttached
```
void onAttached()
```

onDetached
```
void onDetached()
```

attachChild
```
void attachChild(IEntity pEntity)
```

getChildByTag
```
IEntity getChildByTag(int pTag)
```

getChildByMatcher

IEntity getChildByMatcher(IEntityMatcher pEntityMatcher)

getChildByIndex
```
IEntity getChildByIndex(int pIndex)
```

getFirstChild
```
IEntity getFirstChild()
```

getLastChild
```
IEntity getLastChild()
```

query
```
java.util.ArrayList<IEntity> query(IEntityMatcher pEntityMatcher)
```
Parameters:

pEntityMatcher -

Returns:

all children (recursively!) that match the supplied IEntityMatcher.

queryFirst
```
IEntity queryFirst(IEntityMatcher pEntityMatcher)
```
Parameters:

pEntityMatcher -

Returns:

the first child (recursively!) that matches the supplied IEntityMatcher or null if none matches..

query
```
<L extends java.util.List<IEntity>> L query(IEntityMatcher pEntityMatcher,
                                            L pResult)
```
Parameters:

pEntityMatcher -

pResult - the List to put the result into.

Returns:

all children (recursively!) that match the supplied IEntityMatcher.

queryFirstForSubclass
```
<S extends IEntity> S queryFirstForSubclass(IEntityMatcher pEntityMatcher)
```
Parameters:

pEntityMatcher -

Returns:

the first child (recursively!) that matches the supplied IEntityMatcher or null if none matches..

Throws:

java.lang.ClassCastException - when the supplied IEntityMatcher matched an IEntity that was not of the requested subtype.

queryForSubclass
```
<S extends IEntity> java.util.ArrayList<S> queryForSubclass(IEntityMatcher pEntityMatcher)
                                                     throws java.lang.ClassCastException
```
Parameters:

pEntityMatcher -

Returns:

all children (recursively!) that match the supplied IEntityMatcher.

Throws:

java.lang.ClassCastException - when the supplied IEntityMatcher matched an IEntity that was not of the requested subtype.

queryForSubclass

<L extends java.util.List<S>,S extends IEntity> L queryForSubclass(IEntityMatcher pEntityMatcher,
                                                                   L pResult)
                                                            throws java.lang.ClassCastException

Parameters:: pEntityMatcher -; pResult - the List to put the result into.
Returns:: all children (recursively!) that match the supplied IEntityMatcher.
Throws:: java.lang.ClassCastException - when the supplied IEntityMatcher matched an IEntity that was not of the requested subtype.

sortChildren
```
void sortChildren()
```
Immediately sorts the IEntitys based on their ZIndex. Sort is stable.

sortChildren
```
void sortChildren(boolean pImmediate)
```
Sorts the IEntitys based on their ZIndex. Sort is stable. In contrast to sortChildren() this method is particularly useful to avoid multiple sorts per frame.

Parameters:

pImmediate - if true, the sorting is executed immediately. If false the sorting is executed before the next (visible) drawing of the children of this IEntity.

sortChildren
```
void sortChildren(IEntityComparator pEntityComparator)
```
Sorts the IEntitys based on the Comparator supplied. Sort is stable.

Parameters:

pEntityComparator -

detachSelf
```
boolean detachSelf()
```

detachChild
```
boolean detachChild(IEntity pEntity)
```
WARNING: This function should be called from within RunnableHandler.postRunnable(Runnable) which is registered to a Scene or the Engine itself, because otherwise it may throw an IndexOutOfBoundsException in the Update-Thread or the GL-Thread!

detachChild
```
IEntity detachChild(int pTag)
```
WARNING: This function should be called from within RunnableHandler.postRunnable(Runnable) which is registered to a Scene or the Engine itself, because otherwise it may throw an IndexOutOfBoundsException in the Update-Thread or the GL-Thread!

detachChild
```
IEntity detachChild(IEntityMatcher pEntityMatcher)
```
WARNING: This function should be called from within RunnableHandler.postRunnable(Runnable) which is registered to a Scene or the Engine itself, because otherwise it may throw an IndexOutOfBoundsException in the Update-Thread or the GL-Thread!

detachChildren
```
boolean detachChildren(IEntityMatcher pEntityMatcher)
```
WARNING: This function should be called from within RunnableHandler.postRunnable(Runnable) which is registered to a Scene or the Engine itself, because otherwise it may throw an IndexOutOfBoundsException in the Update-Thread or the GL-Thread!

detachChildren
```
void detachChildren()
```

callOnChildren

void callOnChildren(IEntityParameterCallable pEntityParameterCallable)

callOnChildren

void callOnChildren(IEntityParameterCallable pEntityParameterCallable,
                    IEntityMatcher pEntityMatcher)

registerUpdateHandler

void registerUpdateHandler(IUpdateHandler pUpdateHandler)

unregisterUpdateHandler

boolean unregisterUpdateHandler(IUpdateHandler pUpdateHandler)

unregisterUpdateHandlers

boolean unregisterUpdateHandlers(IUpdateHandler.IUpdateHandlerMatcher pUpdateHandlerMatcher)

getUpdateHandlerCount
```
int getUpdateHandlerCount()
```

clearUpdateHandlers
```
void clearUpdateHandlers()
```

registerEntityModifier

void registerEntityModifier(IEntityModifier pEntityModifier)

unregisterEntityModifier

boolean unregisterEntityModifier(IEntityModifier pEntityModifier)

unregisterEntityModifiers

boolean unregisterEntityModifiers(IEntityModifier.IEntityModifierMatcher pEntityModifierMatcher)

getEntityModifierCount
```
int getEntityModifierCount()
```

clearEntityModifiers
```
void clearEntityModifiers()
```

isCullingEnabled
```
boolean isCullingEnabled()
```

setCullingEnabled

void setCullingEnabled(boolean pCullingEnabled)

isCulled
```
boolean isCulled(Camera pCamera)
```
Will only be performed if isCullingEnabled() is true.

Parameters:

pCamera - the currently active camera to perform culling checks against.

Returns:

true when this object is visible by the Camera, false otherwise.

setUserData

void setUserData(java.lang.Object pUserData)

getUserData
```
java.lang.Object getUserData()
```

toString

void toString(java.lang.StringBuilder pStringBuilder)

Interface IEntity

Nested Class Summary

Nested classes/interfaces inherited from interface org.andengine.engine.handler.IUpdateHandler

Nested classes/interfaces inherited from interface org.andengine.util.IDisposable

Field Summary

Method Summary

Methods inherited from interface org.andengine.engine.handler.IDrawHandler

Methods inherited from interface org.andengine.engine.handler.IUpdateHandler

Methods inherited from interface org.andengine.util.IDisposable

Field Detail

TAG_INVALID

Method Detail

isVisible

setVisible

isIgnoreUpdate

setIgnoreUpdate

isChildrenVisible

setChildrenVisible

isChildrenIgnoreUpdate

setChildrenIgnoreUpdate

getTag

setTag

getZIndex

setZIndex

hasParent

getParent

setParent

getX

getY

setX

setY

setPosition

setPosition

isRotated

getRotation

setRotation

getRotationCenterX

getRotationCenterY

setRotationCenterX

setRotationCenterY

setRotationCenter

isScaled

getScaleX

getScaleY

setScaleX

setScaleY

setScale

setScale

getScaleCenterX

getScaleCenterY

setScaleCenterX

setScaleCenterY

setScaleCenter

isSkewed

getSkewX

getSkewY

setSkewX

setSkewY

setSkew

setSkew

getSkewCenterX

getSkewCenterY

setSkewCenterX

setSkewCenterY

setSkewCenter

isRotatedOrScaledOrSkewed

getRed

getGreen

getBlue

getAlpha

getColor

setRed

setGreen

setBlue

setAlpha

setColor

setColor

setColor

getSceneCenterCoordinates

getSceneCenterCoordinates