src/MeshVS/MeshVS_Tool.cdl

   1 -- Created on: 2003-12-17
   2 -- Created by: Alexander SOLOVYOV
   3 -- Copyright (c) 2003-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 class Tool from MeshVS
  17
  18         ---Purpose: This class provides auxiliary methods to create differents aspects
  19
  20 uses
  21   Boolean from Standard,
  22
  23   Drawer from MeshVS,
  24
  25   AspectFillArea3d from Graphic3d,
  26   AspectLine3d     from Graphic3d,
  27   AspectMarker3d   from Graphic3d,
  28   AspectText3d     from Graphic3d,
  29   MaterialAspect   from Graphic3d,
  30
  31   Array1OfReal     from TColStd,
  32
  33   Vec              from gp,
  34   Dir              from gp
  35
  36 is
  37   CreateAspectFillArea3d ( myclass; theDr : Drawer; UseDefaults : Boolean = Standard_True ) returns AspectFillArea3d from Graphic3d;
  38         ---Purpose: Creates fill area aspect with values from Drawer according to keys from DrawerAttribute
  39
  40   CreateAspectFillArea3d ( myclass; theDr : Drawer; Mat : MaterialAspect; UseDefaults : Boolean = Standard_True ) returns AspectFillArea3d from Graphic3d;
  41         ---Purpose: Creates fill aspect with values from Drawer according to keys from DrawerAttribute
  42         -- and specific material aspect
  43
  44   CreateAspectLine3d     ( myclass; theDr : Drawer; UseDefaults : Boolean = Standard_True ) returns AspectLine3d from Graphic3d;
  45         ---Purpose: Creates line aspect with values from Drawer according to keys from DrawerAttribute
  46
  47   CreateAspectMarker3d   ( myclass; theDr : Drawer; UseDefaults : Boolean = Standard_True ) returns AspectMarker3d from Graphic3d;
  48         ---Purpose: Creates marker aspect with values from Drawer according to keys from DrawerAttribute
  49
  50   CreateAspectText3d     ( myclass; theDr : Drawer; UseDefaults : Boolean = Standard_True ) returns AspectText3d from Graphic3d;
  51         ---Purpose: Creates text aspect with values from Drawer according to keys from DrawerAttribute
  52
  53   GetNormal( myclass; Nodes : Array1OfReal from TColStd;
  54                       Norm  : out Vec from gp ) returns Boolean;
  55         ---Purpose: Get one of normals to polygon described by these points.
  56         --          If the polygon isn't planar, function returns false
  57
  58   GetAverageNormal( myclass; Nodes : Array1OfReal from TColStd;
  59                       Norm  : out Vec from gp ) returns Boolean;
  60         ---Purpose: Get an average of normals to non-planar polygon described by these points or compute
  61         --          normal of planar polygon. If the polygon isn't planar, function returns false
  62
  63 end Tool;