Perform 3D offset for the shape. More...

Inheritance diagram for GeomAlgoAPI_Offset:

Public Types
enum	BuilderType { Unknown , OCCT_BRepBuilderAPI_MakeShape , OCCT_BOPAlgo_Builder , OCCT_BRepOffset_MakeOffset }
	Builder type enum. More...

Public Member Functions
GEOMALGOAPI_EXPORT	GeomAlgoAPI_Offset (const GeomShapePtr &theShape, const double theOffsetValue)
	Perform simple offset. More...

GEOMALGOAPI_EXPORT	GeomAlgoAPI_Offset (const GeomShapePtr &theShape, const double theOffsetValue, const bool isPipeJoint)
	Perform 3d offset algorithm. More...

GEOMALGOAPI_EXPORT	GeomAlgoAPI_Offset (const GeomShapePtr &theShape, const ListOfShape &theFaces, const double theOffsetValue)
	Perform partial 3d offset algorithm. More...

GEOMALGOAPI_EXPORT	GeomAlgoAPI_Offset (const std::shared_ptr< GeomAPI_Pln > &thePlane, const GeomShapePtr &theEdgeOrWire, const double theOffsetValue, const GeomAlgoAPI_OffsetJoint theJoint=GeomAlgoAPI_OffsetJoint::KeepDistance, const bool theIsApprox=false)
	Perform 2d offset algorithm on the plane. More...

virtual GEOMALGOAPI_EXPORT void	generated (const GeomShapePtr theOldShape, ListOfShape &theNewShapes)

template<class T >
void	initialize (T *theBuilder, const BuilderType theBuilderType=OCCT_BRepBuilderAPI_MakeShape)
	Initializes internals. More...

virtual GEOMALGOAPI_EXPORT void	build ()
	Execute the algorithm. More...

GEOMALGOAPI_EXPORT bool	isDone () const

virtual GEOMALGOAPI_EXPORT const GeomShapePtr	shape () const

GEOMALGOAPI_EXPORT bool	isValid () const

GEOMALGOAPI_EXPORT std::shared_ptr< GeomAPI_DataMapOfShapeShape >	mapOfSubShapes () const

virtual GEOMALGOAPI_EXPORT void	modified (const GeomShapePtr theOldShape, ListOfShape &theNewShapes)
	Get a list of new shapes, modified from the given old shape. More...

GEOMALGOAPI_EXPORT void	modifiedCached (const GeomShapePtr theOldShape, ListOfShape &theNewShapes)
	Get a list of new shapes, modified from the given old shape. More...

virtual GEOMALGOAPI_EXPORT bool	isDeleted (const GeomShapePtr theOldShape)

virtual GEOMALGOAPI_EXPORT bool	check ()

virtual GEOMALGOAPI_EXPORT void	prepareNamingFaces ()
	Prepare the naming of faces. More...

GEOMALGOAPI_EXPORT std::map< std::string, GeomShapePtr >	getCreatedFaces ()

GEOMALGOAPI_EXPORT std::string	getError ()

GEOMALGOAPI_EXPORT bool	checkValid (std::string theMessage)
	Check the validity of the produced shape. More...

GEOMALGOAPI_EXPORT bool	isNewShapesCollected (GeomShapePtr theWholeOld, const int theShapeType)
	Optimization of access the new shapes by old shapes for the limited set of needed new shapes. More...

GEOMALGOAPI_EXPORT void	collectNewShapes (GeomShapePtr theWholeOld, const int theShapeType)
	Optimization of access the new shapes by old shapes for the limited set of needed new shapes. More...

GEOMALGOAPI_EXPORT void	cleanNewShapes (GeomShapePtr theWholeOld, const int theShapeType)
	Clean cached data, created by collectNewShapes() method, called with the same arguments. More...

GEOMALGOAPI_EXPORT GeomShapePtr	oldShapesForNew (GeomShapePtr theWholeOld, GeomShapePtr theNewShape, const int theShapeType)
	Optimization of access the new shapes by old shapes for the limited set of needed new shapes. More...

GEOMALGOAPI_EXPORT void	fixOrientation (GeomShapePtr &theShape)
	Replaces theShape with shape from myMap. More...

template<class T >
T *	implPtr ()
	Returns the pointer to the impl. More...

template<class T >
const T *	implPtr () const
	Returns the pointer to the impl. More...

template<class T >
const T &	impl () const
	Returns the reference object of the impl. More...

template<class T >
void	setImpl (T *theImpl)
	Updates the impl (deletes the old one) More...

GEOMAPI_EXPORT bool	empty () const
	Returns true if the impl is empty. More...

Protected Member Functions
GEOMALGOAPI_EXPORT void	setBuilderType (const BuilderType theBuilderType)
	Sets builder type. More...

GEOMALGOAPI_EXPORT void	setDone (const bool theFlag)
	Sets status of builder. More...

GEOMALGOAPI_EXPORT void	setShape (const GeomShapePtr theShape)
	Sets result shape. More...

bool	isValidForHistory (const GeomShapePtr theShape)

Protected Attributes
std::shared_ptr< GeomAPI_DataMapOfShapeShape >	myMap
	Data map to keep correct orientation of sub-shapes. More...

std::string	myError
	Error occurred during the execution of an algorithm. More...

std::map< std::string, GeomShapePtr >	myCreatedFaces
	Map of created faces with their name for naming. More...

Detailed Description

Perform 3D offset for the shape.

Member Enumeration Documentation

◆ BuilderType

enum GeomAlgoAPI_MakeShape::BuilderType

inherited

Builder type enum.

Constructor & Destructor Documentation

◆ GeomAlgoAPI_Offset() [1/4]

GeomAlgoAPI_Offset::GeomAlgoAPI_Offset	(	const GeomShapePtr &	theShape,
		const double	theOffsetValue
	)

Perform simple offset.

Parameters

[in]	theShape	base shape
[in]	theOffsetValue	offset distance, it can be negative

◆ GeomAlgoAPI_Offset() [2/4]

GeomAlgoAPI_Offset::GeomAlgoAPI_Offset	(	const GeomShapePtr &	theShape,
		const double	theOffsetValue,
		const bool	isPipeJoint
	)

Perform 3d offset algorithm.

Parameters

[in]	theShape	base shape
[in]	theOffsetValue	offset distance, it can be negative
[in]	isPipeJoint	type of joint of faces (pipes or intersections)

◆ GeomAlgoAPI_Offset() [3/4]

GeomAlgoAPI_Offset::GeomAlgoAPI_Offset	(	const GeomShapePtr &	theShape,
		const ListOfShape &	theFaces,
		const double	theOffsetValue
	)

Perform partial 3d offset algorithm.

Parameters

[in]	theShape	base shape
[in]	theFaces	list of faces to be offset
[in]	theOffsetValue	offset distance for selected faces, it can be negative

◆ GeomAlgoAPI_Offset() [4/4]

GeomAlgoAPI_Offset::GeomAlgoAPI_Offset	(	const std::shared_ptr< GeomAPI_Pln > &	thePlane,
		const GeomShapePtr &	theEdgeOrWire,
		const double	theOffsetValue,
		const GeomAlgoAPI_OffsetJoint	theJoint = `GeomAlgoAPI_OffsetJoint::KeepDistance`,
		const bool	theIsApprox = `false`
	)

Perform 2d offset algorithm on the plane.

Parameters

[in]	thePlane	base plane for all offsets
[in]	theEdgesOrWire	base shapes
[in]	theOffsetValue	offset distance, it can be negative
[in]	theJointType	type of joint of straight edges

Member Function Documentation

◆ generated()

void GeomAlgoAPI_Offset::generated	(	const GeomShapePtr	theOldShape,
		ListOfShape &	theNewShapes
	)

virtual

Returns: the list of shapes generated from the shape theShape.

Parameters

[in]	theOldShape	base shape.
[out]	theNewShapes	shapes generated from theShape. Does not cleared!

Reimplemented from GeomAlgoAPI_MakeShape.

◆ initialize()

template<class T >

void GeomAlgoAPI_MakeShape::initialize	(	T *	theBuilder,
		const BuilderType	theBuilderType = `OCCT_BRepBuilderAPI_MakeShape`
	)

inlineinherited

Initializes internals.

Parameters

[in]	theBuilder	pointer to the builder.
[in]	theBuilderType	builder type.

◆ build()

virtual GEOMALGOAPI_EXPORT void GeomAlgoAPI_MakeShape::build ( )

inlinevirtualinherited

Execute the algorithm.

Reimplemented in GeomAlgoAPI_Tube, GeomAlgoAPI_Torus, GeomAlgoAPI_Sphere, GeomAlgoAPI_Ellipsoid, GeomAlgoAPI_Cylinder, GeomAlgoAPI_ConeSegment, GeomAlgoAPI_Cone, and GeomAlgoAPI_Box.

◆ isDone()

bool GeomAlgoAPI_MakeShape::isDone ( ) const

inherited

Returns: status of builder.

◆ shape()

const GeomShapePtr GeomAlgoAPI_MakeShape::shape ( ) const

virtualinherited

Returns: a shape built by the shape construction algorithm.

Reimplemented in GeomAlgoAPI_MakeShapeList.

◆ isValid()

bool GeomAlgoAPI_MakeShape::isValid ( ) const

inherited

Returns: true if resulting shape is valid.

◆ mapOfSubShapes()

std::shared_ptr< GeomAPI_DataMapOfShapeShape > GeomAlgoAPI_MakeShape::mapOfSubShapes ( ) const

inherited

Returns: map of sub-shapes of the result. To be used for History keeping.

◆ modified()

void GeomAlgoAPI_MakeShape::modified	(	const GeomShapePtr	theOldShape,
		ListOfShape &	theNewShapes
	)

virtualinherited

Get a list of new shapes, modified from the given old shape.

Returns: the list of shapes modified from the shape theOldShape.

Parameters

[in]	theOldShape	base shape.
[out]	theNewShapes	shapes modified from theOldShape. Does not cleared!

Reimplemented in GeomAlgoAPI_UnifySameDomain, GeomAlgoAPI_Sewing, GeomAlgoAPI_MakeShapeCustom, GeomAlgoAPI_MakeShapeSet, GeomAlgoAPI_MakeShapeList, GeomAlgoAPI_MakeVolume, GeomAlgoAPI_Fillet1D, and GeomAlgoAPI_Boolean.

◆ modifiedCached()

void GeomAlgoAPI_MakeShape::modifiedCached	(	const GeomShapePtr	theOldShape,
		ListOfShape &	theNewShapes
	)

inherited

Get a list of new shapes, modified from the given old shape.

Works correctly only in case if the modifications are cached. Check this with isNewShapesCollected().

Returns: the list of shapes modified from the shape theOldShape.

Parameters

[in]	theOldShape	base shape.
[out]	theNewShapes	shapes modified from theOldShape. Does not cleared!

◆ isDeleted()

bool GeomAlgoAPI_MakeShape::isDeleted ( const GeomShapePtr theOldShape )

virtualinherited

Returns: true if theShape was deleted.

Parameters

[in] theOldShape base shape.

Reimplemented in GeomAlgoAPI_MakeShapeList, and GeomAlgoAPI_MakeShapeCustom.

◆ check()

virtual GEOMALGOAPI_EXPORT bool GeomAlgoAPI_MakeShape::check ( )

inlinevirtualinherited

Returns: true if the data were correct.

Reimplemented in GeomAlgoAPI_Tube, GeomAlgoAPI_Torus, GeomAlgoAPI_Sphere, GeomAlgoAPI_Ellipsoid, GeomAlgoAPI_Cylinder, GeomAlgoAPI_ConeSegment, GeomAlgoAPI_Cone, and GeomAlgoAPI_Box.

◆ prepareNamingFaces()

void GeomAlgoAPI_MakeShape::prepareNamingFaces ( )

virtualinherited

Prepare the naming of faces.

Reimplemented in GeomAlgoAPI_Box.

◆ getCreatedFaces()

GEOMALGOAPI_EXPORT std::map< std::string, GeomShapePtr > GeomAlgoAPI_MakeShape::getCreatedFaces ( )

inlineinherited

Returns: the list of created faces.

◆ getError()

GEOMALGOAPI_EXPORT std::string GeomAlgoAPI_MakeShape::getError ( )

inlineinherited

Returns: the error.

◆ checkValid()

bool GeomAlgoAPI_MakeShape::checkValid ( std::string theMessage )

inherited

Check the validity of the produced shape.

◆ isNewShapesCollected()

bool GeomAlgoAPI_MakeShape::isNewShapesCollected	(	GeomShapePtr	theWholeOld,
		const int	theShapeType
	)

inherited

Optimization of access the new shapes by old shapes for the limited set of needed new shapes.

Parameters

theWholeOld	the whole old shape
theShapeType	type of the sub-shapes that is used for optimization

Returns: true if optimization containers are already filled

◆ collectNewShapes()

void GeomAlgoAPI_MakeShape::collectNewShapes	(	GeomShapePtr	theWholeOld,
		const int	theShapeType
	)

inherited

Optimization of access the new shapes by old shapes for the limited set of needed new shapes.

Parameters

theWholeOld	the whole old shape
theShapeType	type of the sub-shapes that is used for optimization

Returns: true if optimization containers are already filled

◆ cleanNewShapes()

void GeomAlgoAPI_MakeShape::cleanNewShapes	(	GeomShapePtr	theWholeOld,
		const int	theShapeType
	)

inherited

Clean cached data, created by collectNewShapes() method, called with the same arguments.

Parameters

theWholeOld	the whole old shape
theShapeType	type of the sub-shapes that is used for optimization

◆ oldShapesForNew()

GeomShapePtr GeomAlgoAPI_MakeShape::oldShapesForNew	(	GeomShapePtr	theWholeOld,
		GeomShapePtr	theNewShape,
		const int	theShapeType
	)

inherited

Optimization of access the new shapes by old shapes for the limited set of needed new shapes.

Parameters

theWholeOld	the whole old shape
theNewShape	the whole new shape
theShapeType	type of the old sub-shapes

Returns: compound of all old shapes that were used for creation of the given new

◆ fixOrientation()

void GeomAlgoAPI_MakeShape::fixOrientation ( GeomShapePtr & theShape )

inherited

Replaces theShape with shape from myMap.

◆ setBuilderType()

void GeomAlgoAPI_MakeShape::setBuilderType ( const BuilderType theBuilderType )

protectedinherited

Sets builder type.

Parameters

[in] theBuilderType new builder type.

◆ setDone()

void GeomAlgoAPI_MakeShape::setDone ( const bool theFlag )

protectedinherited

Sets status of builder.

Parameters

[in] theFlag new status.

◆ setShape()

void GeomAlgoAPI_MakeShape::setShape ( const GeomShapePtr theShape )

protectedinherited

Sets result shape.

Parameters

[in] theShape new shape.

◆ isValidForHistory()

bool GeomAlgoAPI_MakeShape::isValidForHistory ( const GeomShapePtr theShape )

protectedinherited

Returns: true if passed shape is valid for history.

◆ implPtr() [1/2]

template<class T >

T* GeomAPI_Interface::implPtr ( )

inlineinherited

Returns the pointer to the impl.

◆ implPtr() [2/2]

template<class T >

const T* GeomAPI_Interface::implPtr ( ) const

inlineinherited

Returns the pointer to the impl.

◆ impl()

template<class T >

const T& GeomAPI_Interface::impl ( ) const

inlineinherited

Returns the reference object of the impl.

◆ setImpl()

template<class T >

void GeomAPI_Interface::setImpl ( T * theImpl )

inlineinherited

Updates the impl (deletes the old one)

◆ empty()

bool GeomAPI_Interface::empty ( ) const

inherited

Returns true if the impl is empty.

Field Documentation

◆ myMap

std::shared_ptr<GeomAPI_DataMapOfShapeShape> GeomAlgoAPI_MakeShape::myMap

protectedinherited

Data map to keep correct orientation of sub-shapes.

◆ myError

std::string GeomAlgoAPI_MakeShape::myError

protectedinherited

Error occurred during the execution of an algorithm.

◆ myCreatedFaces

std::map< std::string, GeomShapePtr > GeomAlgoAPI_MakeShape::myCreatedFaces

protectedinherited

Map of created faces with their name for naming.

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ BuilderType

Constructor & Destructor Documentation

◆ GeomAlgoAPI_Offset() [1/4]

◆ GeomAlgoAPI_Offset() [2/4]

◆ GeomAlgoAPI_Offset() [3/4]

◆ GeomAlgoAPI_Offset() [4/4]

Member Function Documentation

◆ generated()

◆ initialize()

◆ build()

◆ isDone()

◆ shape()

◆ isValid()

◆ mapOfSubShapes()

◆ modified()

◆ modifiedCached()

◆ isDeleted()

◆ check()

◆ prepareNamingFaces()

◆ getCreatedFaces()

◆ getError()

◆ checkValid()

◆ isNewShapesCollected()

◆ collectNewShapes()

◆ cleanNewShapes()

◆ oldShapesForNew()

◆ fixOrientation()

◆ setBuilderType()

◆ setDone()

◆ setShape()

◆ isValidForHistory()

◆ implPtr() [1/2]

◆ implPtr() [2/2]

◆ impl()

◆ setImpl()

◆ empty()

Field Documentation

◆ myMap

◆ myError

◆ myCreatedFaces