Test for 0022778: Bug in BRepMesh
[occt.git] / src / Graphic3d / Graphic3d_Vertex.cdl
CommitLineData
b311480e 1-- Created by: NW,JPB,CAL
2-- Copyright (c) 1991-1999 Matra Datavision
3-- Copyright (c) 1999-2012 OPEN CASCADE SAS
7fd59977 4--
b311480e 5-- The content of this file is subject to the Open CASCADE Technology Public
6-- License Version 6.5 (the "License"). You may not use the content of this file
7-- except in compliance with the License. Please obtain a copy of the License
8-- at http://www.opencascade.org and read it completely before using this file.
7fd59977 9--
b311480e 10-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
7fd59977 12--
b311480e 13-- The Original Code and all software distributed under the License is
14-- distributed on an "AS IS" basis, without warranty of any kind, and the
15-- Initial Developer hereby disclaims all such warranties, including without
16-- limitation, any warranties of merchantability, fitness for a particular
17-- purpose or non-infringement. Please see the License for the specific terms
18-- and conditions governing the rights and limitations under the License.
19
7fd59977 20
21class Vertex from Graphic3d
22
23 ---Purpose: This class allows the creation and update of a
24 -- 3D point.
25
26 is
27
28 Create
29 returns Vertex from Graphic3d;
30 ---Level: Public
31 ---Purpose: Creates a point with 0.0, 0.0, 0.0 coordinates.
32
33 Create ( APoint : Vertex from Graphic3d )
34 returns Vertex from Graphic3d;
35 ---Level: Public
36 ---Purpose: Creates a point with coordinates identical to <APoint>.
37 --
38 -- It's just a copy, but this simplifies the management
39 -- of the constructors of VertexC, VertexN and VertexNC.
40
41 Create ( AX, AY ,AZ : Real from Standard )
42 returns Vertex from Graphic3d;
43 ---Level: Public
44 ---Purpose: Creates a point with <AX>, <AY> and <AZ> coordinates.
45
46 ---------------------------------------------------
47 -- Category: Methods to modify the class definition
48 ---------------------------------------------------
49
50 SetCoord ( me : in out;
51 Xnew, Ynew, Znew : Real from Standard )
52 is static;
53 ---Level: Public
54 ---Purpose: Modifies the coordinates of the point <me>.
55 ---Category: Methods to modify the class definition
56
57 SetXCoord ( me : in out;
58 Xnew : Real from Standard )
59 is static;
60 ---Level: Public
61 ---Purpose: Modifies the X coordinate of the point <me>.
62 ---Category: Methods to modify the class definition
63
64 SetYCoord ( me : in out;
65 Ynew : Real from Standard )
66 is static;
67 ---Level: Public
68 ---Purpose: Modifies the Y coordinate of the point <me>.
69 ---Category: Methods to modify the class definition
70
71 SetZCoord ( me : in out;
72 Znew : Real from Standard )
73 is static;
74 ---Level: Public
75 ---Purpose: Modifies the Z coordinate of the point <me>.
76 ---Category: Methods to modify the class definition
77
78 ----------------------------
79 -- Category: Inquire methods
80 ----------------------------
81
82 Coord ( me;
83 AX, AY, AZ : out Real from Standard )
84 is static;
85 ---Level: Public
86 ---Purpose: Returns the coordinates of the point <me>.
87 ---Category: Inquire methods
88
89 X ( me )
90 returns Real from Standard
91 is static;
92 ---Level: Public
93 ---Purpose: Returns the X coordinates of the point <me>.
94 ---Category: Inquire methods
95
96 Y ( me )
97 returns Real from Standard
98 is static;
99 ---Level: Public
100 ---Purpose: Returns the Y coordinate of the point <me>.
101 ---Category: Inquire methods
102
103 Z ( me )
104 returns Real from Standard
105 is static;
106 ---Level: Public
107 ---Purpose: Returns the Z coordinate of the point <me>.
108 ---Category: Inquire methods
109
110 --------------------------
111 -- Category: Class methods
112 --------------------------
113
114 Distance ( myclass;
115 AV1 : Vertex from Graphic3d;
116 AV2 : Vertex from Graphic3d )
117 returns Real from Standard;
118 ---Level: Public
119 ---Purpose: Returns the distance between <AV1> and <AV2>.
120 ---Category: Class methods
121
122--\f
123
124fields
125
126--
127-- Class : Graphic3d_Vertex
128--
129-- Purpose : Declaration of variables specific to points
130--
131-- Reminder : A point is defined by its coordinates
132--
133--
134
135 -- the coordinates of a point
136 MyX : ShortReal from Standard;
137 MyY : ShortReal from Standard;
138 MyZ : ShortReal from Standard;
139
140end Vertex;