src/IGESSolid/IGESSolid_SelectedComponent.cdl

   1 -- Created on: 1993-01-09
   2 -- Created by: CKY / Contract Toubro-Larsen ( SIVA )
   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 SelectedComponent from IGESSolid  inherits IGESEntity
  18
  19         ---Purpose: defines SelectedComponent, Type <182> Form Number <0>
  20         --          in package IGESSolid
  21         --          The Selected Component entity provides a means of
  22         --          selecting one component of a disjoint CSG solid
  23
  24 uses
  25
  26         BooleanTree     from IGESSolid,
  27         XYZ             from gp,
  28         Pnt             from gp
  29
  30 is
  31
  32         Create returns SelectedComponent;
  33
  34         -- Specific Methods pertaining to the class
  35
  36         Init (me        : mutable;
  37               anEntity  : BooleanTree;
  38               selectPnt : XYZ);
  39         ---Purpose : This method is used to set the fields of the class
  40         --           SelectedComponent
  41         --       - anEntity  : the Boolean tree entity
  42         --       - selectPnt : Point in or on the desired component
  43
  44         Component(me) returns BooleanTree;
  45         ---Purpose : returns the Boolean tree entity
  46
  47         SelectPoint(me) returns Pnt;
  48         ---Purpose : returns the point on/in the selected component
  49
  50         TransformedSelectPoint(me) returns Pnt;
  51         ---Purpose : returns the point on/in the selected component
  52         -- after applying TransformationMatrix
  53
  54 fields
  55
  56 --
  57 -- Class    : IGESSolid_SelectedComponent
  58 --
  59 -- Purpose  : Declaration of variables specific to the definition
  60 --            of the Class SelectedComponent.
  61 --
  62 -- Reminder : A SelectedComponent instance is defined by :
  63 --            a pointer to the Boolean Tree entity(Entity) and the X, Y
  64 --            and Z components (X,Y,Z) of a selected point.
  65
  66         theEntity      : BooleanTree;
  67             -- the desired boolean tree entity
  68
  69         theSelectPoint : XYZ;
  70             -- the X, Y and Z coordinates of the point
  71
  72 end SelectedComponent;