src/Aspect/Aspect_PixMap.cdl

   1 -- Created on: 1999-10-14
   2 -- Created by: VKH
   3 -- Copyright (c) 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 -- Updated:     GG IMP100701 Add the "depth" field and method
  22 --              to the pixmap object.
  23
  24
  25 deferred class PixMap from Aspect
  26 inherits
  27     TShared from MMgt
  28     ---Purpose: This class allows the definition of a pixmap(bitmap)
  29
  30 uses
  31     Handle                from Aspect,
  32     Color                 from Quantity
  33
  34 raises
  35     PixmapDefinitionError       from Aspect,
  36     PixmapError           from Aspect
  37 is
  38     Initialize ( aWidth, anHeight : Integer from Standard;
  39                  aDepth           : Integer from Standard );
  40     ---Level: Public
  41     ---Purpose: Initializes the datas of a pixmap with a pixel size
  42     -- <aWidth>,<anHeight> and depth.
  43
  44     Destroy ( me : mutable )
  45     raises PixmapError from Aspect is deferred;
  46     ---Level: Advanced
  47     ---Purpose: Destroy the pixmap
  48     ---Category: Methods to modify the class definition
  49
  50     Dump ( me ; aFilename : CString from Standard;
  51            aGammaValue: Real from Standard = 1.0 )
  52     returns Boolean
  53     raises PixmapError from Aspect is deferred;
  54     ---Level: Advanced
  55     ---Purpose:
  56     -- Dumps the Bitmap to an image file with
  57     -- an optional gamma correction value
  58     -- and returns TRUE if the dump occurs normaly.
  59     ---Trigger: Raises if pixmap is not defined properly
  60
  61     PixelColor ( me         : in;
  62                  theX, theY : in Integer from Standard )
  63     returns Color from Quantity is deferred;
  64     ---Purpose:
  65     -- Returns the pixel color.
  66
  67           ----------------------------
  68     -- Category: Inquire methods
  69     ----------------------------
  70
  71     PixmapID ( me ) returns Handle from Aspect
  72     is deferred;
  73     ---Level: Advanced
  74     ---Purpose: Returns the ID of the just created pixmap
  75     ---Category: Inquire methods
  76
  77     Size ( me ; aWidth, anHeight : out Integer from Standard )
  78     is static;
  79     ---Level: Public
  80     ---Purpose: Returns the allocated pixmap's size in PIXEL
  81     ---Category: Inquire methods
  82
  83     Depth ( me ) returns Integer from Standard
  84     is static;
  85     ---Level: Public
  86     ---Purpose: Returns the allocated pixmap's depth (planes number)
  87     ---Category: Inquire methods
  88 fields
  89     myWidth  : Integer from Standard is protected;
  90     myHeight : Integer from Standard is protected;
  91     myDepth      : Integer from Standard is protected;
  92 end PixMap;