src/IGESGraph/IGESGraph_HighLight.cdl

   1 -- Created on: 1993-01-09
   2 -- Created by: CKY / Contract Toubro-Larsen ( TCD )
   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 HighLight from IGESGraph  inherits IGESEntity
  18
  19         ---Purpose: defines IGESHighLight, Type <406> Form <20>
  20         --          in package IGESGraph
  21         --
  22         --          Attaches information that an entity is to be
  23         --          displayed in some system dependent manner
  24
  25 uses  Integer  -- no one specific type
  26
  27
  28 is
  29
  30         Create returns HighLight;
  31
  32         -- Specific Methods pertaining to the class
  33
  34         Init (me               : mutable;
  35               nbProps          : Integer;
  36               aHighLightStatus : Integer);
  37         ---Purpose : This method is used to set the fields of the class
  38         --           HighLight
  39         --      - nbProps          : Number of property values (NP = 1)
  40         --      - aHighLightStatus : HighLight Flag
  41
  42         NbPropertyValues(me) returns Integer;
  43         ---Purpose : returns the number of property values in <me>
  44
  45         HighLightStatus(me) returns Integer;
  46         ---Purpose : returns 0 if <me> is not highlighted(default),
  47         --         1 if <me> is highlighted
  48
  49         IsHighLighted(me) returns Boolean;
  50         ---Purpose : returns True if entity is highlighted
  51
  52 fields
  53
  54 --
  55 -- Class    : IGESGraph_HighLight
  56 --
  57 -- Purpose  : Declaration of the variables specific to a
  58 --            HighLight property.
  59 --
  60 -- Reminder : A HighLight property is defined by :
  61 --                  - Number of property values (NP=1)
  62 --                  - Flag
  63 --
  64
  65         theNbPropertyValues : Integer;
  66
  67         theHighLight        : Integer;
  68
  69 end HighLight;