Options
All
  • Public
  • Public/Protected
  • All
Menu

Class View

cc.view is the singleton object which represents the game window.
It's main task include:

  • Apply the design resolution policy
  • Provide interaction with the window, like resize event on web, retina display support, etc...
  • Manage the game view port which can be different with the window
  • Manage the content scale and translation

    Since the cc.view is a singleton, you don't need to call any constructor or create functions,
    the standard way to use it is by calling:
  • cc.view.methodName();
class

View

Hierarchy

Index

Constructors

constructor

  • Returns View

Properties

Private _antiAliasEnabled

_antiAliasEnabled: boolean

Private _autoFullScreen

_autoFullScreen: boolean

_callbackTable

_callbackTable: ICallbackTable = createMap(true)

_designResolutionSize

_designResolutionSize: Size

Private _devicePixelRatio

_devicePixelRatio: number

Private _frameSize

_frameSize: Size

Private _isAdjustViewport

_isAdjustViewport: boolean

Private _isRotated

_isRotated: boolean

Private _orientation

_orientation: any

Private _orientationChanging

_orientationChanging: boolean

_originalDesignResolutionSize

_originalDesignResolutionSize: Size

Private _resizeCallback

_resizeCallback: null

_resizeWithBrowserSize

_resizeWithBrowserSize: boolean

Private _resizing

_resizing: boolean

Private _resolutionPolicy

_resolutionPolicy: any

Private _retinaEnabled

_retinaEnabled: boolean

Private _rpExactFit

_rpExactFit: ResolutionPolicy

Private _rpFixedHeight

_rpFixedHeight: ResolutionPolicy

Private _rpFixedWidth

_rpFixedWidth: ResolutionPolicy

Private _rpNoBorder

_rpNoBorder: ResolutionPolicy

Private _rpShowAll

_rpShowAll: ResolutionPolicy

Private _scaleX

_scaleX: number

Private _scaleY

_scaleY: number

Private _viewportRect

_viewportRect: Rect

Private _visibleRect

_visibleRect: Rect

Static instance

instance: View

Methods

Private adjustSizeKeepCanvasSize

  • _adjustSizeKeepCanvasSize(): void
  • Returns void

Private adjustViewportMeta

  • _adjustViewportMeta(): void
  • Returns void

Private convertMouseToLocation

  • convertMouseToLocation(in_out_point: any, relatedPos: any): void
  • Parameters

    • in_out_point: any
    • relatedPos: any

    Returns void

convertPointWithScale

  • convertPointWithScale(point: any): void
  • Parameters

    • point: any

    Returns void

Private convertTouchWidthScale

  • convertTouchWidthScale(selTouch: any): void
  • Parameters

    • selTouch: any

    Returns void

Private convertTouchesWithScale

  • convertTouchesWithScale(touches: any): void
  • Parameters

    • touches: any

    Returns void

Private initFrameSize

  • _initFrameSize(): void
  • Returns void

Private orientationChange

  • _orientationChange(): void
  • Returns void

Private resizeEvent

  • _resizeEvent(): void
  • Returns void

Private setViewportMeta

  • setViewportMeta(metas: any, overwrite: any): void
  • Parameters

    • metas: any
    • overwrite: any

    Returns void

adjustViewportMeta

  • adjustViewportMeta(enabled: any): void
  • 设置引擎是否调整 viewport meta 来配合屏幕适配。 默认设置为启动,我们强烈建议你不要将它设置为关闭。 即使当它启动时,你仍然能够设置你的 viewport meta,它不会被覆盖。 仅在 Web 模式下有效

    method

    adjustViewportMeta

    Parameters

    • enabled: any

      Enable automatic modification to "viewport" meta

    Returns void

convertToLocationInView

  • convertToLocationInView(tx: any, ty: any, relatedPos: any, out: any): any
  • 将屏幕坐标转换为游戏视图下的坐标。

    method

    convertToLocationInView

    Parameters

    • tx: any

      The X axis translation

    • ty: any

      The Y axis translation

    • relatedPos: any

      The related position object including "left", "top", "width", "height" informations

    • out: any

    Returns any

emit

  • emit(key: string, ...args: any[]): void
  • 事件派发

    Parameters

    • key: string

      一个监听事件类型的字符串

    • Rest ...args: any[]

    Returns void

enableAntiAlias

  • enableAntiAlias(enabled: any): void
  • 控制抗锯齿是否开启

    method

    enableAntiAlias

    Parameters

    • enabled: any

      Enable or not anti-alias

    Returns void

enableAutoFullScreen

  • enableAutoFullScreen(enabled: any): void
  • 启动时,移动端游戏会在移动端自动尝试进入全屏模式。 你能够传入 true 为参数去启动它,用 false 参数来关闭它。

    method

    enableAutoFullScreen

    Parameters

    • enabled: any

      Enable or disable auto full screen on mobile devices

    Returns void

enableRetina

  • enableRetina(enabled: any): void
  • 对于 Apple 这种支持 Retina 显示的设备上默认进行优化而其他类型设备默认不进行优化, 它仅会在你调用 setDesignResolutionPolicy 方法时有影响。 仅在 Web 模式下有效。

    method

    enableRetina

    Parameters

    • enabled: any

      Enable or disable retina display

    Returns void

getCanvasSize

  • getCanvasSize(): any
  • 返回视图中 canvas 的尺寸。 在 native 平台下,它返回全屏视图下屏幕的尺寸。 在 Web 平台下,它返回 canvas 元素尺寸。

    method

    getCanvasSize

    Returns any

getDesignResolutionSize

  • getDesignResolutionSize(): any
  • 返回视图的设计分辨率。 默认下分辨率尺寸同 getFrameSize 方法相同

    method

    getDesignResolutionSize

    Returns any

getDevicePixelRatio

  • getDevicePixelRatio(): number
  • 返回设备或浏览器像素比例。

    method

    getDevicePixelRatio

    Returns number

getFrameSize

  • getFrameSize(): any
  • 返回视图中边框尺寸。 在 native 平台下,它返回全屏视图下屏幕的尺寸。 在 web 平台下,它返回 canvas 元素的外层 DOM 元素尺寸。

    method

    getFrameSize

    Returns any

getResolutionPolicy

  • getResolutionPolicy(): any
  • 返回当前分辨率方案

    see

    ResolutionPolicy

    method

    getResolutionPolicy

    Returns any

getScaleX

  • getScaleX(): number
  • 返回横轴的缩放比,这个缩放比是将画布像素分辨率放到设计分辨率的比例。

    method

    getScaleX

    Returns number

getScaleY

  • getScaleY(): number
  • 返回纵轴的缩放比,这个缩放比是将画布像素分辨率缩放到设计分辨率的比例。

    method

    getScaleY

    Returns number

getScissorRect

  • getScissorRect(): Rect
  • 返回当前的 scissor 剪裁区域。

    method

    getScissorRect

    deprecated

    since v2.0

    Returns Rect

getViewportRect

  • getViewportRect(): Rect
  • 返回视窗剪裁区域。

    method

    getViewportRect

    Returns Rect

getVisibleOrigin

  • getVisibleOrigin(): any
  • 返回视图窗口可见区域原点。

    method

    getVisibleOrigin

    Returns any

getVisibleOriginInPixel

  • getVisibleOriginInPixel(): any
  • 返回视图窗口可见区域像素原点。

    method

    getVisibleOriginInPixel

    Returns any

getVisibleSize

  • getVisibleSize(): any
  • 返回视图窗口可见区域尺寸。

    method

    getVisibleSize

    Returns any

getVisibleSizeInPixel

  • getVisibleSizeInPixel(): any
  • 返回视图窗口可见区域像素尺寸。

    method

    getVisibleSizeInPixel

    Returns any

hasEventListener

  • hasEventListener(key: string, callback?: Function, target?: Object | null): boolean
  • 检查指定事件是否已注册回调。

    Parameters

    • key: string

      一个监听事件类型的字符串。

    • Optional callback: Function

      事件分派时将被调用的回调函数。

    • Default value target: Object | null = null

      调用回调的目标。

    Returns boolean

    • 指定事件是否已注册回调。

init

  • init(): void
  • Returns void

isAntiAliasEnabled

  • isAntiAliasEnabled(): boolean
  • 返回当前是否抗锯齿

    method

    isAntiAliasEnabled

    Returns boolean

isAutoFullScreenEnabled

  • isAutoFullScreenEnabled(): boolean
  • 检查自动进入全屏模式是否启动。 仅在 Web 模式下有效。

    method

    isAutoFullScreenEnabled

    Returns boolean

    Auto full screen enabled or not

isRetinaEnabled

  • isRetinaEnabled(): boolean
  • 检查是否对 Retina 显示设备进行优化。 仅在 Web 模式下有效。

    method

    isRetinaEnabled

    Returns boolean

isScissorEnabled

  • isScissorEnabled(): any
  • 检查 scissor 是否生效。

    method

    isScissorEnabled

    deprecated

    since v2.0

    Returns any

off

  • off(type: string, callback?: Function, target?: Object): void
  • 删除之前用同类型,回调,目标或 useCapture 注册的事件监听器,如果只传递 type,将会删除 type 类型的所有事件监听器。

    example
    // register fire eventListener
    var callback = eventTarget.on('fire', function () {
        cc.log("fire in the hole");
    }, target);
    // remove fire event listener
    eventTarget.off('fire', callback, target);
    // remove all fire event listeners
    eventTarget.off('fire');

    Parameters

    • type: string

      一个监听事件类型的字符串。

    • Optional callback: Function

      事件分派时将被调用的回调函数。

    • Optional target: Object

      调用回调的目标。如果为空, 只有没有目标的事件会被移除。

    Returns void

on

  • on(type: string, callback: Function, target?: Object): undefined | Function
  • 注册事件目标的特定事件类型回调。这种类型的事件应该被 emit 触发。

    example
    eventTarget.on('fire', function () {
        cc.log("fire in the hole");
    }, node);

    Parameters

    • type: string

      一个监听事件类型的字符串.

    • callback: Function

      事件分派时将被调用的回调函数。如果该回调存在则不会重复添加.

    • Optional target: Object

      回调的目标。可以为空。

    Returns undefined | Function

    • 返回监听回调函数自身。

once

  • once(type: string, callback: Function, target?: Object): undefined | Function
  • 注册事件目标的特定事件类型回调,回调会在第一时间被触发后删除自身。

    example
    eventTarget.once('fire', function () {
        cc.log("this is the callback and will be invoked only once");
    }, node);

    Parameters

    • type: string

      一个监听事件类型的字符串。

    • callback: Function

      事件分派时将被调用的回调函数。如果该回调存在则不会重复添加。

    • Optional target: Object

      调用回调的目标。可以为空。

    Returns undefined | Function

removeAll

  • removeAll(keyOrTarget?: string | Object): void
  • 移除在特定事件类型中注册的所有回调或在某个目标中注册的所有回调。

    Parameters

    • Optional keyOrTarget: string | Object

      要删除的事件键或要删除的目标。

    Returns void

resizeWithBrowserSize

  • resizeWithBrowserSize(enabled: any): void
  • 设置当发现浏览器的尺寸改变时,是否自动调整 canvas 尺寸大小。 仅在 Web 模式下有效。

    method

    resizeWithBrowserSize

    Parameters

    • enabled: any

      Whether enable automatic resize with browser's resize event

    Returns void

setCanvasSize

  • setCanvasSize(width: any, height: any): void
  • Parameters

    • width: any
    • height: any

    Returns void

setDesignResolutionSize

  • setDesignResolutionSize(width: any, height: any, resolutionPolicy: any): void
  • 通过设置设计分辨率和匹配模式来进行游戏画面的屏幕适配。

    method

    setDesignResolutionSize

    Parameters

    • width: any

      Design resolution width.

    • height: any

      Design resolution height.

    • resolutionPolicy: any

      The resolution policy desired

    Returns void

setFrameSize

  • setFrameSize(width: any, height: any): void
  • 在 native 平台下,设置视图框架尺寸。 在 web 平台下,设置 canvas 外层 DOM 元素尺寸。

    method

    setFrameSize

    Parameters

    • width: any
    • height: any

    Returns void

setOrientation

  • setOrientation(orientation: any): void
  • 设置游戏屏幕朝向,它能够是横版,竖版或自动。 当设置为横版或竖版,并且屏幕的宽高比例不匹配时, cc.view 会自动用 CSS 旋转游戏场景的 canvas, 这个方法不会对 native 部分产生任何影响,对于 native 而言,你需要在应用设置中的设置排版。

    method

    setOrientation

    Parameters

    • orientation: any

      Possible values: macro.ORIENTATION_LANDSCAPE | macro.ORIENTATION_PORTRAIT | macro.ORIENTATION_AUTO

    Returns void

setRealPixelResolution

  • setRealPixelResolution(width: any, height: any, resolutionPolicy: any): void
  • 设置容器(container)需要的像素分辨率并且适配相应分辨率的游戏内容。

    method

    setRealPixelResolution

    Parameters

    • width: any

      Design resolution width.

    • height: any

      Design resolution height.

    • resolutionPolicy: any

      The resolution policy desired

    Returns void

setResizeCallback

  • setResizeCallback(callback: any): void
  • 设置 cc.view 调整视窗尺寸行为的回调函数, 这个回调函数会在应用适配模式之前被调用, 因此你可以在这个回调函数内添加任意附加改变, 仅在 Web 平台下有效。

    method

    setResizeCallback

    Parameters

    • callback: any

      The callback function

    Returns void

setResolutionPolicy

  • setResolutionPolicy(resolutionPolicy: any): void
  • 设置当前分辨率模式

    see

    ResolutionPolicy

    method

    setResolutionPolicy

    Parameters

    • resolutionPolicy: any

    Returns void

setScissorInPoints

  • setScissorInPoints(x: any, y: any, w: any, h: any): void
  • 用设计分辨率下的点的尺寸来设置 scissor 剪裁区域。

    method

    setScissorInPoints

    deprecated

    since v2.0

    Parameters

    • x: any
    • y: any
    • w: any
    • h: any

    Returns void

setViewportInPoints

  • setViewportInPoints(x: any, y: any, w: any, h: any): void
  • 用设计分辨率下的点尺寸来设置视窗。

    method

    setViewportInPoints

    deprecated

    since v2.0

    Parameters

    • x: any
    • y: any
    • w: any

      width

    • h: any

      height

    Returns void

targetOff

  • targetOff(keyOrTarget?: string | Object): void
  • 在当前 EventTarget 上删除指定目标(target 参数)注册的所有事件监听器。 这个函数无法删除当前 EventTarget 的所有事件监听器,也无法删除 target 参数所注册的所有事件监听器。 这个函数只能删除 target 参数在当前 EventTarget 上注册的所有事件监听器。

    Parameters

    • Optional keyOrTarget: string | Object

    Returns void

Generated using TypeDoc