rsence-pre 2.1.0.1.pre

data/js/foundation/geom/point/point.js

@@ -0,0 +1,202 @@
+/*   RSence
+ *   Copyright 2006 Riassence Inc.
+ *   http://riassence.com/
+ *
+ *   You should have received a copy of the GNU General Public License along
+ *   with this software package. If not, contact licensing@riassence.com
+ */
+
+/*** = Description
+  ** Point objects represent points on a two-dimensional coordinate grid. The
+  ** object's coordinates are stored as public x and y data members.
+  **
+  ** = Instance Variables
+  ** +type+::  '[HPoint]'
+  ** +x+::     The X coordinate of the point
+  ** +y+::     The Y coordinate of the point
+  **
+  ***/
+var//RSence.Foundation.Geom
+HPoint = HClass.extend({
+
+/** = Description
+  * Creates a new Point object that corresponds to the point (x, y), or that's
+  * copied from point. If no coordinate values are assigned, the Point's
+  * location is indeterminate.
+  *
+  * = Parameters
+  * by using a HPoint instance:
+  * +point+::  Another +HPoint+ or other compatible structure.
+  *
+  * by using separate numeric coordinates:
+  * +x+::  x coordinate
+  * +y+::  y coordinate
+  *
+  * = Usage
+  *  var myPoint = new HPoint(100,200);
+  *  var mySameCoordPoint = new HPoint( myPoint );
+  *
+  **/
+  constructor: function() {
+    this.type = '[HPoint]';
+    var _args=arguments;
+    
+    if (_args.length === 0) {
+      this._constructorDefault();
+    }
+    else if (_args.length === 2) {
+      this._constructorValues(_args[0],_args[1]);
+    }
+    else if (_args.length === 1) {
+      this._constructorPoint(_args[0]);
+    }
+    else {
+      throw "Invalid number of arguments.";
+    }
+
+  },
+  _constructorDefault: function() {
+    this.x = null;
+    this.y = null;
+  },
+  _constructorValues: function(x, y) {
+    this.x = x;
+    this.y = y;
+  },
+  _constructorPoint: function(_point) {
+    this.x = _point.x;
+    this.y = _point.y;
+  },
+  
+/** = Description
+  * Sets the Point's x and y coordinates.
+  *
+  * = Parameters
+  * +x+::  The new X coordinate of the point
+  * +y+::  The new Y coordinate of the point
+  *
+  **/
+  set: function() {
+    var _args=arguments;
+    
+    if (_args.length === 0) {
+      this._constructorDefault();
+    }
+    else if (_args.length === 2) {
+      this._constructorValues(_args[0],_args[1]);
+    }
+    else if (_args.length === 1) {
+      this._constructorPoint(_args[0]);
+    }
+    else {
+      throw "Invalid number of arguments.";
+    }
+  },
+  
+/** = Description
+  * Ensures that the Point lies within rect. If it's already contained in the
+  * rectangle, the Point is unchanged; otherwise, it's moved to the rect's
+  * nearest edge.
+  *
+  * = Parameters
+  * +_rect+::   A HRect instance to constrain to.
+  *
+  **/
+  constrainTo: function(_rect) {
+    
+    if (this.x < _rect.left) {
+        this.x = _rect.left;
+    }
+    if (this.y < _rect.top) {
+      this.y = _rect.top;
+    }
+    if (this.x > _rect.right) {
+      this.x = _rect.right;
+    }
+    if (this.y > _rect.bottom) {
+      this.y = _rect.bottom;
+    }
+    
+  },
+  
+/** = Description
+  * Creates and returns a new Point that adds the given Point and this Point
+  * together. The new object's x coordinate is the sum of the operands' x
+  * values; its y value is the sum of the operands' y values.
+  *
+  * = Parameters 
+  * with HPoint:
+  * +_point+::  An HPoint to add to.
+  *
+  * with coordinates:
+  * +_x+::  An X-coordinate to add to.
+  * +_y+::  An Y-coordinate to add to.
+  *
+  * = Returns
+  * A new HPoint.
+  *
+  **/
+  add: function(_point) {
+    _args = arguments;
+    if((_args.length===1)&&(_args[0].type===this.type)){
+      _point = _args[0];
+      return new HPoint( (this.x + _point.x), (this.y + _point.y) );
+    }
+    else if(_args.length===2){
+      return new HPoint( (this.x + _args[0]), (this.y + _args[1]) );
+    } else {
+      return new HPoint( 0, 0 );
+    }
+  },
+  
+  
+/** = Description
+  * Creates and returns a new Point that subtracts the given Point from this
+  * Point. The new object's x coordinate is the difference between the
+  * operands' x values; its y value is the difference between the operands'
+  * y values.
+  *
+  * = Parameters 
+  *
+  * with HPoint:
+  * +_point+:: An HPoint to subtract from.
+  *
+  * with coordinates:
+  * +_x+::  An X-coordinate to subtract from.
+  * +_y+::  An Y-coordinate to subtract from.
+  *
+  * = Returns
+  * A new HPoint.
+  *
+  **/
+  subtract: function(){
+    _args = arguments;
+    if((_args.length===1)&&(_args[0].type===this.type)){
+      _point = _args[0];
+      return new HPoint( this.x-_point.x, this.y-_point.y );
+    }
+    else if(_args.length===2){
+      return new HPoint( this.x-_args[0], this.y-_args[1] );
+    } else {
+      return new HPoint( 0, 0 );
+    }
+  },
+  
+  
+/** = Description
+  * Returns true if the two objects' point exactly coincide.
+  *
+  * = Parameter
+  * +_point+::  A HPoint to compare to.
+  *
+  * = Returns
+  * The result; true or false.
+  *
+  **/
+  equals: function(_point) {
+    return ( this.x === _point.x && this.y === _point.y );
+  }
+  
+});
+
+