BOPAlgo_MakePeriodic is the tool for making an arbitrary shape periodic in 3D space in specified directions. More...

#include <BOPAlgo_MakePeriodic.hxx>

Inheritance diagram for BOPAlgo_MakePeriodic:

Data Structures
struct	PeriodicityParams

Public Member Functions

Constructor

Empty constructor

BOPAlgo_MakePeriodic ()

Setting the shape to make it periodic

Sets the shape to make it periodic.

Parameters

[in] theShape The shape to make periodic.

void SetShape (const TopoDS_Shape &theShape)

Setters/Getters for periodicity parameters structure

Sets the periodicity parameters.

Parameters

[in] theParams Periodicity parameters

void SetPeriodicityParameters (const PeriodicityParams &theParams)

const PeriodicityParams & PeriodicityParameters () const

Methods for setting/getting periodicity info using ID as a direction

Sets the flag to make the shape periodic in specified direction:

0 - X direction;
1 - Y direction;
2 - Z direction.

Parameters

[in]	theDirectionID	The direction's ID;
[in]	theIsPeriodic	Flag defining periodicity in given direction;
[in]	thePeriod	Required period in given direction.

void MakePeriodic (const Standard_Integer theDirectionID, const Standard_Boolean theIsPeriodic, const Standard_Real thePeriod=0.0)

Returns the info about Periodicity of the shape in specified direction.

Standard_Boolean IsPeriodic (const Standard_Integer theDirectionID) const

Returns the info about Periodicity of the shape in specified direction.

Standard_Real Period (const Standard_Integer theDirectionID) const

Returns the Period of the shape in specified direction.

Named methods for setting/getting info about shape's periodicity

Sets the flag to make the shape periodic in X direction.

Parameters

[in]	theIsPeriodic	Flag defining periodicity in X direction;
[in]	thePeriod	Required period in X direction.

void MakeXPeriodic (const Standard_Boolean theIsPeriodic, const Standard_Real thePeriod=0.0)

Returns the info about periodicity of the shape in X direction.

Standard_Boolean IsXPeriodic () const

Returns the info about periodicity of the shape in X direction.

Standard_Real XPeriod () const

Returns the XPeriod of the shape.

void MakeYPeriodic (const Standard_Boolean theIsPeriodic, const Standard_Real thePeriod=0.0)

Sets the flag to make the shape periodic in Y direction.

Standard_Boolean IsYPeriodic () const

Returns the info about periodicity of the shape in Y direction.

Standard_Real YPeriod () const

Returns the YPeriod of the shape.

void MakeZPeriodic (const Standard_Boolean theIsPeriodic, const Standard_Real thePeriod=0.0)

Sets the flag to make the shape periodic in Z direction.

Standard_Boolean IsZPeriodic () const

Returns the info about periodicity of the shape in Z direction.

Standard_Real ZPeriod () const

Returns the ZPeriod of the shape.

Methods for setting/getting trimming info taking Direction ID as a parameter

Defines whether the input shape is already trimmed in specified direction to fit the period in this direction. Direction is defined by an ID:

0 - X direction;
1 - Y direction;
2 - Z direction.

If the shape is not trimmed it is required to set the first parameter of the period in that direction. The algorithm will make the shape fit into the period.

Before calling this method, the shape has to be set to be periodic in this direction.

Parameters

[in]	theDirectionID	The direction's ID;
[in]	theIsTrimmed	The flag defining trimming of the shape in given direction;
[in]	theFirst	The first periodic parameter in the given direction.

void SetTrimmed (const Standard_Integer theDirectionID, const Standard_Boolean theIsTrimmed, const Standard_Real theFirst=0.0)

Returns whether the input shape was trimmed in the specified direction.

Standard_Boolean IsInputTrimmed (const Standard_Integer theDirectionID) const

Returns whether the input shape was trimmed in the specified direction.

Standard_Real PeriodFirst (const Standard_Integer theDirectionID) const

Returns the first periodic parameter in the specified direction.

Named methods for setting/getting trimming info

Defines whether the input shape is already trimmed in X direction to fit the X period. If the shape is not trimmed it is required to set the first parameter for the X period. The algorithm will make the shape fit into the period.

Before calling this method, the shape has to be set to be periodic in this direction.

Parameters

[in]	theIsTrimmed	Flag defining whether the shape is already trimmed in X direction to fit the X period;
[in]	theFirst	The first X periodic parameter.

void SetXTrimmed (const Standard_Boolean theIsTrimmed, const Standard_Boolean theFirst=0.0)

Returns whether the input shape was already trimmed for X period.

Standard_Boolean IsInputXTrimmed () const

Returns whether the input shape was already trimmed for X period.

Standard_Real XPeriodFirst () const

Returns the first parameter for the X period.

void SetYTrimmed (const Standard_Boolean theIsTrimmed, const Standard_Boolean theFirst=0.0)

Defines whether the input shape is already trimmed in Y direction to fit the Y period. If the shape is not trimmed it is required to set the first parameter for the Y period. The algorithm will make the shape fit into the period.

Standard_Boolean IsInputYTrimmed () const

Returns whether the input shape was already trimmed for Y period.

Standard_Real YPeriodFirst () const

Returns the first parameter for the Y period.

void SetZTrimmed (const Standard_Boolean theIsTrimmed, const Standard_Boolean theFirst=0.0)

Defines whether the input shape is already trimmed in Z direction to fit the Z period. If the shape is not trimmed it is required to set the first parameter for the Z period. The algorithm will make the shape fit into the period.

Standard_Boolean IsInputZTrimmed () const

Returns whether the input shape was already trimmed for Z period.

Standard_Real ZPeriodFirst () const

Returns the first parameter for the Z period.

Performing the operation

Makes the shape periodic in necessary directions

void Perform ()

Using the algorithm to repeat the shape

Performs repetition of the shape in specified direction required number of times. Negative value of times means that the repetition should be perform in negative direction. Makes the repeated shape a base for following repetitions.

Parameters

[in]	theDirectionID	The direction's ID;
[in]	theTimes	Requested number of repetitions.

const TopoDS_Shape & RepeatShape (const Standard_Integer theDirectionID, const Standard_Integer theTimes)

Repeats the shape in X direction specified number of times. Negative value of times means that the repetition should be perform in negative X direction. Makes the repeated shape a base for following repetitions.

const TopoDS_Shape & XRepeat (const Standard_Integer theTimes)

Repeats the shape in X direction specified number of times. Negative value of times means that the repetition should be perform in negative X direction. Makes the repeated shape a base for following repetitions.

const TopoDS_Shape & YRepeat (const Standard_Integer theTimes)

Repeats the shape in Y direction specified number of times. Negative value of times means that the repetition should be perform in negative Y direction. Makes the repeated shape a base for following repetitions.

const TopoDS_Shape & ZRepeat (const Standard_Integer theTimes)

Repeats the shape in Z direction specified number of times. Negative value of times means that the repetition should be perform in negative Z direction. Makes the repeated shape a base for following repetitions.

Starting the repetitions over

Returns the repeated shape

const TopoDS_Shape & RepeatedShape () const

Clears all performed repetitions. The next repetition will be performed on the base shape.

void ClearRepetitions ()

Clears all performed repetitions. The next repetition will be performed on the base shape.

Obtaining the result shape

Returns the resulting periodic shape

const TopoDS_Shape & Shape () const

Getting the identical shapes

Returns the identical shapes for the given shape located on the opposite periodic side. Returns empty list in case the shape has no twin.

Parameters

[in] theS Shape to get the twins for.

const TopTools_ListOfShape & GetTwins (const TopoDS_Shape &theS) const

Getting the History of the algorithm

Returns the History of the algorithm

const Handle< BRepTools_History > & History () const

Clearing the algorithm from previous runs

Clears the algorithm from previous runs

void Clear ()

Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared.

Public Member Functions inherited from BOPAlgo_Options

BOPAlgo_Options ()

Empty constructor.

BOPAlgo_Options (const Handle< NCollection_BaseAllocator > &theAllocator)

Constructor with allocator.

virtual ~BOPAlgo_Options ()

Destructor.

const Handle< NCollection_BaseAllocator > & Allocator () const

Returns allocator.

void AddError (const Handle< Message_Alert > &theAlert)

Adds the alert as error (fail)

void AddWarning (const Handle< Message_Alert > &theAlert)

Adds the alert as warning.

Standard_Boolean HasErrors () const

Returns true if algorithm has failed.

Standard_Boolean HasError (const Handle< Standard_Type > &theType) const

Returns true if algorithm has generated error of specified type.

Standard_Boolean HasWarnings () const

Returns true if algorithm has generated some warning alerts.

Standard_Boolean HasWarning (const Handle< Standard_Type > &theType) const

Returns true if algorithm has generated warning of specified type.

const Handle< Message_Report > & GetReport () const

Returns report collecting all errors and warnings.

void DumpErrors (Standard_OStream &theOS) const

Dumps the error status into the given stream.

void DumpWarnings (Standard_OStream &theOS) const

Dumps the warning statuses into the given stream.

void ClearWarnings ()

Clears the warnings of the algorithm.

void SetFuzzyValue (const Standard_Real theFuzz)

Sets the additional tolerance.

Standard_Real FuzzyValue () const

Returns the additional tolerance.

void SetUseOBB (const Standard_Boolean theUseOBB)

Enables/Disables the usage of OBB.

Standard_Boolean UseOBB () const

Returns the flag defining usage of OBB.

void SetRunParallel (const Standard_Boolean theFlag)

Set the flag of parallel processing if <theFlag> is true the parallel processing is switched on if <theFlag> is false the parallel processing is switched off.

Standard_Boolean RunParallel () const

Returns the flag of parallel processing.

Static Public Member Functions
Conversion of the integer to ID of periodic direction
Converts the integer to ID of periodic direction
static Standard_Integer	ToDirectionID (const Standard_Integer theDirectionID)

static Standard_Boolean	GetParallelMode ()
	Gets the global parallel mode.

static void	SetParallelMode (const Standard_Boolean theNewMode)
	Sets the global parallel mode.

Protected Member Functions
Protected methods performing the operation
Checks the validity of input data
void	CheckData ()
	Trims the shape to fit to the periodic bounds.

void	Trim ()
	Trims the shape to fit to the periodic bounds.

void	MakeIdentical ()
	Makes the shape identical on opposite sides.

void	SplitNegative ()
	Splits the negative side of the shape with the geometry located on the positive side copying the geometry from positive side to the negative.

void	SplitPositive ()
	Splits the positive side of the shape with the geometry located on the negative side of the shape. Ensures that the geometries on the opposite sides will be identical. Associates the identical opposite sub-shapes.

void	SplitShape (const TopTools_ListOfShape &theTools, Handle< BRepTools_History > theSplitShapeHistory=NULL, Handle< BRepTools_History > theSplitToolsHistory=NULL)
	Splits the shape by the given tools, copying the geometry of coinciding parts from the given tools to the split shape.

void	UpdateTwins (const BRepTools_History &theTranslationHistory, const BRepTools_History &theGluingHistory)
	Updates the map of twins after periodic shape repetition.

Standard_Boolean	UserBreak (const Message_ProgressScope &thePS)
	Adds error to the report if the break signal was caught. Returns true in this case, false otherwise.

Protected Attributes
Fields
TopoDS_Shape	myInputShape
	Input shape to make periodic.

PeriodicityParams	myPeriodicityParams
	Periodicity parameters.

TopoDS_Shape	myShape
	Resulting periodic shape (base for repetitions)

TopoDS_Shape	myRepeatedShape
	Resulting shape after making repetitions of the base.

Standard_Real	myRepeatPeriod [3]
	XYZ repeat period.

TopTools_DataMapOfShapeListOfShape	myRepeatedTwins
	Map of associations of the identical sub-shapes after repetition of the periodic shape.

TopTools_DataMapOfShapeListOfShape	myTwins
	Map of associations of the identical sub-shapes located on the opposite sides of the shape.

Handle< BRepTools_History >	mySplitHistory
	Split history - history of shapes modification after the split for making the shape periodic.

Handle< BRepTools_History >	myHistory
	Final history of shapes modifications (to include the history of shape repetition)

Handle< NCollection_BaseAllocator >	myAllocator
	Enables/Disables the usage of OBB.

Handle< Message_Report >	myReport
	Enables/Disables the usage of OBB.

Standard_Boolean	myRunParallel
	Enables/Disables the usage of OBB.

Standard_Real	myFuzzyValue
	Enables/Disables the usage of OBB.

Standard_Boolean	myUseOBB
	Enables/Disables the usage of OBB.

Detailed Description

BOPAlgo_MakePeriodic is the tool for making an arbitrary shape periodic in 3D space in specified directions.

Periodicity of the shape means that the shape can be repeated in any periodic direction any number of times without creation of the new geometry or splits.

The idea is to make the shape look identical on the opposite sides of the periodic directions, so when translating the copy of a shape on the period there will be no coinciding parts of different dimensions.

If necessary the algorithm will trim the shape to fit it into the requested period by splitting it by the planes limiting the shape's requested period.

For making the shape periodic in certain direction the algorithm performs the following steps:

Creates the copy of the shape and moves it on the period into negative side of the requested direction;
Splits the negative side of the shape by the moved copy, ensuring copying of the geometry from positive side to negative;
Creates the copy of the shape (with already split negative side) and moves it on the period into the positive side of the requested direction;
Splits the positive side of the shape by the moved copy, ensuring copying of the geometry from negative side to positive.

The algorithm also associates the identical (or twin) shapes located on the opposite sides of the result shape. Using the GetTwins() method it is possible to get the twin shapes from the opposite sides.

Algorithm also provides the methods to repeat the periodic shape in periodic directions. The subsequent repetitions are performed on the repeated shape, thus repeating the shape two times in X direction will create result in three shapes (original plus two copies). Single subsequent repetition will result already in 6 shapes. The repetitions can be cleared and started over.

The algorithm supports History of shapes modifications, thus it is possible to track how the shape has been changed to make it periodic and what new shapes have been created during repetitions.

The algorithm supports the parallel processing mode, which allows faster completion of the operations.

The algorithm supports the Error/Warning system and returns the following alerts:

BOPAlgo_AlertNoPeriodicityRequired - Error alert is given if no periodicity has been requested in any direction;
BOPAlgo_AlertUnableToTrim - Error alert is given if the trimming of the shape for fitting it into requested period has failed;
BOPAlgo_AlertUnableToMakeIdentical - Error alert is given if splitting of the shape by its moved copies has failed;
BOPAlgo_AlertUnableToRepeat - Warning alert is given if the gluing of the repeated shapes has failed.

Example of usage of the algorithm:

TopoDS_Shape aShape = ...;                 // The shape to make periodic
Standard_Boolean bMakeXPeriodic = ...;     // Flag for making or not the shape periodic in X
direction Standard_Real aXPeriod = ...;              // X period for the shape Standard_Boolean
isXTrimmed = ...;         // Flag defining whether it is necessary to trimming
                                           // the shape to fit to X period
Standard_Real aXFirst = ...;               // Start of the X period
                                           // (really necessary only if the trimming is
                                           requested)
Standard_Boolean bRunParallel = ...;       // Parallel processing mode or single
 
BOPAlgo_MakePeriodic aPeriodicityMaker;                   // Periodicity maker
aPeriodicityMaker.SetShape(aShape);                       // Set the shape
aPeriodicityMaker.MakeXPeriodic(bMakePeriodic, aXPeriod); // Making the shape periodic in X
direction aPeriodicityMaker.SetTrimmed(isXTrimmed, aXFirst);        // Trim the shape to fit X
period aPeriodicityMaker.SetRunParallel(bRunParallel);           // Set the parallel processing
mode aPeriodicityMaker.Perform();                              // Performing the operation
 
if (aPeriodicityMaker.HasErrors())                        // Check for the errors
{
  // errors treatment
  Standard_SStream aSStream;
  aPeriodicityMaker.DumpErrors(aSStream);
  return;
}
if (aPeriodicityMaker.HasWarnings())                      // Check for the warnings
{
  // warnings treatment
  Standard_SStream aSStream;
  aPeriodicityMaker.DumpWarnings(aSStream);
}
const TopoDS_Shape& aPeriodicShape = aPeriodicityMaker.Shape(); // Result periodic shape
 
 
aPeriodicityMaker.XRepeat(2);                                    // Making repetitions
const TopoDS_Shape& aRepeat = aPeriodicityMaker.RepeatedShape(); // Getting the repeated shape
aPeriodicityMaker.ClearRepetitions();                            // Clearing the repetitions

Constructor & Destructor Documentation

◆ BOPAlgo_MakePeriodic()

BOPAlgo_MakePeriodic::BOPAlgo_MakePeriodic ( )

inline

Member Function Documentation

◆ CheckData()

void BOPAlgo_MakePeriodic::CheckData ( )

protected

Trims the shape to fit to the periodic bounds.

◆ Clear()

void BOPAlgo_MakePeriodic::Clear ( )

inlinevirtual

Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared.

Reimplemented from BOPAlgo_Options.

◆ ClearRepetitions()

void BOPAlgo_MakePeriodic::ClearRepetitions ( )

inline

Clears all performed repetitions. The next repetition will be performed on the base shape.

◆ GetTwins()

const TopTools_ListOfShape & BOPAlgo_MakePeriodic::GetTwins ( const TopoDS_Shape & theS ) const

inline

◆ History()

const Handle< BRepTools_History > & BOPAlgo_MakePeriodic::History ( ) const

inline

◆ IsInputTrimmed()

Standard_Boolean BOPAlgo_MakePeriodic::IsInputTrimmed ( const Standard_Integer theDirectionID ) const

inline

Returns whether the input shape was trimmed in the specified direction.

Parameters

[in] theDirectionID The direction's ID.

◆ IsInputXTrimmed()

Standard_Boolean BOPAlgo_MakePeriodic::IsInputXTrimmed ( ) const

inline

Returns whether the input shape was already trimmed for X period.

◆ IsInputYTrimmed()

Standard_Boolean BOPAlgo_MakePeriodic::IsInputYTrimmed ( ) const

inline

Returns whether the input shape was already trimmed for Y period.

◆ IsInputZTrimmed()

Standard_Boolean BOPAlgo_MakePeriodic::IsInputZTrimmed ( ) const

inline

Returns whether the input shape was already trimmed for Z period.

◆ IsPeriodic()

Standard_Boolean BOPAlgo_MakePeriodic::IsPeriodic ( const Standard_Integer theDirectionID ) const

inline

Returns the info about Periodicity of the shape in specified direction.

Parameters

[in] theDirectionID The direction's ID.

◆ IsXPeriodic()

Standard_Boolean BOPAlgo_MakePeriodic::IsXPeriodic ( ) const

inline

Returns the info about periodicity of the shape in X direction.

◆ IsYPeriodic()

Standard_Boolean BOPAlgo_MakePeriodic::IsYPeriodic ( ) const

inline

Returns the info about periodicity of the shape in Y direction.

◆ IsZPeriodic()

Standard_Boolean BOPAlgo_MakePeriodic::IsZPeriodic ( ) const

inline

Returns the info about periodicity of the shape in Z direction.

◆ MakeIdentical()

void BOPAlgo_MakePeriodic::MakeIdentical ( )

protected

Makes the shape identical on opposite sides.

◆ MakePeriodic()

void BOPAlgo_MakePeriodic::MakePeriodic	(	const Standard_Integer	theDirectionID,
		const Standard_Boolean	theIsPeriodic,
		const Standard_Real	thePeriod = 0.0 )

inline

Returns the info about Periodicity of the shape in specified direction.

Parameters

[in] theDirectionID The direction's ID.

◆ MakeXPeriodic()

void BOPAlgo_MakePeriodic::MakeXPeriodic	(	const Standard_Boolean	theIsPeriodic,
		const Standard_Real	thePeriod = 0.0 )

inline

Returns the info about periodicity of the shape in X direction.

◆ MakeYPeriodic()

void BOPAlgo_MakePeriodic::MakeYPeriodic	(	const Standard_Boolean	theIsPeriodic,
		const Standard_Real	thePeriod = 0.0 )

inline

Sets the flag to make the shape periodic in Y direction.

Parameters

[in]	theIsPeriodic	Flag defining periodicity in Y direction;
[in]	thePeriod	Required period in Y direction.

◆ MakeZPeriodic()

void BOPAlgo_MakePeriodic::MakeZPeriodic	(	const Standard_Boolean	theIsPeriodic,
		const Standard_Real	thePeriod = 0.0 )

inline

Sets the flag to make the shape periodic in Z direction.

Parameters

[in]	theIsPeriodic	Flag defining periodicity in Z direction;
[in]	thePeriod	Required period in Z direction.

◆ Perform()

void BOPAlgo_MakePeriodic::Perform ( )

◆ Period()

Standard_Real BOPAlgo_MakePeriodic::Period ( const Standard_Integer theDirectionID ) const

inline

Returns the Period of the shape in specified direction.

Parameters

[in] theDirectionID The direction's ID.

◆ PeriodFirst()

Standard_Real BOPAlgo_MakePeriodic::PeriodFirst ( const Standard_Integer theDirectionID ) const

inline

Returns the first periodic parameter in the specified direction.

Parameters

[in] theDirectionID The direction's ID.

◆ PeriodicityParameters()

const PeriodicityParams & BOPAlgo_MakePeriodic::PeriodicityParameters ( ) const

inline

◆ RepeatedShape()

const TopoDS_Shape & BOPAlgo_MakePeriodic::RepeatedShape ( ) const

inline

Clears all performed repetitions. The next repetition will be performed on the base shape.

◆ RepeatShape()

const TopoDS_Shape & BOPAlgo_MakePeriodic::RepeatShape	(	const Standard_Integer	theDirectionID,
		const Standard_Integer	theTimes )

Repeats the shape in X direction specified number of times. Negative value of times means that the repetition should be perform in negative X direction. Makes the repeated shape a base for following repetitions.

Parameters

[in] theTimes Requested number of repetitions.

◆ SetPeriodicityParameters()

void BOPAlgo_MakePeriodic::SetPeriodicityParameters ( const PeriodicityParams & theParams )

inline

◆ SetShape()

void BOPAlgo_MakePeriodic::SetShape ( const TopoDS_Shape & theShape )

inline

◆ SetTrimmed()

void BOPAlgo_MakePeriodic::SetTrimmed	(	const Standard_Integer	theDirectionID,
		const Standard_Boolean	theIsTrimmed,
		const Standard_Real	theFirst = 0.0 )

inline

Returns whether the input shape was trimmed in the specified direction.

Parameters

[in] theDirectionID The direction's ID.

◆ SetXTrimmed()

void BOPAlgo_MakePeriodic::SetXTrimmed	(	const Standard_Boolean	theIsTrimmed,
		const Standard_Boolean	theFirst = 0.0 )

inline

Returns whether the input shape was already trimmed for X period.

◆ SetYTrimmed()

void BOPAlgo_MakePeriodic::SetYTrimmed	(	const Standard_Boolean	theIsTrimmed,
		const Standard_Boolean	theFirst = 0.0 )

inline

Defines whether the input shape is already trimmed in Y direction to fit the Y period. If the shape is not trimmed it is required to set the first parameter for the Y period. The algorithm will make the shape fit into the period.

Before calling this method, the shape has to be set to be periodic in this direction.

Parameters

[in]	theIsTrimmed	Flag defining whether the shape is already trimmed in Y direction to fit the Y period;
[in]	theFirst	The first Y periodic parameter.

◆ SetZTrimmed()

void BOPAlgo_MakePeriodic::SetZTrimmed	(	const Standard_Boolean	theIsTrimmed,
		const Standard_Boolean	theFirst = 0.0 )

inline

Defines whether the input shape is already trimmed in Z direction to fit the Z period. If the shape is not trimmed it is required to set the first parameter for the Z period. The algorithm will make the shape fit into the period.

Before calling this method, the shape has to be set to be periodic in this direction.

Parameters

[in]	theIsTrimmed	Flag defining whether the shape is already trimmed in Z direction to fit the Z period;
[in]	theFirst	The first Z periodic parameter.

◆ Shape()

const TopoDS_Shape & BOPAlgo_MakePeriodic::Shape ( ) const

inline

◆ SplitNegative()

void BOPAlgo_MakePeriodic::SplitNegative ( )

protected

Splits the negative side of the shape with the geometry located on the positive side copying the geometry from positive side to the negative.

◆ SplitPositive()

void BOPAlgo_MakePeriodic::SplitPositive ( )

protected

Splits the positive side of the shape with the geometry located on the negative side of the shape. Ensures that the geometries on the opposite sides will be identical. Associates the identical opposite sub-shapes.

◆ SplitShape()

void BOPAlgo_MakePeriodic::SplitShape	(	const TopTools_ListOfShape &	theTools,
		Handle< BRepTools_History >	theSplitShapeHistory = NULL,
		Handle< BRepTools_History >	theSplitToolsHistory = NULL )

protected

Splits the shape by the given tools, copying the geometry of coinciding parts from the given tools to the split shape.

Parameters

[in]	theTools	The tools to split the shape and take the geometry for coinciding parts.
[out]	theSplitShapeHistory	The history of shape split
[out]	theSplitToolsHistory	The history of tools modifications during the split

◆ ToDirectionID()

static Standard_Integer BOPAlgo_MakePeriodic::ToDirectionID ( const Standard_Integer theDirectionID )

inlinestatic

◆ Trim()

void BOPAlgo_MakePeriodic::Trim ( )

protected

Trims the shape to fit to the periodic bounds.

◆ UpdateTwins()

void BOPAlgo_MakePeriodic::UpdateTwins	(	const BRepTools_History &	theTranslationHistory,
		const BRepTools_History &	theGluingHistory )

protected

Updates the map of twins after periodic shape repetition.

Parameters

[in]	theTranslationHistory	The history of translation of the periodic shape.
[in]	theGluingHistory	The history of gluing of the repeated shapes.

◆ XPeriod()

Standard_Real BOPAlgo_MakePeriodic::XPeriod ( ) const

inline

Returns the XPeriod of the shape.

◆ XPeriodFirst()

Standard_Real BOPAlgo_MakePeriodic::XPeriodFirst ( ) const

inline

Returns the first parameter for the X period.

◆ XRepeat()

const TopoDS_Shape & BOPAlgo_MakePeriodic::XRepeat ( const Standard_Integer theTimes )

inline

Repeats the shape in X direction specified number of times. Negative value of times means that the repetition should be perform in negative X direction. Makes the repeated shape a base for following repetitions.

Parameters

[in] theTimes Requested number of repetitions.

◆ YPeriod()

Standard_Real BOPAlgo_MakePeriodic::YPeriod ( ) const

inline

Returns the YPeriod of the shape.

◆ YPeriodFirst()

Standard_Real BOPAlgo_MakePeriodic::YPeriodFirst ( ) const

inline

Returns the first parameter for the Y period.

◆ YRepeat()

const TopoDS_Shape & BOPAlgo_MakePeriodic::YRepeat ( const Standard_Integer theTimes )

inline

Repeats the shape in Y direction specified number of times. Negative value of times means that the repetition should be perform in negative Y direction. Makes the repeated shape a base for following repetitions.

Parameters

[in] theTimes Requested number of repetitions.

◆ ZPeriod()

Standard_Real BOPAlgo_MakePeriodic::ZPeriod ( ) const

inline

Returns the ZPeriod of the shape.

◆ ZPeriodFirst()

Standard_Real BOPAlgo_MakePeriodic::ZPeriodFirst ( ) const

inline

Returns the first parameter for the Z period.

◆ ZRepeat()

const TopoDS_Shape & BOPAlgo_MakePeriodic::ZRepeat ( const Standard_Integer theTimes )

inline

Repeats the shape in Z direction specified number of times. Negative value of times means that the repetition should be perform in negative Z direction. Makes the repeated shape a base for following repetitions.

Parameters

[in] theTimes Requested number of repetitions.

Field Documentation

◆ myHistory

Handle< BRepTools_History > BOPAlgo_MakePeriodic::myHistory

protected

Final history of shapes modifications (to include the history of shape repetition)

◆ myInputShape

TopoDS_Shape BOPAlgo_MakePeriodic::myInputShape

protected

Input shape to make periodic.

◆ myPeriodicityParams

PeriodicityParams BOPAlgo_MakePeriodic::myPeriodicityParams

protected

Periodicity parameters.

◆ myRepeatedShape

TopoDS_Shape BOPAlgo_MakePeriodic::myRepeatedShape

protected

Resulting shape after making repetitions of the base.

◆ myRepeatedTwins

TopTools_DataMapOfShapeListOfShape BOPAlgo_MakePeriodic::myRepeatedTwins

protected

Map of associations of the identical sub-shapes after repetition of the periodic shape.

◆ myRepeatPeriod

Standard_Real BOPAlgo_MakePeriodic::myRepeatPeriod[3]

protected

XYZ repeat period.

◆ myShape

TopoDS_Shape BOPAlgo_MakePeriodic::myShape

protected

Resulting periodic shape (base for repetitions)

◆ mySplitHistory

Handle< BRepTools_History > BOPAlgo_MakePeriodic::mySplitHistory

protected

Split history - history of shapes modification after the split for making the shape periodic.

◆ myTwins

TopTools_DataMapOfShapeListOfShape BOPAlgo_MakePeriodic::myTwins

protected

Map of associations of the identical sub-shapes located on the opposite sides of the shape.

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

BOPAlgo_MakePeriodic.hxx

Data Structures

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BOPAlgo_MakePeriodic()

Member Function Documentation

◆ CheckData()

◆ Clear()

◆ ClearRepetitions()

◆ GetTwins()

◆ History()

◆ IsInputTrimmed()

◆ IsInputXTrimmed()

◆ IsInputYTrimmed()

◆ IsInputZTrimmed()

◆ IsPeriodic()

◆ IsXPeriodic()

◆ IsYPeriodic()

◆ IsZPeriodic()

◆ MakeIdentical()

◆ MakePeriodic()

◆ MakeXPeriodic()

◆ MakeYPeriodic()

◆ MakeZPeriodic()

◆ Perform()

◆ Period()

◆ PeriodFirst()

◆ PeriodicityParameters()

◆ RepeatedShape()

◆ RepeatShape()

◆ SetPeriodicityParameters()

◆ SetShape()

◆ SetTrimmed()

◆ SetXTrimmed()

◆ SetYTrimmed()

◆ SetZTrimmed()

◆ Shape()

◆ SplitNegative()

◆ SplitPositive()

◆ SplitShape()

◆ ToDirectionID()

◆ Trim()

◆ UpdateTwins()

◆ XPeriod()

◆ XPeriodFirst()

◆ XRepeat()

◆ YPeriod()

◆ YPeriodFirst()

◆ YRepeat()

◆ ZPeriod()

◆ ZPeriodFirst()

◆ ZRepeat()

Field Documentation

◆ myHistory

◆ myInputShape

◆ myPeriodicityParams

◆ myRepeatedShape

◆ myRepeatedTwins

◆ myRepeatPeriod

◆ myShape

◆ mySplitHistory

◆ myTwins