1 -- Created on: 1993-03-24
3 -- Copyright (c) 1993-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
6 -- This file is part of Open CASCADE Technology software library.
8 -- This library is free software; you can redistribute it and/or modify it under
9 -- the terms of the GNU Lesser General Public License version 2.1 as published
10 -- by the Free Software Foundation, with special exception defined in the file
11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 -- distribution for complete text of the license and disclaimer of any warranty.
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
17 class AxisPlacement from Geom2d inherits Geometry from Geom2d
20 --- Purpose : Describes an axis in 2D space.
21 -- An axis is defined by:
22 -- - its origin, also termed the "Location point" of the axis,
23 -- - its unit vector, termed the "Direction" of the axis.
24 -- Note: Geom2d_AxisPlacement axes provide the
25 -- same kind of "geometric" services as gp_Ax2d axes
26 -- but have more complex data structures. The
27 -- geometric objects provided by the Geom2d package
28 -- use gp_Ax2d objects to include axes in their data
29 -- structures, or to define an axis of symmetry or axis of rotation.
30 -- Geom2d_AxisPlacement axes are used in a context
31 -- where they can be shared by several objects
32 -- contained inside a common data structure.
43 Create (A : Ax2d) returns AxisPlacement;
44 --- Purpose : Constructs an axis by conversion of the gp_Ax2d axis A.
47 Create (P : Pnt2d; V : Dir2d) returns AxisPlacement;
48 --- Purpose : Constructs an axis from a given origin P and unit vector V.
51 Reverse (me : mutable);
53 Reversed (me) returns AxisPlacement is static;
54 ---Purpose: Reverses the unit vector of this axis.
56 -- - Reverse assigns the result to this axis, while
57 -- - Reversed creates a new one.
59 SetAxis (me : mutable; A : Ax2d);
60 --- Purpose : Changes the complete definition of the axis placement.
63 SetDirection (me : mutable; V : Dir2d);
65 -- Changes the "Direction" of the axis placement.
69 SetLocation (me : mutable; P : Pnt2d);
71 -- Changes the "Location" point (origin) of the axis placement.
74 Angle (me; Other : AxisPlacement) returns Real;
76 -- Computes the angle between the "Direction" of
77 -- two axis placement in radians.
78 -- The result is comprised between -Pi and Pi.
80 Ax2d (me) returns Ax2d;
81 --- Purpose : Converts this axis into a gp_Ax2d axis.
84 Direction (me) returns Dir2d;
85 --- Purpose : Returns the "Direction" of <me>.
86 -- -C++: return const&
89 Location (me) returns Pnt2d;
91 -- Returns the "Location" point (origin) of the axis placement.
92 -- -C++: return const&
97 Transform (me : mutable; T : Trsf2d);
99 ---Purpose: Applies the transformation T to this axis.
102 Copy (me) returns like me;
104 ---Purpose: Creates a new object which is a copy of this axis.