src/AIS/AIS_DimensionOwner.cdl

   1 -- Created on: 1996-12-05
   2 -- Created by: Odile Olivier
   3 -- Copyright (c) 1996-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 class DimensionOwner from AIS inherits EntityOwner from SelectMgr
  23
  24   ---Purpose: The owner is the entity which makes it possible to link
  25     -- the sensitive primitives and the reference shapes that
  26     -- you want to detect. It stocks the various pieces of
  27     -- information which make it possible to find objects. An
  28     -- owner has a priority which you can modulate, so as to
  29     -- make one entity more selectable than another. You
  30     -- might want to make edges more selectable than
  31     -- faces, for example. In that case, you could attribute sa
  32     -- higher priority to the one compared to the other. An
  33     -- edge, could have priority 5, for example, and a face,
  34     -- priority 4. The default priority is 5.
  35
  36 uses
  37
  38     SelectableObject       from SelectMgr,
  39     PresentationManager    from PrsMgr,
  40     PresentationManager3d  from PrsMgr,
  41     NameOfColor            from Quantity,
  42     DimensionSelectionMode from AIS
  43
  44 is
  45
  46     Create (theSelObject  : SelectableObject;
  47             theSelMode    : DimensionSelectionMode from AIS;
  48             thePriority   : Integer from Standard = 0)
  49     returns mutable DimensionOwner from AIS;
  50       ---Purpose:
  51       -- Initializes the dimension owner, theSO, and attributes it
  52       -- the priority, thePriority.
  53
  54     SelectionMode (me)
  55     returns DimensionSelectionMode from AIS;
  56
  57     HilightWithColor (me       : mutable;
  58                       thePM    : PresentationManager3d from PrsMgr;
  59                       theColor : NameOfColor from Quantity;
  60                       theMode  : Integer  from  Standard = 0)
  61     is redefined virtual;
  62
  63     IsHilighted (me;
  64                  thePM   : PresentationManager from PrsMgr;
  65                  theMode : Integer  from  Standard  =0)
  66     returns Boolean from Standard is redefined virtual;
  67     ---Purpose: Returns true if an object with the selection mode
  68     -- aMode is highlighted in the presentation manager aPM.
  69
  70     Hilight(me    : mutable;
  71             thePM   : PresentationManager from PrsMgr;
  72             theMode : Integer  from  Standard  =0) is redefined virtual;
  73
  74     Unhilight(me    : mutable;
  75               thePM   : PresentationManager from PrsMgr;
  76               theMode : Integer  from  Standard  =0) is redefined virtual;
  77     ---Purpose: Removes highlighting from the selected part of dimension.
  78
  79 fields
  80
  81     mySelectionMode : DimensionSelectionMode from AIS;
  82
  83 end DimensionOwner;