Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Camera

3D场景相机。

Hierarchy

  • BaseCamera
    • Camera

Index

Constructors

constructor

  • new Camera(entity: Entity3D): Camera
  • 请使用entity.addComponent(engine.Camera)来创建。

    Parameters

    • entity: Entity3D

    Returns Camera

Properties

Readonly entity

entity: Entity3D

forDebug

forDebug: boolean = false

决定是否要添加到renderSystem从而进入RenderGraph流程,必须在onEnable前设置!

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

Static Readonly AspectType

AspectType: Readonly<typeof CameraAspectType> = ...

宽高比模式

static
memberof

BaseCamera

Static Readonly ClearFlag

ClearFlag: Readonly<typeof ClearFlag> = ...

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

  • Align: number
  • Layout: number
  • Low: number
  • Physics: number
  • Render: number
  • Tool: number

Static Readonly ProjectionType

ProjectionType: Readonly<typeof CameraProjectionType> = ...

投影类型

static
memberof

BaseCamera

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

    • (...args: any[]): any
    • Parameters

      • Rest ...args: any[]

      Returns any

Static Readonly ShadowFitMode

ShadowFitMode: Readonly<typeof EShadowFitMode> = ...

阴影适配模式

Static Readonly ShadowMode

ShadowMode: Readonly<typeof EShadowMode> = ...

阴影模式。

Accessors

active

  • get active(): boolean
  • set active(value: boolean): void
  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

activeInHierarchy

  • get activeInHierarchy(): boolean
  • 在场景树中是否active

    readonly
    memberof

    Component

    Returns boolean

aspect

  • get aspect(): number
  • set aspect(val: number): void
  • 相机宽高比。
    仅当CameraAspectType = Custom 时可设置。

    Returns number

  • 相机宽高比。
    仅当CameraAspectType = Custom 时可设置。

    Parameters

    • val: number

    Returns void

aspectType

  • get aspectType(): CameraAspectType
  • set aspectType(val: CameraAspectType): void
  • 相机宽高比模式。

    Returns CameraAspectType

  • 相机宽高比模式。

    Parameters

    • val: CameraAspectType

    Returns void

cascadedSplits

  • get cascadedSplits(): Vector3
  • set cascadedSplits(val: Vector3): void
  • Cascaded splits。

    Returns Vector3

  • Cascaded splits。

    Parameters

    Returns void

center

  • Returns Vector3

clearColor

  • get clearColor(): Color
  • set clearColor(val: Color): void
  • 清除颜色缓冲的值。
    暂不支持clearColor.r = 255 这种写法。

    Returns Color

  • 清除颜色缓冲的值。
    暂不支持clearColor.r = 255 这种写法。

    Parameters

    Returns void

clearDepth

  • get clearDepth(): number
  • set clearDepth(val: number): void
  • 清除深度缓冲的值,范围0-1。

    Returns number

  • 清除深度缓冲的值,范围0-1。

    Parameters

    • val: number

    Returns void

clearFlag

  • get clearFlag(): ClearFlag
  • set clearFlag(val: ClearFlag): void
  • Returns ClearFlag

  • Parameters

    • val: ClearFlag

    Returns void

clearStencil

  • get clearStencil(): number
  • set clearStencil(val: number): void
  • 清除模板缓冲的值,范围0-255。

    Returns number

  • 清除模板缓冲的值,范围0-255。

    Parameters

    • val: number

    Returns void

cullingMask

  • get cullingMask(): number
  • set cullingMask(cullingMask: number): void
  • 剔除掩码,有效值:0~0x3fffffff。最高两位为工具预留。
    剔除时将使用该值与MeshRenderer的cullingMask做按位与,有值时才渲染。

    Returns number

  • 剔除掩码,有效值:0~0x3fffffff。最高两位为工具预留。
    剔除时将使用该值与MeshRenderer的cullingMask做按位与,有值时才渲染。

    Parameters

    • cullingMask: number

    Returns void

depth

  • get depth(): number
  • set depth(val: number): void
  • 相机深度,决定了相机的渲染顺序,深度小的先被渲染。

    Returns number

  • 相机深度,决定了相机的渲染顺序,深度小的先被渲染。

    Parameters

    • val: number

    Returns void

drawGizmo

  • get drawGizmo(): boolean
  • set drawGizmo(val: boolean): void
  • 是否绘制Gizmo

    memberof

    Camera

    Returns boolean

  • 是否绘制Gizmo

    Parameters

    • val: boolean

    Returns void

drawSkybox

  • get drawSkybox(): boolean
  • set drawSkybox(val: boolean): void
  • 是否绘制天空盒。

    Returns boolean

  • 是否绘制天空盒。

    Parameters

    • val: boolean

    Returns void

editorRenderTarget

  • Returns RenderTexture

  • Parameters

    Returns void

eye

  • Returns Vector3

farClipPlane

  • get farClipPlane(): number
  • set farClipPlane(val: number): void
  • 相机远剪裁面。

    Returns number

  • 相机远剪裁面。

    Parameters

    • val: number

    Returns void

fieldOfView

  • get fieldOfView(): number
  • set fieldOfView(val: number): void
  • 视野大小,用角度表示,透视模式专用。

    Returns number

  • 视野大小,用角度表示,透视模式专用。

    Parameters

    • val: number

    Returns void

fieldOfViewRadians

  • get fieldOfViewRadians(): number
  • set fieldOfViewRadians(val: number): void
  • 视野大小,用弧度表示,透视模式专用。

    Returns number

  • 视野大小,用弧度表示,透视模式专用。

    Parameters

    • val: number

    Returns void

hdr

  • get hdr(): boolean
  • set hdr(val: boolean): void
  • 是否开启HDR。

    Returns boolean

  • 是否开启HDR。

    Parameters

    • val: boolean

    Returns void

isClearColor

  • get isClearColor(): boolean
  • set isClearColor(val: boolean): void
  • 是否要清除颜色。

    Returns boolean

  • 是否要清除颜色。

    Parameters

    • val: boolean

    Returns void

isClearDepth

  • get isClearDepth(): boolean
  • set isClearDepth(val: boolean): void
  • 是否清除深度缓冲。

    Returns boolean

  • 是否清除深度缓冲。

    Parameters

    • val: boolean

    Returns void

isClearStencil

  • get isClearStencil(): boolean
  • set isClearStencil(val: boolean): void
  • 是否清除模板缓冲。

    Returns boolean

  • 是否清除模板缓冲。

    Parameters

    • val: boolean

    Returns void

layerCullDistances

  • get layerCullDistances(): number[]
  • set layerCullDistances(v: number[]): void
  • 每个layer自己的远平面,如果为0则使用相机的。

    Returns number[]

  • 每个layer自己的远平面,如果为0则使用相机的。

    Parameters

    • v: number[]

    Returns void

nearClipPlane

  • get nearClipPlane(): number
  • set nearClipPlane(val: number): void
  • 相机近剪裁面。

    Returns number

  • 相机近剪裁面。

    Parameters

    • val: number

    Returns void

onProjectionMatrixChange

  • get onProjectionMatrixChange(): Delegate<default, void>
  • Returns Delegate<default, void>

orthographicSize

  • get orthographicSize(): number
  • set orthographicSize(val: number): void
  • 正交相机视野高的一半。

    Returns number

  • 正交相机视野高的一半。

    Parameters

    • val: number

    Returns void

postProcess

  • Returns PostProcessAsset

  • Parameters

    Returns void

projectionMatrix

  • get projectionMatrix(): DeepImmutableObject<Matrix4>
  • 投影矩阵。

    Returns DeepImmutableObject<Matrix4>

projectionType

  • get projectionType(): CameraProjectionType
  • set projectionType(val: CameraProjectionType): void
  • 投影类型。

    Returns CameraProjectionType

  • 投影类型。

    Parameters

    • val: CameraProjectionType

    Returns void

renderTarget

shadowDistance

  • get shadowDistance(): number
  • set shadowDistance(val: number): void
  • 阴影距离。

    Returns number

  • 阴影距离。

    Parameters

    • val: number

    Returns void

shadowFitMode

  • 阴影适配模式。

    Returns EShadowFitMode

  • 阴影适配模式。

    Parameters

    Returns void

shadowMode

  • 阴影渲染模式

    Returns EShadowMode

  • 阴影渲染模式

    Parameters

    Returns void

targetTexture

  • deprecate

    请使用renderTarget

    Returns Screen | RenderTexture

  • Parameters

    Returns void

targetTransform

  • 相机的跟拍目标。
    该属性有值时,相机为跟拍模式,相机的rotation会被自动更新。
    该属性设置为null时,相机为自由旋转模式。

    Returns Transform3D

  • 相机的跟拍目标。
    该属性有值时,相机为跟拍模式,相机的rotation会被自动更新。
    该属性设置为null时,相机为自由旋转模式。

    Parameters

    Returns void

up

  • Returns Vector3

view

  • 渲染的View。

    Returns View

viewMatrix

  • get viewMatrix(): DeepImmutableObject<Matrix4>
  • 观察矩阵。

    Returns DeepImmutableObject<Matrix4>

viewMatrixInverse

  • get viewMatrixInverse(): DeepImmutableObject<Matrix4>
  • 观察矩阵的逆。

    Returns DeepImmutableObject<Matrix4>

viewport

  • get viewport(): Rect
  • set viewport(val: Rect): void
  • Returns Rect

  • Parameters

    Returns void

Methods

changeProjectMatrix

  • changeProjectMatrix(manual: boolean, mat4?: Matrix4): void
  • 修改projectMatrix的设置类型。

    Parameters

    • manual: boolean

      是否要设置为手动模式。

    • Optional mat4: Matrix4

      手动模式下,要设置的值。

    Returns void

changeViewMatrix

  • changeViewMatrix(manual: boolean, mat4?: Matrix4): void
  • 修改viewMatrix的设置类型。

    Parameters

    • manual: boolean

      是否要设置为手动模式。

    • Optional mat4: Matrix4

      手动模式下,要设置的值。

    Returns void

clear

  • clear(): void
  • 使用此相机的View进行RenderTarget的清屏。

    Returns void

convertClipPositionToWorld

  • 将齐次裁剪空间转换到世界坐标系位置。

    Parameters

    Returns Vector3

convertWorldPositionToClip

  • 将世界坐标系位置转换到齐次裁剪空间。

    Parameters

    Returns Vector3

cull

  • 使用此相机进行剔除。

    Parameters

    • cullResult: ScalableList

      要存储剔除结果的列表。

    • lightMode: string

      作为剔除依据的光照模式。

    Returns void

destroy

  • destroy(): void
  • Returns void

draw

  • 使用此相机进行绘制。

    Parameters

    • renderList: ScalableList

      要绘制的渲染列表。

    • lightMode: string

      作为绘制依据的光照模式。

    Returns void

drawLight

  • 通过一个平行光绘制阴影。

    Parameters

    Returns void

getTypeName

  • getTypeName(): string
  • Returns string

isDetached

  • isDetached(): boolean
  • Returns boolean

resetProperties

  • resetProperties(): void
  • Returns void

Generated using TypeDoc