src/XCAFDoc/XCAFDoc_Color.cdl

   1 -- Created on: 2000-08-16
   2 -- Created by: data exchange team
   3 -- Copyright (c) 2000-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20
  21
  22 class Color from XCAFDoc inherits     Attribute from TDF
  23
  24         ---Purpose:
  25
  26 uses
  27     Color from Quantity,
  28     NameOfColor from Quantity,
  29     Label from TDF,
  30     RelocationTable from TDF
  31
  32 is
  33     Create returns Color from XCAFDoc;
  34
  35     ---Category: class methods
  36     --           =============
  37
  38     GetID (myclass)
  39         ---C++: return const &
  40     returns GUID from Standard;
  41
  42
  43     Set (myclass; label : Label from TDF; C : Color from Quantity)
  44     returns Color from XCAFDoc;
  45
  46     Set (myclass; label : Label from TDF; C : NameOfColor from Quantity)
  47     returns Color from XCAFDoc;
  48
  49     Set (myclass; label : Label from TDF; R,G,B : Real from Standard)
  50     returns Color from XCAFDoc;
  51
  52     ---Purpose: Find, or create, a Color attribute and set it's value
  53     --          the Color attribute is returned.
  54
  55
  56
  57     ---Category: Color methods
  58     --           ===============
  59
  60     Set (me : mutable;  C : Color from Quantity);
  61
  62     Set (me : mutable;  C : NameOfColor from Quantity);
  63
  64     Set (me : mutable;  R,G,B : Real from Standard);
  65
  66     GetColor (me) returns Color from Quantity;
  67         ---C++: return const &
  68
  69     GetNOC (me) returns NameOfColor from Quantity;
  70
  71     GetRGB (me;  R,G,B : out Real from Standard);
  72
  73     --IsCaptured(me) returns Boolean;
  74         ---Purpose: Returns True if there is a reference on the same label
  75
  76     ---Category: methodes de TDF_Attribute
  77     --           =========================
  78
  79     ID (me)
  80         ---C++: return const &
  81     returns GUID from Standard;
  82
  83     Restore (me: mutable; With : Attribute from TDF);
  84
  85     NewEmpty (me)
  86     returns mutable Attribute from TDF;
  87
  88     Paste (me; Into : mutable Attribute from TDF;
  89                RT   : mutable RelocationTable from TDF);
  90
  91 --    Dump(me; anOS : in out OStream from Standard)
  92 --      returns OStream from Standard
  93 --      is redefined;
  94 --      -C++: return &
  95
  96 fields
  97     myColor   : Color from Quantity;
  98
  99 end Color;