Source: Renderables/FontRenderable.js

  1. /*
  2.  * File: FontRenderable.js 
  3.  */
  5. /*jslint node: true, vars: true */
  6. /*global gEngine: false, Transform: false, SpriteRenderable: false */
  7. /* find out more about jslint: http://www.jslint.com/help.html */
  9. // Constructor and object definition
  10. "use strict";  // Operate in Strict mode such that variables must be declared before used!
  12. /**
  13.  * Default Constructor.<p>
  14.  * Default Constructor creates an instance of FontRenderable.
  15.  * @class FontRenderable
  16.  * @param {String} aString - text to display
  17.  * @returns {FontRenderable} a new instance of FontRenderable.
  18.  */
  19. function FontRenderable(aString) {
  20.     this.mFont = gEngine.DefaultResources.getDefaultFont();
  21.     this.mOneChar = new SpriteRenderable(this.mFont + ".png");
  22.     this.mXform = new Transform(); // transform that moves this object around
  23.     this.mText = aString;
  24. }
  26. //<editor-fold desc="Public Methods">
  27. //**-----------------------------------------
  28. // Public methods
  29. //**-----------------------------------------
  30. /**
  31.  * Draws the FontRenderable to the screen in the aCamera viewport.
  32.  * @memberOf FontRenderable
  33.  * @param {Camera} aCamera - Camera object to draw to.
  34.  * @returns {void}
  35.  */
  36. FontRenderable.prototype.draw = function (aCamera) {
  37.     // we will draw the text string by calling to mOneChar for each of the
  38.     // chars in the mText string.
  39.     var widthOfOneChar = this.mXform.getWidth() / this.mText.length;
  40.     var heightOfOneChar = this.mXform.getHeight();
  41.     // this.mOneChar.getXform().setRotationInRad(this.mXform.getRotationInRad());
  42.     var yPos = this.mXform.getYPos();
  44.     // center position of the first char
  45.     var xPos = this.mXform.getXPos() - (widthOfOneChar / 2) + (widthOfOneChar * 0.5);
  46.     var charIndex, aChar, charInfo, xSize, ySize, xOffset, yOffset;
  47.     for (charIndex = 0; charIndex < this.mText.length; charIndex++) {
  48.         aChar = this.mText.charCodeAt(charIndex);
  49.         charInfo = gEngine.Fonts.getCharInfo(this.mFont, aChar);
  51.         // set the texture coordinate
  52.         this.mOneChar.setElementUVCoordinate(charInfo.mTexCoordLeft, charInfo.mTexCoordRight,
  53.             charInfo.mTexCoordBottom, charInfo.mTexCoordTop);
  55.         // now the size of the char
  56.         xSize = widthOfOneChar * charInfo.mCharWidth;
  57.         ySize = heightOfOneChar * charInfo.mCharHeight;
  58.         this.mOneChar.getXform().setSize(xSize, ySize);
  60.         // how much to offset from the center
  61.         xOffset = widthOfOneChar * charInfo.mCharWidthOffset * 0.5;
  62.         yOffset = heightOfOneChar * charInfo.mCharHeightOffset * 0.5;
  64.         this.mOneChar.getXform().setPosition(xPos - xOffset, yPos - yOffset);
  65.         // allows for zPos to affect FontRenderables
  66.         this.mOneChar.getXform().setZPos(this.mXform.getZPos());
  67.         this.mOneChar.draw(aCamera);
  69.         xPos += widthOfOneChar;
  70.     }
  71. };
  73. /**
  74.  * Returns the Renderable's Transform.
  75.  * @memberOf FontRenderable
  76.  * @returns {Transform} the return of the Renderable.
  77.  */
  78. FontRenderable.prototype.getXform = function () { return this.mXform; };
  80. /**
  81.  * Returns the text of the FontRenderable.
  82.  * @memberOf FontRenderable
  83.  * @returns {String} text of the FontRenderable.
  84.  */
  85. FontRenderable.prototype.getText = function () { return this.mText; };
  87. /**
  88.  * Set the text of the FontRenderable.
  89.  * @memberOf FontRenderable
  90.  * @param {String} t - text to set to the FontRenderable.
  91.  * @returns {void}
  92.  */
  93. FontRenderable.prototype.setText = function (t) {
  94.     this.mText = t;
  95.     this.setTextHeight(this.getXform().getHeight());
  96. };
  98. /**
  99.  * Set the Text Height of the FontRenderable.
  100.  * @memberOf FontRenderable
  101.  * @param {float} h - height of the Renderable.
  102.  * @returns {void}
  103.  */
  104. FontRenderable.prototype.setTextHeight = function (h) {
  105.     var charInfo = gEngine.Fonts.getCharInfo(this.mFont, "A".charCodeAt(0)); // this is for "A"
  106.     var w = h * charInfo.mCharAspectRatio;
  107.     this.getXform().setSize(w * this.mText.length, h);
  108. };
  110. /**
  111.  * Get the size of a symbol in the FontRenderable
  112.  * @memberof FontRenderable
  113.  * @returns {vec2} The size of one symbol
  114.  */
  115. FontRenderable.prototype.getSymbolSize = function() {
  116.   var size = this.getXform().getSize();
  117.   return vec2.fromValues(size[0] / this.mText.length, size[1]);
  118. };
  120. FontRenderable.prototype.getWidth = function() {
  121.   var size = this.getXform().getSize();
  122.   return size[0];
  123. };
  125. /**
  126.  * Returns the FontRenderable's Font
  127.  * @memberOf FontRenderable
  128.  * @returns {String} the Font of the FontRenderable.
  129.  */
  130. FontRenderable.prototype.getFont = function () { return this.mFont; };
  132. /**
  133.  * Sets the Font of the FontRenderable.
  134.  * @memberOf FontRenderable
  135.  * @param {Font} f - font of the FontRenderable.
  136.  * @returns {void}
  137.  */
  138. FontRenderable.prototype.setFont = function (f) {
  139.     this.mFont = f;
  140.     this.mOneChar.setTexture(this.mFont + ".png");
  141. };
  143. /**
  144.  * Sets the Color of the FontRenderable.
  145.  * @memberOf FontRenderable
  146.  * @param {float[]} color The desired Color of the FontRenderable.
  147.  * @returns {void}
  148.  */
  149. FontRenderable.prototype.setColor = function (c) { this.mOneChar.setColor(c); };
  151. /**
  152.  * Gets the Color of the FontRenderable.
  153.  * @memberOf FontRenderable
  154.  * @returns {float[]} The color of the FontRenderable.
  155.  */
  156. FontRenderable.prototype.getColor = function () { return this.mOneChar.getColor(); };
  158. /**
  159.  * Update function called on Gameloop
  160.  * @memberOf FontRenderable
  161.  * @returns {void}
  162.  */
  163. FontRenderable.prototype.update = function () {};
  165. //--- end of Public Methods
  166. //</editor-fold>