CameraComponent

java.lang.Object
- ohos.agp.render.render3d.components.CameraComponent

所有已实现的接口:

Component
```
public class CameraComponent
extends Object
implements Component
```
Represents the camera component.
You can use this class to define the attributes of a virtual camera for a scene.

从以下版本开始:

3

嵌套类概要

嵌套类
限定符和类型类说明

static class CameraComponent.CameraType
Enumerates camera types.

嵌套类
限定符和类型	类	说明
`static class`	`CameraComponent.CameraType`	Enumerates camera types.

字段概要

字段
限定符和类型字段说明

static int CAMERA_FLAG_SHADOW_BIT
Specifies whether the camera is used for shadow rendering.

字段
限定符和类型	字段	说明
`static int`	`CAMERA_FLAG_SHADOW_BIT`	Specifies whether the camera is used for shadow rendering.

构造器概要

构造器
构造器说明

CameraComponent()

构造器
构造器	说明
`CameraComponent()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`int`	`getAdditionalFlags()`	Obtains the additional flags of the camera, for example, whether the camera is used for shadow rendering.
`CameraComponent.CameraType`	`getCameraType()`	Obtains the camera type.
`Matrix4x4`	`getCustomProjection()`	Obtains the projection matrix for the customized type of camera.
`String`	`getName()`	Obtains the camera name.
`float`	`getOrthoHeight()`	Obtains the height of the viewport for the orthographic camera only.
`float`	`getOrthoWidth()`	Obtains the width of the viewport for the orthographic camera only.
`float`	`getPerspectiveAspectRatio()`	Obtains the aspect ratio for the perspective camera only.
`float`	`getPerspectiveVerticalFov()`	Obtains the vertical field of view (FOV) for the perspective camera only.
`int`	`getRenderResolutionX()`	Obtains the horizontal rendering resolution (in pixels) for the camera.
`int`	`getRenderResolutionY()`	Obtains the vertical rendering resolution (in pixels) for the camera.
`float[]`	`getViewportParams()`	Obtains the position and size of the viewport for a normalized rendering resolution (from 0.0 to 1.0).
`float`	`getZfar()`	Obtains the far plane location.
`float`	`getZnear()`	Obtains the near plane location.
`void`	`setAdditionalFlags(int additionalFlags)`	Sets the additional flags of the camera.
`void`	`setCameraType(CameraComponent.CameraType cameraType)`	Sets the camera type.
`void`	`setCustomProjection(Matrix4x4 customProjection)`	Sets the projection matrix for the customized type of camera.
`void`	`setName(String name)`	Sets the camera name.
`void`	`setOrthoHeight(float orthoHeight)`	Sets the viewport height for the orthographic camera only.
`void`	`setOrthoWidth(float orthoWidth)`	Sets the viewport width for the orthographic camera only.
`void`	`setPerspectiveAspectRatio(float perspectiveAspectRatio)`	Sets the aspect ratio for the perspective camera only.
`void`	`setPerspectiveVerticalFov(float perspectiveVerticalFov)`	Sets the vertical FOV for the perspective camera only.
`void`	`setRenderResolution(int renderResolutionX, int renderResolutionY)`	Sets rendering resolutions for the camera.
`void`	`setViewportParams(float[] viewportParams)`	Sets the position and size of the viewport.
`void`	`setZfar(float zfar)`	Sets the far plane location.
`void`	`setZnear(float znear)`	Sets the near plane location.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - CAMERA_FLAG_SHADOW_BIT
```
public static final int CAMERA_FLAG_SHADOW_BIT
```
    Specifies whether the camera is used for shadow rendering. This flag is used with other camera flags.
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - CameraComponent
```
public CameraComponent()
```
- 方法详细资料
  - getName
```
public String getName()
```
    Obtains the camera name.
    
    返回:
    
    Returns the camera name.
  - setName
```
public void setName(String name)
```
    Sets the camera name.
    
    参数:
    
    name - Indicates the camera name to set.
  - getCameraType
```
public CameraComponent.CameraType getCameraType()
```
    Obtains the camera type.
    
    返回:
    
    Returns the camera type.
  - setCameraType
```
public void setCameraType(CameraComponent.CameraType cameraType)
```
    Sets the camera type.
    
    参数:
    
    cameraType - Indicates the camera type, as enumerated in CameraType.
  - getAdditionalFlags
```
public int getAdditionalFlags()
```
    Obtains the additional flags of the camera, for example, whether the camera is used for shadow rendering.
    
    返回:
    
    Returns the flag bits.
  - setAdditionalFlags
```
public void setAdditionalFlags(int additionalFlags)
```
    Sets the additional flags of the camera.
    
    参数:
    
    additionalFlags - Indicates the flags to set.
  - getPerspectiveAspectRatio
```
public float getPerspectiveAspectRatio()
```
    Obtains the aspect ratio for the perspective camera only.
    If the initial aspect ratio is 0 or less, you should use the aspect ratio of the render target.
    
    返回:
    
    Returns the aspect ratio.
  - setPerspectiveAspectRatio
```
public void setPerspectiveAspectRatio(float perspectiveAspectRatio)
```
    Sets the aspect ratio for the perspective camera only.
    
    参数:
    
    perspectiveAspectRatio - Indicates the aspect ratio to set.
  - getPerspectiveVerticalFov
```
public float getPerspectiveVerticalFov()
```
    Obtains the vertical field of view (FOV) for the perspective camera only.
    
    返回:
    
    Returns the FOV.
  - setPerspectiveVerticalFov
```
public void setPerspectiveVerticalFov(float perspectiveVerticalFov)
```
    Sets the vertical FOV for the perspective camera only.
    
    参数:
    
    perspectiveVerticalFov - Indicates the vertical FOV to set.
  - getOrthoWidth
```
public float getOrthoWidth()
```
    Obtains the width of the viewport for the orthographic camera only.
    
    返回:
    
    Returns the viewport width.
  - setOrthoWidth
```
public void setOrthoWidth(float orthoWidth)
```
    Sets the viewport width for the orthographic camera only.
    
    参数:
    
    orthoWidth - Indicates the viewport width to set.
  - getOrthoHeight
```
public float getOrthoHeight()
```
    Obtains the height of the viewport for the orthographic camera only.
    
    返回:
    
    Returns the viewport height.
  - setOrthoHeight
```
public void setOrthoHeight(float orthoHeight)
```
    Sets the viewport height for the orthographic camera only.
    
    参数:
    
    orthoHeight - Indicates the viewport height to set.
  - getCustomProjection
```
public Matrix4x4 getCustomProjection()
```
    Obtains the projection matrix for the customized type of camera.
    
    返回:
    
    Returns the projection matrix.
  - setCustomProjection
```
public void setCustomProjection(Matrix4x4 customProjection)
```
    Sets the projection matrix for the customized type of camera.
    
    参数:
    
    customProjection - Indicates the projection matrix to set.
  - getZnear
```
public float getZnear()
```
    Obtains the near plane location.
    
    返回:
    
    Returns the near plane location.
  - setZnear
```
public void setZnear(float znear)
```
    Sets the near plane location.
    
    参数:
    
    znear - Indicates the near plane location to set.
  - getZfar
```
public float getZfar()
```
    Obtains the far plane location.
    
    返回:
    
    Returns the far plane location.
  - setZfar
```
public void setZfar(float zfar)
```
    Sets the far plane location.
    
    参数:
    
    zfar - Indicates the far plane location to set.
  - getViewportParams
```
public float[] getViewportParams()
```
    Obtains the position and size of the viewport for a normalized rendering resolution (from 0.0 to 1.0).
    The position and size are represented in an array consisting of four float values: [0] = x, [1] = y, [2] = the relative width, [3] = the relative height.
    
    返回:
    
    Returns the viewport parameters.
  - setViewportParams
```
public void setViewportParams(float[] viewportParams)
```
    Sets the position and size of the viewport. For details, see getViewportParams().
    
    参数:
    
    viewportParams - Indicates the viewport parameters.
  - getRenderResolutionX
```
public int getRenderResolutionX()
```
    Obtains the horizontal rendering resolution (in pixels) for the camera.
    
    返回:
    
    Returns the horizontal rendering resolution for the camera.
  - getRenderResolutionY
```
public int getRenderResolutionY()
```
    Obtains the vertical rendering resolution (in pixels) for the camera.
    
    返回:
    
    Returns the vertical rendering resolution for the camera.
  - setRenderResolution
```
public void setRenderResolution(int renderResolutionX,
                                int renderResolutionY)
```
    Sets rendering resolutions for the camera.
    
    参数:
    
    renderResolutionX - Indicates the horizontal rendering resolution.
    
    renderResolutionY - Indicates the vertical rendering resolution.

类 CameraComponent

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

CAMERA_FLAG_SHADOW_BIT

构造器详细资料

CameraComponent

方法详细资料

getName

setName

getCameraType

setCameraType

getAdditionalFlags

setAdditionalFlags

getPerspectiveAspectRatio

setPerspectiveAspectRatio

getPerspectiveVerticalFov

setPerspectiveVerticalFov

getOrthoWidth

setOrthoWidth

getOrthoHeight

setOrthoHeight

getCustomProjection

setCustomProjection

getZnear

setZnear

getZfar

setZfar

getViewportParams

setViewportParams

getRenderResolutionX

getRenderResolutionY

setRenderResolution