Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions
BRepFill_PipeShell Class Reference

Computes a topological shell using some wires (spines and profiles) and displacement option Perform general sweeping construction. More...

#include <BRepFill_PipeShell.hxx>

Inheritance diagram for BRepFill_PipeShell:
Inheritance graph
[legend]

Public Member Functions

 BRepFill_PipeShell (const TopoDS_Wire &Spine)
 Set an sweep's mode If no mode are set, the mode used in MakePipe is used.
 
void Set (const bool Frenet=false)
 Set an Frenet or an CorrectedFrenet trihedron to perform the sweeping.
 
void SetDiscrete ()
 Set a Discrete trihedron to perform the sweeping.
 
void Set (const gp_Ax2 &Axe)
 Set an fixed trihedron to perform the sweeping all sections will be parallel.
 
void Set (const gp_Dir &BiNormal)
 Set an fixed BiNormal direction to perform the sweeping.
 
bool Set (const TopoDS_Shape &SpineSupport)
 Set support to the spine to define the BiNormal at the spine, like the normal the surfaces. Warning: To be effective, Each edge of the <spine> must have an representation on one face of<SpineSupport>
 
void Set (const TopoDS_Wire &AuxiliarySpine, const bool CurvilinearEquivalence=true, const BRepFill_TypeOfContact KeepContact=BRepFill_NoContact)
 Set an auxiliary spine to define the Normal For each Point of the Spine P, an Point Q is evaluated on <AuxiliarySpine> If <CurvilinearEquivalence> Q split <AuxiliarySpine> with the same length ratio than P split <Spline>. Else the plan define by P and the tangent to the <Spine> intersect <AuxiliarySpine> in Q. If <KeepContact> equals BRepFill_NoContact: The Normal is defined by the vector PQ. If <KeepContact> equals BRepFill_Contact: The Normal is defined to achieve that the sweeped section is in contact to the auxiliarySpine. The width of section is constant all along the path. In other words, the auxiliary spine lies on the swept surface, but not necessarily is a boundary of this surface. However, the auxiliary spine has to be close enough to the main spine to provide intersection with any section all along the path. If <KeepContact> equals BRepFill_ContactOnBorder: The auxiliary spine becomes a boundary of the swept surface and the width of section varies along the path.
 
void SetMaxDegree (const int NewMaxDegree)
 Define the maximum V degree of resulting surface.
 
void SetMaxSegments (const int NewMaxSegments)
 Define the maximum number of spans in V-direction on resulting surface.
 
void SetForceApproxC1 (const bool ForceApproxC1)
 Set the flag that indicates attempt to approximate a C1-continuous surface if a swept surface proved to be C0. Give section to sweep. Possibilities are:
 
void SetIsBuildHistory (const bool theIsBuildHistory)
 Sets the build history flag. If set to True, the pipe shell will store the history of the sections and the spine, which can be used for further modifications or analysis.
 
bool IsBuildHistory () const
 Returns the build history flag. If True, the pipe shell stores the history of the sections and the spine.
 
void Add (const TopoDS_Shape &Profile, const bool WithContact=false, const bool WithCorrection=false)
 Set an section. The correspondence with the spine, will be automatically performed.
 
void Add (const TopoDS_Shape &Profile, const TopoDS_Vertex &Location, const bool WithContact=false, const bool WithCorrection=false)
 Set an section. The correspondence with the spine, is given by Location.
 
void SetLaw (const TopoDS_Shape &Profile, const occ::handle< Law_Function > &L, const bool WithContact=false, const bool WithCorrection=false)
 Set an section and an homotetic law. The homotetie's centers is given by point on the <Spine>.
 
void SetLaw (const TopoDS_Shape &Profile, const occ::handle< Law_Function > &L, const TopoDS_Vertex &Location, const bool WithContact=false, const bool WithCorrection=false)
 Set an section and an homotetic law. The homotetie center is given by point on the <Spine>
 
void DeleteProfile (const TopoDS_Shape &Profile)
 Delete an section.
 
bool IsReady () const
 Say if <me> is ready to build the shape return False if <me> do not have section definition.
 
GeomFill_PipeError GetStatus () const
 Get a status, when Simulate or Build failed.
 
void SetTolerance (const double Tol3d=1.0e-4, const double BoundTol=1.0e-4, const double TolAngular=1.0e-2)
 
void SetTransition (const BRepFill_TransitionStyle Mode=BRepFill_Modified, const double Angmin=1.0e-2, const double Angmax=6.0)
 Set the Transition Mode to manage discontinuities on the sweep.
 
void Simulate (const int NumberOfSection, NCollection_List< TopoDS_Shape > &Sections)
 Perform simulation of the sweep: Some Section are returned.
 
bool Build ()
 Builds the resulting shape (redefined from MakeShape).
 
bool MakeSolid ()
 Transform the sweeping Shell in Solid. If the section are not closed returns False.
 
const TopoDS_ShapeShape () const
 Returns the result Shape.
 
double ErrorOnSurface () const
 
const TopoDS_ShapeFirstShape () const
 Returns the TopoDS Shape of the bottom of the sweep.
 
const TopoDS_ShapeLastShape () const
 Returns the TopoDS Shape of the top of the sweep.
 
void Profiles (NCollection_List< TopoDS_Shape > &theProfiles)
 Returns the list of original profiles.
 
const TopoDS_WireSpine ()
 Returns the spine.
 
void Generated (const TopoDS_Shape &S, NCollection_List< TopoDS_Shape > &L)
 Returns the list of shapes generated from the shape .
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (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_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.
 
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 Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_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.
 

Detailed Description

Computes a topological shell using some wires (spines and profiles) and displacement option Perform general sweeping construction.

Constructor & Destructor Documentation

◆ BRepFill_PipeShell()

BRepFill_PipeShell::BRepFill_PipeShell ( const TopoDS_Wire & Spine)

Set an sweep's mode If no mode are set, the mode used in MakePipe is used.

Member Function Documentation

◆ Add() [1/2]

void BRepFill_PipeShell::Add ( const TopoDS_Shape & Profile,
const bool WithContact = false,
const bool WithCorrection = false )

Set an section. The correspondence with the spine, will be automatically performed.

◆ Add() [2/2]

void BRepFill_PipeShell::Add ( const TopoDS_Shape & Profile,
const TopoDS_Vertex & Location,
const bool WithContact = false,
const bool WithCorrection = false )

Set an section. The correspondence with the spine, is given by Location.

◆ Build()

bool BRepFill_PipeShell::Build ( )

Builds the resulting shape (redefined from MakeShape).

◆ DeleteProfile()

void BRepFill_PipeShell::DeleteProfile ( const TopoDS_Shape & Profile)

Delete an section.

◆ ErrorOnSurface()

double BRepFill_PipeShell::ErrorOnSurface ( ) const

◆ FirstShape()

const TopoDS_Shape & BRepFill_PipeShell::FirstShape ( ) const

Returns the TopoDS Shape of the bottom of the sweep.

◆ Generated()

void BRepFill_PipeShell::Generated ( const TopoDS_Shape & S,
NCollection_List< TopoDS_Shape > & L )

Returns the list of shapes generated from the shape .

◆ GetStatus()

GeomFill_PipeError BRepFill_PipeShell::GetStatus ( ) const

Get a status, when Simulate or Build failed.

◆ IsBuildHistory()

bool BRepFill_PipeShell::IsBuildHistory ( ) const
inline

Returns the build history flag. If True, the pipe shell stores the history of the sections and the spine.

◆ IsReady()

bool BRepFill_PipeShell::IsReady ( ) const

Say if <me> is ready to build the shape return False if <me> do not have section definition.

◆ LastShape()

const TopoDS_Shape & BRepFill_PipeShell::LastShape ( ) const

Returns the TopoDS Shape of the top of the sweep.

◆ MakeSolid()

bool BRepFill_PipeShell::MakeSolid ( )

Transform the sweeping Shell in Solid. If the section are not closed returns False.

◆ Profiles()

void BRepFill_PipeShell::Profiles ( NCollection_List< TopoDS_Shape > & theProfiles)
inline

Returns the list of original profiles.

◆ Set() [1/5]

void BRepFill_PipeShell::Set ( const bool Frenet = false)

Set an Frenet or an CorrectedFrenet trihedron to perform the sweeping.

◆ Set() [2/5]

void BRepFill_PipeShell::Set ( const gp_Ax2 & Axe)

Set an fixed trihedron to perform the sweeping all sections will be parallel.

◆ Set() [3/5]

void BRepFill_PipeShell::Set ( const gp_Dir & BiNormal)

Set an fixed BiNormal direction to perform the sweeping.

◆ Set() [4/5]

bool BRepFill_PipeShell::Set ( const TopoDS_Shape & SpineSupport)

Set support to the spine to define the BiNormal at the spine, like the normal the surfaces. Warning: To be effective, Each edge of the <spine> must have an representation on one face of<SpineSupport>

◆ Set() [5/5]

void BRepFill_PipeShell::Set ( const TopoDS_Wire & AuxiliarySpine,
const bool CurvilinearEquivalence = true,
const BRepFill_TypeOfContact KeepContact = BRepFill_NoContact )

Set an auxiliary spine to define the Normal For each Point of the Spine P, an Point Q is evaluated on <AuxiliarySpine> If <CurvilinearEquivalence> Q split <AuxiliarySpine> with the same length ratio than P split <Spline>. Else the plan define by P and the tangent to the <Spine> intersect <AuxiliarySpine> in Q. If <KeepContact> equals BRepFill_NoContact: The Normal is defined by the vector PQ. If <KeepContact> equals BRepFill_Contact: The Normal is defined to achieve that the sweeped section is in contact to the auxiliarySpine. The width of section is constant all along the path. In other words, the auxiliary spine lies on the swept surface, but not necessarily is a boundary of this surface. However, the auxiliary spine has to be close enough to the main spine to provide intersection with any section all along the path. If <KeepContact> equals BRepFill_ContactOnBorder: The auxiliary spine becomes a boundary of the swept surface and the width of section varies along the path.

◆ SetDiscrete()

void BRepFill_PipeShell::SetDiscrete ( )

Set a Discrete trihedron to perform the sweeping.

◆ SetForceApproxC1()

void BRepFill_PipeShell::SetForceApproxC1 ( const bool ForceApproxC1)

Set the flag that indicates attempt to approximate a C1-continuous surface if a swept surface proved to be C0. Give section to sweep. Possibilities are:

  • Give one or several profile
  • Give one profile and an homotetic law.
  • Automatic compute of correspondence between profile, and section on the sweeped shape
  • correspondence between profile, and section on the sweeped shape defined by a vertex of the spine

◆ SetIsBuildHistory()

void BRepFill_PipeShell::SetIsBuildHistory ( const bool theIsBuildHistory)
inline

Sets the build history flag. If set to True, the pipe shell will store the history of the sections and the spine, which can be used for further modifications or analysis.

◆ SetLaw() [1/2]

void BRepFill_PipeShell::SetLaw ( const TopoDS_Shape & Profile,
const occ::handle< Law_Function > & L,
const bool WithContact = false,
const bool WithCorrection = false )

Set an section and an homotetic law. The homotetie's centers is given by point on the <Spine>.

◆ SetLaw() [2/2]

void BRepFill_PipeShell::SetLaw ( const TopoDS_Shape & Profile,
const occ::handle< Law_Function > & L,
const TopoDS_Vertex & Location,
const bool WithContact = false,
const bool WithCorrection = false )

Set an section and an homotetic law. The homotetie center is given by point on the <Spine>

◆ SetMaxDegree()

void BRepFill_PipeShell::SetMaxDegree ( const int NewMaxDegree)

Define the maximum V degree of resulting surface.

◆ SetMaxSegments()

void BRepFill_PipeShell::SetMaxSegments ( const int NewMaxSegments)

Define the maximum number of spans in V-direction on resulting surface.

◆ SetTolerance()

void BRepFill_PipeShell::SetTolerance ( const double Tol3d = 1.0e-4,
const double BoundTol = 1.0e-4,
const double TolAngular = 1.0e-2 )

◆ SetTransition()

void BRepFill_PipeShell::SetTransition ( const BRepFill_TransitionStyle Mode = BRepFill_Modified,
const double Angmin = 1.0e-2,
const double Angmax = 6.0 )

Set the Transition Mode to manage discontinuities on the sweep.

◆ Shape()

const TopoDS_Shape & BRepFill_PipeShell::Shape ( ) const

Returns the result Shape.

◆ Simulate()

void BRepFill_PipeShell::Simulate ( const int NumberOfSection,
NCollection_List< TopoDS_Shape > & Sections )

Perform simulation of the sweep: Some Section are returned.

◆ Spine()

const TopoDS_Wire & BRepFill_PipeShell::Spine ( )
inline

Returns the spine.


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