org.andengine.entity.primitive

Class Line

java.lang.Object

org.andengine.entity.Entity

org.andengine.entity.shape.Shape

org.andengine.entity.primitive.Line

All Implemented Interfaces:

IDrawHandler, IUpdateHandler, IEntity, ITouchArea, IShape, IDisposable

public class Line
extends Shape

(c) 2010 Nicolas Gramlich (c) 2011 Zynga Inc.

Since:

09:50:36 - 04.04.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

Nested classes/interfaces inherited from interface org.andengine.entity.scene.ITouchArea

ITouchArea.ITouchAreaMatcher

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLOR_INDEX
static int	LINE_SIZE
static float	LINE_WIDTH_DEFAULT
protected ILineVertexBufferObject	mLineVertexBufferObject
protected float	mLineWidth
protected float	mX2
protected float	mY2
static int	VERTEX_INDEX_X
static int	VERTEX_INDEX_Y
static int	VERTEX_SIZE
static VertexBufferObjectAttributes	VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT
static int	VERTICES_PER_LINE

Fields inherited from class org.andengine.entity.shape.Shape

mBlendFunctionDestination, mBlendFunctionSource, mBlendingEnabled, mShaderProgram

Fields inherited from class org.andengine.entity.Entity

mChildren, mChildrenIgnoreUpdate, mChildrenSortPending, mChildrenVisible, mColor, mCullingEnabled, mDisposed, mIgnoreUpdate, mRotation, mRotationCenterX, mRotationCenterY, mScaleCenterX, mScaleCenterY, mScaleX, mScaleY, mSkewCenterX, mSkewCenterY, mSkewX, mSkewY, mTag, mVisible, mX, mY, mZIndex

Fields inherited from interface org.andengine.entity.shape.IShape

BLENDFUNCTION_DESTINATION_DEFAULT, BLENDFUNCTION_DESTINATION_PREMULTIPLYALPHA_DEFAULT, BLENDFUNCTION_SOURCE_DEFAULT, BLENDFUNCTION_SOURCE_PREMULTIPLYALPHA_DEFAULT

Fields inherited from interface org.andengine.entity.IEntity

TAG_INVALID

Constructor Summary

Constructors

Constructor and Description
Line(float pX1, float pY1, float pX2, float pY2, float pLineWidth, ILineVertexBufferObject pLineVertexBufferObject)
Line(float pX1, float pY1, float pX2, float pY2, float pLineWidth, VertexBufferObjectManager pVertexBufferObjectManager) Uses a default HighPerformanceLineVertexBufferObject in DrawType.STATIC with the VertexBufferObjectAttributes: VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT.
Line(float pX1, float pY1, float pX2, float pY2, float pLineWidth, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType)
Line(float pX1, float pY1, float pX2, float pY2, VertexBufferObjectManager pVertexBufferObjectManager) Uses a default HighPerformanceLineVertexBufferObject in DrawType.STATIC with the VertexBufferObjectAttributes: VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT.
Line(float pX1, float pY1, float pX2, float pY2, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType) Uses a default HighPerformanceLineVertexBufferObject with the VertexBufferObjectAttributes: VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT.

Method Summary

Modifier and Type	Method and Description
boolean	collidesWith(IShape pOtherShape)
boolean	contains(float pX, float pY) Deprecated.
protected void	draw(GLState pGLState, Camera pCamera)
float	getLineWidth()
float[]	getSceneCenterCoordinates()
float[]	getSceneCenterCoordinates(float[] pReuse)
ILineVertexBufferObject	getVertexBufferObject()
float	getX() Deprecated. Instead use getX1() or getX2().
float	getX1()
float	getX2()
float	getY() Deprecated.
float	getY1()
float	getY2()
boolean	isCulled(Camera pCamera) Will only be performed if IEntity.isCullingEnabled() is true.
protected void	onUpdateColor()
protected void	onUpdateVertices()
protected void	postDraw(GLState pGLState, Camera pCamera)
protected void	preDraw(GLState pGLState, Camera pCamera)
void	setLineWidth(float pLineWidth)
void	setPosition(float pX, float pY) Deprecated.
void	setPosition(float pX1, float pY1, float pX2, float pY2)
void	setX(float pX) Deprecated.
void	setY(float pY) Deprecated.

Methods inherited from class org.andengine.entity.shape.Shape

dispose, getBlendFunctionDestination, getBlendFunctionSource, getShaderProgram, getVertexBufferObjectManager, initBlendFunction, initBlendFunction, initBlendFunction, isBlendingEnabled, onAreaTouched, reset, setBlendFunction, setBlendFunctionDestination, setBlendFunctionSource, setBlendingEnabled, setShaderProgram

Methods inherited from class org.andengine.entity.Entity

applyRotation, applyScale, applySkew, applyTranslation, attachChild, callOnChildren, callOnChildren, clearEntityModifiers, clearUpdateHandlers, convertLocalToSceneCoordinates, convertLocalToSceneCoordinates, convertLocalToSceneCoordinates, convertLocalToSceneCoordinates, convertSceneToLocalCoordinates, convertSceneToLocalCoordinates, convertSceneToLocalCoordinates, convertSceneToLocalCoordinates, detachChild, detachChild, detachChild, detachChildren, detachChildren, detachSelf, finalize, getAlpha, getBlue, getChildByIndex, getChildByMatcher, getChildByTag, getChildCount, getColor, getEntityModifierCount, getFirstChild, getGreen, getLastChild, getLocalToParentTransformation, getLocalToSceneTransformation, getParent, getParentToLocalTransformation, getRed, getRotation, getRotationCenterX, getRotationCenterY, getScaleCenterX, getScaleCenterY, getScaleX, getScaleY, getSceneToLocalTransformation, getSkewCenterX, getSkewCenterY, getSkewX, getSkewY, getTag, getUpdateHandlerCount, getUserData, getZIndex, hasParent, isChildrenIgnoreUpdate, isChildrenVisible, isCullingEnabled, isDisposed, isIgnoreUpdate, isRotated, isRotatedOrScaledOrSkewed, isScaled, isSkewed, isVisible, onApplyTransformations, onAttached, onDetached, onDraw, onManagedDraw, onManagedUpdate, onUpdate, query, query, queryFirst, queryFirstForSubclass, queryForSubclass, queryForSubclass, registerEntityModifier, registerUpdateHandler, setAlpha, setBlue, setChildrenIgnoreUpdate, setChildrenVisible, setColor, setColor, setColor, setCullingEnabled, setGreen, setIgnoreUpdate, setParent, setPosition, setRed, setRotation, setRotationCenter, setRotationCenterX, setRotationCenterY, setScale, setScale, setScaleCenter, setScaleCenterX, setScaleCenterY, setScaleX, setScaleY, setSkew, setSkew, setSkewCenter, setSkewCenterX, setSkewCenterY, setSkewX, setSkewY, setTag, setUserData, setVisible, setZIndex, sortChildren, sortChildren, sortChildren, toString, toString, unregisterEntityModifier, unregisterEntityModifiers, unregisterUpdateHandler, unregisterUpdateHandlers

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.andengine.entity.IEntity

attachChild, callOnChildren, callOnChildren, clearEntityModifiers, clearUpdateHandlers, convertLocalToSceneCoordinates, convertLocalToSceneCoordinates, convertLocalToSceneCoordinates, convertLocalToSceneCoordinates, convertSceneToLocalCoordinates, convertSceneToLocalCoordinates, convertSceneToLocalCoordinates, convertSceneToLocalCoordinates, detachChild, detachChild, detachChild, detachChildren, detachChildren, detachSelf, getAlpha, getBlue, getChildByIndex, getChildByMatcher, getChildByTag, getChildCount, getColor, getEntityModifierCount, getFirstChild, getGreen, getLastChild, getLocalToParentTransformation, getLocalToSceneTransformation, getParent, getParentToLocalTransformation, getRed, getRotation, getRotationCenterX, getRotationCenterY, getScaleCenterX, getScaleCenterY, getScaleX, getScaleY, getSceneToLocalTransformation, getSkewCenterX, getSkewCenterY, getSkewX, getSkewY, getTag, getUpdateHandlerCount, getUserData, getZIndex, hasParent, isChildrenIgnoreUpdate, isChildrenVisible, isCullingEnabled, isIgnoreUpdate, isRotated, isRotatedOrScaledOrSkewed, isScaled, isSkewed, isVisible, onAttached, onDetached, query, query, queryFirst, queryFirstForSubclass, queryForSubclass, queryForSubclass, registerEntityModifier, registerUpdateHandler, setAlpha, setBlue, setChildrenIgnoreUpdate, setChildrenVisible, setColor, setColor, setColor, setCullingEnabled, setGreen, setIgnoreUpdate, setParent, setPosition, setRed, setRotation, setRotationCenter, setRotationCenterX, setRotationCenterY, setScale, setScale, setScaleCenter, setScaleCenterX, setScaleCenterY, setScaleX, setScaleY, setSkew, setSkew, setSkewCenter, setSkewCenterX, setSkewCenterY, setSkewX, setSkewY, setTag, setUserData, setVisible, setZIndex, sortChildren, sortChildren, sortChildren, toString, unregisterEntityModifier, unregisterEntityModifiers, unregisterUpdateHandler, unregisterUpdateHandlers

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

onDraw

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

onUpdate

Methods inherited from interface org.andengine.util.IDisposable

isDisposed

Methods inherited from interface org.andengine.entity.scene.ITouchArea

convertLocalToSceneCoordinates, convertSceneToLocalCoordinates

Field Detail

LINE_WIDTH_DEFAULT

public static final float LINE_WIDTH_DEFAULT

See Also:

Constant Field Values

VERTEX_INDEX_X

public static final int VERTEX_INDEX_X

See Also:

Constant Field Values

VERTEX_INDEX_Y

public static final int VERTEX_INDEX_Y

See Also:

Constant Field Values

COLOR_INDEX

public static final int COLOR_INDEX

See Also:

Constant Field Values

VERTEX_SIZE

public static final int VERTEX_SIZE

See Also:

Constant Field Values

VERTICES_PER_LINE

public static final int VERTICES_PER_LINE

See Also:

Constant Field Values

LINE_SIZE

public static final int LINE_SIZE

See Also:

Constant Field Values

VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT

public static final VertexBufferObjectAttributes VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT

mX2

protected float mX2

mY2

protected float mY2

mLineWidth

protected float mLineWidth

mLineVertexBufferObject

protected final ILineVertexBufferObject mLineVertexBufferObject

Constructor Detail

Line

public Line(float pX1,
            float pY1,
            float pX2,
            float pY2,
            VertexBufferObjectManager pVertexBufferObjectManager)

Uses a default HighPerformanceLineVertexBufferObject in DrawType.STATIC with the VertexBufferObjectAttributes: VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT.

Line

public Line(float pX1,
            float pY1,
            float pX2,
            float pY2,
            VertexBufferObjectManager pVertexBufferObjectManager,
            DrawType pDrawType)

Uses a default HighPerformanceLineVertexBufferObject with the VertexBufferObjectAttributes: VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT.

Line

public Line(float pX1,
            float pY1,
            float pX2,
            float pY2,
            float pLineWidth,
            VertexBufferObjectManager pVertexBufferObjectManager)

Uses a default HighPerformanceLineVertexBufferObject in DrawType.STATIC with the VertexBufferObjectAttributes: VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT.

Line

public Line(float pX1,
            float pY1,
            float pX2,
            float pY2,
            float pLineWidth,
            VertexBufferObjectManager pVertexBufferObjectManager,
            DrawType pDrawType)

Line

public Line(float pX1,
            float pY1,
            float pX2,
            float pY2,
            float pLineWidth,
            ILineVertexBufferObject pLineVertexBufferObject)

Method Detail

getX

@Deprecated
public float getX()

Deprecated. Instead use getX1() or getX2().

Specified by:

getX in interface IEntity

Overrides:

getX in class Entity

getY

@Deprecated
public float getY()

Deprecated.

Specified by:

getY in interface IEntity

Overrides:

getY in class Entity

getX1

public float getX1()

getY1

public float getY1()

getX2

public float getX2()

getY2

public float getY2()

getLineWidth

public float getLineWidth()

setLineWidth

public void setLineWidth(float pLineWidth)

setX

@Deprecated
public void setX(float pX)

Deprecated.

Instead use setPosition(float, float, float, float).

Specified by:

setX in interface IEntity

Overrides:

setX in class Entity

setY

@Deprecated
public void setY(float pY)

Deprecated.

Instead use setPosition(float, float, float, float).

Specified by:

setY in interface IEntity

Overrides:

setY in class Entity

setPosition

@Deprecated
public void setPosition(float pX,
                                    float pY)

Deprecated.

Instead use setPosition(float, float, float, float).

Specified by:

setPosition in interface IEntity

Overrides:

setPosition in class Entity

setPosition

public void setPosition(float pX1,
                        float pY1,
                        float pX2,
                        float pY2)

getVertexBufferObject

public ILineVertexBufferObject getVertexBufferObject()

isCulled

public boolean isCulled(Camera pCamera)

Description copied from interface: IEntity

Will only be performed if IEntity.isCullingEnabled() is true.

Specified by:

isCulled in interface IEntity

Overrides:

isCulled in class Entity

Parameters:

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

Returns:

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

preDraw

protected void preDraw(GLState pGLState,
                       Camera pCamera)

Overrides:

preDraw in class Shape

Parameters:

pGLState - the currently active GLState i.e. to apply transformations to.

pCamera - the currently active Camera i.e. to be used for culling.

draw

protected void draw(GLState pGLState,
                    Camera pCamera)

Overrides:

draw in class Entity

Parameters:

pGLState - the currently active GLState i.e. to apply transformations to.

pCamera - the currently active Camera i.e. to be used for culling.

postDraw

protected void postDraw(GLState pGLState,
                        Camera pCamera)

Overrides:

postDraw in class Shape

Parameters:

pGLState - the currently active GLState i.e. to apply transformations to.

pCamera - the currently active Camera i.e. to be used for culling.

onUpdateColor

protected void onUpdateColor()

Overrides:

onUpdateColor in class Entity

onUpdateVertices

protected void onUpdateVertices()

Specified by:

onUpdateVertices in class Shape

getSceneCenterCoordinates

public float[] getSceneCenterCoordinates()

Specified by:

getSceneCenterCoordinates in interface IEntity

Overrides:

getSceneCenterCoordinates in class Entity

Returns:

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

getSceneCenterCoordinates

public float[] getSceneCenterCoordinates(float[] pReuse)

Specified by:

getSceneCenterCoordinates in interface IEntity

Overrides:

getSceneCenterCoordinates in class Entity

Parameters:

pReuse - must be of length 2.

Returns:

pReuse as a convenience.

contains

@Deprecated
public boolean contains(float pX,
                                    float pY)

Deprecated.

collidesWith

public boolean collidesWith(IShape pOtherShape)