Open CASCADE Technology  7.7.0.dev
Public Member Functions

BRep_TFace Class Reference

The Tface from BRep is based on the TFace from TopoDS. The TFace contains : More...

#include <BRep_TFace.hxx>

Inheritance diagram for BRep_TFace:
Inheritance graph
[legend]

Public Member Functions

 BRep_TFace ()
 Creates an empty TFace. More...
 
const Handle< Geom_Surface > & Surface () const
 Returns face surface. More...
 
void Surface (const Handle< Geom_Surface > &theSurface)
 Sets surface for this face. More...
 
const TopLoc_LocationLocation () const
 Returns the face location. More...
 
void Location (const TopLoc_Location &theLocation)
 Sets the location for this face. More...
 
Standard_Real Tolerance () const
 Returns the face tolerance. More...
 
void Tolerance (const Standard_Real theTolerance)
 Sets the tolerance for this face. More...
 
Standard_Boolean NaturalRestriction () const
 Returns TRUE if the boundary of this face is known to be the parametric space (Umin, UMax, VMin, VMax). More...
 
void NaturalRestriction (const Standard_Boolean theRestriction)
 Sets the flag that is TRUE if the boundary of this face is known to be the parametric space. More...
 
const Handle< Poly_Triangulation > & Triangulation (const Poly_MeshPurpose thePurpose=Poly_MeshPurpose_NONE) const
 Returns the triangulation of this face according to the mesh purpose. More...
 
void Triangulation (const Handle< Poly_Triangulation > &theTriangulation, const Standard_Boolean theToReset=true)
 Sets input triangulation for this face. More...
 
virtual Handle< TopoDS_TShapeEmptyCopy () const override
 Returns a copy of the TShape with no sub-shapes. The new Face has no triangulation. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
const Poly_ListOfTriangulationTriangulations () const
 Returns the list of available face triangulations. More...
 
void Triangulations (const Poly_ListOfTriangulation &theTriangulations, const Handle< Poly_Triangulation > &theActiveTriangulation)
 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. More...
 
Standard_Integer NbTriangulations () const
 Returns number of available face triangulations. More...
 
const Handle< Poly_Triangulation > & ActiveTriangulation () const
 Returns current active triangulation. More...
 
- Public Member Functions inherited from TopoDS_TFace
 TopoDS_TFace ()
 Creates an empty TFace. More...
 
TopAbs_ShapeEnum ShapeType () const override
 returns FACE. More...
 
- Public Member Functions inherited from TopoDS_TShape
Standard_Boolean Free () const
 Returns the free flag. More...
 
void Free (Standard_Boolean theIsFree)
 Sets the free flag. More...
 
Standard_Boolean Locked () const
 Returns the locked flag. More...
 
void Locked (Standard_Boolean theIsLocked)
 Sets the locked flag. More...
 
Standard_Boolean Modified () const
 Returns the modification flag. More...
 
void Modified (Standard_Boolean theIsModified)
 Sets the modification flag. More...
 
Standard_Boolean Checked () const
 Returns the checked flag. More...
 
void Checked (Standard_Boolean theIsChecked)
 Sets the checked flag. More...
 
Standard_Boolean Orientable () const
 Returns the orientability flag. More...
 
void Orientable (Standard_Boolean theIsOrientable)
 Sets the orientability flag. More...
 
Standard_Boolean Closed () const
 Returns the closedness flag. More...
 
void Closed (Standard_Boolean theIsClosed)
 Sets the closedness flag. More...
 
Standard_Boolean Infinite () const
 Returns the infinity flag. More...
 
void Infinite (Standard_Boolean theIsInfinite)
 Sets the infinity flag. More...
 
Standard_Boolean Convex () const
 Returns the convexness flag. More...
 
void Convex (Standard_Boolean theIsConvex)
 Sets the convexness flag. More...
 
Standard_Integer NbChildren () const
 Returns the number of direct sub-shapes (children). More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Member Functions inherited from TopoDS_TShape
 TopoDS_TShape ()
 Constructs an empty TShape. Free : True Modified : True Checked : False Orientable : True Closed : False Infinite : False Convex : False. More...
 

Detailed Description

The Tface from BRep is based on the TFace from TopoDS. The TFace contains :

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.

Constructor & Destructor Documentation

◆ BRep_TFace()

BRep_TFace::BRep_TFace ( )

Creates an empty TFace.

Member Function Documentation

◆ ActiveTriangulation()

const Handle< Poly_Triangulation >& BRep_TFace::ActiveTriangulation ( ) const
inline

Returns current active triangulation.

◆ DumpJson()

virtual void BRep_TFace::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
overridevirtual

Dumps the content of me into the stream.

Reimplemented from TopoDS_TShape.

◆ EmptyCopy()

virtual Handle< TopoDS_TShape > BRep_TFace::EmptyCopy ( ) const
overridevirtual

Returns a copy of the TShape with no sub-shapes. The new Face has no triangulation.

Reimplemented from TopoDS_TFace.

◆ Location() [1/2]

const TopLoc_Location& BRep_TFace::Location ( ) const
inline

Returns the face location.

◆ Location() [2/2]

void BRep_TFace::Location ( const TopLoc_Location theLocation)
inline

Sets the location for this face.

◆ NaturalRestriction() [1/2]

Standard_Boolean BRep_TFace::NaturalRestriction ( ) const
inline

Returns TRUE if the boundary of this face is known to be the parametric space (Umin, UMax, VMin, VMax).

◆ NaturalRestriction() [2/2]

void BRep_TFace::NaturalRestriction ( const Standard_Boolean  theRestriction)
inline

Sets the flag that is TRUE if the boundary of this face is known to be the parametric space.

◆ NbTriangulations()

Standard_Integer BRep_TFace::NbTriangulations ( ) const
inline

Returns number of available face triangulations.

◆ Surface() [1/2]

const Handle< Geom_Surface >& BRep_TFace::Surface ( ) const
inline

Returns face surface.

◆ Surface() [2/2]

void BRep_TFace::Surface ( const Handle< Geom_Surface > &  theSurface)
inline

Sets surface for this face.

◆ Tolerance() [1/2]

Standard_Real BRep_TFace::Tolerance ( ) const
inline

Returns the face tolerance.

◆ Tolerance() [2/2]

void BRep_TFace::Tolerance ( const Standard_Real  theTolerance)
inline

Sets the tolerance for this face.

◆ Triangulation() [1/2]

void BRep_TFace::Triangulation ( const Handle< Poly_Triangulation > &  theTriangulation,
const Standard_Boolean  theToReset = true 
)

Sets input triangulation for this face.

Parameters
theTriangulation[in] triangulation to be set
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.

◆ Triangulation() [2/2]

const Handle< Poly_Triangulation >& BRep_TFace::Triangulation ( const Poly_MeshPurpose  thePurpose = Poly_MeshPurpose_NONE) const

Returns the triangulation of this face according to the mesh purpose.

Parameters
[in]thePurposea mesh purpose to find appropriate triangulation (NONE by default).
Returns
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.

◆ Triangulations() [1/2]

const Poly_ListOfTriangulation& BRep_TFace::Triangulations ( ) const
inline

Returns the list of available face triangulations.

◆ Triangulations() [2/2]

void BRep_TFace::Triangulations ( const Poly_ListOfTriangulation theTriangulations,
const Handle< Poly_Triangulation > &  theActiveTriangulation 
)

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.


The documentation for this class was generated from the following file: