EIC code displayed by LXR master/​include/​opencascade/​TopAbs.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 10:05:22

 // Created on: 1992-01-24
 // Created by: Remi LEQUETTE
 // Copyright (c) 1992-1999 Matra Datavision
 // Copyright (c) 1999-2014 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef _TopAbs_HeaderFile
 #define _TopAbs_HeaderFile
 
 #include <Standard.hxx>
 #include <Standard_DefineAlloc.hxx>
 #include <Standard_Handle.hxx>
 
 #include <TopAbs_Orientation.hxx>
 #include <Standard_OStream.hxx>
 #include <TopAbs_ShapeEnum.hxx>
 #include <TopAbs_State.hxx>
 
 
 //! This package gives resources for Topology oriented
 //! applications such as : Topological Data Structure,
 //! Topological Algorithms.
 //!
 //! It contains :
 //!
 //! * The ShapeEnum   enumeration  to  describe  the
 //! different topological shapes.
 //!
 //! * The  Orientation  enumeration to  describe the
 //! orientation of a topological shape.
 //!
 //! * The  State    enumeration  to  describes  the
 //! position of a point relative to a Shape.
 //!
 //! * Methods to manage the enumerations.
 
 class TopAbs 
 {
 public:
 
   DEFINE_STANDARD_ALLOC
 
   
   //! Compose  the Orientation    <Or1>  and  <Or2>.    This
   //! composition is not symmetric (if  you switch <Or1> and
   //! <Or2> the result  is different). It assumes that <Or1>
   //! is the Orientation of a Shape S1 containing a Shape S2
   //! of Orientation   Or2.  The result    is the  cumulated
   //! orientation of S2 in S1.  The composition law is :
   //!
   //! \ Or2     FORWARD  REVERSED INTERNAL EXTERNAL
   //! Or1       -------------------------------------
   //! FORWARD   | FORWARD  REVERSED INTERNAL EXTERNAL
   //! |
   //! REVERSED  | REVERSED FORWARD  INTERNAL EXTERNAL
   //! |
   //! INTERNAL  | INTERNAL INTERNAL INTERNAL INTERNAL
   //! |
   //! EXTERNAL  | EXTERNAL EXTERNAL EXTERNAL EXTERNAL
   //! Note: The top corner in the table is the most important
   //! for the purposes of Open CASCADE topology and shape sharing.
   Standard_EXPORT static TopAbs_Orientation Compose (const TopAbs_Orientation Or1, const TopAbs_Orientation Or2);
   
   //! xchanges the interior/exterior status of the two
   //! sides. This is what happens when the sense of
   //! direction is reversed. The following rules apply:
   //!
   //! FORWARD          REVERSED
   //! REVERSED         FORWARD
   //! INTERNAL         INTERNAL
   //! EXTERNAL         EXTERNAL
   //!
   //! Reverse exchange the material sides.
   Standard_EXPORT static TopAbs_Orientation Reverse (const TopAbs_Orientation Or);
   
   //! Reverses the interior/exterior status of each side of
   //! the object. So, to take the complement of an object
   //! means to reverse the interior/exterior status of its
   //! boundary, i.e. inside becomes outside.
   //! The method returns the complementary orientation,
   //! following the rules in the table below:
   //! FORWARD          REVERSED
   //! REVERSED         FORWARD
   //! INTERNAL         EXTERNAL
   //! EXTERNAL         INTERNAL
   //!
   //! Complement  complements   the  material  side.  Inside
   //! becomes outside.
   Standard_EXPORT static TopAbs_Orientation Complement (const TopAbs_Orientation Or);
   
   //! Prints the name of Shape type as a String on the Stream.
   static Standard_OStream& Print (const TopAbs_ShapeEnum theShapeType, Standard_OStream& theStream)
   {
     return (theStream << ShapeTypeToString (theShapeType));
   }
   
   //! Prints the name of the Orientation as a String on the Stream.
   static Standard_OStream& Print (const TopAbs_Orientation theOrientation, Standard_OStream& theStream)
   {
     return (theStream << ShapeOrientationToString (theOrientation));
   }
   
   //! Prints the name of the State <St> as a String on
   //! the Stream <S> and returns <S>.
   Standard_EXPORT static Standard_OStream& Print (const TopAbs_State St, Standard_OStream& S);
 
   //! Returns the string name for a given shape type.
   //! @param theType shape type
   //! @return string identifier from the list COMPOUND, COMPSOLID, SOLID, SHELL, FACE, WIRE, EDGE, VERTEX, SHAPE
   Standard_EXPORT static Standard_CString ShapeTypeToString (TopAbs_ShapeEnum theType);
 
   //! Returns the shape type from the given string identifier (using case-insensitive comparison).
   //! @param theTypeString string identifier
   //! @return shape type or TopAbs_SHAPE if string identifier is invalid
   static TopAbs_ShapeEnum ShapeTypeFromString (Standard_CString theTypeString)
   {
     TopAbs_ShapeEnum aType = TopAbs_SHAPE;
     ShapeTypeFromString (theTypeString, aType);
     return aType;
   }
 
   //! Determines the shape type from the given string identifier (using case-insensitive comparison).
   //! @param theTypeString string identifier
   //! @param theType detected shape type
   //! @return TRUE if string identifier is known
   Standard_EXPORT static Standard_Boolean ShapeTypeFromString (Standard_CString theTypeString,
                                                                TopAbs_ShapeEnum& theType);
 
   //! Returns the string name for a given shape orientation.
   //! @param theOrientation shape orientation
   //! @return string identifier from the list FORWARD, REVERSED, INTERNAL, EXTERNAL
   Standard_EXPORT static Standard_CString ShapeOrientationToString (TopAbs_Orientation theOrientation);
 
   //! Returns the shape orientation from the given string identifier (using case-insensitive comparison).
   //! @param theOrientationString string identifier
   //! @return shape orientation or TopAbs_FORWARD if string identifier is invalid
   static TopAbs_Orientation ShapeOrientationFromString (const Standard_CString theOrientationString)
   {
     TopAbs_Orientation aType = TopAbs_FORWARD;
     ShapeOrientationFromString (theOrientationString, aType);
     return aType;
   }
 
   //! Determines the shape orientation from the given string identifier (using case-insensitive comparison).
   //! @param theOrientationString string identifier
   //! @param theOrientation detected shape orientation
   //! @return TRUE if string identifier is known
   Standard_EXPORT static Standard_Boolean ShapeOrientationFromString (const Standard_CString theOrientationString,
                                                                       TopAbs_Orientation& theOrientation);
 };
 
 #endif // _TopAbs_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team