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

File indexing completed on 2025-01-18 10:03:06

 // Created on: 1992-05-27
 // 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 _BRep_TFace_HeaderFile
 #define _BRep_TFace_HeaderFile
 
 #include <Standard.hxx>
 
 #include <Poly_ListOfTriangulation.hxx>
 #include <TopLoc_Location.hxx>
 #include <Standard_Real.hxx>
 #include <TopoDS_TFace.hxx>
 class Geom_Surface;
 class TopoDS_TShape;
 
 class BRep_TFace;
 DEFINE_STANDARD_HANDLE(BRep_TFace, TopoDS_TFace)
 
 //! The Tface from BRep  is  based  on the TFace  from
 //! TopoDS. The TFace contains :
 //!
 //! * A surface, a tolerance and a Location.
 //!
 //! * A NaturalRestriction flag,   when this  flag  is
 //! True the  boundary of the  face is known to be the
 //! parametric space (Umin, UMax, VMin, VMax).
 //!
 //! * An optional list of triangulations. If there are any
 //! triangulations the surface can be absent.
 //!
 //! The  Location is  used   for the Surface.
 //!
 //! The triangulation  is in the same reference system
 //! than the TFace.     A point on mySurface must   be
 //! transformed with myLocation,  but  not a point  on
 //! the triangulation.
 //!
 //! The Surface may  be shared by different TFaces but
 //! not the  Triangulation, because the  Triangulation
 //! may be modified by  the edges.
 class BRep_TFace : public TopoDS_TFace
 {
 
 public:
 
   //! Creates an empty TFace.
   Standard_EXPORT BRep_TFace();
 
   //! Returns face surface.
   const Handle(Geom_Surface)& Surface() const { return mySurface; }
 
   //! Sets surface for this face.
   void Surface (const Handle(Geom_Surface)& theSurface) { mySurface = theSurface;}
 
   //! Returns the face location.
   const TopLoc_Location& Location() const { return myLocation; }
 
   //! Sets the location for this face.
   void Location (const TopLoc_Location& theLocation) { myLocation = theLocation; }
 
   //! Returns the face tolerance.
   Standard_Real Tolerance() const { return myTolerance; }
 
   //! Sets the tolerance for this face.
   void Tolerance (const Standard_Real theTolerance) { myTolerance = theTolerance; }
 
   //! Returns TRUE if the boundary of this face is known to be the parametric space (Umin, UMax, VMin, VMax).
   Standard_Boolean NaturalRestriction() const { return myNaturalRestriction; }
 
   //! Sets the flag that is TRUE if the boundary of this face is known to be the parametric space.
   void NaturalRestriction (const Standard_Boolean theRestriction) { myNaturalRestriction = theRestriction; }
 
   //! Returns the triangulation of this face according to the mesh purpose.
   //! @param[in] thePurpose a mesh purpose to find appropriate triangulation (NONE by default).
   //! @return an active triangulation in case of NONE purpose,
   //!         the first triangulation appropriate for the input purpose,
   //!         just the first triangulation if none matching other criteria and input purpose is AnyFallback
   //!         or null handle if there is no any suitable triangulation.
   Standard_EXPORT const Handle(Poly_Triangulation)& Triangulation (const Poly_MeshPurpose thePurpose = Poly_MeshPurpose_NONE) const;
 
   //! Sets input triangulation for this face.
   //! @param theTriangulation [in] triangulation to be set
   //! @param theToReset [in] flag to reset triangulations list to new list with only one input triangulation.
   //! If theTriangulation is NULL internal list of triangulations will be cleared and active triangulation will be nullified.
   //! If theToReset is TRUE internal list of triangulations will be reset
   //! to new list with only one input triangulation that will be active.
   //! Else if input triangulation is contained in internal triangulations list it will be made active,
   //!      else the active triangulation will be replaced to input one.
   Standard_EXPORT void Triangulation (const Handle(Poly_Triangulation)& theTriangulation, const Standard_Boolean theToReset = true);
 
   //! Returns a copy  of the  TShape  with no sub-shapes.
   //! The new Face has no triangulation.
   Standard_EXPORT virtual Handle(TopoDS_TShape) EmptyCopy() const Standard_OVERRIDE;
 
   //! Dumps the content of me into the stream
   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
 
 public:
 
   //! Returns the list of available face triangulations.
   const Poly_ListOfTriangulation& Triangulations() const { return myTriangulations; }
 
   //! Sets input list of triangulations and currently active triangulation for this face.
   //! If list is empty internal list of triangulations will be cleared and active triangulation will be nullified.
   //! Else this list will be saved and the input active triangulation be saved as active.
   //! Use NULL active triangulation to set the first triangulation in list as active.
   //! Note: the method throws exception if there is any NULL triangulation in input list or
   //!       if this list doesn't contain input active triangulation.
   Standard_EXPORT void Triangulations (const Poly_ListOfTriangulation& theTriangulations, const Handle(Poly_Triangulation)& theActiveTriangulation);
 
   //! Returns number of available face triangulations.
   Standard_Integer NbTriangulations() const { return myTriangulations.Size(); }
 
   //! Returns current active triangulation.
   const Handle(Poly_Triangulation)& ActiveTriangulation() const { return myActiveTriangulation; }
 
   DEFINE_STANDARD_RTTIEXT(BRep_TFace,TopoDS_TFace)
 
 private:
 
   Poly_ListOfTriangulation myTriangulations;
   Handle(Poly_Triangulation) myActiveTriangulation;
   Handle(Geom_Surface) mySurface;
   TopLoc_Location myLocation;
   Standard_Real myTolerance;
   Standard_Boolean myNaturalRestriction;
 };
 
 #endif // _BRep_TFace_HeaderFile

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