src/V3d/V3d_ColorScale.cdl

   1 -- Created on: 2004-06-24
   2 -- Created by: STV
   3 -- Copyright (c) 2004-2014 OPEN CASCADE SAS
   4 --
   5 -- This file is part of Open CASCADE Technology software library.
   6 --
   7 -- This library is free software; you can redistribute it and/or modify it under
   8 -- the terms of the GNU Lesser General Public License version 2.1 as published
   9 -- by the Free Software Foundation, with special exception defined in the file
  10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 -- distribution for complete text of the license and disclaimer of any warranty.
  12 --
  13 -- Alternatively, this file may be used under the terms of Open CASCADE
  14 -- commercial license or contractual agreement.
  15
  16 private class ColorScale from V3d inherits ColorScale from Aspect
  17
  18     ---Purpose: A colorscale class
  19 uses
  20
  21        --View           from V3d,
  22        LayerMgr         from V3d,
  23        LayerMgrPointer  from V3d,
  24        --Layer          from Visual3d,
  25        Color          from Quantity,
  26        ExtendedString from TCollection
  27
  28 is
  29
  30        ---Category: Public
  31
  32        Create(theMgr : LayerMgr from V3d)
  33        returns ColorScale from V3d;
  34        ---Purpose: Returns returns ColorScale from V3d.
  35
  36        --View(me)
  37        --returns View from V3d;
  38        ---Purpose: Returns View from V3d.
  39
  40        Display(me : mutable);
  41
  42        Erase(me : mutable);
  43
  44        IsDisplayed(me)
  45        returns Boolean from Standard;
  46
  47        ---Category: Protected
  48
  49        UpdateColorScale(me : mutable)
  50        is redefined protected;
  51
  52        --BeginPaint(me : mutable)
  53        --returns Boolean from Standard
  54        --is redefined protected;
  55
  56        --EndPaint(me : mutable)
  57        --returns Boolean from Standard
  58        --is redefined protected;
  59
  60        PaintRect(me : mutable; theX, theY, theWidth, theHeight : Integer from Standard;
  61                                theColor     : Color from Quantity;
  62                                theFilled    : Boolean from Standard = Standard_False)
  63        is redefined;
  64
  65        PaintText(me : mutable; theText  : ExtendedString from TCollection;
  66                                theX, theY   : Integer from Standard;
  67                                theColor : Color from Quantity)
  68        is redefined;
  69
  70        TextWidth(me; theText : ExtendedString from TCollection)
  71        returns Integer from Standard
  72        is redefined;
  73
  74        TextHeight(me; theText : ExtendedString from TCollection)
  75        returns Integer from Standard
  76        is redefined;
  77
  78        TextSize( me;
  79                 theText    : ExtendedString from TCollection;
  80                 theHeight  : Integer from Standard;
  81                 theWidth   : in out Integer from Standard;
  82                 theAscent : in out Integer from Standard;
  83                 theDescent : in out Integer from Standard );
  84
  85        DrawScale(me : mutable);
  86
  87     ---Category: Private
  88
  89        --Overlay(me)
  90        --returns Layer from Visual3d
  91        --is private;
  92
  93 fields
  94
  95        --myView     : View from V3d;
  96        myLayerMgr : LayerMgrPointer from V3d;
  97        --myOverlay  : Layer from Visual3d;
  98        myDisplay  : Boolean from Standard;
  99
 100 end ColorScale;