src/BRepMesh/BRepMesh_DiscretRoot.cdl

   1 -- Created on: 2008-04-10
   2 -- Created by: Peter KURNEV <pkv@irinox>
   3 -- Copyright (c) 2008-2014 OPEN CASCADE SAS
   4 --
   5 -- This file is part of Open CASCADE Technology software library.
   6 --
   7 -- This library is free software; you can redistribute it and/or modify it under
   8 -- the terms of the GNU Lesser General Public License version 2.1 as published
   9 -- by the Free Software Foundation, with special exception defined in the file
  10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 -- distribution for complete text of the license and disclaimer of any warranty.
  12 --
  13 -- Alternatively, this file may be used under the terms of Open CASCADE
  14 -- commercial license or contractual agreement.
  15
  16 deferred class DiscretRoot from BRepMesh
  17
  18 inherits Transient from Standard
  19
  20     ---Purpose:
  21     -- This is a common interface for meshing algorithms
  22     -- instantiated by Mesh Factory and implemented by plugins.
  23
  24 uses
  25     Shape from TopoDS
  26
  27 --raises
  28
  29 is
  30     Initialize
  31         returns DiscretRoot from BRepMesh;
  32
  33     SetDeflection (           me : mutable;
  34                    theDeflection : Real from Standard);
  35     ---Purpose:
  36     -- Setup linear deflection.
  37
  38     ---C++: alias "Standard_EXPORT virtual ~BRepMesh_DiscretRoot();"
  39
  40     Deflection (me)
  41         returns Real from Standard;
  42     ---Purpose:
  43     -- Returns linear deflection.
  44
  45     SetAngle (      me : mutable;
  46               theAngle : Real from Standard);
  47     ---Purpose:
  48     -- Setup angular deflection.
  49
  50     Angle (me)
  51         returns Real from Standard;
  52     ---Purpose:
  53     -- Returns angular deflection.
  54
  55     SetShape (      me : mutable;
  56               theShape : Shape from TopoDS);
  57     ---Purpose:
  58     -- Set the shape to triangulate.
  59
  60     Shape (me)
  61         returns Shape from TopoDS;
  62     ---C++: return const &
  63
  64     Perform (me : mutable)
  65         is deferred;
  66     ---Purpose:
  67     -- Compute triangulation for set shape.
  68
  69     IsDone (me)
  70         returns Boolean from Standard;
  71     ---Purpose:
  72     -- Returns true if triangualtion was performed and has success.
  73
  74     --
  75     --  Protected methods
  76     --
  77     SetDone (me : mutable)
  78         is protected;
  79
  80     SetNotDone (me : mutable)
  81         is protected;
  82
  83     Init (me : mutable)
  84         is virtual protected;
  85
  86 fields
  87     myDeflection : Real from Standard is protected;
  88     myAngle      : Real from Standard is protected;
  89     myShape      : Shape from TopoDS  is protected;
  90     myIsDone     : Boolean from Standard is protected;
  91
  92 end DiscretRoot;