0023486: Remove obsolete image manipulation classes
[occt.git] / src / AlienImage / AlienImage.cdl
1 -- Created on: 1993-07-27
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 package AlienImage
23
24         ---Purpose: This package allows importation of images 
25         --          from some other format into CAS.CADE format.
26
27 uses
28     Image,
29     TColStd,
30     TCollection,
31     Aspect,
32     OSD,
33     MMgt
34
35 is
36
37         ------------------------
38         ---Category: The classes
39         ------------------------
40
41         deferred class AlienImage;
42         ---Purpose: Define the general methods on AlienImage
43
44         deferred class AlienImageData  ;
45         ---Purpose: Internal Definition of  AlienImage.
46
47         deferred class AlienUserImage  ;
48         ---Purpose: Public Definition of  AlienImage.
49     
50 --      class PSAlienImage;
51         ---Purpose: Definition of PostScript AlienImage.
52
53         class SunRFAlienData;
54         ---Purpose: Private definition of Sun Raster File .rs AlienImage.
55
56         class SunRFAlienImage;
57         ---Purpose: Public definition of Sun Raster File .rs AlienImage.
58
59         class EuclidAlienData;
60         ---Purpose: Private definition of Euclid .pix AlienImage.
61
62         class EuclidAlienImage;
63         ---Purpose: Public definition of Euclid .pix AlienImage.
64
65         class SGIRGBAlienData;
66         ---Purpose: Private definition of SGI .rgb AlienImage.
67
68         class SGIRGBAlienImage;
69         ---Purpose: Public definition of SGI .rgb AlienImage.
70
71         class X11XWDAlienData;
72         ---Purpose: Private definition X11 .xwd AlienImage .
73         
74         class XAlienImage;
75         ---Purpose: Public definition X11 .xwd AlienImage.
76        
77         class AidaAlienData;
78         ---Purpose: Private definition of Aida .i AlienImage .
79         
80         class AidaAlienImage;
81         ---Purpose: Public definition of Aida .i AlienImage.
82        
83         class MemoryOperations;
84         ---Purpose: A set of function to swap byte in memory, used for
85         --          comaptibility between LSBFirst and MSBFirst .
86
87
88
89
90         private class BMPAlienData;
91         ---Purpose: Private definition of windows .bmp AlienImage.
92
93         private class GIFAlienData;
94         ---Purpose: Private definition of windows .gif AlienImage.
95
96         class BMPAlienImage;
97         ---Purpose: Public definition of windows .bmp AlienImage.
98
99         class GIFAlienImage;
100         ---Purpose: Public definition of windows .gif AlienImage.
101
102
103
104
105         ---Category: Imported types:
106         imported GIFLZWDict;
107         imported BMPHeader;
108         
109         imported X11XColor ;
110         imported X11XWDFileHeader ;
111         imported SGIRGBFileHeader ;
112         imported SUNRFFileHeader ;
113
114         enumeration SUNRFFormat is      SUNRF_Old,
115                                         SUNRF_Standard,
116                                         SUNRF_ByteEncoded,
117                                         SUNRF_RGB,
118                                         SUNRF_Unknown
119         end SUNRFFormat ;
120 ---Purpose: Type of code for a SUNRF image.
121     
122         ----------------------------
123         ---Category: Package methods
124         ----------------------------
125         CreateImage (theFileName :     AsciiString from TCollection;
126                      theImage    : out Image from Image)
127         returns Boolean from Standard;
128         ---Purpose:
129
130         CreateImage (theFileName :     CString from Standard;
131                      theImage    : out Image from Image)
132         returns Boolean from Standard;
133         ---Purpose:
134
135         CreateImage (theFile  : in out File from OSD;
136                      theImage :    out Image from Image)
137         returns Boolean from Standard;
138         ---Purpose:
139
140         LoadImageFile (anImageFile :     CString     from Standard;
141                        anImage     : out Image       from Image;
142                        aWidth      : out Integer     from Standard;
143                        aHeight     : out Integer     from Standard
144         ) returns Boolean from Standard;
145         ---Purpose: Used by plotter drivers
146
147 end AlienImage;
148