Android APIs
public class

Camera

extends Object
java.lang.Object
   ↳ android.graphics.Camera

Class Overview

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()
Invoked when the garbage collector has detected that this instance is no longer reachable.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Camera ()

Added in API level 1

Creates a new camera, with empty transformations.

Public Methods

public void applyToCanvas (Canvas canvas)

Added in API level 1

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

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

Added in API level 1

Parameters
dx float
dy float
dz float
Returns
float

public float getLocationX ()

Added in API level 16

Gets the x location of the camera.

Returns
float

public float getLocationY ()

Added in API level 16

Gets the y location of the camera.

Returns
float

public float getLocationZ ()

Added in API level 16

Gets the z location of the camera.

Returns
float

public void getMatrix (Matrix matrix)

Added in API level 1

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

public void restore ()

Added in API level 1

Restores the saved state, if any.

See also:

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

Added in API level 12

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

public void rotateX (float deg)

Added in API level 1

Applies a rotation transform around the X axis.

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

public void rotateY (float deg)

Added in API level 1

Applies a rotation transform around the Y axis.

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

public void rotateZ (float deg)

Added in API level 1

Applies a rotation transform around the Z axis.

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

public void save ()

Added in API level 1

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

See also:

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

Added in API level 12

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

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

Added in API level 1

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

protected void finalize ()

Added in API level 1

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

Throws
Throwable