src/Materials/Materials_Color.cdl

   1 -- Created on: 1993-04-15
   2 -- Created by: Gilles DEBARBOUILLE
   3 -- Copyright (c) 1993-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class Color from Materials
  18
  19         ---Purpose: This class  encapsulates   a Quantity_Color  in  a
  20         --          Transient object, to be used in an ObjectProperty
  21         --          from the package Dynamic.
  22
  23 inherits
  24
  25     Transient
  26
  27 uses
  28
  29     Color from Quantity, TypeOfColor from Quantity, NameOfColor from Quantity
  30
  31 --raises
  32
  33 is
  34
  35     Create returns mutable Color from Materials;
  36     ---Level: Internal
  37     ---Purpose: Creates an empty instance of Color.
  38
  39     Create(acolor : Color from Quantity)
  40     ---Level: Internal
  41     ---Purpose: Creates an instance of Color, with <acolor> as color.
  42
  43     returns mutable Color from Materials;
  44
  45     Color(me : mutable ; acolor : Color from Quantity)
  46     ---Level: Internal
  47     ---Purpose: Sets <acolor> into <me>.
  48     is static;
  49
  50     Color(me) returns Color from Quantity
  51     ---Level: Internal
  52     ---Purpose: Returns a Quantity_Color corresponding to <me>.
  53     is static;
  54
  55     Color(me; aTypeOfColor : in TypeOfColor from Quantity; Reel1, Reel2, Reel3 : out Real from Standard);
  56     ---Purpose: Get the values ( RGB or HLS )  between 0.0 and 1.0
  57
  58     Color255(me; aTypeOfColor : in TypeOfColor from Quantity; Reel1, Reel2, Reel3 : out Real from Standard);
  59     ---Purpose: Get the values ( RGB or HLS )  between 0.0 and 255.0
  60
  61     SetColor(me : mutable; aTypeOfColor : in TypeOfColor from Quantity; Reel1, Reel2, Reel3 : in Real from Standard);
  62     ---Purpose: Set the values ( RGB or HLS )  between 0.0 and 1.0
  63
  64     SetColor255(me : mutable; aTypeOfColor : in TypeOfColor from Quantity; Reel1, Reel2, Reel3 : in Real from Standard);
  65    ---Purpose: Set the values ( RGB or HLS )  between 0.0 and 255.0
  66
  67 fields
  68
  69     thecolor : Color from Quantity;
  70
  71 end Color;