0023024: Update headers of OCCT files
[occt.git] / src / AlienImage / AlienImage_AidaAlienData.cdl
1 -- Created on: 1993-03-23
2 -- Created by: BBL
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 class AidaAlienData from AlienImage inherits AlienImageData from AlienImage
23
24         ---Version: 0.0
25
26         ---Level: Public
27         ---Purpose: This class defines an Aida Alien image.
28
29
30 uses
31         File                    from OSD,
32         ColorImage              from Image,
33         PseudoColorImage        from Image,
34         ColorMap                from Aspect,
35         HArray2OfInteger        from TColStd,
36         DitheringMethod         from Image,
37         Image                   from Image
38
39 raises
40         OutOfRange      from Standard,
41         TypeMismatch    from Standard
42
43 is
44         Create returns mutable AidaAlienData from AlienImage ;
45
46         Clear( me : in out mutable ) ;
47         ---Level: Public
48         ---Purpose: Frees memory allocated by AidaAlienData
49         ---C++: alias ~
50
51         Read ( me : in out mutable ; afile : in out File from OSD )
52           returns Boolean from Standard ;
53         ---Level: Public
54           ---Purpose: Read content of a  AidaAlienData object from a file .
55           --          Returns True if file is a Aida file .
56
57         Write( me : in immutable; afile : in out File from OSD )
58           returns Boolean from Standard ;
59         ---Level: Public
60           ---Purpose: Write content of a  AidaAlienData object to a file .
61
62         ToImage( me : in  immutable) 
63           returns mutable Image from Image 
64           raises TypeMismatch from Standard ;
65           ---Purpose : Converts a AidaAlienData object to a Image object.
66
67         FromImage( me : in out mutable ; anImage : in Image from Image )
68           raises TypeMismatch from Standard ;
69           ---Purpose : Converts a Image object to a AidaAlienData object.
70
71         SetColorImageDitheringMethod( me : in out mutable ; 
72                                       aMethod : DitheringMethod from Image;
73                                       aColorMap : ColorMap from Aspect ) ;
74
75         ---Level: Public
76           ---Purpose: Set the ImageDitheringMethod and the ColorMap when
77           --          FromImage is called with a ColorImage .
78           --          Aida BYTEMAPS file handle only PseudoColorImage .
79           --          Default value is DM_NearestColor,
80           --            ColorCubeColorMap( 40, 5,1, 8,6, 3,54 )
81
82
83         AllocData( me : in out mutable ; DX,DY : in Integer from Standard ) 
84                 is private;
85         ---Level: Internal
86            ---Purpose : Allocate HArray2 to store Image data
87
88         Pixel   ( me : in immutable ;     X,Y : in Integer from Standard ) 
89                         returns Integer from Standard
90                         raises OutOfRange from Standard is private ;
91         ---Level: Internal
92
93         SetPixel( me : in out mutable; X,Y   : in Integer from Standard ;
94                         Value : in Integer from Standard )
95                         raises OutOfRange from Standard is private ;
96         ---Level: Internal
97
98         FromPseudoColorImage( me      : in out mutable; 
99                               anImage : in PseudoColorImage from Image )
100                 is private ;
101         ---Level: Internal
102           ---Purpose : convert a Image object to a AidaAlienData object.
103
104         FromColorImage( me : in out mutable;
105                         anImage : in ColorImage from Image)
106                 is private ;
107         ---Level: Internal
108           ---Purpose : convert a Image object to a AidaAlienData object.
109
110 fields
111         myDitheringMethod   : DitheringMethod from Image is protected ;
112
113         myDitheringColorMap : ColorMap from Aspect  is protected ;
114
115         myColors : ColorMap from Aspect  is protected ;
116         myColorsIsDef : Boolean from Standard  is protected ;
117
118                         -- AidaColors definition
119         myData   : HArray2OfInteger from TColStd ;
120         myDataIsDef : Boolean from Standard  is protected ;
121
122 end ;
123