Constructor # new module:Scene(containeropt, optionsopt) Scene constructor Parameters: Name Type Attributes Default Description container HTMLElement <optional> document.body Container of the renderer options SceneOptions <optional> Specific options Source: modules/scene/scene.js, line 18 Extends module:OffscreenCanvas Members # (static) defaultOptions :SceneOptions Type: SceneOptions Source: modules/scene/scene.js, line 186 # (static) events :SceneEvents Type: SceneEvents Source: modules/scene/scene.js, line 201 # containerPosition :Position Type: Position Source: modules/scene/scene.js, line 46 # cursorPosition :Position Type: Position Source: modules/scene/scene.js, line 42 # fps :Number Type: Number Source: modules/scene/scene.js, line 62 # isClicked :Boolean Type: Boolean Source: modules/scene/scene.js, line 58 # isLooped :Boolean Type: Boolean Source: modules/scene/scene.js, line 54 # isScene :Boolean Type: Boolean Source: modules/scene/scene.js, line 50 # lastTick :Number Type: Number Source: modules/scene/scene.js, line 66 Methods # (static) from(definition) → {Scene} Parameters: Name Type Description definition Object Scene definition Source: modules/scene/scene.js, line 157 Returns: Type Scene # (static) getDrawingContext(container) Build a canvas and set it to fill the entire document.body Parameters: Name Type Description container HTMLElement Element holding the canvas Source: modules/scene/scene.js, line 166 # hide() → {Scene} Source: modules/scene/scene.js, line 138 Returns: Itself Type Scene # isHover() → {Boolean} Define if is hovered Source: modules/scene/scene.js, line 110 Returns: Type Boolean # render() → {Scene} Draw the whole scene Overrides: module:OffscreenCanvas#render Source: modules/scene/scene.js, line 85 Returns: Itself Type Scene # setCursor(cursoropt) → {Scene} Parameters: Name Type Attributes Default Description cursor String <optional> Component.cursors.default Cursor string Source: modules/scene/scene.js, line 76 Returns: Itself Type Scene # show() → {Scene} Source: modules/scene/scene.js, line 147 Returns: Itself Type Scene # startLoop() → {Scene} Start to render the scene each frame Source: modules/scene/scene.js, line 118 Returns: Itself Type Scene # stopLoop() → {Scene} Stop scene from being rendered Source: modules/scene/scene.js, line 128 Returns: Itself Type Scene Type Definitions # SceneEvents Type: Object Properties Name Type Description change String Source: modules/scene/scene.js, line 193 # SceneOptions Type: Object Properties Name Type Attributes Default Description cursor String <optional> Component.cursors.defaultOptions Cursor on hover Source: modules/scene/scene.js, line 178