seed-engine

Version:

A Lightweight 2D game engine using WebGL2. The engine is designed on the focus of creating a bridge between creating and publishing games to the Seed Network as modules.

github.com/JaegarSarauer/SeedGameEngine

JaegarSarauer/SeedGameEngine

311 lines (279 loc) • 23.3 kB

HTML

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">src/component/Renderable.js | seed-engine</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> <meta name="description" content="A Lightweight 2D game engine using WebGL2. The engine is designed on the focus of creating a bridge between creating and publishing games to the Seed Network as modules."><meta property="twitter:card" content="summary"><meta property="twitter:title" content="seed-engine"><meta property="twitter:description" content="A Lightweight 2D game engine using WebGL2. The engine is designed on the focus of creating a bridge between creating and publishing games to the Seed Network as modules."></head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <a href="test.html" data-ice="testLink">Test</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> <a style="position:relative; top:3px;" href="https://github.com/JaegarSarauer/SeedGameEngine"><img width="20px" src="./image/github.png"></a></header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc">C<a href="class/src/Engine.js~_Engine.html">_Engine</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-Engine">Engine</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#base">base</a>C<a href="class/src/base/Updateable.js~Updateable.html">Updateable</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#component">component</a>C<a href="class/src/component/Animation.js~Animation.html">Animation</a></li> <li data-ice="doc">C<a href="class/src/component/Audio.js~Audio.html">Audio</a></li> <li data-ice="doc">C<a href="class/src/component/BoxCollider.js~BoxCollider.html">BoxCollider</a></li> <li data-ice="doc">C<a href="class/src/component/CircleCollider.js~CircleCollider.html">CircleCollider</a></li> <li data-ice="doc">C<a href="class/src/component/ClickController.js~ClickController.html">ClickController</a></li> <li data-ice="doc">C<a href="class/src/component/Collider.js~Collider.html">Collider</a></li> <li data-ice="doc">C<a href="class/src/component/Collider2D.js~Collider2D.html">Collider2D</a></li> <li data-ice="doc">C<a href="class/src/component/Component.js~Component.html">Component</a></li> <li data-ice="doc">C<a href="class/src/component/Controller.js~Controller.html">Controller</a></li> <li data-ice="doc">C<a href="class/src/component/Physics.js~Physics.html">Physics</a></li> <li data-ice="doc">C<a href="class/src/component/Physics2D.js~Physics2D.html">Physics2D</a></li> <li data-ice="doc">C<a href="class/src/component/Renderable.js~Renderable.html">Renderable</a></li> <li data-ice="doc">C<a href="class/src/component/Renderable2D.js~Renderable2D.html">Renderable2D</a></li> <li data-ice="doc">C<a href="class/src/component/Renderable2DGrid.js~Renderable2DGrid.html">Renderable2DGrid</a></li> <li data-ice="doc">C<a href="class/src/component/Renderable2DMultitex.js~Renderable2DMultitex.html">Renderable2DMultitex</a></li> <li data-ice="doc">C<a href="class/src/component/RenderableSquare.js~RenderableSquare.html">RenderableSquare</a></li> <li data-ice="doc">C<a href="class/src/component/RenderableText.js~RenderableText.html">RenderableText</a></li> <li data-ice="doc">C<a href="class/src/component/TopDownController.js~TopDownController.html">TopDownController</a></li> <li data-ice="doc">C<a href="class/src/component/Transform.js~Transform.html">Transform</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#const">const</a>V<a href="variable/index.html#static-variable-DEFAULT_F">DEFAULT_F</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-TILEMAP_F">TILEMAP_F</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-KeyCode">KeyCode</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-DEFAULT_V">DEFAULT_V</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#internal">internal</a>C<a href="class/src/internal/Bounds.js~Bounds.html">Bounds</a></li> <li data-ice="doc">C<a href="class/src/internal/Color.js~Color.html">Color</a></li> <li data-ice="doc">C<a href="class/src/internal/Point.js~Point.html">Point</a></li> <li data-ice="doc">C<a href="class/src/internal/PostBoard.js~PostBoard.html">PostBoard</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#manager">manager</a>C<a href="class/src/manager/AudioManager.js~_AudioManager.html">_AudioManager</a></li> <li data-ice="doc">C<a href="class/src/manager/DOMManager.js~_DOMManager.html">_DOMManager</a></li> <li data-ice="doc">C<a href="class/src/manager/EngineManager.js~_EngineManager.html">_EngineManager</a></li> <li data-ice="doc">C<a href="class/src/manager/InputManager.js~_InputManager.html">_InputManager</a></li> <li data-ice="doc">C<a href="class/src/manager/Manager.js~Manager.html">Manager</a></li> <li data-ice="doc">C<a href="class/src/manager/PersistentManager.js~_PersistentManager.html">_PersistentManager</a></li> <li data-ice="doc">C<a href="class/src/manager/PhysicsManager.js~_PhysicsManager.html">_PhysicsManager</a></li> <li data-ice="doc">C<a href="class/src/manager/ProgramManager.js~_ProgramManager.html">_ProgramManager</a></li> <li data-ice="doc">C<a href="class/src/manager/RenderManager.js~_RenderManager.html">_RenderManager</a></li> <li data-ice="doc">C<a href="class/src/manager/SceneManager.js~_SceneManager.html">_SceneManager</a></li> <li data-ice="doc">C<a href="class/src/manager/TextureManager.js~_TextureManager.html">_TextureManager</a></li> <li data-ice="doc">C<a href="class/src/manager/UIManager.js~_UIManager.html">_UIManager</a></li> <li data-ice="doc">C<a href="class/src/manager/UpdateableManager.js~_UpdateableManager.html">_UpdateableManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-AudioManager">AudioManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-DOMManager">DOMManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-EngineManager">EngineManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-InputManager">InputManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-PersistentManager">PersistentManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-PhysicsManager">PhysicsManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-ProgramManager">ProgramManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-RenderManager">RenderManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-SceneManager">SceneManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-TextureManager">TextureManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-UIManager">UIManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-UpdateableManager">UpdateableManager</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#object">object</a>C<a href="class/src/object/GameObject.js~GameObject.html">GameObject</a></li> <li data-ice="doc">C<a href="class/src/object/PersistentObject.js~PersistentObject.html">PersistentObject</a></li> <li data-ice="doc">C<a href="class/src/object/SceneObject.js~SceneObject.html">SceneObject</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#prefab-ui">prefab/ui</a>C<a href="class/src/prefab/ui/UIButton.js~UIButton.html">UIButton</a></li> <li data-ice="doc">C<a href="class/src/prefab/ui/UIElement.js~UIElement.html">UIElement</a></li> <li data-ice="doc">C<a href="class/src/prefab/ui/UIPanel.js~UIPanel.html">UIPanel</a></li> <li data-ice="doc">C<a href="class/src/prefab/ui/UIText.js~UIText.html">UIText</a></li> <li data-ice="doc">C<a href="class/src/prefab/ui/UITextInput.js~UITextInput.html">UITextInput</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#render">render</a>C<a href="class/src/render/Viewport.js~Viewport.html">Viewport</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#render-webgl">render/WebGL</a>C<a href="class/src/render/WebGL/Matrix.js~Matrix.html">Matrix</a></li> <li data-ice="doc">C<a href="class/src/render/WebGL/Matrix3.js~Matrix3.html">Matrix3</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#scene">scene</a>C<a href="class/src/scene/BasicScene.js~BasicScene.html">BasicScene</a></li> <li data-ice="doc">C<a href="class/src/scene/Scene.js~Scene.html">Scene</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#utils">utils</a>C<a href="class/src/utils/Loader.js~Loader.html">Loader</a></li> <li data-ice="doc">C<a href="class/src/utils/Messager.js~Messager.html">Messager</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-degToRad">degToRad</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-radToDeg">radToDeg</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">src/component/Renderable.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">import Component from './Component'; import SceneManager from '../manager/SceneManager'; import RenderManager from '../manager/RenderManager'; import ProgramManager from '../manager/ProgramManager'; import Matrix3 from '../render/WebGL/Matrix3'; import Color from '../internal/Color'; const DepthRange = 10000000; /** * Base Renderable Component for all Components that want to draw to the screen. If * you want to show something on screen, it should derive Renderable. * * Contained in the class are functions for attaching the Renderable to viewports, * and updating Transform data into matricies for use with the Render Manager. * * The Renderable Component contains data on how the Renderable expects to be rendered. * Programs, render vectors, shader data, and other data that is on a per-object basis * for rendering is defined here. * * Classes which derive a Renderable should handle all base data and add or modify data * as needed to achieve certain effects. */ export default class Renderable extends Component { /** * Constructor for the Renderable component. Allows defaults to be assigned without * having to call setter functions later. * * @param {Program} program A Program Object from the ProgramManager. */ constructor(program = ProgramManager.getProgram('Default')) { super(true); this.deregisterViewports = {}; //currently unused this.program = program; this._matrixPosition = new Matrix3(); this._matrixScale = new Matrix3(); this._matrixRotation = new Matrix3(); this._matrixOriginOffset = new Matrix3(); this.color = new Color(); this.renderPositions = [0, 0, 1, 0, 0, 1, 0, 1, 1, 0, 1, 1]; this.primitiveType = RenderManager.GL.TRIANGLES; this.primitiveCount = 6; //textures this.textures = []; this._subSpriteData = [0, 0, 1, 1]; this.depth = 0.5; } requestRedraw() { RenderManager.forceUpdate(); } setColor(r, g, b, a) { this.color.set(r, g, b, a); this.requestRedraw(); } setDepth(depth) { this.depth = (Math.max(-DepthRange, Math.min(depth, DepthRange)) + DepthRange) / (DepthRange * 2); this.requestRedraw(); } setSubIndex(spriteIndex) { if (this.textures.length < 1) return; let framesWidth = this.textures[0].frameWidth / this.textures[0].width; let framesHeight = this.textures[0].frameHeight / this.textures[0].height; let frameWidthIndex = spriteIndex % (1 / framesWidth); let frameHeightIndex = Math.floor(spriteIndex * framesWidth); this._subSpriteData = [-frameWidthIndex, -frameHeightIndex, framesWidth, framesHeight]; this.requestRedraw(); } setUniformData(positionMatrix) { this.program.setUniforms({ 'u_color': this.color.color, 'u_matrix': positionMatrix, 'u_depth': this.depth, 'u_texture': 0, 'u_subTexcoord': this._subSpriteData, }); return true; } setTexture(textureObject) { this.textures[0] = textureObject; this.requestRedraw(); } /** * Returns a joined matrix of position, scale, rotation and origin adjustment. */ getMatrix() { return Matrix3.copy(this._matrixPosition).multiply(this._matrixRotation).multiply(this._matrixScale).multiply(this._matrixOriginOffset); } /** * Sets the position matrix to the new position point assigned. * * @param {Point} point A position point. */ setPosition(point) { this._matrixPosition.setPosition(point.x, point.y); //point.z if we had 3D to override this this.requestRedraw(); } /** * Sets the origin offset matrix to the new position point assigned. This matrix reacts differently from other matrix * assignment. 0,0 is regular top left corner origin, -0.5, -0.5 centers the origin to the center of the Transform, and * -1, -1 will align the origin to the bottom right. * * @param {Point} point Origin offset point. */ setOriginOffset(point) { this._matrixOriginOffset.setPosition(point.x, point.y); //point.z if we had 3D to override this } /** * Sets the rotation matrix to the new rotation value assigned. * * TODO: Change to a rotation point for x, y, z rotation instead of just z. * * @param {number} rotation A rotation in degrees. */ setRotation(rotation) { this._matrixRotation.setRotation(rotation); this.requestRedraw(); } /** * Sets the scale matrix to the new scale point assigned. * * @param {Point} scale A scale point. */ setScale(scale) { this._matrixScale.setScale(scale.x, scale.y); this.requestRedraw(); } /** * Called immediatly after the Render component is added to a game object. * * Updates the data of this renderable to the current Transform data. */ onAddComponent() { let transform = this.gameObject.getComponent("Transform"); transform.renderable = this; this.setPosition(transform._position); this.setScale(transform._scale); this.setRotation(transform._rotation); this.requestRedraw(); } /** * Adds this component to another viewport to be drawn. * * @param {number} viewportID Object ID of the viewport. */ addToViewport(viewportID) { this.deregisterViewports[viewportID] = SceneManager.getCurrentScene().registerRenderableComponent(this, viewportID); this.requestRedraw(); return this; } /** * Removes the renderable from all viewports. */ removeFromViewports() { let objKeys = Object.keys(this.deregisterViewports); for (let i = 0; i < objKeys.length; i++) { this.deregisterViewports[objKeys[i]](); } this.requestRedraw(); } onEnd() { this.removeFromViewports(); } }</code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(1.1.0)<img src="./image/esdoc-logo-mini-black.png"></a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>