Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UICamera

2D相机组件。

export

Hierarchy

  • BaseCamera
    • UICamera

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new UICamera(entity: Entity2D): UICamera

  • Parameters

    • entity: Entity2D

    Returns UICamera

Properties

Readonly entity

entity: Entity2D

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 = ...

renderMananger

renderMananger: default = ...

Readonly touchEvent

touchEvent: Emitter<RawTouchEvents, TouchEvent> = ...

Readonly touchManager

touchManager: TouchManager

touchable

touchable: boolean = false

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

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

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
  • override

    Returns number

  • Parameters

    • cullingMask: number

    Returns void

depth

  • get depth(): number
  • set depth(val: number): void

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

    Returns number

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

    Parameters

    • val: number

    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

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>

onViewMatrixChange

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>

projectionMatrix2D

  • get projectionMatrix2D(): DeepImmutableObject<Matrix4>

  • Returns DeepImmutableObject<Matrix4>

projectionType

  • get projectionType(): CameraProjectionType
  • set projectionType(val: CameraProjectionType): void

  • 投影类型。

    Returns CameraProjectionType

  • 投影类型。

    Parameters

    • val: CameraProjectionType

    Returns void

renderTarget

targetTexture

  • deprecate

    请使用renderTarget。

    Returns Screen | RenderTexture

  • Parameters

    Returns void

uiCanvas

  • legacy

    在工具内部使用，应该可以直接替换成cullingMask

    Returns UICanvas

up

  • Returns Vector3

view

  • 渲染的View。

    Returns View

viewMatrix

  • get viewMatrix(): DeepImmutableObject<Matrix4>

  • 观察矩阵。

    Returns DeepImmutableObject<Matrix4>

viewMatrix2D

  • get viewMatrix2D(): DeepImmutableObject<Matrix4>

  • Returns DeepImmutableObject<Matrix4>

viewMatrixInverse

  • get viewMatrixInverse(): DeepImmutableObject<Matrix4>

  • 观察矩阵的逆。

    Returns DeepImmutableObject<Matrix4>

viewMatrixInverse2D

  • get viewMatrixInverse2D(): DeepImmutableObject<Matrix4>

  • Returns DeepImmutableObject<Matrix4>

viewport

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

  • Returns Rect

  • Parameters

    Returns void

Methods

clear

  • clear(): void

  • 使用此相机的View进行RenderTarget的清屏。

    Returns void

convertClipPositionToCanvas

  • 将齐次裁剪坐标转换为UICanvas世界坐标

    memberof

    UICamera

    Parameters

    Returns Vector2

    UICanvas坐标，Y轴向上

convertClipPositionToWorld

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

    Parameters

    Returns Vector3

convertEventPositionToClip

  • 将事件坐标转换为齐次裁剪坐标

    memberof

    UICamera

    Parameters

    Returns Vector2

    齐次裁剪坐标

convertEventPositionToUICanvas

  • 将事件坐标转换为UICanvas世界坐标

    memberof

    UICamera

    Parameters

    • eventPosition: DeepImmutableObject<Vector2>

      事件坐标，Y轴向下

    • Optional dst: Vector2

    Returns Vector2

    UICanvas坐标，Y轴向上

convertWorldPositionToClip

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

    Parameters

    Returns Vector3

cull

  • 使用此相机进行剔除。

    Parameters

    • cullResult: ScalableList

      要存储剔除结果的列表。

    • lightMode: string

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

    Returns void

destroy

  • destroy(): void

  • Returns void

draw

  • Parameters

    Returns void

getTypeName

  • getTypeName(): string

  • Returns string

isDetached

  • isDetached(): boolean

  • Returns boolean

resetProperties

  • resetProperties(): void

  • Returns void

updateTree

  • updateTree(): void

  • Returns void

Static RECEIVE_SHARD_TOUCH

  • RECEIVE_SHARD_TOUCH(info: ISharedTouchInfo[]): void

  • Parameters

    • info: ISharedTouchInfo[]

    Returns void

Generated using TypeDoc