Open CASCADE Technology  7.3.1.dev
Public Member Functions
BRepOffsetAPI_ThruSections Class Reference

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:
Inheritance graph
[legend]

Public Member Functions

 BRepOffsetAPI_ThruSections (const Standard_Boolean isSolid=Standard_False, const Standard_Boolean ruled=Standard_False, const Standard_Real pres3d=1.0e-06)
 Initializes an algorithm for building a shell or a solid passing through a set of sections, where: More...
 
void Init (const Standard_Boolean isSolid=Standard_False, const Standard_Boolean ruled=Standard_False, const Standard_Real pres3d=1.0e-06)
 Initializes this algorithm for building a shell or a solid passing through a set of sections, where: More...
 
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. More...
 
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. More...
 
void CheckCompatibility (const Standard_Boolean check=Standard_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. More...
 
void SetSmoothing (const Standard_Boolean UseSmoothing)
 Define the approximation algorithm. More...
 
void SetParType (const Approx_ParametrizationType ParType)
 Define the type of parametrization used in the approximation. More...
 
void SetContinuity (const GeomAbs_Shape C)
 Define the Continuity used in the approximation. More...
 
void SetCriteriumWeight (const Standard_Real W1, const Standard_Real W2, const Standard_Real W3)
 define the Weights associed to the criterium used in the optimization. More...
 
void SetMaxDegree (const Standard_Integer MaxDeg)
 Define the maximal U degree of result surface. More...
 
Approx_ParametrizationType ParType () const
 returns the type of parametrization used in the approximation More...
 
GeomAbs_Shape Continuity () const
 returns the Continuity used in the approximation More...
 
Standard_Integer MaxDegree () const
 returns the maximal U degree of result surface More...
 
Standard_Boolean UseSmoothing () const
 Define the approximation algorithm. More...
 
void CriteriumWeight (Standard_Real &W1, Standard_Real &W2, Standard_Real &W3) const
 returns the Weights associed to the criterium used in the optimization. More...
 
virtual void Build () override
 This is called by Shape(). It does nothing but may be redefined. More...
 
const TopoDS_ShapeFirstShape () const
 Returns the TopoDS Shape of the bottom of the loft if solid. More...
 
const TopoDS_ShapeLastShape () const
 Returns the TopoDS Shape of the top of the loft if solid. More...
 
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 More...
 
virtual const TopTools_ListOfShapeGenerated (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). More...
 
const TopTools_ListOfShapeWires () const
 Returns the list of original wires. More...
 
- Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual const TopoDS_ShapeShape ()
 Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built. More...
 
 operator TopoDS_Shape ()
 
virtual const TopTools_ListOfShapeModified (const TopoDS_Shape &S)
 Returns the list of shapes modified from the shape <S>. More...
 
virtual Standard_Boolean IsDeleted (const TopoDS_Shape &S)
 Returns true if the shape S has been deleted. More...
 
- Public Member Functions inherited from BRepBuilderAPI_Command
virtual ~BRepBuilderAPI_Command ()
 
virtual Standard_Boolean IsDone () const
 
void Check () const
 Raises NotDone if done is false. More...
 

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. More...
 
void Done ()
 Set done to true. More...
 
void NotDone ()
 Set done to false. More...
 
- Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape myShape
 
TopTools_ListOfShape 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 Standard_Boolean  isSolid = Standard_False,
const Standard_Boolean  ruled = Standard_False,
const Standard_Real  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()

virtual void BRepOffsetAPI_ThruSections::Build ( )
overridevirtual

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

Reimplemented from BRepBuilderAPI_MakeShape.

◆ CheckCompatibility()

void BRepOffsetAPI_ThruSections::CheckCompatibility ( const Standard_Boolean  check = Standard_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 ( Standard_Real W1,
Standard_Real W2,
Standard_Real 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()

virtual const TopTools_ListOfShape& 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

◆ Init()

void BRepOffsetAPI_ThruSections::Init ( const Standard_Boolean  isSolid = Standard_False,
const Standard_Boolean  ruled = Standard_False,
const Standard_Real  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.

◆ LastShape()

const TopoDS_Shape& BRepOffsetAPI_ThruSections::LastShape ( ) const

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

◆ MaxDegree()

Standard_Integer 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 Standard_Real  W1,
const Standard_Real  W2,
const Standard_Real  W3 
)

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

if Wi <= 0

◆ SetMaxDegree()

void BRepOffsetAPI_ThruSections::SetMaxDegree ( const Standard_Integer  MaxDeg)

Define the maximal U degree of result surface.

◆ SetParType()

void BRepOffsetAPI_ThruSections::SetParType ( const Approx_ParametrizationType  ParType)

Define the type of parametrization used in the approximation.

◆ SetSmoothing()

void BRepOffsetAPI_ThruSections::SetSmoothing ( const Standard_Boolean  UseSmoothing)

Define the approximation algorithm.

◆ UseSmoothing()

Standard_Boolean BRepOffsetAPI_ThruSections::UseSmoothing ( ) const

Define the approximation algorithm.

◆ Wires()

const TopTools_ListOfShape& BRepOffsetAPI_ThruSections::Wires ( ) const
inline

Returns the list of original wires.


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