Test for 0022778: Bug in BRepMesh
[occt.git] / src / Graphic3d / Graphic3d_VertexNT.cdl
1 -- Created on: 1997-09-27
2 -- Created by: PCT
3 -- Copyright (c) 1997-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21 -- Modified:    03-02-98 : FMN ; Add Flag Normal
22
23 class VertexNT from Graphic3d inherits VertexN from Graphic3d
24
25         ---Version:
26
27         ---Purpose: This class allows the creation and update of
28         --          a vertex with a 3D normal and texture coordinate.
29
30         ---Keywords: Vertex, Normal, Coordinate, Point, Texture
31
32         ---Warning:
33         ---References:
34
35 uses
36
37         Vector  from Graphic3d,
38         Vertex  from Graphic3d
39
40 is
41
42         Create
43                 returns VertexNT from Graphic3d;
44         ---Level: Public
45         ---Purpose: Creates a point with 0.0, 0.0, 0.0 coordinates
46         --          for which the normal is 0.0, 0.0, 1.0.
47         --          texture coordinate is 0.0, 0.0.
48
49         Create ( AX, AY, AZ     : Real from Standard;
50                  ANX, ANY, ANZ  : Real from Standard;
51                  ATX            : Real from Standard;
52                  ATY            : Real from Standard = 0.0;
53                  FlagNormalise  : Boolean from Standard = Standard_True )
54                 returns VertexNT from Graphic3d;
55         ---Level: Public
56         ---Purpose: Creates a point with coordinates <AX>, <AY>, <AZ> and
57         --          for which the normal is <ANX>, <ANY>, <ANZ>,
58         --          texture coordinate is <ATX>, <ATY>.
59         --          If <FlagNormalise> is True the normal is already normalised
60         --          Else the normal is not normalised, the graphic do it.
61
62         Create ( APoint         : Vertex from Graphic3d;
63                  AVector        : Vector from Graphic3d;
64                  ATX            : Real from Standard;
65                  ATY            : Real from Standard = 0.0;
66                  FlagNormalise  : Boolean from Standard = Standard_True )
67                 returns VertexNT from Graphic3d;
68         ---Level: Public
69         ---Purpose: Creates a point in <APoint> for which the normal is <AVector>. 
70         --          <ATX>, <ATY> are texture coordinate.
71         --          If <FlagNormalise> is True the normal is already normalised
72         --          Else the normal is not normalised, the graphic do it.
73
74         ---------------------------------------------------
75         -- Category: Methods to modify the class definition
76         ---------------------------------------------------
77
78         SetTextureCoordinate( me        : in out;
79                               ATX       : Real from Standard;
80                               ATY       : Real from Standard = 0.0)
81                 is static;
82         ---Level: Public
83         ---Purpose: Modifies the texture coordinate to the point <me>.
84         ---Category: Methods to modify the class definition
85
86
87         ----------------------------
88         -- Category: Inquire methods
89         ----------------------------
90         
91         TextureCoordinate( me;
92                            ATX, ATY : out Real from Standard)
93                 is static;
94         ---Level: Public
95         ---Purpose: Returns the texture coordinate to the point <me>.
96         ---Category: Inquire methods
97
98 --\f
99
100 fields
101
102 --
103 -- Class        :       Graphic3d_VertexNT
104 --
105 -- Purpose      :       Declaration of variables specific to points.
106 --
107 -- Reminder     :       A point is defined by its coordinates and its normal.
108
109         -- the texel
110         MyTX, MyTY      :       Real from Standard;
111
112 end VertexNT;