src/GEOMAlgo/GEOMAlgo_WESScaler.cdl

   1 --  Copyright (C) 2007-2010  CEA/DEN, EDF R&D, OPEN CASCADE
   2 --
   3 --  This library is free software; you can redistribute it and/or
   4 --  modify it under the terms of the GNU Lesser General Public
   5 --  License as published by the Free Software Foundation; either
   6 --  version 2.1 of the License.
   7 --
   8 --  This library is distributed in the hope that it will be useful,
   9 --  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 --  Lesser General Public License for more details.
  12 --
  13 --  You should have received a copy of the GNU Lesser General Public
  14 --  License along with this library; if not, write to the Free Software
  15 --  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 --
  17 --  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 --
  19 -- File:        GEOMAlgo_WESScaler.cdl
  20 -- Created:
  21 -- Author:
  22 --              <pkv@VORTEX>
  23
  24
  25 class WESScaler from GEOMAlgo
  26         inherits Algo from GEOMAlgo
  27
  28         ---Purpose:
  29
  30 uses
  31     Face from TopoDS,
  32     Shape  from TopoDS,
  33     ListOfShape from  TopTools,
  34     DataMapOfOrientedShapeShape from GEOMAlgo,
  35     WireEdgeSet from GEOMAlgo,
  36     PWireEdgeSet from GEOMAlgo
  37
  38 --raises
  39
  40 is
  41     Create
  42         ---Purpose: Empty constructor
  43         returns WESScaler from GEOMAlgo;
  44     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_WESScaler();"
  45
  46     SetScale  (me:out;
  47                 aWES: Real from Standard);
  48     ---Purpose:
  49     -- Modifier
  50
  51     Scale(me)
  52         returns Real from Standard;
  53     ---Purpose:
  54     -- Selector
  55
  56     SetFace  (me:out;
  57                 aF: Face from TopoDS);
  58
  59     Face (me)
  60         returns Face from TopoDS;
  61     ---C++:  return const &
  62
  63     SetEdges  (me:out;
  64                 aLE:ListOfShape from  TopTools);
  65
  66     Edges  (me)
  67          returns ListOfShape from  TopTools;
  68     ---C++:  return const &
  69
  70     Perform(me:out)
  71         ---Purpose:  Performs the algorithm
  72         is redefined;
  73
  74     FaceScaled (me)
  75         returns Face from TopoDS;
  76     ---C++:  return const &
  77
  78     EdgesScaled  (me)
  79          returns ListOfShape from  TopTools;
  80     ---C++:  return const &
  81
  82     Image(me;
  83             aS:Shape from TopoDS)
  84         returns Shape from TopoDS;
  85     ---C++: return const &
  86     ---Purpose:
  87
  88     Origin(me;
  89             aS:Shape from TopoDS)
  90         returns Shape from TopoDS;
  91     ---C++: return const &
  92
  93     ---Purpose:
  94     Images(me)
  95         returns  DataMapOfOrientedShapeShape from GEOMAlgo;
  96     ---C++: return const &
  97     ---Purpose:
  98     --- Selector
  99
 100     Origins(me)
 101         returns   DataMapOfOrientedShapeShape from GEOMAlgo;
 102     ---C++: return const &
 103     ---Purpose:
 104     --- Selector
 105
 106     CheckData(me:out)
 107         ---Purpose:  Performs the algorithm
 108         is redefined protected;
 109
 110 fields
 111     myScale         : Real from Standard is protected;
 112     myFace          : Face from TopoDS is protected;
 113
 114     myEdges         : ListOfShape from  TopTools is protected;
 115     myFaceScaled    : Face from TopoDS is protected;
 116     myEdgesScaled   : ListOfShape from  TopTools is protected;
 117     myImages        : DataMapOfOrientedShapeShape from GEOMAlgo is protected;
 118     myOrigins       : DataMapOfOrientedShapeShape from GEOMAlgo is protected;
 119     myShapeTmp      : Shape  from TopoDS is protected;
 120 end WESScaler;
 121