Added in API level 1

Camera


open class Camera
kotlin.Any
   ↳ 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

Creates a new camera, with empty transformations.

Public methods
open Unit

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

open Float
dotWithNormal(dx: Float, dy: Float, dz: Float)

open Float

Gets the x location of the camera.

open Float

Gets the y location of the camera.

open Float

Gets the z location of the camera.

open Unit
getMatrix(matrix: Matrix!)

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

open Unit

Restores the saved state, if any.

open Unit
rotate(x: Float, y: Float, z: Float)

Applies a rotation transform around all three axis.

open Unit
rotateX(deg: Float)

Applies a rotation transform around the X axis.

open Unit
rotateY(deg: Float)

Applies a rotation transform around the Y axis.

open Unit
rotateZ(deg: Float)

Applies a rotation transform around the Z axis.

open Unit

Saves the camera state.

open Unit
setLocation(x: Float, y: Float, z: Float)

Sets the location of the camera.

open Unit
translate(x: Float, y: Float, z: Float)

Applies a translation transform on all three axis.

Protected methods
open Unit

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

Public constructors

Camera

Added in API level 1
Camera()

Creates a new camera, with empty transformations.

Public methods

applyToCanvas

Added in API level 1
open fun applyToCanvas(canvas: Canvas!): Unit

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
open fun dotWithNormal(
    dx: Float,
    dy: Float,
    dz: Float
): Float

getLocationX

Added in API level 16
open fun getLocationX(): Float

Gets the x location of the camera.

getLocationY

Added in API level 16
open fun getLocationY(): Float

Gets the y location of the camera.

getLocationZ

Added in API level 16
open fun getLocationZ(): Float

Gets the z location of the camera.

getMatrix

Added in API level 1
open fun getMatrix(matrix: Matrix!): Unit

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
open fun restore(): Unit

Restores the saved state, if any.

See Also

rotate

Added in API level 12
open fun rotate(
    x: Float,
    y: Float,
    z: Float
): Unit

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
open fun rotateX(deg: Float): Unit

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
open fun rotateY(deg: Float): Unit

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
open fun rotateZ(deg: Float): Unit

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
open fun save(): Unit

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

See Also

setLocation

Added in API level 12
open fun setLocation(
    x: Float,
    y: Float,
    z: Float
): Unit

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
open fun translate(
    x: Float,
    y: Float,
    z: Float
): Unit

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 open fun finalize(): Unit

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.

Exceptions
java.lang.Throwable the Exception raised by this method