Test for 0022778: Bug in BRepMesh
[occt.git] / src / Graphic3d / Graphic3d_VertexNC.cdl
1 -- Created by: NW,JPB,CAL
2 -- Copyright (c) 1991-1999 Matra Datavision
3 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
4 --
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.
9 --
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.
12 --
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
20 -- Modified:    03-02-98 : FMN ; Add Flag Normal
21
22 class VertexNC from Graphic3d inherits VertexN from Graphic3d
23
24         ---Version:
25
26         ---Purpose: This class allows the creation of a vertex with
27         --          a colour and a 3D normal.
28
29         ---Keywords: Vertex, Normal, Color, Coordinate, Point
30
31         ---Warning:
32         ---References:
33
34 uses
35
36         Color   from Quantity,
37
38         Vector  from Graphic3d,
39         Vertex  from Graphic3d
40
41 is
42
43         Create
44                 returns VertexNC from Graphic3d;
45         ---Level: Public
46         ---Purpose: Creates a point with coordinates 0.0, 0.0, 0.0
47         --          for which the normal is 0.0, 0.0, 1.0 and
48         --          the colour is Quantity_NOC_WHITE.
49
50         Create ( AX, AY, AZ     : Real from Standard;
51                  ANX, ANY, ANZ  : Real from Standard;
52                  AColor         : Color from Quantity;
53                  FlagNormalise  : Boolean from Standard = Standard_True )
54                 returns VertexNC from Graphic3d;
55         ---Level: Public
56         ---Purpose: Creates a point with coordinates <AX>, <AY>, <AZ>
57         --          for which the normal is <ANX>, <ANY>, <ANZ> and
58         --          the colour is <AColor>.
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                  AColor         : Color from Quantity;
65                  FlagNormalise  : Boolean from Standard = Standard_True )
66                 returns VertexNC from Graphic3d;
67         ---Level: Public
68         ---Purpose: Creates a point in <APoint> for which the normal
69         --          is <AVector> and the colour is <AColor>.
70         --          If <FlagNormalise> is True the normal is already normalised
71         --          Else the normal is not normalised, the graphic do it.
72
73         ---------------------------------------------------
74         -- Category: Methods to modify the class definition
75         ---------------------------------------------------
76
77         SetColor ( me           : in out;
78                    ColorNew     : Color from Quantity )
79                 is static;
80         ---Level: Public
81         ---Purpose: Modifies the colour of the point <me>.
82         ---Category: Methods to modify the class definition
83
84         ----------------------------
85         -- Category: Inquire methods
86         ----------------------------
87
88         Color ( me )
89                 returns Color from Quantity
90                 is static;
91         ---Level: Public
92         ---Purpose: Returns the colour of the point <me>.
93         ---Category: Inquire methods
94
95 --\f
96
97 fields
98
99 --
100 -- Class        :       Graphic3d_VertexNC
101 --
102 -- Purpose      :       Declaration of variables specific to points
103 --
104 -- Reminder     :       A point is defined by its coordinates, its normal
105 --                      and its colour.
106
107         -- the colour
108         MyColor         :       Color from Quantity;
109
110 end VertexNC;