Integration of OCCT 6.5.0 from SVN

src/Geom2d/Geom2d_VectorWithMagnitude.cdl

@@ -0,0 +1,152 @@
+-- File:	Geom2d_VectorWithMagnitude.cdl
+-- Created:	Wed Mar 24 18:36:20 1993
+-- Author:	JCV
+--		<fid@sdsun2>
+-- Copyright:	 Matra Datavision 1993
+
+---Copyright:   Matra Datavision 1991
+
+
+
+class VectorWithMagnitude from Geom2d inherits Vector from Geom2d
+
+        --- Purpose :
+        --  Defines a vector with magnitude.
+        --  A vector with magnitude can have a zero length.
+
+uses Pnt2d     from gp,
+     Trsf2d    from gp,
+     Vec2d     from gp,
+     Geometry  from Geom2d
+
+raises ConstructionError from Standard
+
+is
+
+
+  Create (V : Vec2d) returns mutable VectorWithMagnitude;
+        --- Purpose : Creates a persistent copy of V.
+
+
+  Create (X, Y : Real)   returns mutable VectorWithMagnitude;
+        --- Purpose : Creates a vector with two cartesian coordinates. 
+
+
+  Create (P1, P2 : Pnt2d)   returns mutable VectorWithMagnitude;
+        --- Purpose :
+        --  Creates a vector from the point P1 to the point P2.
+        --  The magnitude of the vector is the distance between P1 and P2
+
+
+
+  SetCoord (me : mutable; X, Y : Real);
+        --- Purpose :  Set <me> to X, Y coordinates.
+
+
+  SetVec2d (me : mutable; V : Vec2d);
+        -- Purpose : Set <me> to V.X(), V.Y() coordinates.
+
+
+  SetX (me : mutable; X : Real);
+        --- Purpose : Changes the X coordinate of <me>.
+
+
+  SetY (me : mutable; Y : Real);
+        --- Purpose :  Changes the Y coordinate of <me>
+
+
+  Magnitude (me)  returns Real;
+        --- Purpose : Returns the magnitude of <me>.
+
+
+  SquareMagnitude (me)  returns Real;
+        --- Purpose : Returns the square magnitude of <me>.
+
+
+  Add (me : mutable; Other : Vector);
+        --- Purpose :
+        --  Adds the Vector Other to <me>.
+        ---C++: alias operator +=
+
+
+  Added (me; Other : Vector)  returns mutable VectorWithMagnitude
+        --- Purpose :
+        --  Adds the vector Other to <me>.
+        ---C++: alias operator +
+     is static;
+
+
+  Crossed (me; Other : Vector)  returns Real;
+        --- Purpose :
+        --  Computes the cross product  between <me> and Other 
+        --  <me> ^ Other. A new vector is returned.
+        ---C++: alias operator ^
+
+
+  Divide (me : mutable; Scalar : Real);
+        --- Purpose : Divides <me> by a scalar.
+        ---C++: alias operator /=
+
+
+  Divided (me; Scalar : Real)  returns mutable VectorWithMagnitude
+        --- Purpose :
+        --  Divides <me> by a scalar. A new vector is returned.
+        ---C++: alias operator /
+     is static;
+
+
+  Multiplied (me; Scalar : Real)  returns mutable VectorWithMagnitude
+        --- Purpose :
+        --  Computes the product of the vector <me> by a scalar.
+        --  A new vector is returned.
+        --  
+        --  -C++: alias operator * 
+        --  Collision with same operator defined for the class Vector!
+     is static;
+
+
+  Multiply (me : mutable; Scalar : Real);
+        --- Purpose : 
+        --  Computes the product of the vector <me> by a scalar.
+        ---C++: alias operator *=
+
+
+  Normalize (me : mutable)
+        --- Purpose : Normalizes <me>.
+     raises ConstructionError;
+        --- Purpose : 
+        --  Raised if the magnitude of the vector is lower or equal to
+        --  Resolution from package gp.
+
+
+  Normalized (me)  returns mutable VectorWithMagnitude
+        --- Purpose : Returns a copy of <me> Normalized.
+     raises ConstructionError
+        --- Purpose :
+        --  Raised if the magnitude of the vector is lower or equal to
+        --  Resolution from package gp.
+     is static;
+
+
+  Subtract (me : mutable; Other : Vector);
+        --- Purpose : Subtracts the Vector Other to <me>.
+        ---C++: alias operator -=
+
+
+  Subtracted (me; Other : Vector)  returns mutable VectorWithMagnitude
+        --- Purpose :
+        --  Subtracts the vector Other to <me>. A new vector is returned.
+        ---C++: alias operator -
+     is static;
+
+
+
+  Transform (me: mutable; T : Trsf2d);
+    	---Purpose: Applies the transformation T to this vector.
+
+
+  Copy (me)  returns mutable like me;
+    	--- Purpose: Creates a new object which is a copy of this vector.    
+end;
+
+