topical media & game development
[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

talk show tell print

mobile-graphic-easel-src-easeljs-display-Shadow.js / js



  /*
  * Shadow
  * Visit http://createjs.com/ for documentation, updates and examples.
  *
  * Copyright (c) 2010 gskinner.com, inc.
  * 
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
  * files (the "Software"), to deal in the Software without
  * restriction, including without limitation the rights to use,
  * copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the
  * Software is furnished to do so, subject to the following
  * conditions:
  * 
  * The above copyright notice and this permission notice shall be
  * included in all copies or substantial portions of the Software.
  * 
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  * OTHER DEALINGS IN THE SOFTWARE.
  */
  
  // namespace:
  this.createjs = this.createjs||{};
  
  (function() {
This class encapsulates the properties required to define a shadow to apply to a {{#crossLink "DisplayObject"}}{{/crossLink}} via it's <code>shadow</code> property. <h4>Example</h4> myImage.shadow = new createjs.Shadow("#000000", 5, 5, 10); @class Shadow @constructor
parameter: {String} color The color of the shadow.
parameter: {Number} offsetX The x offset of the shadow in pixels.
parameter: {Number} offsetY The y offset of the shadow in pixels.
parameter: {Number} blur The size of the blurring effect. 

  
  var Shadow = function(color, offsetX, offsetY, blur) {
    this.initialize(color, offsetX, offsetY, blur);
  }
  var p = Shadow.prototype;
          
  // static public properties:
An identity shadow object (all properties are set to 0). Read-only. @property identity @type Shadow @static @final 

  
          Shadow.identity = null; // set at bottom of class definition.
          
  // public properties:
The color of the shadow. property color @type String @default null 

  
          p.color = null;
The x offset of the shadow. property offsetX @type Number @default 0 

  
          p.offsetX = 0;
The y offset of the shadow. property offsetY @type Number @default 0 

  
          p.offsetY = 0;
The blur of the shadow. property blur @type Number @default 0 

  
          p.blur = 0;
          
  // constructor:
Initialization method. @method initialize @protected
parameter: {String} color The color of the shadow.
parameter: {Number} offsetX The x offset of the shadow.
parameter: {Number} offsetY The y offset of the shadow.
parameter: {Number} blur The size of the blurring effect. 

  
          p.initialize = function(color, offsetX, offsetY, blur) {
                  this.color = color;
                  this.offsetX = offsetX;
                  this.offsetY = offsetY;
                  this.blur = blur;
          }
          
  // public methods:
Returns a string representation of this object. @method toString
returns: {String} a string representation of the instance. 

  
          p.toString = function() {
                  return "[Shadow]";
          }
Returns a clone of this Shadow instance. @method clone
returns: {Shadow} A clone of the current Shadow instance. 

  
          p.clone = function() {
                  return new Shadow(this.color, this.offsetX, this.offsetY, this.blur);
          }
          
          // this has to be populated after the class is defined:
          Shadow.identity = new Shadow("transparent", 0, 0, 0);
          
  createjs.Shadow = Shadow;
  }());
[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

(C) Æliens 04/09/2009

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.