Describes functions to build a loft. This is a shell or a solid passing through a set of sections in a given sequence. Usually sections are wires, but the first and the last sections may be vertices (punctual sections). More...

#include <BRepOffsetAPI_ThruSections.hxx>

Inheritance diagram for BRepOffsetAPI_ThruSections:

[legend]

Public Member Functions
	BRepOffsetAPI_ThruSections (const bool isSolid=false, const bool ruled=false, const double pres3d=1.0e-06)
	Initializes an algorithm for building a shell or a solid passing through a set of sections, where:

void	Init (const bool isSolid=false, const bool ruled=false, const double pres3d=1.0e-06)
	Initializes this algorithm for building a shell or a solid passing through a set of sections, where:

void	AddWire (const TopoDS_Wire &wire)
	Adds the wire wire to the set of sections through which the shell or solid is built. Use the Build function to construct the shape.

void	AddVertex (const TopoDS_Vertex &aVertex)
	Adds the vertex Vertex (punctual section) to the set of sections through which the shell or solid is built. A vertex may be added to the set of sections only as first or last section. At least one wire must be added to the set of sections by the method AddWire. Use the Build function to construct the shape.

void	CheckCompatibility (const bool check=true)
	Sets/unsets the option to compute origin and orientation on wires to avoid twisted results and update wires to have same number of edges.

void	SetSmoothing (const bool UseSmoothing)
	Define the approximation algorithm.

void	SetParType (const Approx_ParametrizationType ParType)
	Define the type of parametrization used in the approximation.

void	SetContinuity (const GeomAbs_Shape C)
	Define the Continuity used in the approximation.

void	SetCriteriumWeight (const double W1, const double W2, const double W3)
	define the Weights associed to the criterium used in the optimization.

void	SetMaxDegree (const int MaxDeg)
	Define the maximal U degree of result surface.

Approx_ParametrizationType	ParType () const
	returns the type of parametrization used in the approximation

GeomAbs_Shape	Continuity () const
	returns the Continuity used in the approximation

int	MaxDegree () const
	returns the maximal U degree of result surface

bool	UseSmoothing () const
	Define the approximation algorithm.

void	CriteriumWeight (double &W1, double &W2, double &W3) const
	returns the Weights associed to the criterium used in the optimization.

void	Build (const Message_ProgressRange &theRange=Message_ProgressRange()) override
	This is called by Shape(). It does nothing but may be redefined.

const TopoDS_Shape &	FirstShape () const
	Returns the TopoDS Shape of the bottom of the loft if solid.

const TopoDS_Shape &	LastShape () const
	Returns the TopoDS Shape of the top of the loft if solid.

TopoDS_Shape	GeneratedFace (const TopoDS_Shape &Edge) const
	if Ruled Returns the Face generated by each edge except the last wire if smoothed Returns the Face generated by each edge of the first wire

void	SetMutableInput (const bool theIsMutableInput)
	Sets the mutable input state. If true then the input profile can be modified inside the thrusection operation. Default value is true.

const NCollection_List< TopoDS_Shape > &	Generated (const TopoDS_Shape &S) override
	Returns a list of new shapes generated from the shape S by the shell-generating algorithm. This function is redefined from BRepBuilderAPI_MakeShape::Generated. S can be an edge or a vertex of a given Profile (see methods AddWire and AddVertex).

const NCollection_List< TopoDS_Shape > &	Wires () const
	Returns the list of original wires.

bool	IsMutableInput () const
	Returns the current mutable input state.

BRepFill_ThruSectionErrorStatus	GetStatus () const
	Returns the status of thrusection operation.

Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual const TopoDS_Shape &	Shape ()
	Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built.

	operator TopoDS_Shape ()

virtual const NCollection_List< TopoDS_Shape > &	Modified (const TopoDS_Shape &S)
	Returns the list of shapes modified from the shape .

virtual bool	IsDeleted (const TopoDS_Shape &S)
	Returns true if the shape S has been deleted.

Public Member Functions inherited from BRepBuilderAPI_Command
virtual	~BRepBuilderAPI_Command ()

virtual bool	IsDone () const

void	Check () const
	Raises NotDone if done is false.

Additional Inherited Members
Protected Member Functions inherited from BRepBuilderAPI_MakeShape
	BRepBuilderAPI_MakeShape ()

Protected Member Functions inherited from BRepBuilderAPI_Command
	BRepBuilderAPI_Command ()
	Set done to False.

void	Done ()
	Set done to true.

void	NotDone ()
	Set done to false.

Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape	myShape

NCollection_List< TopoDS_Shape >	myGenerated

Detailed Description

Describes functions to build a loft. This is a shell or a solid passing through a set of sections in a given sequence. Usually sections are wires, but the first and the last sections may be vertices (punctual sections).

Constructor & Destructor Documentation

◆ BRepOffsetAPI_ThruSections()

BRepOffsetAPI_ThruSections::BRepOffsetAPI_ThruSections	(	const bool	isSolid = false,
		const bool	ruled = false,
		const double	pres3d = 1.0e-06 )

Initializes an algorithm for building a shell or a solid passing through a set of sections, where:

isSolid is set to true if the construction algorithm is required to build a solid or to false if it is required to build a shell (the default value),
ruled is set to true if the faces generated between the edges of two consecutive wires are ruled surfaces or to false (the default value) if they are smoothed out by approximation,
pres3d defines the precision criterion used by the approximation algorithm; the default value is 1.0e-6. Use AddWire and AddVertex to define the successive sections of the shell or solid to be built.

Member Function Documentation

◆ AddVertex()

void BRepOffsetAPI_ThruSections::AddVertex ( const TopoDS_Vertex & aVertex )

Adds the vertex Vertex (punctual section) to the set of sections through which the shell or solid is built. A vertex may be added to the set of sections only as first or last section. At least one wire must be added to the set of sections by the method AddWire. Use the Build function to construct the shape.

◆ AddWire()

void BRepOffsetAPI_ThruSections::AddWire ( const TopoDS_Wire & wire )

Adds the wire wire to the set of sections through which the shell or solid is built. Use the Build function to construct the shape.

◆ Build()

void BRepOffsetAPI_ThruSections::Build ( const Message_ProgressRange & theRange = Message_ProgressRange() )

overridevirtual

This is called by Shape(). It does nothing but may be redefined.

Reimplemented from BRepBuilderAPI_MakeShape.

◆ CheckCompatibility()

void BRepOffsetAPI_ThruSections::CheckCompatibility ( const bool check = true )

Sets/unsets the option to compute origin and orientation on wires to avoid twisted results and update wires to have same number of edges.

◆ Continuity()

GeomAbs_Shape BRepOffsetAPI_ThruSections::Continuity ( ) const

returns the Continuity used in the approximation

◆ CriteriumWeight()

void BRepOffsetAPI_ThruSections::CriteriumWeight	(	double &	W1,
		double &	W2,
		double &	W3 ) const

returns the Weights associed to the criterium used in the optimization.

◆ FirstShape()

const TopoDS_Shape & BRepOffsetAPI_ThruSections::FirstShape ( ) const

Returns the TopoDS Shape of the bottom of the loft if solid.

◆ Generated()

const NCollection_List< TopoDS_Shape > & BRepOffsetAPI_ThruSections::Generated ( const TopoDS_Shape & S )

overridevirtual

Returns a list of new shapes generated from the shape S by the shell-generating algorithm. This function is redefined from BRepBuilderAPI_MakeShape::Generated. S can be an edge or a vertex of a given Profile (see methods AddWire and AddVertex).

Reimplemented from BRepBuilderAPI_MakeShape.

◆ GeneratedFace()

TopoDS_Shape BRepOffsetAPI_ThruSections::GeneratedFace ( const TopoDS_Shape & Edge ) const

if Ruled Returns the Face generated by each edge except the last wire if smoothed Returns the Face generated by each edge of the first wire

◆ GetStatus()

BRepFill_ThruSectionErrorStatus BRepOffsetAPI_ThruSections::GetStatus ( ) const

inline

Returns the status of thrusection operation.

◆ Init()

void BRepOffsetAPI_ThruSections::Init	(	const bool	isSolid = false,
		const bool	ruled = false,
		const double	pres3d = 1.0e-06 )

Initializes this algorithm for building a shell or a solid passing through a set of sections, where:

isSolid is set to true if this construction algorithm is required to build a solid or to false if it is required to build a shell. false is the default value;
ruled is set to true if the faces generated between the edges of two consecutive wires are ruled surfaces or to false (the default value) if they are smoothed out by approximation,
pres3d defines the precision criterion used by the approximation algorithm; the default value is 1.0e-6. Use AddWire and AddVertex to define the successive sections of the shell or solid to be built.

◆ IsMutableInput()

bool BRepOffsetAPI_ThruSections::IsMutableInput ( ) const

Returns the current mutable input state.

◆ LastShape()

const TopoDS_Shape & BRepOffsetAPI_ThruSections::LastShape ( ) const

Returns the TopoDS Shape of the top of the loft if solid.

◆ MaxDegree()

int BRepOffsetAPI_ThruSections::MaxDegree ( ) const

returns the maximal U degree of result surface

◆ ParType()

Approx_ParametrizationType BRepOffsetAPI_ThruSections::ParType ( ) const

returns the type of parametrization used in the approximation

◆ SetContinuity()

void BRepOffsetAPI_ThruSections::SetContinuity ( const GeomAbs_Shape C )

Define the Continuity used in the approximation.

◆ SetCriteriumWeight()

void BRepOffsetAPI_ThruSections::SetCriteriumWeight	(	const double	W1,
		const double	W2,
		const double	W3 )

define the Weights associed to the criterium used in the optimization.

if Wi <= 0

◆ SetMaxDegree()

void BRepOffsetAPI_ThruSections::SetMaxDegree ( const int MaxDeg )

Define the maximal U degree of result surface.

◆ SetMutableInput()

void BRepOffsetAPI_ThruSections::SetMutableInput ( const bool theIsMutableInput )

Sets the mutable input state. If true then the input profile can be modified inside the thrusection operation. Default value is true.

◆ SetParType()

void BRepOffsetAPI_ThruSections::SetParType ( const Approx_ParametrizationType ParType )

Define the type of parametrization used in the approximation.

◆ SetSmoothing()

void BRepOffsetAPI_ThruSections::SetSmoothing ( const bool UseSmoothing )

Define the approximation algorithm.

◆ UseSmoothing()

bool BRepOffsetAPI_ThruSections::UseSmoothing ( ) const