Class OrthographicCamera

constructor

• new OrthographicCamera(entity, options?): OrthographicCamera

• Parameters

  • entity: Entity
  • options: OrthographicCameraOptions = {}

  Returns OrthographicCamera

Readonlyentity

ReadonlyisCamera

ReadonlyisOrthographicCamera

userData

colorTexture

• get colorTexture(): Readonly<Texture>

• Get camera color texture

  Returns Readonly<Texture>

  Memberof

  Camera

depthTexture

• get depthTexture(): Readonly<DepthTexture>

• Get camera depth texture

  Returns Readonly<DepthTexture>

  Memberof

  Camera

enabled

• get enabled(): boolean

• Indicates whether the component is enabled.

  Returns boolean

  Memberof

  Component

• set enabled(value): void

• Set whether the component is enabled.

  Parameters

  • value: boolean

  Returns void

  Memberof

  Component

far

• get far(): number

• Get camera frustum far plane.

  Returns number

  Memberof

  OrthographicCamera

• set far(value): void

• Set camera frustum far plane.

  Parameters

  • value: number

  Returns void

  Memberof

  OrthographicCamera

frustumSize

• get frustumSize(): number

• Get camera frustum size

  Returns number

  Memberof

  OrthographicCamera

• set frustumSize(value): void

• Set camera frustum size

  Parameters

  • value: number

  Returns void

  Memberof

  OrthographicCamera

native

• get native(): Camera

• Get three.js native camera

  Returns Camera

  Memberof

  Camera

near

• get near(): number

• Get camera frustum far plane.

  Returns number

  Memberof

  OrthographicCamera

• set near(value): void

• Set camera frustum far plane.

  Parameters

  • value: number

  Returns void

  Memberof

  OrthographicCamera

pixelViewport

• get pixelViewport(): Readonly<Vector4>

• Get pixel viewport size

  Returns Readonly<Vector4>

  Memberof

  Camera

priority

• get priority(): number

• Get camera priority

  Returns number

  Memberof

  Camera

• set priority(value): void

• Set priority

  Parameters

  • value: number

  Returns void

  Memberof

  Camera

renderTarget

• get renderTarget(): WebGLRenderTarget<Texture>

• Get camera render target

  Returns WebGLRenderTarget<Texture>

  Memberof

  Camera

• set renderTarget(value): void

• Set camera render target

  Parameters

  • value: WebGLRenderTarget<Texture>

  Returns void

  Memberof

  Camera

scene

• get scene(): Scene

• Scene own the component

  Returns Scene

  Memberof

  Component

updateFlagManager

• get updateFlagManager(): UpdateFlagManager

• Get camera update flag manager

  Returns UpdateFlagManager

  Memberof

  Camera

viewport

• get viewport(): Readonly<Vector4>

• Get normalized viewport size

  Returns Readonly<Vector4>

  Memberof

  Camera

• set viewport(value): void

• Set normalized viewport size

  Parameters

  • value: Vector4

  Returns void

  Memberof

  Camera

_captureFrameBuffer

• _captureFrameBuffer(): void

• Capture camera frame buffer

  Returns void

  Memberof

  Camera

desrtoy

• desrtoy(): void

• Destroy component

  Returns void

  Memberof

  Component

dispose

• dispose(): void

• Clear subscribers

  Returns void

  Memberof

  EventDispatcher

emit

• emit(event): void

• Emit event

  Parameters

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

    • [key: string]: any

    • type: string

  Returns void

  Memberof

  EventDispatcher

intersectEntity

• intersectEntity(ray, entity, queryMask?): {
      intersection: Intersection<Object3D<Object3DEventMap>>;
      renderer: Renderer;
  }

• Intersect a entity by ray

  Parameters

  • ray: Ray
  • entity: Entity
  • OptionalqueryMask: QueryMask

  Returns {
      intersection: Intersection<Object3D<Object3DEventMap>>;
      renderer: Renderer;
  }

  • intersection: Intersection<Object3D<Object3DEventMap>>

  • renderer: Renderer

  Memberof

  Camera

• intersectEntity(screenPoint, entity, queryMask?): {
      intersection: Intersection<Object3D<Object3DEventMap>>;
      renderer: Renderer;
  }

• Intersect a entity by screen point

  Parameters

  • screenPoint: Vector2
  • entity: Entity
  • OptionalqueryMask: QueryMask

  Returns {
      intersection: Intersection<Object3D<Object3DEventMap>>;
      renderer: Renderer;
  }

  • intersection: Intersection<Object3D<Object3DEventMap>>

  • renderer: Renderer

  Memberof

  Camera

intersectRenderer

• intersectRenderer(ray, renderer): Intersection<Object3D<Object3DEventMap>>

• Intersect a renderer by ray

  Parameters

  • ray: Ray
  • renderer: Renderer

  Returns Intersection<Object3D<Object3DEventMap>>

  Memberof

  Camera

• intersectRenderer(screenPoint, renderer): Intersection<Object3D<Object3DEventMap>>

• Intersect a renderer by screen point

  Parameters

  • screenPoint: Vector2
  • renderer: Renderer

  Returns Intersection<Object3D<Object3DEventMap>>

  Memberof

  Camera

off

• off(type, callback?): void

• Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.

  Parameters

  • type: string
  • Optionalcallback: SubscriberCallbackFn

    subscriber callback

  Returns void

  Memberof

  EventDispatcher

on

• on(type, callback, options?): void

• Subscribe a event

  Parameters

  • type: string

    event type
  • callback: SubscriberCallbackFn

    callback functions
  • Optionaloptions: {
        priority?: Priority;
        target?: any;
    } = {}

    options

    • Optionalpriority?: Priority

    • Optionaltarget?: any

  Returns void

  Memberof

  EventDispatcher

once

• once(type, callback, options?): void

• Subscribe a event, just emit once

  Parameters

  • type: string
  • callback: SubscriberCallbackFn

    subscriber callback
  • options: {
        priority?: Priority;
        target?: any;
    } = {}

    • Optionalpriority?: Priority

    • Optionaltarget?: any

  Returns void

  Memberof

  EventDispatcher

raycast

• raycast(ray, queryMask?): QueryResult[]

• Raycast by ray

  Parameters

  • ray: Ray
  • OptionalqueryMask: QueryMask

  Returns QueryResult[]

  Memberof

  Camera

• raycast(screenPoint, queryMask?): QueryResult[]

• Raycast by screen point

  Parameters

  • screenPoint: Vector2
  • OptionalqueryMask: QueryMask

  Returns QueryResult[]

  Memberof

  Camera

resize

• resize(width, height): void

• Resize camera viewport

  Parameters

  • width: number

    render viewport width
  • height: number

    render viewport height

  Returns void

  Memberof

  OrthographicCamera

screenPointToRay

• screenPointToRay(point, out): Ray

• Screen point to ray

  Parameters

  • point: Vector2
  • out: Ray

  Returns Ray

  Memberof

  Camera

screenToWorldPoint

• screenToWorldPoint(point, out): Vector3

• Screen point to world point

  Parameters

  • point: Vector3

    Screen space point, the top-left of the screen is (0,0), the right-bottom is (pixelWidth,pixelHeight), The z position is in world units from the camera
  • out: Vector3

    World space point

  Returns Vector3

  Memberof

  OrthographicCamera

updateProjectionMatrix

• updateProjectionMatrix(): void

• Update camera projection matrix

  Returns void

  Memberof

  OrthographicCamera

updateWorldMatrix

• updateWorldMatrix(): void

• Update camera world matrix

  Returns void

  Memberof

  OrthographicCamera

worldToScreenPoint

• worldToScreenPoint(point, out): Vector2

• World point to screen point

  Parameters

  • point: Vector3

    World space point
  • out: Vector2

    Screen space point, the top-left of the screen is (0,0), the right-bottom is (pixelWidth,pixelHeight)

  Returns Vector2

  Memberof

  Camera