Files
OCCT/src/Geom2d/Geom2d_Vector.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

101 lines
3.0 KiB
Plaintext
Executable File

-- Created on: 1993-03-24
-- Created by: JCV
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
deferred class Vector from Geom2d inherits Geometry from Geom2d
--- Purpose : The abstract class Vector describes the common
-- behavior of vectors in 2D space.
-- The Geom2d package provides two concrete
-- classes of vectors: Geom2d_Direction (unit vector)
-- and Geom2d_VectorWithMagnitude.
uses Ax2d from gp,
Pnt2d from gp,
Vec2d from gp
raises DomainError from Standard,
VectorWithNullMagnitude from gp
is
Reverse (me : mutable);
--- Purpose : Reverses the vector <me>.
Reversed (me) returns mutable like me
--- Purpose : Returns a copy of <me> reversed.
is static;
Angle (me; Other : Vector) returns Real
--- Purpose : Computes the angular value, in radians, between this
-- vector and vector Other. The result is a value
-- between -Pi and Pi. The orientation is from this
-- vector to vector Other.
-- Raises VectorWithNullMagnitude if one of the two vectors is a vector with
-- null magnitude because the angular value is indefinite.
raises VectorWithNullMagnitude;
Coord (me; X, Y : out Real);
--- Purpose : Returns the coordinates of <me>.
Magnitude (me) returns Real
--- Purpose : Returns the Magnitude of <me>.
is deferred;
SquareMagnitude (me) returns Real
--- Purpose : Returns the square magnitude of <me>.
is deferred;
X (me) returns Real;
--- Purpose : Returns the X coordinate of <me>.
Y (me) returns Real;
--- Purpose : Returns the Y coordinate of <me>.
Crossed (me; Other : Vector) returns Real
--- Purpose : Cross product of <me> with the vector <Other>.
is deferred;
Dot (me; Other : Vector) returns Real;
--- Purpose : Returns the scalar product of 2 Vectors.
Vec2d (me) returns Vec2d;
--- Purpose : Returns a non persistent copy of <me>.
fields
gpVec2d : Vec2d is protected;
end;