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

322 lines (298 loc) • 23.5 kB

HTML

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">src/component/Transform.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/Transform.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">import Component from './Component'; import Point from '../internal/Point'; /** * A component all GameObjects are given by default on instantiation. * * Transform components are unique to the object, meaning there cannot be more than * one Transform on a GameObject. * * Transforms keep track of GameObject position, scale (size), rotation, and * origin offset. These should be changes with their respective setters, and not directly, * to ensure the correct components are notified of these changes. * * TODO: Make rotation work on 3 axis like position and scale. * TODO: Change the updates and setters of the position/scale/rotation to use funcions in their base * definitions and remove the wrappers here to reduce code. */ export default class Transform extends Component { constructor(position = new Point(0, 0, 0), scale = new Point(1, 1, 1), rotation = 0) { super(true); this.className='Transform'; this._position = position; this._rotation = rotation; this._scale = scale; this._originOffset = new Point(0, 0, 0); this.renderable = null; } /** * Sets the Transforms position. * * @param {number} x X position. Defaults to current X position. * @param {number} y Y position. Defaults to current Y position. * @param {number} z Z position. Defaults to current Z position. */ setPosition(x = this._position.x, y = this._position.y, z = this._position.z) { this._position.set(x, y, z); if (this.renderable != null) { this.renderable.setPosition(this._position); } } /** * Triggers between two types of regularly used origin points. * * Origin points are used with Renderables and other components to offset the origin different from the Transform's position. * * "Center": (-0.5, -0.5, -0.5) centered to the Tranform's position, and "Default": (0, 0, 0), beginning at the top left of the Transform. * * @param {boolean} center "Center" if true, "Default" if false. */ centerOrigin(center = true) { if (center) { this.setOriginOffset(-0.5, -0.5, -0.5); } else { this.setOriginOffset(0, 0, 0); } } /** * Sets the origin offset position. * * If you want an object to exist at a * position, but do something else (like drawing, animations) * in a relative position the the Tranform, use this to change the * offset from the Transfrom. * * (0, 0, 0) would be top left of the transform. * (-0.5, -0.5, -0.5) would be center of the transform. * (-1, -1, -1) would be bottom right of transform. * * Parameters default to their current values. * * @param {number} x X axis offset. Defaults to current origin offset X. * @param {number} y Y axis offset. Defaults to current origin offset Y. * @param {number} z Z axis offset. Defaults to current origin offset Z. */ setOriginOffset(x = this._originOffset.x, y = this._originOffset.y, z = this._originOffset.z) { this._originOffset.set(x, y, z); if (this.renderable != null) { this.renderable.setOriginOffset(this._originOffset); } } /** * Rotates the transform to face a different direction. * * TODO: implement more than z axis rotation. * * @param {number} rotation Rotation around the Z axis (in degrees). */ setRotation(rotation) { this._rotation = rotation; if (this.renderable != null) { this.renderable.setRotation(this._rotation); } } /** * * @param {number} scaleX X scale from 1. Defaults to current scale X. * @param {number} scaleY Y scale from 1. Defaults to current scale Y. * @param {number} scaleZ Z scale from 1. Defaults to current scale Z. */ setScale(scaleX = this.scaleX, scaleY = this.scaleY, scaleZ = this.scaleZ) { this._scale.set(scaleX, scaleY, scaleZ); if (this.renderable != null) { this.renderable.setScale(this._scale); } } /** * Adds the parameters of this function to the Transforms position. * * @param {number} x X position. Defaults to 0. * @param {number} y Y position. Defaults to 0. * @param {number} z Z position. Defaults to 0. */ translate(x = 0, y = 0, z = 0) { this._position.x += x; this._position.y += y; this._position.z += z; if (this.renderable != null) { this.renderable.setPosition(this._position); } } flipX() { this._scale.x = -this._scale.x; if (this.renderable != null) { this.renderable.setScale(this._scale); } } flipY() { this._scale.y = -this._scale.y; if (this.renderable != null) { this.renderable.setScale(this._scale); } } /** * Adds the rotation parameter to the current Transform rotation. * * @param {number} rotation Rotation to add. */ rotate(rotation) { this._rotation += rotation; if (this.renderable != null) { this.renderable.setRotation(this._rotation); } } /** * Adds the parameters of this function to the Transforms scale. * * @param {number} scaleX X scale. Defaults to 0. * @param {number} scaleY Y scale. Defaults to 0. * @param {number} scaleZ Z scale. Defaults to 0. */ scale(scaleX = 0, scaleY = 0, scaleZ = 0) { this._scale.x += scaleX; this._scale.y += scaleY; this._scale.z += scaleZ; if (this.renderable != null) { this.renderable.setScale(this._scale); } } /** * @returns {Point} The transform's position. */ getPosition() { return Point.copy(this._position); } /** * @returns {Point} The transform's scale. */ getScale() { return Point.copy(this._scale); } /** * @returns {number} The transform's rotation. */ getRotation() { return this._rotation; } /** * @returns {Point} The transform's origin offset. */ getOriginOffset() { return Point.copy(this._originOffset); } }</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>