SarEngine2D

Document

SarEngine2D Scene

Scene

场景，是承载和维护各种游戏对象和相互作用的一个空间，具有一个主坐标系，并且可以通过设置图层在场景中使用不同的坐标系。

Syntax

//from global
var scene = new Scene();
//from SarEngine
var scene = new SarEngine.Scene();

Classes

Physics
应用于场景中的各种全局物理量的类。
BackgroundCollection
维护场景中的背景集合类。
LayerCollection
维护场景中的图层集合类。

Properties

background
Scene.BackgroundCollection 场景中的背景的集合。
cameraList
Array 场景中的摄像机的集合。
collideGroups
Array 场景中的碰撞组的集合。该集合内有两个特殊的碰撞组，defaultGroup和ignoreGroup。
device
Device 用户输入设备。包含鼠标、键盘和触屏上的触点的状态。
doubleClickDelay
Number 用户触发双击事件的两次点击的时间间隔。
engine
SarEngine 拥有该场景的引擎。
eventSource
HTMLElement 用于捕获作为场景中各种输入事件的底层HTMLElement元素。
GUI
GUI 用户图形界面。
layers
Scene.LayerCollection 维护场景内的所有图层的集合。
objectList
Array 在该场景内的所有GameObject的集合。
physics
Scene.Physics 该场景内的全局物理量。例如全局阻力、重力加速度等。
runtime
Number 场景的运行事件，从引擎启动时开始计时，单位为ms。

Methods

addBackground(background, zIndex)
将指定的背景添加到场景中，并设置为指定的z序。
addCamera(camera)
将指定的摄像机添加到该场景中。
addCollideGroup(group)
将指定的碰撞组添加到该场景中。
addGameObject(obj, layer, colliderGroup)
将指定的游戏对象添加到该场景中，可以指定其图层和碰撞组。
addLayer(layer, depth)
将指定的图层添加到该场景中，并处于指定的层次深度，depth的取值可以是0以外的任意整数，depth低的图层将被优先渲染，即depth高的图层将覆盖在depth低的图层之上。
initEvent(output)
在指定的输出接口初始化用户输入事件的捕获。
physicalSimulate(dt)
通过指定模拟时长进行场景内的物理模拟计算。
removeBackground(background)
将指定的背景从场景中移除。
removeCamera(camera)
将指定的摄像机从场景中移除。
removeGameObject(id)
从场景中移除指定ID的游戏对象。
removeLayer(depth)
从场景中移除指定层次的图层。
render(dt)
以指定的曝光时间渲染该场景。
reset()
重置该场景，调用此函数将清空场景中的一切，包括游戏对象、图层、背景和碰撞组等。
updateFrame(delay)
游戏帧更新，由内部调用。

Events

onClick
在场景受到用户点击时触发。
onEndRender
在场景结束所有渲染时触发。
onKeyDown
在用户键盘按下时触发。
onKeyPress
在用户按下并释放一个键盘按键时触发。
onKeyUp
在用户释放键盘按键时触发。
onMouseDown
在鼠标按下时触发。
onMouseMove
在鼠标移动时触发。
onMouseOut
在鼠标离开场景时触发。
onMouseUp
在鼠标按键释放时触发。
onMouseWheel
在鼠标滚轮滚动时触发。
onRender
在场景开始渲染时触发。
onTouchEnd
在用户释放一个触点时触发。
onTouchMove
在用户触摸屏上一个触点移动时触发。
onTouchStart
在用户触摸到触屏时触发。
onUpdate
在场景开始更新游戏帧时触发。