src/AIS/AIS_GlobalStatus.cdl

   1 -- Created on: 1997-01-24
   2 -- Created by: Robert COUBLANC
   3 -- Copyright (c) 1997-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23 private class GlobalStatus from AIS inherits TShared from MMgt
  24
  25         ---Purpose: Stores  information  about objects in graphic context:
  26         --          - Status Of Display : in the main viewer
  27         --                                in the  collector
  28         --                                fully Erased
  29         --          - Displayed Modes
  30         --          - Active Selection Modes
  31         --          - is the Interactive Object Current ?
  32         --          - Layer Index
  33
  34 uses
  35     ListOfInteger from TColStd,
  36     DisplayStatus from AIS,
  37     NameOfColor from Quantity
  38
  39 is
  40
  41     Create returns mutable GlobalStatus from AIS;
  42
  43     Create (aStat             : DisplayStatus from AIS;
  44             aDispMode,aSelMode: Integer from Standard;
  45             ishilighted       : Boolean from Standard=Standard_False;
  46             TheHiCol          : NameOfColor from Quantity = Quantity_NOC_WHITE;
  47             aLayerIndex       : Integer from Standard = 0)
  48             returns mutable GlobalStatus from AIS;
  49
  50                     ---Category: Modifications.
  51
  52     SetGraphicStatus(me:mutable; aStat :  DisplayStatus from AIS);
  53     ---C++: inline
  54     AddDisplayMode(me:mutable; aMode: Integer from Standard);
  55     ---C++: inline
  56     AddSelectionMode(me:mutable; aMode : Integer from Standard);
  57     ---C++: inline
  58     SetLayerIndex (me: mutable ; AnIndex : Integer from Standard);
  59     ---C++: inline
  60     SetHilightStatus (me: mutable; aStat:Boolean from Standard);
  61     ---C++: inline
  62     SetHilightColor(me:mutable;aHiCol : NameOfColor from Quantity);
  63     ---C++: inline
  64
  65
  66
  67     IsSubIntensityOn(me) returns Boolean from Standard;
  68     ---C++: inline
  69     SubIntensityOn (me: mutable);
  70     ---C++: inline
  71     SubIntensityOff (me: mutable);
  72     ---C++: inline
  73
  74
  75
  76     RemoveDisplayMode(me:mutable; aMode : Integer from Standard);
  77
  78     RemoveSelectionMode(me:mutable; aMode : Integer from Standard);
  79     ClearSelectionModes(me:mutable);
  80
  81
  82                     ---Category: Information.
  83
  84
  85     GraphicStatus(me) returns DisplayStatus from AIS;
  86     ---C++: inline
  87
  88     DisplayedModes(me) returns ListOfInteger from TColStd;
  89     ---C++: return const &
  90     ---C++: inline
  91     ---Purpose: keeps the information of displayed modes in the
  92     --          main viewer.
  93     --          (The convention is that the object is displayed
  94     --          with the mode 0 in the collector...)
  95
  96     SelectionModes(me) returns ListOfInteger from TColStd;
  97     ---C++: return const &
  98     ---C++: inline
  99     ---Purpose: keeps the active selection modes of the object
 100     --          in the main viewer.
 101     --          (The convention is that the active selection mode
 102     --          for an object in the collector is the mode 0).
 103
 104     IsHilighted(me) returns Boolean from Standard;
 105     ---C++: inline
 106
 107     HilightColor(me) returns NameOfColor from Quantity;
 108     ---C++: inline
 109
 110     IsDModeIn(me; aMode : Integer from Standard) returns Boolean from Standard;
 111
 112     IsSModeIn(me; aMode : Integer from Standard) returns Boolean from Standard;
 113
 114
 115 fields
 116
 117     myStatus     : DisplayStatus from AIS;
 118     myDispModes  : ListOfInteger from TColStd;
 119     mySelModes   : ListOfInteger from TColStd;
 120     myLayerIndex : Integer       from Standard;
 121     myIsHilit    : Boolean       from Standard;
 122     myHiCol      : NameOfColor   from Quantity;
 123     mySubInt     : Boolean;
 124 end GlobalStatus;