src/AIS/AIS_SignatureFilter.cdl

   1 -- File:        AIS_SignatureFilter.cdl
   2 -- Created:     Tue Mar  4 17:29:20 1997
   3 -- Author:      Robert COUBLANC
   4 --              <rob@robox.paris1.matra-dtv.fr>
   5 ---Copyright:    Matra Datavision 1997
   6
   7
   8 class SignatureFilter from AIS inherits TypeFilter from AIS
   9
  10         ---Purpose: Selects Interactive Objects through their signatures
  11         -- and types. The signature provides an
  12         -- additional   characterization of an object's type, and
  13         -- takes the form of an index. The filter questions each
  14         -- Interactive Object in local context to determine
  15         -- whether it has an non-null owner, and if so, whether
  16         -- it has the desired signature. If the object returns true
  17         -- in each case, it is kept. If not, it is rejected.
  18         -- By default, the   interactive object has a None   type
  19         -- and a signature of 0. If you want to give a particular
  20         -- type and signature to your Interactive Object, you
  21         -- must redefine two virtual methods:   Type and Signature.
  22         -- This filter is only used in an open local contexts.
  23         -- In the Collector viewer, you can only locate
  24         -- Interactive Objects which answer positively to the
  25         -- positioned filters when a local context is open.
  26         -- Warning
  27         -- Some signatures have already been used by standard
  28         -- objects delivered in AIS. These include:
  29         -- -   signature 0 - Shape
  30         -- -   signature 1 - Point
  31         -- -   signature 2 - Axis
  32         -- -   signature 3 - Trihedron
  33         -- -   signature 4 - PlaneTrihedron
  34         -- -   signature 5 - Line
  35         -- -   signature 6 - Circle
  36         -- -   signature 7 - Plane
  37
  38
  39
  40 uses
  41
  42     KindOfInteractive from AIS,
  43     EntityOwner from SelectMgr
  44
  45 is
  46
  47     Create(aGivenKind      : KindOfInteractive from AIS;
  48            aGivenSignature : Integer from Standard)
  49     returns mutable SignatureFilter from AIS;
  50         --- Purpose: Initializes the signature filter, adding the signature
  51         -- specification, aGivenSignature, to that for type,
  52         -- aGivenKind, in AIS_TypeFilter.
  53
  54     IsOk (me;anobj : EntityOwner from SelectMgr)
  55     returns Boolean from Standard is redefined static;
  56         ---Purpose: Returns False if the transient is not an AIS_InteractiveObject.
  57         --          Returns False if the signature of InteractiveObject
  58         --          is not the same as the stored one in the filter...
  59
  60
  61 fields
  62     mySig  : Integer           from Standard;
  63 end SignatureFilter;