Describes algorithms for offsetting wires from a set of wires contained in a planar face. A MakeOffset object provides a framework for: More...

#include <BRepOffsetAPI_MakeOffset.hxx>

Inheritance diagram for BRepOffsetAPI_MakeOffset:

[legend]

Public Member Functions
	BRepOffsetAPI_MakeOffset ()
	Constructs an algorithm for creating an empty offset.
	BRepOffsetAPI_MakeOffset (const TopoDS_Face &Spine, const GeomAbs_JoinType Join=GeomAbs_Arc, const bool IsOpenResult=false)
	Constructs an algorithm for creating an algorithm to build parallels to the spine Spine.
void	Init (const TopoDS_Face &Spine, const GeomAbs_JoinType Join=GeomAbs_Arc, const bool IsOpenResult=false)
	Initializes the algorithm to construct parallels to the spine Spine. Join defines the type of parallel generated by the salient vertices of the spine. The default type is GeomAbs_Arc where the vertices generate sections of a circle. If join type is GeomAbs_Intersection, the edges that intersect in a salient vertex generate the edges prolonged until intersection.
	BRepOffsetAPI_MakeOffset (const TopoDS_Wire &Spine, const GeomAbs_JoinType Join=GeomAbs_Arc, const bool IsOpenResult=false)
void	Init (const GeomAbs_JoinType Join=GeomAbs_Arc, const bool IsOpenResult=false)
	Initialize the evaluation of Offsetting.
void	SetApprox (const bool ToApprox)
	Set approximation flag for conversion input contours into ones consisting of 2D circular arcs and 2D linear segments only.
void	AddWire (const TopoDS_Wire &Spine)
	Initializes the algorithm to construct parallels to the wire Spine.
void	Perform (const double Offset, const double Alt=0.0)
	Computes a parallel to the spine at distance Offset and at an altitude Alt from the plane of the spine in relation to the normal to the spine. Exceptions: StdFail_NotDone if the offset is not built.
void	Build (const Message_ProgressRange &theRange=Message_ProgressRange()) override
	Builds the resulting shape (redefined from MakeShape).
const NCollection_List< TopoDS_Shape > &	Generated (const TopoDS_Shape &S) override
	returns a list of the created shapes from the shape .
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.

Static Public Member Functions
static TopoDS_Face	ConvertFace (const TopoDS_Face &theFace, const double theAngleTolerance)
	Converts each wire of the face into contour consisting only of arcs and segments. New 3D curves are built too.

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 algorithms for offsetting wires from a set of wires contained in a planar face. A MakeOffset object provides a framework for:

defining the construction of an offset,
implementing the construction algorithm, and
consulting the result.

Constructor & Destructor Documentation

◆ BRepOffsetAPI_MakeOffset() [1/3]

BRepOffsetAPI_MakeOffset::BRepOffsetAPI_MakeOffset ( )

Constructs an algorithm for creating an empty offset.

◆ BRepOffsetAPI_MakeOffset() [2/3]

BRepOffsetAPI_MakeOffset::BRepOffsetAPI_MakeOffset	(	const TopoDS_Face &	Spine,
		const GeomAbs_JoinType	Join = GeomAbs_Arc,
		const bool	IsOpenResult = false )

Constructs an algorithm for creating an algorithm to build parallels to the spine Spine.

◆ BRepOffsetAPI_MakeOffset() [3/3]

BRepOffsetAPI_MakeOffset::BRepOffsetAPI_MakeOffset	(	const TopoDS_Wire &	Spine,
		const GeomAbs_JoinType	Join = GeomAbs_Arc,
		const bool	IsOpenResult = false )

Member Function Documentation

◆ AddWire()

void BRepOffsetAPI_MakeOffset::AddWire ( const TopoDS_Wire & Spine )

Initializes the algorithm to construct parallels to the wire Spine.

◆ Build()

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

overridevirtual

Builds the resulting shape (redefined from MakeShape).

Reimplemented from BRepBuilderAPI_MakeShape.

◆ ConvertFace()

TopoDS_Face BRepOffsetAPI_MakeOffset::ConvertFace	(	const TopoDS_Face &	theFace,
		const double	theAngleTolerance )

static

Converts each wire of the face into contour consisting only of arcs and segments. New 3D curves are built too.

◆ Generated()

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

overridevirtual

returns a list of the created shapes from the shape .

Reimplemented from BRepBuilderAPI_MakeShape.

◆ Init() [1/2]

void BRepOffsetAPI_MakeOffset::Init	(	const GeomAbs_JoinType	Join = GeomAbs_Arc,
		const bool	IsOpenResult = false )

Initialize the evaluation of Offsetting.

◆ Init() [2/2]

void BRepOffsetAPI_MakeOffset::Init	(	const TopoDS_Face &	Spine,
		const GeomAbs_JoinType	Join = GeomAbs_Arc,
		const bool	IsOpenResult = false )

Initializes the algorithm to construct parallels to the spine Spine. Join defines the type of parallel generated by the salient vertices of the spine. The default type is GeomAbs_Arc where the vertices generate sections of a circle. If join type is GeomAbs_Intersection, the edges that intersect in a salient vertex generate the edges prolonged until intersection.

◆ Perform()

void BRepOffsetAPI_MakeOffset::Perform	(	const double	Offset,
		const double	Alt = 0.0 )

Computes a parallel to the spine at distance Offset and at an altitude Alt from the plane of the spine in relation to the normal to the spine. Exceptions: StdFail_NotDone if the offset is not built.

◆ SetApprox()

void BRepOffsetAPI_MakeOffset::SetApprox ( const bool ToApprox )

Set approximation flag for conversion input contours into ones consisting of 2D circular arcs and 2D linear segments only.

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

BRepOffsetAPI_MakeOffset.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members