src/AIS/AIS_TangentRelation.cdl

   1 -- Created on: 1996-12-05
   2 -- Created by: Jean-Pierre COMBE/Odile Olivier
   3 -- Copyright (c) 1996-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 TangentRelation from AIS inherits Relation from AIS
  18         ---Purpose: A framework to display tangency constraints between
  19         -- two or more Interactive Objects of the datum type.
  20         -- The datums are normally faces or edges.
  21 uses Shape                 from TopoDS,
  22      Presentation          from Prs3d,
  23      PresentationManager3d from PrsMgr,
  24      Selection             from SelectMgr,
  25      Pnt                   from gp,
  26      Dir                   from gp,
  27      Projector             from Prs3d,
  28      Transformation        from Geom,
  29      Plane                 from Geom
  30
  31 is
  32     Create (aFShape     : Shape          from TopoDS;
  33             aSShape     : Shape          from TopoDS;
  34             aPlane      : Plane          from Geom;
  35             anExternRef : Integer        from Standard = 0)
  36             ---Purpose:  TwoFacesTangent or TwoEdgesTangent relation
  37     returns TangentRelation from AIS;
  38         ---Purpose: Constructs an object to display tangency constraints.
  39         -- This object is defined by the first shape aFShape, the
  40         -- second shape aSShape, the plane aPlane and the index anExternRef.
  41         -- aPlane serves as an optional axis.
  42         -- anExternRef set to 0 indicates that there is no relation.
  43
  44     ExternRef(me: mutable) returns Integer from Standard
  45     is static;
  46         ---Purpose: Returns the external reference for tangency.
  47         -- The values are as follows:
  48         -- -   0 - there is no connection;
  49         -- -   1 - there is a connection to the first shape;
  50         -- -   2 - there is a connection to the second shape.
  51         --   This reference is defined at construction time.
  52
  53     SetExternRef(me: mutable;aRef : Integer from Standard)
  54     is static;
  55         ---Purpose: Sets the external reference for tangency, aRef.
  56         -- The values are as follows:
  57         -- -   0 - there is no connection;
  58         -- -   1 - there is a connection to the first shape;
  59         -- -   2 - there is a connection to the second shape.
  60         -- This reference is initially defined at construction time.
  61
  62     Compute(me            : mutable;
  63             aPresentationManager: PresentationManager3d from PrsMgr;
  64             aPresentation : Presentation from Prs3d;
  65             aMode         : Integer from Standard= 0)
  66     is redefined static private;
  67
  68     Compute(me:mutable;
  69                 aProjector: Projector from Prs3d;
  70                 aPresentation: Presentation from Prs3d)
  71     is redefined static private;
  72
  73     Compute(me            : mutable;
  74             aProjector    : Projector from Prs3d;
  75             aTrsf         : Transformation from Geom;
  76             aPresentation : Presentation from Prs3d)
  77     is redefined;
  78         ---Purpose: computes the presentation according to a point of view
  79         --          given by <aProjector>.
  80         --          To be Used when the associated degenerated Presentations
  81         --          have been transformed by <aTrsf> which is not a Pure
  82         --          Translation. The HLR Prs can't be deducted automatically
  83         --          WARNING :<aTrsf> must be applied
  84         --           to the object to display before computation  !!!
  85
  86 -- Methods from SelectableObject
  87
  88     ComputeSelection(me         : mutable;
  89                      aSelection : Selection from SelectMgr;
  90                      aMode      : Integer from Standard)is private;
  91
  92
  93 --
  94 --     Computation private methods
  95 --
  96
  97     ComputeTwoFacesTangent(me: mutable;
  98                            aPresentation : Presentation from Prs3d)
  99     is private;
 100
 101     ComputeTwoEdgesTangent(me: mutable;
 102                            aPresentation : Presentation from Prs3d)
 103     is private;
 104
 105
 106 fields
 107
 108     myAttach      : Pnt   from gp;
 109     myDir         : Dir   from gp;
 110     myLength      : Real  from Standard;
 111     myExternRef   : Integer from Standard;  ---purpose: (0  no attachment,1  attachment with first shape, 2  attachment with second shape)
 112
 113 end TangentRelation;
 114