View 类型

继承于 EventTarget

模块: _decorator 父模块: cc

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();
  

索引

方法

• setTargetDensityDPI 设置目标内容的每英寸像素点密度。
• getTargetDensityDPI 获取目标内容的每英寸像素点密度。
• resizeWithBrowserSize 设置当发现浏览器的尺寸改变时，是否自动调整 canvas 尺寸大小。
• setResizeCallback 仅在 Web 平台下有效。
• setOrientation 设置游戏屏幕朝向，它能够是横版，竖版或自动。
• adjustViewportMeta 设置引擎是否调整 viewport meta 来配合屏幕适配。
• enableRetina 它仅会在你调用 setDesignResolutionPolicy 方法时有影响。
• isRetinaEnabled 检查是否对 Retina 显示设备进行优化。
• enableAntiAlias 控制抗锯齿是否开启
• isAntiAliasEnabled 返回当前是否抗锯齿
• enableAutoFullScreen 启动时，移动端游戏会在移动端自动尝试进入全屏模式。
• isAutoFullScreenEnabled 检查自动进入全屏模式是否启动。
• getCanvasSize 返回视图中 canvas 的尺寸。
• getFrameSize 返回视图中边框尺寸。
• setFrameSize 在 native 平台下，设置视图框架尺寸。
• getVisibleSize 返回视图窗口可见区域尺寸。
• getVisibleSizeInPixel 返回视图窗口可见区域像素尺寸。
• getVisibleOrigin 返回视图窗口可见区域原点。
• getVisibleOriginInPixel 返回视图窗口可见区域像素原点。
• getResolutionPolicy 返回当前分辨率方案
• setResolutionPolicy 设置当前分辨率模式
• setDesignResolutionSize 通过设置设计分辨率和匹配模式来进行游戏画面的屏幕适配。
• getDesignResolutionSize 返回视图的设计分辨率。
• setRealPixelResolution 设置容器（container）需要的像素分辨率并且适配相应分辨率的游戏内容。
• setViewportInPoints 用设计分辨率下的点尺寸来设置视窗。
• setScissorInPoints 用设计分辨率下的点的尺寸来设置 scissor 剪裁区域。
• isScissorEnabled 检查 scissor 是否生效。
• getScissorRect 返回当前的 scissor 剪裁区域。
• getViewportRect 返回视窗剪裁区域。
• getScaleX 返回横轴的缩放比，这个缩放比是将画布像素分辨率放到设计分辨率的比例。
• getScaleY 返回纵轴的缩放比，这个缩放比是将画布像素分辨率缩放到设计分辨率的比例。
• getDevicePixelRatio 返回设备或浏览器像素比例。
• convertToLocationInView 将屏幕坐标转换为游戏视图下的坐标。
• hasEventListener 检查事件目标对象是否有为特定类型的事件注册的回调。
• on 注册事件目标的特定事件类型回调。
• off 删除之前用同类型，回调，目标或 useCapture 注册的事件监听器，如果只传递 type，将会删除 type 类型的所有事件监听器。
• targetOff 在当前 EventTarget 上删除指定目标（target 参数）注册的所有事件监听器。
• once 注册事件目标的特定事件类型回调，回调会在第一时间被触发后删除自身。
• emit 通过事件名发送自定义事件
• dispatchEvent 通过事件对象派发事件

事件

• design-resolution-changed 当设计分辨率改变时发送。
• canvas-resize 当画布大小改变时发送。

Details

方法

setTargetDensityDPI

设置目标内容的每英寸像素点密度。

参数列表

• densityDPI String

getTargetDensityDPI

获取目标内容的每英寸像素点密度。

resizeWithBrowserSize

设置当发现浏览器的尺寸改变时，是否自动调整 canvas 尺寸大小。 仅在 Web 模式下有效。

参数列表

• enabled Boolean Whether enable automatic resize with browser's resize event

setResizeCallback

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

参数列表

• callback Function | Null The callback function

setOrientation

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

参数列表

• orientation Number Possible values: cc.macro.ORIENTATION_LANDSCAPE | cc.macro.ORIENTATION_PORTRAIT | cc.macro.ORIENTATION_AUTO

adjustViewportMeta

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

参数列表

• enabled Boolean Enable automatic modification to "viewport" meta

enableRetina

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

参数列表

• enabled Boolean Enable or disable retina display

isRetinaEnabled

检查是否对 Retina 显示设备进行优化。 仅在 Web 模式下有效。

enableAntiAlias

控制抗锯齿是否开启

参数列表

• enabled Boolean Enable or not anti-alias

isAntiAliasEnabled

返回当前是否抗锯齿

enableAutoFullScreen

启动时，移动端游戏会在移动端自动尝试进入全屏模式。 你能够传入 true 为参数去启动它，用 false 参数来关闭它。

参数列表

• enabled Boolean Enable or disable auto full screen on mobile devices

isAutoFullScreenEnabled

检查自动进入全屏模式是否启动。 仅在 Web 模式下有效。

getCanvasSize

返回视图中 canvas 的尺寸。 在 native 平台下，它返回全屏视图下屏幕的尺寸。 在 Web 平台下，它返回 canvas 元素尺寸。

getFrameSize

返回视图中边框尺寸。 在 native 平台下，它返回全屏视图下屏幕的尺寸。 在 web 平台下，它返回 canvas 元素的外层 DOM 元素尺寸。

setFrameSize

在 native 平台下，设置视图框架尺寸。 在 web 平台下，设置 canvas 外层 DOM 元素尺寸。

参数列表

• width Number
• height Number

getVisibleSize

返回视图窗口可见区域尺寸。

getVisibleSizeInPixel

返回视图窗口可见区域像素尺寸。

getVisibleOrigin

返回视图窗口可见区域原点。

getVisibleOriginInPixel

返回视图窗口可见区域像素原点。

getResolutionPolicy

返回当前分辨率方案

setResolutionPolicy

设置当前分辨率模式

参数列表

• resolutionPolicy ResolutionPolicy | Number

setDesignResolutionSize

通过设置设计分辨率和匹配模式来进行游戏画面的屏幕适配。

参数列表

• width Number Design resolution width.
• height Number Design resolution height.
• resolutionPolicy ResolutionPolicy | Number The resolution policy desired

getDesignResolutionSize

返回视图的设计分辨率。 默认下分辨率尺寸同 getFrameSize 方法相同

setRealPixelResolution

设置容器（container）需要的像素分辨率并且适配相应分辨率的游戏内容。

参数列表

• width Number Design resolution width.
• height Number Design resolution height.
• resolutionPolicy ResolutionPolicy | Number The resolution policy desired

setViewportInPoints

用设计分辨率下的点尺寸来设置视窗。

参数列表

• x Number
• y Number
• w Number width
• h Number height

setScissorInPoints

用设计分辨率下的点的尺寸来设置 scissor 剪裁区域。

参数列表

• x Number
• y Number
• w Number
• h Number

isScissorEnabled

检查 scissor 是否生效。

getScissorRect

返回当前的 scissor 剪裁区域。

getViewportRect

返回视窗剪裁区域。

getScaleX

返回横轴的缩放比，这个缩放比是将画布像素分辨率放到设计分辨率的比例。

getScaleY

返回纵轴的缩放比，这个缩放比是将画布像素分辨率缩放到设计分辨率的比例。

getDevicePixelRatio

返回设备或浏览器像素比例。

convertToLocationInView

将屏幕坐标转换为游戏视图下的坐标。

参数列表

• tx Number The X axis translation
• ty Number The Y axis translation
• relatedPos Object The related position object including "left", "top", "width", "height" informations

hasEventListener

检查事件目标对象是否有为特定类型的事件注册的回调。

参数列表

• type String The type of event.

on

注册事件目标的特定事件类型回调。这种类型的事件应该被 emit 触发。

参数列表

• type String A string representing the event type to listen for.
• callback Function The callback that will be invoked when the event is dispatched.

                         The callback is ignored if it is a duplicate (the callbacks are unique).
  

  • arg1 Any arg1
  • arg2 Any arg2
  • arg3 Any arg3
  • arg4 Any arg4
  • arg5 Any arg5
• target Object The target (this object) to invoke the callback, can be null

示例

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

off

删除之前用同类型，回调，目标或 useCapture 注册的事件监听器，如果只传递 type，将会删除 type 类型的所有事件监听器。

参数列表

• type String A string representing the event type being removed.
• callback Function The callback to remove.
• target Object The target (this object) to invoke the callback, if it's not given, only callback without target will be removed

示例

// 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');

targetOff

在当前 EventTarget 上删除指定目标（target 参数）注册的所有事件监听器。 这个函数无法删除当前 EventTarget 的所有事件监听器，也无法删除 target 参数所注册的所有事件监听器。 这个函数只能删除 target 参数在当前 EventTarget 上注册的所有事件监听器。

参数列表

• target Object The target to be searched for all related listeners

once

注册事件目标的特定事件类型回调，回调会在第一时间被触发后删除自身。

参数列表

• type String A string representing the event type to listen for.
• callback Function The callback that will be invoked when the event is dispatched.

                         The callback is ignored if it is a duplicate (the callbacks are unique).
  

  • arg1 Any arg1
  • arg2 Any arg2
  • arg3 Any arg3
  • arg4 Any arg4
  • arg5 Any arg5
• target Object The target (this object) to invoke the callback, can be null

示例

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

emit

通过事件名发送自定义事件

参数列表

• type String event type
• arg1 Any First argument
• arg2 Any Second argument
• arg3 Any Third argument
• arg4 Any Fourth argument
• arg5 Any Fifth argument

示例

eventTarget.emit('fire', event);
eventTarget.emit('fire', message, emitter);

dispatchEvent

通过事件对象派发事件

参数列表

• event Event

事件

design-resolution-changed Event

模块: _decorator 父模块: cc

!en Emit when design resolution changed. !zh 当设计分辨率改变时发送。

索引

Details

canvas-resize Event

模块: _decorator 父模块: cc

!en Emit when canvas resize. !zh 当画布大小改变时发送。

索引

Details