0023024: Update headers of OCCT files
[occt.git] / src / AlienImage / AlienImage_AidaAlienImage.cdl
CommitLineData
b311480e 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
7fd59977 5--
b311480e 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.
7fd59977 10--
b311480e 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.
7fd59977 13--
b311480e 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: 02-06-98 : FMN ; Suppression appel Clear (deja fait dans ALienData)
7fd59977 22
23class AidaAlienImage from AlienImage inherits AlienUserImage from AlienImage
24
25 ---Version: 0.0
26
27 ---Purpose: This class defines an Aida Alien image ( BYTEMAPS ).
28 ---Keywords:
29 ---Warning:
30 ---References:
31
32uses
33 File from OSD,
34 ColorMap from Aspect,
35 Image from Image,
36 DitheringMethod from Image,
37 AidaAlienData from AlienImage
38
39is
40 Create returns mutable AidaAlienImage from AlienImage;
41
42 Clear( me : in out mutable) ;
43 ---Level: Public
44 ---Purpose: Frees memory allocated by AidaAlienImage
45
46 ToImage( me : in immutable )
47 returns mutable Image from Image ;
48 ---Level: Public
49 ---Purpose : convert a AidaAlienImage object to a Image object.
50
51 FromImage( me : in out mutable ; anImage : in Image from Image ) ;
52 ---Level: Public
53 ---Purpose : convert a Image object to a AidaAlienImage object.
54
55 Read ( me : in out mutable; afile : in out File from OSD )
56 returns Boolean from Standard ;
57 ---Level: Public
58 ---Purpose: Read content of a AidaAlienImage object from a file .
59 -- Returns True if file is a Aida file .
60
61 Write( me : in immutable; afile : in out File from OSD )
62 returns Boolean from Standard ;
63 ---Level: Public
64 ---Purpose: Write content of a AidaAlienImage object to a file .
65
66 SetColorImageDitheringMethod( me : in out mutable ;
67 aMethod : DitheringMethod from Image;
68 aColorMap : ColorMap from Aspect ) ;
69
70 ---Level: Public
71 ---Purpose: Set the ImageDitheringMethod and the ColorMap when
72 -- FromImage is called with a ColorImage .
73 -- Aida BYTEMAPS file handle only PseudoColorImage .
74 -- Default value is DM_NearestColor,
75 -- ColorCubeColorMap( 40, 5,1, 8,6, 3,54 )
76
77fields
78 myData : AidaAlienData from AlienImage;
79
80end ;
81