目录

Camera

Class Info

public class Camera extends Component

相机组件。

Public Method Summary

Qualifier and Type

Method Name and Description

static Component.Descriptor<Camera>

descriptor()

获取相机组件描述符。

float

getAspect()

获取视窗比例。

float

getFarClipPlane()

获取远裁剪平面。

float

getFOV()

获取视场角。

float

getNearClipPlane()

获取近裁剪平面。

Camera.ProjectionMode

getProjectionMode()

获取投影模式。

float

getRightClipPlane()

获取右裁剪平面。

float

getTopClipPlane()

获取上裁剪平面。

boolean

isActive()

获取相机是否激活。

Ray

screenPointToRay(Vector2 screenPoint)

屏幕坐标转射线。

Camera

setActive(boolean active)

设置相机是否激活。

Camera

setAspect(float aspect)

设置视窗比例。

Camera

setFarClipPlane(float far)

设置远裁剪平面。

Camera

setFOV(float fov)

设置视场角。

Camera

setNearClipPlane(float near)

设置近裁剪平面。

Camera

setProjection(Matrix4 projection)

设置投影矩阵。

Camera

setProjectionMode(Camera.ProjectionMode projectionMode)

设置投影模式。

Camera

setRightClipPlane(float right)

设置右裁剪平面。

Camera

setTopClipPlane(float top)

设置上裁剪平面。

Public Methods

[h2]descriptor

Method

public static Component.Descriptor<Camera> descriptor()

获取相机组件描述符。

Returns

Type

Description

Component.Descriptor<Camera>

获取相机组件描述符。

[h2]getAspect

Method

public float getAspect()

获取视窗比例。

Returns

Type

Description

float

视窗的宽高比例。

[h2]getFarClipPlane

Method

public float getFarClipPlane()

获取远裁剪平面。

Returns

Type

Description

float

远裁剪平面。

[h2]getFOV

Method

public float getFOV()

获取视场角。

Returns

Type

Description

float

视场角。

[h2]getNearClipPlane

Method

public float getNearClipPlane()

获取近裁剪平面。

Returns

Type

Description

float

近裁剪平面。

[h2]getProjectionMode

Method

public Camera.ProjectionMode getProjectionMode()

获取投影模式。

Returns

Type

Description

Camera.ProjectionMode

投影模式。

[h2]getRightClipPlane

Method

public float getRightClipPlane()

获取右裁剪平面。

Returns

Type

Description

float

右裁剪平面。

[h2]getTopClipPlane

Method

public float getTopClipPlane()

获取上裁剪平面。

Returns

Type

Description

float

上裁剪平面。

[h2]isActive

Method

public boolean isActive()

获取相机组件是否激活。

Returns

Type

Description

boolean

相机组件是否激活。

  • true:相机组件已激活。
  • false:相机组件未激活。

[h2]screenPointToRay

Method

public Ray screenPointToRay(Vector2 screenPoint)

屏幕坐标转射线。

Parameters

Name

Description

screenPoint

屏幕坐标,坐标原点为屏幕左上角,横竖坐标取值范围[0, 1]。

Returns

Type

Description

Ray

射线实例。

[h2]setActive

Method

public Camera setActive(boolean active)

设置相机是否激活。

Parameters

Name

Description

active

相机是否激活。

  • true:激活相机。
  • false:不激活相机。

Returns

Type

Description

Camera

自身实例。

[h2]setAspect

Method

public Camera setAspect(float aspect)

设置视窗的宽高比例。

Parameters

Name

Description

aspect

视窗的宽高比例,大于0。

Returns

Type

Description

Camera

自身实例。

[h2]setFarClipPlane

Method

public Camera setFarClipPlane(float far)

设置远裁剪平面。

Parameters

Name

Description

far

远裁剪平面,取值范围大于0且大于近平面。

Returns

Type

Description

Camera

自身实例。

[h2]setFOV

Method

public Camera setFOV(float fov)

设置视场角。

Parameters

Name

Description

fov

视场角,取值范围 (0, 180]。

Returns

Type

Description

Camera

自身实例。

[h2]setNearClipPlane

Method

public Camera setNearClipPlane(float near)

设置近裁剪平面。

Parameters

Name

Description

near

近裁剪平面,取值范围:

  • 透视投影:(0, 远平面]。
  • 正交投影:小于远平面。

Returns

Type

Description

Camera

自身实例。

[h2]setProjection

Method

public Camera setProjection(Matrix4 projection)

设置投影矩阵。

Parameters

Name

Description

projection

投影矩阵。

Returns

Type

Description

Camera

自身实例。

[h2]setProjectionMode

Method

public Camera setProjectionMode(Camera.ProjectionMode projectionMode)

设置投影模式。

Parameters

Name

Description

projectionMode

投影模式。

Returns

Type

Description

Camera

自身实例。

[h2]setRightClipPlane

Method

public Camera setRightClipPlane(float right)

设置右裁剪平面。

Parameters

Name

Description

right

右裁剪平面,取值范围大于0。

Returns

Type

Description

Camera

自身实例。

[h2]setTopClipPlane

Method

public Camera setTopClipPlane(float top)

设置上裁剪平面。

Parameters

Name

Description

top

上裁剪平面,取值范围大于0。

Returns

Type

Description

Camera

自身实例。