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:

Public Member Functions
	BRep_TFace ()
	Creates an empty TFace.
const occ::handle< Geom_Surface > &	Surface () const
	Returns face surface.
void	Surface (const occ::handle< Geom_Surface > &theSurface)
	Sets surface for this face.
const TopLoc_Location &	Location () const
	Returns the face location.
void	Location (const TopLoc_Location &theLocation)
	Sets the location for this face.
double	Tolerance () const
	Returns the face tolerance.
void	Tolerance (const double theTolerance)
	Sets the tolerance for this face.
bool	NaturalRestriction () const
	Returns TRUE if the boundary of this face is known to be the parametric space (Umin, UMax, VMin, VMax).
void	NaturalRestriction (const bool theRestriction)
	Sets the flag that is TRUE if the boundary of this face is known to be the parametric space.
const occ::handle< Poly_Triangulation > &	Triangulation (const Poly_MeshPurpose thePurpose=Poly_MeshPurpose_NONE) const
	Returns the triangulation of this face according to the mesh purpose.
void	Triangulation (const occ::handle< Poly_Triangulation > &theTriangulation, const bool theToReset=true)
	Sets input triangulation for this face.
occ::handle< TopoDS_TShape >	EmptyCopy () const override
	Returns a copy of the TShape with no sub-shapes. The new Face has no triangulation.
void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.
const NCollection_List< occ::handle< Poly_Triangulation > > &	Triangulations () const
	Returns the list of available face triangulations.
void	Triangulations (const NCollection_List< occ::handle< Poly_Triangulation > > &theTriangulations, const occ::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.
int	NbTriangulations () const
	Returns number of available face triangulations.
const occ::handle< Poly_Triangulation > &	ActiveTriangulation () const
	Returns current active triangulation.
Public Member Functions inherited from TopoDS_TFace
	TopoDS_TFace ()
	Creates an empty TFace.
occ::handle< TopoDS_TShape >	EmptyCopy () const override
	Returns an empty TFace.
Public Member Functions inherited from TopoDS_TShape
bool	Free () const
	Returns the free flag.
void	Free (bool theIsFree)
	Sets the free flag.
bool	Locked () const
	Returns the locked flag.
void	Locked (bool theIsLocked)
	Sets the locked flag.
bool	Modified () const
	Returns the modification flag.
void	Modified (bool theIsModified)
	Sets the modification flag.
bool	Checked () const
	Returns the checked flag.
void	Checked (bool theIsChecked)
	Sets the checked flag.
bool	Orientable () const
	Returns the orientability flag.
void	Orientable (bool theIsOrientable)
	Sets the orientability flag.
bool	Closed () const
	Returns the closedness flag.
void	Closed (bool theIsClosed)
	Sets the closedness flag.
bool	Infinite () const
	Returns the infinity flag.
void	Infinite (bool theIsInfinite)
	Sets the infinity flag.
bool	Convex () const
	Returns the convexness flag.
void	Convex (bool theIsConvex)
	Sets the convexness flag.
TopAbs_ShapeEnum	ShapeType () const
	Returns the type as a term of the ShapeEnum enum: VERTEX, EDGE, WIRE, FACE, SHELL, SOLID, COMPSOLID, COMPOUND. The type is embedded in the lower 4 bits of the state.
int	NbChildren () const
	Returns the number of direct sub-shapes (children).
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
Standard_Transient *	This () 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from TopoDS_TShape
enum	BitLayout : uint16_t {   Bits_ShapeType_Mask = 0x000F , Bits_ShapeType_Shift = 0 , Bit_Free = 0x0010 , Bit_Modified = 0x0020 ,   Bit_Checked = 0x0040 , Bit_Orientable = 0x0080 , Bit_Closed = 0x0100 , Bit_Infinite = 0x0200 ,   Bit_Convex = 0x0400 , Bit_Locked = 0x0800 , Bits_Reserved = 0xF000 }
	Bit layout for compact state storage. Bits 0-3 store the TopAbs_ShapeEnum value (0-8). Bits 4-11 store boolean flags. Bits 12-15 are reserved for future use. More...
typedef void	base_type
	Returns a type descriptor about this object.
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.
Protected Member Functions inherited from TopoDS_TShape
	TopoDS_TShape (TopAbs_ShapeEnum theType)
	Constructs a TShape with the given shape type. Default flags: Free = true, Modified = true, Orientable = true.
void	setBit (uint16_t theBit, bool theIsOn)
	Set a bit flag.

Detailed Description

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.

Constructor & Destructor Documentation

BRep_TFace()

BRep_TFace::BRep_TFace

(

)

Creates an empty TFace.

Member Function Documentation

ActiveTriangulation()

const occ::handle< Poly_Triangulation > & BRep_TFace::ActiveTriangulation ( ) const

inline

Returns current active triangulation.

DumpJson()

void BRep_TFace::DumpJson ( Standard_OStream & theOStream, int theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from TopoDS_TShape.

EmptyCopy()

occ::handle< TopoDS_TShape > BRep_TFace::EmptyCopy ( ) const

overridevirtual

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

Implements TopoDS_TShape.

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]

bool 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 bool theRestriction )

inline

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

NbTriangulations()

int BRep_TFace::NbTriangulations ( ) const

inline

Returns number of available face triangulations.

Surface() [1/2]

const occ::handle< Geom_Surface > & BRep_TFace::Surface ( ) const

inline

Returns face surface.

Surface() [2/2]

void BRep_TFace::Surface ( const occ::handle< Geom_Surface > & theSurface )

inline

Sets surface for this face.

Tolerance() [1/2]

double BRep_TFace::Tolerance ( ) const

inline

Returns the face tolerance.

Tolerance() [2/2]

void BRep_TFace::Tolerance ( const double theTolerance )

inline

Sets the tolerance for this face.

Triangulation() [1/2]

void BRep_TFace::Triangulation	(	const occ::handle< Poly_Triangulation > &	theTriangulation,
		const bool	theToReset = true )

Sets input triangulation for this face.

Parameters

[in]	theTriangulation	triangulation to be set
[in]	theToReset	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 occ::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]

thePurpose

a 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 NCollection_List< occ::handle< Poly_Triangulation > > & BRep_TFace::Triangulations ( ) const

inline

Returns the list of available face triangulations.

Triangulations() [2/2]

void BRep_TFace::Triangulations	(	const NCollection_List< occ::handle< Poly_Triangulation > > &	theTriangulations,
		const occ::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:

• BRep_TFace.hxx