1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-06 10:36:12 +03:00
occt/src/Geom2d/Geom2d_Direction.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

110 lines
3.5 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.
class Direction from Geom2d inherits Vector from Geom2d
--- Purpose :
-- The class Direction specifies a vector that is never null.
-- It is a unit vector.
uses Dir2d from gp,
Pnt2d from gp,
Trsf2d from gp,
Vec2d from gp,
Geometry from Geom2d
raises ConstructionError from Standard
is
Create (X, Y :Real) returns mutable Direction
--- Purpose : Creates a unit vector with it 2 cartesian coordinates.
raises ConstructionError;
--- Purpose :
-- Raised if Sqrt( X*X + Y*Y) <= Resolution from gp.
Create (V : Dir2d) returns mutable Direction;
--- Purpose : Creates a persistent copy of <me>.
SetCoord (me : mutable; X, Y : Real)
--- Purpose : Assigns the coordinates X and Y to this unit vector,
-- then normalizes it.
-- Exceptions
-- Standard_ConstructionError if Sqrt(X*X +
-- Y*Y) is less than or equal to gp::Resolution().
raises ConstructionError;
SetDir2d (me : mutable; V : Dir2d);
--- Purpose : Converts the gp_Dir2d unit vector V into this unit vector.
SetX (me : mutable; X : Real)
--- Purpose :
-- Assigns a value to the X coordinate of this unit vector, then normalizes it.
-- Exceptions
-- Standard_ConstructionError if the value assigned
-- causes the magnitude of the vector to become less
-- than or equal to gp::Resolution().
raises ConstructionError;
SetY (me : mutable; Y : Real)
--- Purpose : Assigns a value to the Y coordinate of this unit vector, then normalizes it.
-- Exceptions
-- Standard_ConstructionError if the value assigned
-- causes the magnitude of the vector to become less
-- than or equal to gp::Resolution().
raises ConstructionError;
Dir2d (me) returns Dir2d;
--- Purpose : Converts this unit vector into a gp_Dir2d unit vector.
Magnitude (me) returns Real;
--- Purpose : returns 1.0
SquareMagnitude (me) returns Real;
--- Purpose : returns 1.0
Crossed (me; Other : Vector) returns Real;
--- Purpose : Computes the cross product between <me> and <Other>.
---C++: alias operator ^
Transform (me : mutable; T : Trsf2d);
---Purpose: Applies the transformation T to this unit vector, then normalizes it.
Copy (me) returns mutable like me;
---Purpose: Creates a new object which is a copy of this unit vector.
end;