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:

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 Standard_Boolean Frenet=Standard_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.
Standard_Boolean	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 Standard_Boolean CurvilinearEquivalence=Standard_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 evalued 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 Standard_Integer NewMaxDegree)
	Define the maximum V degree of resulting surface.
void	SetMaxSegments (const Standard_Integer NewMaxSegments)
	Define the maximum number of spans in V-direction on resulting surface.
void	SetForceApproxC1 (const Standard_Boolean 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	Add (const TopoDS_Shape &Profile, const Standard_Boolean WithContact=Standard_False, const Standard_Boolean WithCorrection=Standard_False)
	Set an section. The correspondence with the spine, will be automatically performed.
void	Add (const TopoDS_Shape &Profile, const TopoDS_Vertex &Location, const Standard_Boolean WithContact=Standard_False, const Standard_Boolean WithCorrection=Standard_False)
	Set an section. The correspondence with the spine, is given by Location.
void	SetLaw (const TopoDS_Shape &Profile, const Handle< Law_Function > &L, const Standard_Boolean WithContact=Standard_False, const Standard_Boolean WithCorrection=Standard_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 Handle< Law_Function > &L, const TopoDS_Vertex &Location, const Standard_Boolean WithContact=Standard_False, const Standard_Boolean WithCorrection=Standard_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.
Standard_Boolean	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 Standard_Real Tol3d=1.0e-4, const Standard_Real BoundTol=1.0e-4, const Standard_Real TolAngular=1.0e-2)
void	SetTransition (const BRepFill_TransitionStyle Mode=BRepFill_Modified, const Standard_Real Angmin=1.0e-2, const Standard_Real Angmax=6.0)
	Set the Transition Mode to manage discontinuities on the sweep.
void	Simulate (const Standard_Integer NumberOfSection, TopTools_ListOfShape &Sections)
	Perform simulation of the sweep : Some Section are returned.
Standard_Boolean	Build ()
	Builds the resulting shape (redefined from MakeShape).
Standard_Boolean	MakeSolid ()
	Transform the sweeping Shell in Solid. If the section are not closed returns False.
const TopoDS_Shape &	Shape () const
	Returns the result Shape.
Standard_Real	ErrorOnSurface () const
const TopoDS_Shape &	FirstShape () const
	Returns the TopoDS Shape of the bottom of the sweep.
const TopoDS_Shape &	LastShape () const
	Returns the TopoDS Shape of the top of the sweep.
void	Profiles (TopTools_ListOfShape &theProfiles)
	Returns the list of original profiles.
const TopoDS_Wire &	Spine ()
	Returns the spine.
void	Generated (const TopoDS_Shape &S, TopTools_ListOfShape &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_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
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.
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.
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.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
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 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.

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 Standard_Boolean	WithContact = Standard_False,
		const Standard_Boolean	WithCorrection = Standard_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 Standard_Boolean	WithContact = Standard_False,
		const Standard_Boolean	WithCorrection = Standard_False )

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

Build()

Standard_Boolean BRepFill_PipeShell::Build

(

)

Builds the resulting shape (redefined from MakeShape).

DeleteProfile()

void BRepFill_PipeShell::DeleteProfile

(

const TopoDS_Shape &

Profile

)

Delete an section.

ErrorOnSurface()

Standard_Real 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,
		TopTools_ListOfShape &	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.

IsReady()

Standard_Boolean 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()

Standard_Boolean BRepFill_PipeShell::MakeSolid

(

)

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

Profiles()

void BRepFill_PipeShell::Profiles ( TopTools_ListOfShape & theProfiles )

inline

Returns the list of original profiles.

Set() [1/5]

void BRepFill_PipeShell::Set

(

const gp_Ax2 &

Axe

)

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

Set() [2/5]

void BRepFill_PipeShell::Set

(

const gp_Dir &

BiNormal

)

Set an fixed BiNormal direction to perform the sweeping.

Set() [3/5]

void BRepFill_PipeShell::Set

(

const Standard_Boolean

Frenet = Standard_False

)

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

Set() [4/5]

Standard_Boolean 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 Standard_Boolean	CurvilinearEquivalence = Standard_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 evalued 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 Standard_Boolean

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

SetLaw() [1/2]

void BRepFill_PipeShell::SetLaw	(	const TopoDS_Shape &	Profile,
		const Handle< Law_Function > &	L,
		const Standard_Boolean	WithContact = Standard_False,
		const Standard_Boolean	WithCorrection = Standard_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 Handle< Law_Function > &	L,
		const TopoDS_Vertex &	Location,
		const Standard_Boolean	WithContact = Standard_False,
		const Standard_Boolean	WithCorrection = Standard_False )

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

SetMaxDegree()

void BRepFill_PipeShell::SetMaxDegree

(

const Standard_Integer

NewMaxDegree

)

Define the maximum V degree of resulting surface.

SetMaxSegments()

void BRepFill_PipeShell::SetMaxSegments

(

const Standard_Integer

NewMaxSegments

)

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

SetTolerance()

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

SetTransition()

void BRepFill_PipeShell::SetTransition	(	const BRepFill_TransitionStyle	Mode = BRepFill_Modified,
		const Standard_Real	Angmin = 1.0e-2,
		const Standard_Real	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 Standard_Integer	NumberOfSection,
		TopTools_ListOfShape &	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:

• BRepFill_PipeShell.hxx