src/TopAbs/TopAbs_Orientation.hxx

   1 // Created on: 1992-01-24
   2 // Created by: Remi LEQUETTE
   3 // Copyright (c) 1992-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 #ifndef _TopAbs_Orientation_HeaderFile
  18 #define _TopAbs_Orientation_HeaderFile
  19
  20 //! Identifies the orientation of a topological shape.
  21 //! Orientation can represent a relation between two
  22 //! entities, or it can apply to a shape in its own right.
  23 //! When used to describe a relation between two
  24 //! shapes, orientation allows you to use the underlying
  25 //! entity in either direction. For example on a curve
  26 //! which is oriented FORWARD (say from left to right)
  27 //! you can have both a FORWARD and a REVERSED
  28 //! edge. The FORWARD edge will be oriented from
  29 //! left to right, and the REVERSED edge from right to
  30 //! left. In this way, you share the underlying entity. In
  31 //! other words, two faces of a cube can share an
  32 //! edge, and can also be used to build compound shapes.
  33 //! For each case in which an element is used as the
  34 //! boundary of a geometric domain of a higher
  35 //! dimension, this element defines two local regions of
  36 //! which one is arbitrarily considered as the default
  37 //! region. A change in orientation implies a switch of
  38 //! default region. This allows you to apply changes of
  39 //! orientation to the shape as a whole.
  40 enum TopAbs_Orientation
  41 {
  42 TopAbs_FORWARD,
  43 TopAbs_REVERSED,
  44 TopAbs_INTERNAL,
  45 TopAbs_EXTERNAL
  46 };
  47
  48 #endif // _TopAbs_Orientation_HeaderFile