Camera (library API)

java.lang.Object
- org.andengine.engine.camera.Camera

All Implemented Interfaces:

IUpdateHandler

Direct Known Subclasses:

BoundCamera
```
public class Camera
extends java.lang.Object
implements IUpdateHandler
```
(c) 2010 Nicolas Gramlich (c) 2011 Zynga Inc.

Since:

10:24:18 - 25.03.2010

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected float`	`mCameraSceneRotation`
`protected boolean`	`mResizeOnSurfaceSizeChanged`
`protected float`	`mRotation`
`protected int`	`mSurfaceHeight`
`protected int`	`mSurfaceWidth`
`protected int`	`mSurfaceX`
`protected int`	`mSurfaceY`
`protected UpdateHandlerList`	`mUpdateHandlers`
`protected float`	`mXMax`
`protected float`	`mXMin`
`protected float`	`mYMax`
`protected float`	`mYMin`

Constructor Summary

Constructors
Constructor and Description

Camera(float pX, float pY, float pWidth, float pHeight)

Constructors
Constructor and Description
`Camera(float pX, float pY, float pWidth, float pHeight)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`applySceneToCameraSceneOffset(float[] pSceneCoordinates)`
`protected void`	`applySceneToCameraSceneOffset(TouchEvent pSceneTouchEvent)`
`void`	`clearUpdateHandlers()`
`void`	`convertCameraSceneToSceneTouchEvent(TouchEvent pCameraSceneTouchEvent)`
`void`	`convertSceneToCameraSceneTouchEvent(TouchEvent pSceneTouchEvent)`
`void`	`convertSceneToSurfaceTouchEvent(TouchEvent pSceneTouchEvent, int pSurfaceWidth, int pSurfaceHeight)`
`void`	`convertSurfaceToSceneTouchEvent(TouchEvent pSurfaceTouchEvent, int pSurfaceWidth, int pSurfaceHeight)`
`float[]`	`getCameraSceneCoordinatesFromSceneCoordinates(float[] pSceneCoordinates)`
`float[]`	`getCameraSceneCoordinatesFromSceneCoordinates(float pSceneX, float pSceneY)`
`float`	`getCameraSceneRotation()`
`float`	`getCenterX()`
`float`	`getCenterY()`
`float`	`getHeight()`
`float`	`getHeightRaw()`
`HUD`	`getHUD()`
`float`	`getRotation()`
`float[]`	`getSceneCoordinatesFromCameraSceneCoordinates(float[] pCameraSceneCoordinates)`
`float[]`	`getSceneCoordinatesFromCameraSceneCoordinates(float pCameraSceneX, float pCameraSceneY)`
`int`	`getSurfaceHeight()`
`int`	`getSurfaceWidth()`
`int`	`getSurfaceX()`
`int`	`getSurfaceY()`
`float`	`getWidth()`
`float`	`getWidthRaw()`
`float`	`getXMax()`
`float`	`getXMin()`
`float`	`getYMax()`
`float`	`getYMin()`
`float`	`getZFar()`
`float`	`getZNear()`
`boolean`	`hasHUD()`
`boolean`	`isLineVisible(Line pLine)`
`boolean`	`isRectangularShapeVisible(float pX, float pY, float pWidth, float pHeight, Transformation pLocalToSceneTransformation)`
`boolean`	`isRectangularShapeVisible(RectangularShape pRectangularShape)`
`boolean`	`isResizeOnSurfaceSizeChanged()`
`boolean`	`isRotated()`
`void`	`offsetCenter(float pX, float pY)`
`void`	`onApplyCameraSceneMatrix(GLState pGLState)`
`void`	`onApplySceneBackgroundMatrix(GLState pGLState)`
`void`	`onApplySceneMatrix(GLState pGLState)`
`void`	`onDrawHUD(GLState pGLState)`
`protected void`	`onSurfaceSizeChanged(int pOldSurfaceX, int pOldSurfaceY, int pOldSurfaceWidth, int pOldSurfaceHeight, int pNewSurfaceX, int pNewSurfaceY, int pNewSurfaceWidth, int pNewSurfaceHeight)`
`protected void`	`onSurfaceSizeInitialized(int pSurfaceX, int pSurfaceY, int pSurfaceWidth, int pSurfaceHeight)`
`void`	`onUpdate(float pSecondsElapsed)`
`void`	`registerUpdateHandler(IUpdateHandler pUpdateHandler)`
`void`	`reset()`
`void`	`set(float pXMin, float pYMin, float pXMax, float pYMax)`
`void`	`setCameraSceneRotation(float pCameraSceneRotation)`
`void`	`setCenter(float pCenterX, float pCenterY)`
`void`	`setChaseEntity(IEntity pChaseEntity)`
`void`	`setHUD(HUD pHUD)`
`void`	`setResizeOnSurfaceSizeChanged(boolean pResizeOnSurfaceSizeChanged)`
`void`	`setRotation(float pRotation)`
`void`	`setSurfaceSize(int pSurfaceX, int pSurfaceY, int pSurfaceWidth, int pSurfaceHeight)`
`void`	`setXMax(float pXMax)`
`void`	`setXMin(float pXMin)`
`void`	`setYMax(float pYMax)`
`void`	`setYMin(float pYMin)`
`void`	`setZClippingPlanes(float pNearZClippingPlane, float pFarZClippingPlane)`
`void`	`setZFar(float pZFar)`
`void`	`setZNear(float pZNear)`
`protected void`	`unapplySceneToCameraSceneOffset(float[] pCameraSceneCoordinates)`
`protected void`	`unapplySceneToCameraSceneOffset(TouchEvent pCameraSceneTouchEvent)`
`boolean`	`unregisterUpdateHandler(IUpdateHandler pUpdateHandler)`
`boolean`	`unregisterUpdateHandlers(IUpdateHandler.IUpdateHandlerMatcher pUpdateHandlerMatcher)`
`void`	`updateChaseEntity()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mXMin
```
protected float mXMin
```

mXMax
```
protected float mXMax
```

mYMin
```
protected float mYMin
```

mYMax
```
protected float mYMax
```

mRotation
```
protected float mRotation
```

mCameraSceneRotation
```
protected float mCameraSceneRotation
```

mSurfaceX
```
protected int mSurfaceX
```

mSurfaceY
```
protected int mSurfaceY
```

mSurfaceWidth
```
protected int mSurfaceWidth
```

mSurfaceHeight
```
protected int mSurfaceHeight
```

mResizeOnSurfaceSizeChanged

protected boolean mResizeOnSurfaceSizeChanged

mUpdateHandlers

protected UpdateHandlerList mUpdateHandlers

Constructor Detail

Camera

public Camera(float pX,
              float pY,
              float pWidth,
              float pHeight)

Method Detail

getXMin
```
public float getXMin()
```

setXMin
```
public void setXMin(float pXMin)
```

getXMax
```
public float getXMax()
```

setXMax
```
public void setXMax(float pXMax)
```

getYMin
```
public float getYMin()
```

setYMin
```
public void setYMin(float pYMin)
```

getYMax
```
public float getYMax()
```

setYMax
```
public void setYMax(float pYMax)
```

set

public void set(float pXMin,
                float pYMin,
                float pXMax,
                float pYMax)

getZNear
```
public float getZNear()
```

getZFar
```
public float getZFar()
```

setZNear
```
public void setZNear(float pZNear)
```

setZFar
```
public void setZFar(float pZFar)
```

setZClippingPlanes

public void setZClippingPlanes(float pNearZClippingPlane,
                               float pFarZClippingPlane)

getWidth
```
public float getWidth()
```

getHeight
```
public float getHeight()
```

getWidthRaw
```
public float getWidthRaw()
```

getHeightRaw
```
public float getHeightRaw()
```

getCenterX
```
public float getCenterX()
```

getCenterY
```
public float getCenterY()
```

setCenter

public void setCenter(float pCenterX,
                      float pCenterY)

offsetCenter

public void offsetCenter(float pX,
                         float pY)

getHUD
```
public HUD getHUD()
```

setHUD
```
public void setHUD(HUD pHUD)
```

hasHUD
```
public boolean hasHUD()
```

setChaseEntity

public void setChaseEntity(IEntity pChaseEntity)

isRotated
```
public boolean isRotated()
```

getRotation
```
public float getRotation()
```

setRotation

public void setRotation(float pRotation)

getCameraSceneRotation
```
public float getCameraSceneRotation()
```

setCameraSceneRotation

public void setCameraSceneRotation(float pCameraSceneRotation)

getSurfaceX
```
public int getSurfaceX()
```

getSurfaceY
```
public int getSurfaceY()
```

getSurfaceWidth
```
public int getSurfaceWidth()
```

getSurfaceHeight
```
public int getSurfaceHeight()
```

setSurfaceSize

public void setSurfaceSize(int pSurfaceX,
                           int pSurfaceY,
                           int pSurfaceWidth,
                           int pSurfaceHeight)

isResizeOnSurfaceSizeChanged

public boolean isResizeOnSurfaceSizeChanged()

setResizeOnSurfaceSizeChanged

public void setResizeOnSurfaceSizeChanged(boolean pResizeOnSurfaceSizeChanged)

onUpdate
```
public void onUpdate(float pSecondsElapsed)
```
Specified by:

onUpdate in interface IUpdateHandler

reset
```
public void reset()
```
Specified by:

reset in interface IUpdateHandler

onDrawHUD

public void onDrawHUD(GLState pGLState)

updateChaseEntity
```
public void updateChaseEntity()
```

isLineVisible

public boolean isLineVisible(Line pLine)

isRectangularShapeVisible

public boolean isRectangularShapeVisible(RectangularShape pRectangularShape)

isRectangularShapeVisible

public boolean isRectangularShapeVisible(float pX,
                                         float pY,
                                         float pWidth,
                                         float pHeight,
                                         Transformation pLocalToSceneTransformation)

onApplySceneMatrix

public void onApplySceneMatrix(GLState pGLState)

onApplySceneBackgroundMatrix

public void onApplySceneBackgroundMatrix(GLState pGLState)

onApplyCameraSceneMatrix

public void onApplyCameraSceneMatrix(GLState pGLState)

convertSceneToCameraSceneTouchEvent

public void convertSceneToCameraSceneTouchEvent(TouchEvent pSceneTouchEvent)

getCameraSceneCoordinatesFromSceneCoordinates

public float[] getCameraSceneCoordinatesFromSceneCoordinates(float pSceneX,
                                                             float pSceneY)

getCameraSceneCoordinatesFromSceneCoordinates

public float[] getCameraSceneCoordinatesFromSceneCoordinates(float[] pSceneCoordinates)

convertCameraSceneToSceneTouchEvent

public void convertCameraSceneToSceneTouchEvent(TouchEvent pCameraSceneTouchEvent)

getSceneCoordinatesFromCameraSceneCoordinates

public float[] getSceneCoordinatesFromCameraSceneCoordinates(float pCameraSceneX,
                                                             float pCameraSceneY)

getSceneCoordinatesFromCameraSceneCoordinates

public float[] getSceneCoordinatesFromCameraSceneCoordinates(float[] pCameraSceneCoordinates)

applySceneToCameraSceneOffset

protected void applySceneToCameraSceneOffset(TouchEvent pSceneTouchEvent)

applySceneToCameraSceneOffset

protected void applySceneToCameraSceneOffset(float[] pSceneCoordinates)

unapplySceneToCameraSceneOffset

protected void unapplySceneToCameraSceneOffset(TouchEvent pCameraSceneTouchEvent)

unapplySceneToCameraSceneOffset

protected void unapplySceneToCameraSceneOffset(float[] pCameraSceneCoordinates)

convertSurfaceToSceneTouchEvent

public void convertSurfaceToSceneTouchEvent(TouchEvent pSurfaceTouchEvent,
                                            int pSurfaceWidth,
                                            int pSurfaceHeight)

convertSceneToSurfaceTouchEvent

public void convertSceneToSurfaceTouchEvent(TouchEvent pSceneTouchEvent,
                                            int pSurfaceWidth,
                                            int pSurfaceHeight)

registerUpdateHandler

public void registerUpdateHandler(IUpdateHandler pUpdateHandler)

unregisterUpdateHandler

public boolean unregisterUpdateHandler(IUpdateHandler pUpdateHandler)

unregisterUpdateHandlers

public boolean unregisterUpdateHandlers(IUpdateHandler.IUpdateHandlerMatcher pUpdateHandlerMatcher)

clearUpdateHandlers
```
public void clearUpdateHandlers()
```

onSurfaceSizeInitialized

protected void onSurfaceSizeInitialized(int pSurfaceX,
                                        int pSurfaceY,
                                        int pSurfaceWidth,
                                        int pSurfaceHeight)

onSurfaceSizeChanged

protected void onSurfaceSizeChanged(int pOldSurfaceX,
                                    int pOldSurfaceY,
                                    int pOldSurfaceWidth,
                                    int pOldSurfaceHeight,
                                    int pNewSurfaceX,
                                    int pNewSurfaceY,
                                    int pNewSurfaceWidth,
                                    int pNewSurfaceHeight)

Class Camera

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mXMin

mXMax

mYMin

mYMax

mRotation

mCameraSceneRotation

mSurfaceX

mSurfaceY

mSurfaceWidth

mSurfaceHeight

mResizeOnSurfaceSizeChanged

mUpdateHandlers

Constructor Detail

Camera

Method Detail

getXMin

setXMin

getXMax

setXMax

getYMin

setYMin

getYMax

setYMax

set

getZNear

getZFar

setZNear

setZFar

setZClippingPlanes

getWidth

getHeight

getWidthRaw

getHeightRaw

getCenterX

getCenterY

setCenter

offsetCenter

getHUD

setHUD

hasHUD

setChaseEntity

isRotated

getRotation

setRotation

getCameraSceneRotation

setCameraSceneRotation

getSurfaceX

getSurfaceY

getSurfaceWidth

getSurfaceHeight

setSurfaceSize

isResizeOnSurfaceSizeChanged

setResizeOnSurfaceSizeChanged

onUpdate

reset

onDrawHUD

updateChaseEntity

isLineVisible

isRectangularShapeVisible

isRectangularShapeVisible

onApplySceneMatrix

onApplySceneBackgroundMatrix

onApplyCameraSceneMatrix

convertSceneToCameraSceneTouchEvent

getCameraSceneCoordinatesFromSceneCoordinates

getCameraSceneCoordinatesFromSceneCoordinates

convertCameraSceneToSceneTouchEvent

getSceneCoordinatesFromCameraSceneCoordinates

getSceneCoordinatesFromCameraSceneCoordinates

applySceneToCameraSceneOffset

applySceneToCameraSceneOffset

unapplySceneToCameraSceneOffset