src/Aspect/Aspect_ColorCubeColorMap.cdl

   1 --
   2 -- File:        Aspect_ColorCubeColorMap.cdl
   3 -- Created:     23/03/93
   4 -- Author:      BBL
   5 --
   6 ---Copyright:   MatraDatavision 1993
   7 --
   8
   9 class ColorCubeColorMap from Aspect inherits ColorMap from Aspect
  10
  11         ---Version: 0.0
  12
  13         ---Purpose: This class defines a ColorCube ColorMap object.
  14         ---Keywords:
  15         ---Warning:
  16         ---References:
  17
  18 uses
  19         Color           from Quantity,
  20         ColorMapEntry   from Aspect
  21
  22 raises
  23         BadAccess       from Aspect,
  24         RangeError from Standard
  25
  26 is
  27         Create( base_pixel, redmax,   redmult,
  28                             greenmax, greenmult,
  29                             bluemax,  bluemult : in Integer from Standard )
  30         returns mutable ColorCubeColorMap from Aspect
  31         raises RangeError from Standard ;
  32         ---Level: Public
  33         ---Purpose : Create a ColorCube ColorMap.
  34
  35         ColorCubeDefinition( me : in ;
  36                           base_pixel,
  37                           redmax,   redmult,
  38                           greenmax, greenmult,
  39                           bluemax,  bluemult : out Integer from Standard );
  40
  41         FindColorMapIndex ( me ;
  42                         AColorMapEntryIndex : Integer from Standard )
  43         returns Integer from Standard
  44         raises BadAccess from Aspect ;
  45         ---Level: Public
  46         ---Purpose: Returns the index in the ColorMap of the
  47         --          ColorMapEntry.Index() equal to <AnEntryIndex>.
  48         --  Warning: Raises BadAccess if the index is not defined in the
  49         --          ColorMap.
  50
  51         FindEntry ( me ; AColorMapEntryIndex : Integer from Standard )
  52         returns ColorMapEntry from Aspect
  53         raises BadAccess from Aspect ;
  54         ---Level: Public
  55         ---Purpose: Returns the ColorMapEntry with ColorMapEntry.Index()
  56         --          equal to <AnEntryIndex>.
  57         --  Warning: Raises BadAccess if the index is not defined in the
  58         --          ColorMap.
  59         ---C++: return const &
  60
  61         NearestColorMapIndex( me ; aColor : Color from Quantity )
  62         returns Integer from Standard ;
  63         ---Level: Public
  64         ---Purpose: Returns the index in the ColorMap of the nearest
  65         --          matching ColorMapEntry
  66
  67         NearestEntry( me ; aColor : Color from Quantity )
  68         returns ColorMapEntry from Aspect ;
  69         ---Level: Public
  70         ---Purpose: Returns the nearest ColorMapEntry that match aColor .
  71         ---C++: return const &
  72
  73         AddEntry (me : mutable; aColor : Color from Quantity)
  74                 returns Integer from Standard;
  75         ---Level: Public
  76         ---Purpose: Search an identical color entry in the color map <me>
  77         -- or returns the nearest ColorMapEntry Index.
  78
  79 fields
  80         mybasepixel              : Integer from Standard ;
  81         mygreenmax , mygreenmult : Integer from Standard ;
  82         myredmax   , myredmult   : Integer from Standard ;
  83         mybluemax  , mybluemult  : Integer from Standard ;
  84                 -- ColorCube definition for a ColorCube ColorMap.
  85
  86 end ColorCubeColorMap ;