0023024: Update headers of OCCT files
[occt.git] / src / Aspect / Aspect_ColorPixel.cdl
1 -- Created on: 1993-07-23
2 -- Created by: Jean Louis FRENKEL
3 -- Copyright (c) 1993-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
22
23 class ColorPixel from Aspect inherits Pixel from Aspect
24
25 uses
26     Color   from Quantity
27 is
28
29     Create returns ColorPixel from Aspect;
30         ---Level: Public
31
32     Create(aColor: Color from Quantity) returns ColorPixel from Aspect;
33         ---Level: Public
34
35     Value (me) returns Color from Quantity is static ;
36         ---Level: Public
37            ---C++: return const &
38
39     SetValue(me: in out; aColor: Color from Quantity) is static ;
40         ---Level: Public
41
42     Print( me ; s : in out OStream from Standard ) is redefined static ;
43         ---Level: Public
44         ---Purpose : Prints the contents of <me> on the stream <s>
45
46     HashCode (me; Upper : Integer ) returns Integer is redefined static ;
47         ---Level: Public
48         ---Purpose: Returns a hashed value denoting <me>. This value is in
49         --         the range 1..<Upper>.
50         ---C++:  function call
51
52         IsEqual(me; Other : ColorPixel from Aspect) returns Boolean;
53             ---C++: alias operator==
54
55         IsNotEqual(me; Other : ColorPixel from Aspect) returns Boolean;
56            ---C++: alias operator!=
57
58
59
60 fields
61     myColor: Color from Quantity;
62
63 end ColorPixel from Aspect;