Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

Camera

public class Camera
extends Object

java.lang.Object
   ↳ android.graphics.Camera


A camera instance can be used to compute 3D transformations and generate a matrix that can be applied, for instance, on a Canvas.

Summary

Public constructors

Camera()

Creates a new camera, with empty transformations.

Public methods

void applyToCanvas(Canvas canvas)

Computes the matrix corresponding to the current transformation and applies it to the specified Canvas.

float dotWithNormal(float dx, float dy, float dz)
float getLocationX()

Gets the x location of the camera.

float getLocationY()

Gets the y location of the camera.

float getLocationZ()

Gets the z location of the camera.

void getMatrix(Matrix matrix)

Computes the matrix corresponding to the current transformation and copies it to the supplied matrix object.

void restore()

Restores the saved state, if any.

void rotate(float x, float y, float z)

Applies a rotation transform around all three axis.

void rotateX(float deg)

Applies a rotation transform around the X axis.

void rotateY(float deg)

Applies a rotation transform around the Y axis.

void rotateZ(float deg)

Applies a rotation transform around the Z axis.

void save()

Saves the camera state.

void setLocation(float x, float y, float z)

Sets the location of the camera.

void translate(float x, float y, float z)

Applies a translation transform on all three axis.

Protected methods

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Inherited methods

Public constructors

Camera

added in API level 1
public Camera ()

Creates a new camera, with empty transformations.

Public methods

applyToCanvas

added in API level 1
public void applyToCanvas (Canvas canvas)

Computes the matrix corresponding to the current transformation and applies it to the specified Canvas.

Parameters
canvas Canvas: The Canvas to set the transform matrix onto

dotWithNormal

added in API level 1
public float dotWithNormal (float dx, 
                float dy, 
                float dz)

Parameters
dx float

dy float

dz float

Returns
float

getLocationX

added in API level 16
public float getLocationX ()

Gets the x location of the camera.

Returns
float

getLocationY

added in API level 16
public float getLocationY ()

Gets the y location of the camera.

Returns
float

getLocationZ

added in API level 16
public float getLocationZ ()

Gets the z location of the camera.

Returns
float

getMatrix

added in API level 1
public void getMatrix (Matrix matrix)

Computes the matrix corresponding to the current transformation and copies it to the supplied matrix object.

Parameters
matrix Matrix: The matrix to copy the current transforms into

restore

added in API level 1
public void restore ()

Restores the saved state, if any.

See also:

rotate

added in API level 12
public void rotate (float x, 
                float y, 
                float z)

Applies a rotation transform around all three axis.

Parameters
x float: The angle of rotation around the X axis, in degrees

y float: The angle of rotation around the Y axis, in degrees

z float: The angle of rotation around the Z axis, in degrees

rotateX

added in API level 1
public void rotateX (float deg)

Applies a rotation transform around the X axis.

Parameters
deg float: The angle of rotation around the X axis, in degrees

rotateY

added in API level 1
public void rotateY (float deg)

Applies a rotation transform around the Y axis.

Parameters
deg float: The angle of rotation around the Y axis, in degrees

rotateZ

added in API level 1
public void rotateZ (float deg)

Applies a rotation transform around the Z axis.

Parameters
deg float: The angle of rotation around the Z axis, in degrees

save

added in API level 1
public void save ()

Saves the camera state. Each save should be balanced with a call to restore().

See also:

setLocation

added in API level 12
public void setLocation (float x, 
                float y, 
                float z)

Sets the location of the camera. The default location is set at 0, 0, -8.

Parameters
x float: The x location of the camera

y float: The y location of the camera

z float: The z location of the camera

translate

added in API level 1
public void translate (float x, 
                float y, 
                float z)

Applies a translation transform on all three axis.

Parameters
x float: The distance to translate by on the X axis

y float: The distance to translate by on the Y axis

z float: The distance to translate by on the Z axis

Protected methods

finalize

added in API level 1
protected void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Throws
Throwable