BRepFeat_SplitShape Class Reference

One of the most significant aspects of BRepFeat functionality is the use of local operations as opposed to global ones. In a global operation, you would first construct a form of the type you wanted in your final feature, and then remove matter so that it could fit into your initial basis object. In a local operation, however, you specify the domain of the feature construction with aspects of the shape on which the feature is being created. These semantics are expressed in terms of a member shape of the basis shape from which - or up to which - matter will be added or removed. As a result, local operations make calculations simpler and faster than global operations. In BRepFeat, the semantics of local operations define features constructed from a contour or a part of the basis shape referred to as the tool. In a SplitShape object, wires or edges of a face in the basis shape to be used as a part of the feature are cut out and projected to a plane outside or inside the basis shape. By rebuilding the initial shape incorporating the edges and the faces of the tool, protrusion or depression features can be constructed. More...

#include <BRepFeat_SplitShape.hxx>

Inheritance diagram for BRepFeat_SplitShape:

Public Member Functions
	BRepFeat_SplitShape ()
	Empty constructor.
	BRepFeat_SplitShape (const TopoDS_Shape &S)
	Creates the process with the shape .
bool	Add (const NCollection_Sequence< TopoDS_Shape > &theEdges)
	Add splitting edges or wires for whole initial shape without additional specification edge->face, edge->edge This method puts edge on the corresponding faces from initial shape.
void	Init (const TopoDS_Shape &S)
	Initializes the process on the shape .
void	SetCheckInterior (const bool ToCheckInterior)
	Set the flag of check internal intersections default value is True (to check).
void	Add (const TopoDS_Wire &W, const TopoDS_Face &F)
	Adds the wire <W> on the face <F>. Raises NoSuchObject if <F> does not belong to the original shape.
void	Add (const TopoDS_Edge &E, const TopoDS_Face &F)
	Adds the edge <E> on the face <F>.
void	Add (const TopoDS_Compound &Comp, const TopoDS_Face &F)
	Adds the compound <Comp> on the face <F>. The compound <Comp> must consist of edges lying on the face <F>. If edges are geometrically connected, they must be connected topologically, i.e. they must share common vertices.
void	Add (const TopoDS_Edge &E, const TopoDS_Edge &EOn)
	Adds the edge <E> on the existing edge <EOn>.
const NCollection_List< TopoDS_Shape > &	DirectLeft () const
	Returns the faces which are the left of the projected wires.
const NCollection_List< TopoDS_Shape > &	Left () const
	Returns the faces of the "left" part on the shape. (It is build from DirectLeft, with the faces connected to this set, and so on...). Raises NotDone if IsDone returns <false>.
const NCollection_List< TopoDS_Shape > &	Right () const
	Returns the faces of the "right" part on the shape.
void	Build (const Message_ProgressRange &theRange=Message_ProgressRange()) override
	Builds the cut and the resulting faces and edges as well.
bool	IsDeleted (const TopoDS_Shape &S) override
	Returns true if the shape has been deleted.
const NCollection_List< TopoDS_Shape > &	Modified (const TopoDS_Shape &F) override
	Returns the list of generated Faces.
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 > &	Generated (const TopoDS_Shape &S)
	Returns the list of shapes generated from the shape .
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

One of the most significant aspects of BRepFeat functionality is the use of local operations as opposed to global ones. In a global operation, you would first construct a form of the type you wanted in your final feature, and then remove matter so that it could fit into your initial basis object. In a local operation, however, you specify the domain of the feature construction with aspects of the shape on which the feature is being created. These semantics are expressed in terms of a member shape of the basis shape from which - or up to which - matter will be added or removed. As a result, local operations make calculations simpler and faster than global operations. In BRepFeat, the semantics of local operations define features constructed from a contour or a part of the basis shape referred to as the tool. In a SplitShape object, wires or edges of a face in the basis shape to be used as a part of the feature are cut out and projected to a plane outside or inside the basis shape. By rebuilding the initial shape incorporating the edges and the faces of the tool, protrusion or depression features can be constructed.

Constructor & Destructor Documentation

BRepFeat_SplitShape() [1/2]

BRepFeat_SplitShape::BRepFeat_SplitShape

(

)

Empty constructor.

BRepFeat_SplitShape() [2/2]

BRepFeat_SplitShape::BRepFeat_SplitShape

(

const TopoDS_Shape &

S

)

Creates the process with the shape .

Member Function Documentation

Add() [1/5]

bool BRepFeat_SplitShape::Add

(

const NCollection_Sequence< TopoDS_Shape > &

theEdges

)

Add splitting edges or wires for whole initial shape without additional specification edge->face, edge->edge This method puts edge on the corresponding faces from initial shape.

Add() [2/5]

void BRepFeat_SplitShape::Add	(	const TopoDS_Compound &	Comp,
		const TopoDS_Face &	F )

Adds the compound <Comp> on the face <F>. The compound <Comp> must consist of edges lying on the face <F>. If edges are geometrically connected, they must be connected topologically, i.e. they must share common vertices.

Raises NoSuchObject if <F> does not belong to the original shape.

Add() [3/5]

void BRepFeat_SplitShape::Add	(	const TopoDS_Edge &	E,
		const TopoDS_Edge &	EOn )

Adds the edge <E> on the existing edge <EOn>.

Add() [4/5]

void BRepFeat_SplitShape::Add	(	const TopoDS_Edge &	E,
		const TopoDS_Face &	F )

Adds the edge <E> on the face <F>.

Add() [5/5]

void BRepFeat_SplitShape::Add	(	const TopoDS_Wire &	W,
		const TopoDS_Face &	F )

Adds the wire <W> on the face <F>. Raises NoSuchObject if <F> does not belong to the original shape.

Build()

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

overridevirtual

Builds the cut and the resulting faces and edges as well.

Reimplemented from BRepBuilderAPI_MakeShape.

DirectLeft()

const NCollection_List< TopoDS_Shape > & BRepFeat_SplitShape::DirectLeft

(

)

const

Returns the faces which are the left of the projected wires.

Init()

void BRepFeat_SplitShape::Init

(

const TopoDS_Shape &

S

)

Initializes the process on the shape .

IsDeleted()

bool BRepFeat_SplitShape::IsDeleted ( const TopoDS_Shape & S )

overridevirtual

Returns true if the shape has been deleted.

Reimplemented from BRepBuilderAPI_MakeShape.

Left()

const NCollection_List< TopoDS_Shape > & BRepFeat_SplitShape::Left

(

)

const

Returns the faces of the "left" part on the shape. (It is build from DirectLeft, with the faces connected to this set, and so on...). Raises NotDone if IsDone returns <false>.

Modified()

const NCollection_List< TopoDS_Shape > & BRepFeat_SplitShape::Modified ( const TopoDS_Shape & F )

overridevirtual

Returns the list of generated Faces.

Reimplemented from BRepBuilderAPI_MakeShape.

Right()

const NCollection_List< TopoDS_Shape > & BRepFeat_SplitShape::Right

(

)

const

Returns the faces of the "right" part on the shape.

SetCheckInterior()

void BRepFeat_SplitShape::SetCheckInterior

(

const bool

ToCheckInterior

)

Set the flag of check internal intersections default value is True (to check).

---

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

• BRepFeat_SplitShape.hxx