Class Camera

相机组件

Export

Date

2022.3.24

Author

lyx

Hierarchy

Constructors

constructor

Properties

_engine _entity autoClippingDistance cameraNode userData

Accessors

aspect cameraAnimation depthTexture enabled engine entity far fov helperVisible near parent position quaternion rotation useDepthBuffer worldDirection

Methods

_onAwake _onDestroy _onDisable _onEnable addEventListener createViewpoint destroy dispatchEvent dispose goto isActive lookAt notifyCameraChanged registerUpdateFlag removeAllEventListeners removeEventListener removeEventListenerByEventId renderDepth setActive update updateMatrixWorld updateProjectionMatrix updateProperties

Constructors

constructor

Properties

Protected _engine

_engine: Engine

Protected _entity

_entity: Entity

Readonly autoClippingDistance

autoClippingDistance: boolean

是否自动更新相机远近裁剪面

Memberof

Camera

Readonly cameraNode

cameraNode: PerspectiveCamera

相机结点

Memberof

Camera

userData

userData: {
    [key: string]: any;
} = {}

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

aspect

  • get aspect(): number

  • 获取相机视锥体宽高比

    Returns number

    Memberof

    Camera

  • set aspect(value): void

  • 设置相机视锥体宽高比

    Parameters

    • value: number

    Returns void

    Memberof

    Camera

cameraAnimation

  • get cameraAnimation(): CameraAnimation

  • 获取当前相机动画

    Returns CameraAnimation

    Memberof

    Camera

depthTexture

  • get depthTexture(): Readonly<DepthTexture>

  • 获取深度纹理

    Returns Readonly<DepthTexture>

    Memberof

    Camera

enabled

  • get enabled(): boolean

  • 获取组件是否启用

    Returns boolean

    Memberof

    Component

  • set enabled(value): void

  • 启用或禁用组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

engine

  • get engine(): Engine

  • 获取引擎对象

    Returns Engine

    Memberof

    EngineObject

entity

  • get entity(): Entity

  • 获取组件所属实体

    Returns Entity

    Memberof

    Component

far

  • get far(): number

  • 获取

    Returns number

    Memberof

    Camera

  • set far(value): void

  • 设置相机远裁剪面距离

    Parameters

    • value: number

    Returns void

    Memberof

    Camera

fov

  • get fov(): number

  • 获取相机fov角度

    Returns number

    Memberof

    Camera

  • set fov(value): void

  • 设置相机fov角度

    Parameters

    • value: number

    Returns void

    Memberof

    Camera

helperVisible

  • set helperVisible(value): void

  • 设置相机辅助助手是否可见

    Parameters

    • value: boolean

    Returns void

    Deprecated

    已弃用，使用CameraHelper代替

    Memberof

    Camera

near

  • get near(): number

  • 获取相机近裁剪面距离

    Returns number

    Memberof

    Camera

  • set near(value): void

  • 设置相机近裁剪面距离

    Parameters

    • value: number

    Returns void

    Memberof

    Camera

parent

  • set parent(value): void

  • 设置父结点

    Parameters

    Returns void

    Memberof

    Camera

position

  • get position(): Readonly<Vector3>

  • 获取相机位置

    Returns Readonly<Vector3>

    Memberof

    Camera

  • set position(value): void

  • 设置相机位置

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    Camera

quaternion

  • get quaternion(): Readonly<Quaternion>

  • 获取相机旋转四元数

    Returns Readonly<Quaternion>

    Memberof

    Camera

  • set quaternion(value): void

  • 设置相机旋转四元数

    Parameters

    • value: number[] | Quaternion

    Returns void

    Memberof

    Camera

rotation

  • get rotation(): Readonly<Euler>

  • 获取相机旋转量

    Returns Readonly<Euler>

    Memberof

    Camera

  • set rotation(value): void

  • 设置相机旋转量

    Parameters

    • value: number[] | Euler

    Returns void

    Memberof

    Camera

useDepthBuffer

  • get useDepthBuffer(): boolean

  • 获取是否启用深度纹理

    Returns boolean

    Memberof

    Camera

  • set useDepthBuffer(value): void

  • 设置是否启用深度缓冲

    Parameters

    • value: boolean

    Returns void

    Memberof

    Camera

worldDirection

  • get worldDirection(): Vector3

  • 获取世界朝向

    Returns Vector3

    Memberof

    Camera

Methods

Protected _onAwake

  • _onAwake(): void
  • Protected

    唤醒组件

    Returns void

    Memberof

    Component

Protected _onDestroy

  • _onDestroy(): void
  • Protected

    销毁接口

    Returns void

    Memberof

    Camera

Protected _onDisable

  • _onDisable(): void
  • Protected

    禁用相机组件

    Returns void

    Memberof

    Camera

Protected _onEnable

  • _onEnable(): void
  • Protected

    启用相机组件

    Returns void

    Memberof

    Camera

addEventListener

  • 添加事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • callback: ((event) => void)

      事件监听回调

        • (event): void

        • Parameters

          • event: {
                type: string;
                [key: string]: any;
            }
            • [key: string]: any
            • type: string

          Returns void

    • Optional parameters: {
          priority?: Priority;
          target?: any;
      } = {}

      事件参数

      • Optional priority?: Priority
      • Optional target?: any

    Returns number

    Memberof

    EventDispatcher

createViewpoint

  • 创建视点

    Parameters

    • Optional name: string = ''

    Returns Viewpoint

    Memberof

    Camera

destroy

  • 销毁组件

    Returns void

    Memberof

    Component

dispatchEvent

  • 分发事件

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

dispose

  • 释放接口

    Returns void

    Memberof

    EventDispatcher

goto

  • 视点跳转

    Parameters

    Returns void

    Memberof

    Camera

isActive

  • 判断相机组件是否被激活

    Returns boolean

    Memberof

    Camera

lookAt

  • 设置相机朝向

    Parameters

    • target: number[] | Vector3

    Returns void

    Memberof

    Camera

notifyCameraChanged

  • 通知相机发生改变

    Returns void

    Memberof

    Camera

registerUpdateFlag

removeAllEventListeners

removeEventListener

  • 移除事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • Optional callback: ((event) => void)

      事件监听回调（可选，不设置则表示移除所有监听器）

        • (event): void

        • Parameters

          • event: {
                type: string;
                [key: string]: any;
            }
            • [key: string]: any
            • type: string

          Returns void

    Returns void

    Memberof

    EventDispatcher

removeEventListenerByEventId

  • 通过事件Id移除事件监听器

    Parameters

    • eventID: number

    Returns void

    Memberof

    EventDispatcher

renderDepth

  • 渲染相机深度

    Parameters

    • renderer: WebGLRenderer
    • scene: Object3D<Object3DEventMap>

    Returns void

    Node

    切勿手动调用

    Memberof

    Camera

setActive

  • 激活或冻结组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

update

  • 帧更新

    Parameters

    • timeSinceLastFrame: number

      距离上一帧更新的时长 （单位：毫秒）

    • totalTime: number

      总时长 (单位：毫秒)

    Returns void

    Memberof

    Camera

updateMatrixWorld

  • 更新世界矩阵

    Returns void

    Memberof

    Camera

updateProjectionMatrix

  • 更新投影矩阵

    Returns void

    Memberof

    Camera

updateProperties

  • 批量更新组件属性

    Parameters

    • parameters: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns Promise<void>

    Memberof

    Component

Settings

Member Visibility

Theme

On This Page