Open CASCADE Technology
7.7.0
|
BOPAlgo_MakePeriodic is the tool for making an arbitrary shape periodic in 3D space in specified directions. More...
#include <BOPAlgo_MakePeriodic.hxx>
Data Structures | |
struct | PeriodicityParams |
Structure to keep all periodicity parameters: More... | |
Public Member Functions | |
Constructor | |
BOPAlgo_MakePeriodic () | |
Empty constructor. More... | |
Setting the shape to make it periodic | |
void | SetShape (const TopoDS_Shape &theShape) |
Sets the shape to make it periodic. More... | |
Setters/Getters for periodicity parameters structure | |
void | SetPeriodicityParameters (const PeriodicityParams &theParams) |
Sets the periodicity parameters. More... | |
const PeriodicityParams & | PeriodicityParameters () const |
Sets the periodicity parameters. More... | |
Methods for setting/getting periodicity info using ID as a direction | |
void | MakePeriodic (const Standard_Integer theDirectionID, const Standard_Boolean theIsPeriodic, const Standard_Real thePeriod=0.0) |
Sets the flag to make the shape periodic in specified direction: More... | |
Standard_Boolean | IsPeriodic (const Standard_Integer theDirectionID) const |
Returns the info about Periodicity of the shape in specified direction. More... | |
Standard_Real | Period (const Standard_Integer theDirectionID) const |
Returns the Period of the shape in specified direction. More... | |
Named methods for setting/getting info about shape's periodicity | |
void | MakeXPeriodic (const Standard_Boolean theIsPeriodic, const Standard_Real thePeriod=0.0) |
Sets the flag to make the shape periodic in X direction. More... | |
Standard_Boolean | IsXPeriodic () const |
Returns the info about periodicity of the shape in X direction. More... | |
Standard_Real | XPeriod () const |
Returns the XPeriod of the shape. More... | |
void | MakeYPeriodic (const Standard_Boolean theIsPeriodic, const Standard_Real thePeriod=0.0) |
Sets the flag to make the shape periodic in Y direction. More... | |
Standard_Boolean | IsYPeriodic () const |
Returns the info about periodicity of the shape in Y direction. More... | |
Standard_Real | YPeriod () const |
Returns the YPeriod of the shape. More... | |
void | MakeZPeriodic (const Standard_Boolean theIsPeriodic, const Standard_Real thePeriod=0.0) |
Sets the flag to make the shape periodic in Z direction. More... | |
Standard_Boolean | IsZPeriodic () const |
Returns the info about periodicity of the shape in Z direction. More... | |
Standard_Real | ZPeriod () const |
Returns the ZPeriod of the shape. More... | |
Methods for setting/getting trimming info taking Direction ID as a parameter | |
void | SetTrimmed (const Standard_Integer theDirectionID, const Standard_Boolean theIsTrimmed, const Standard_Real theFirst=0.0) |
Defines whether the input shape is already trimmed in specified direction to fit the period in this direction. Direction is defined by an ID: More... | |
Standard_Boolean | IsInputTrimmed (const Standard_Integer theDirectionID) const |
Returns whether the input shape was trimmed in the specified direction. More... | |
Standard_Real | PeriodFirst (const Standard_Integer theDirectionID) const |
Returns the first periodic parameter in the specified direction. More... | |
Named methods for setting/getting trimming info | |
void | SetXTrimmed (const Standard_Boolean theIsTrimmed, const Standard_Boolean theFirst=0.0) |
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. More... | |
Standard_Boolean | IsInputXTrimmed () const |
Returns whether the input shape was already trimmed for X period. More... | |
Standard_Real | XPeriodFirst () const |
Returns the first parameter for the X period. More... | |
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. More... | |
Standard_Boolean | IsInputYTrimmed () const |
Returns whether the input shape was already trimmed for Y period. More... | |
Standard_Real | YPeriodFirst () const |
Returns the first parameter for the Y period. More... | |
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. More... | |
Standard_Boolean | IsInputZTrimmed () const |
Returns whether the input shape was already trimmed for Z period. More... | |
Standard_Real | ZPeriodFirst () const |
Returns the first parameter for the Z period. More... | |
Performing the operation | |
void | Perform () |
Makes the shape periodic in necessary directions. More... | |
Using the algorithm to repeat the shape | |
const TopoDS_Shape & | RepeatShape (const Standard_Integer theDirectionID, const Standard_Integer theTimes) |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
Starting the repetitions over | |
const TopoDS_Shape & | RepeatedShape () const |
Returns the repeated shape. More... | |
void | ClearRepetitions () |
Clears all performed repetitions. The next repetition will be performed on the base shape. More... | |
Obtaining the result shape | |
const TopoDS_Shape & | Shape () const |
Returns the resulting periodic shape. More... | |
Getting the identical shapes | |
const TopTools_ListOfShape & | GetTwins (const TopoDS_Shape &theS) const |
Returns the identical shapes for the given shape located on the opposite periodic side. Returns empty list in case the shape has no twin. More... | |
Getting the History of the algorithm | |
const Handle< BRepTools_History > & | History () const |
Returns the History of the algorithm. More... | |
Clearing the algorithm from previous runs | |
void | Clear () |
Clears the algorithm from previous runs. More... | |
Public Member Functions inherited from BOPAlgo_Options | |
BOPAlgo_Options () | |
Empty constructor. More... | |
BOPAlgo_Options (const Handle< NCollection_BaseAllocator > &theAllocator) | |
Constructor with allocator. More... | |
virtual | ~BOPAlgo_Options () |
Destructor. More... | |
const Handle< NCollection_BaseAllocator > & | Allocator () const |
Returns allocator. More... | |
void | AddError (const Handle< Message_Alert > &theAlert) |
Adds the alert as error (fail) More... | |
void | AddWarning (const Handle< Message_Alert > &theAlert) |
Adds the alert as warning. More... | |
Standard_Boolean | HasErrors () const |
Returns true if algorithm has failed. More... | |
Standard_Boolean | HasError (const Handle< Standard_Type > &theType) const |
Returns true if algorithm has generated error of specified type. More... | |
Standard_Boolean | HasWarnings () const |
Returns true if algorithm has generated some warning alerts. More... | |
Standard_Boolean | HasWarning (const Handle< Standard_Type > &theType) const |
Returns true if algorithm has generated warning of specified type. More... | |
const Handle< Message_Report > & | GetReport () const |
Returns report collecting all errors and warnings. More... | |
void | DumpErrors (Standard_OStream &theOS) const |
Dumps the error status into the given stream. More... | |
void | DumpWarnings (Standard_OStream &theOS) const |
Dumps the warning statuses into the given stream. More... | |
void | ClearWarnings () |
Clears the warnings of the algorithm. More... | |
void | SetFuzzyValue (const Standard_Real theFuzz) |
Sets the additional tolerance. More... | |
Standard_Real | FuzzyValue () const |
Returns the additional tolerance. More... | |
void | SetUseOBB (const Standard_Boolean theUseOBB) |
Enables/Disables the usage of OBB. More... | |
Standard_Boolean | UseOBB () const |
Returns the flag defining usage of OBB. More... | |
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. More... | |
Standard_Boolean | RunParallel () const |
Returns the flag of parallel processing. More... | |
Static Public Member Functions | |
Conversion of the integer to ID of periodic direction | |
static Standard_Integer | ToDirectionID (const Standard_Integer theDirectionID) |
Converts the integer to ID of periodic direction. More... | |
Static Public Member Functions inherited from BOPAlgo_Options | |
static Standard_Boolean | GetParallelMode () |
Gets the global parallel mode. More... | |
static void | SetParallelMode (const Standard_Boolean theNewMode) |
Sets the global parallel mode. More... | |
Protected Member Functions | |
Protected methods performing the operation | |
void | CheckData () |
Checks the validity of input data. More... | |
void | Trim () |
Trims the shape to fit to the periodic bounds. More... | |
void | MakeIdentical () |
Makes the shape identical on opposite sides. More... | |
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. More... | |
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. More... | |
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. More... | |
void | UpdateTwins (const BRepTools_History &theTranslationHistory, const BRepTools_History &theGluingHistory) |
Updates the map of twins after periodic shape repetition. More... | |
Protected Member Functions inherited from BOPAlgo_Options | |
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. More... | |
Protected Attributes | |
Fields | |
TopoDS_Shape | myInputShape |
Input shape to make periodic. More... | |
PeriodicityParams | myPeriodicityParams |
Periodicity parameters. More... | |
TopoDS_Shape | myShape |
Resulting periodic shape (base for repetitions) More... | |
TopoDS_Shape | myRepeatedShape |
Resulting shape after making repetitions of the base. More... | |
Standard_Real | myRepeatPeriod [3] |
XYZ repeat period. More... | |
TopTools_DataMapOfShapeListOfShape | myRepeatedTwins |
Map of associations of the identical sub-shapes after repetition of the periodic shape. More... | |
TopTools_DataMapOfShapeListOfShape | myTwins |
Map of associations of the identical sub-shapes located on the opposite sides of the shape. More... | |
Handle< BRepTools_History > | mySplitHistory |
Split history - history of shapes modification after the split for making the shape periodic. More... | |
Handle< BRepTools_History > | myHistory |
Final history of shapes modifications (to include the history of shape repetition) More... | |
Protected Attributes inherited from BOPAlgo_Options | |
Handle< NCollection_BaseAllocator > | myAllocator |
Enables/Disables the usage of OBB. More... | |
Handle< Message_Report > | myReport |
Enables/Disables the usage of OBB. More... | |
Standard_Boolean | myRunParallel |
Enables/Disables the usage of OBB. More... | |
Standard_Real | myFuzzyValue |
Enables/Disables the usage of OBB. More... | |
Standard_Boolean | myUseOBB |
Enables/Disables the usage of OBB. More... | |
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:
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:
Example of usage of the algorithm:
|
inline |
Empty constructor.
|
protected |
Checks the validity of input data.
|
inlinevirtual |
Clears the algorithm from previous runs.
Reimplemented from BOPAlgo_Options.
|
inline |
Clears all performed repetitions. The next repetition will be performed on the base shape.
|
inline |
Returns the identical shapes for the given shape located on the opposite periodic side. Returns empty list in case the shape has no twin.
theS | [in] Shape to get the twins for. |
|
inline |
Returns the History of the algorithm.
|
inline |
Returns whether the input shape was trimmed in the specified direction.
theDirectionID | [in] The direction's ID. |
|
inline |
Returns whether the input shape was already trimmed for X period.
|
inline |
Returns whether the input shape was already trimmed for Y period.
|
inline |
Returns whether the input shape was already trimmed for Z period.
|
inline |
Returns the info about Periodicity of the shape in specified direction.
theDirectionID | [in] The direction's ID. |
|
inline |
Returns the info about periodicity of the shape in X direction.
|
inline |
Returns the info about periodicity of the shape in Y direction.
|
inline |
Returns the info about periodicity of the shape in Z direction.
|
protected |
Makes the shape identical on opposite sides.
|
inline |
Sets the flag to make the shape periodic in specified direction:
theDirectionID | [in] The direction's ID; |
theIsPeriodic | [in] Flag defining periodicity in given direction; |
thePeriod | [in] Required period in given direction. |
|
inline |
Sets the flag to make the shape periodic in X direction.
theIsPeriodic | [in] Flag defining periodicity in X direction; |
thePeriod | [in] Required period in X direction. |
|
inline |
Sets the flag to make the shape periodic in Y direction.
theIsPeriodic | [in] Flag defining periodicity in Y direction; |
thePeriod | [in] Required period in Y direction. |
|
inline |
Sets the flag to make the shape periodic in Z direction.
theIsPeriodic | [in] Flag defining periodicity in Z direction; |
thePeriod | [in] Required period in Z direction. |
void BOPAlgo_MakePeriodic::Perform | ( | ) |
Makes the shape periodic in necessary directions.
|
inline |
Returns the Period of the shape in specified direction.
theDirectionID | [in] The direction's ID. |
|
inline |
Returns the first periodic parameter in the specified direction.
theDirectionID | [in] The direction's ID. |
|
inline |
Sets the periodicity parameters.
theParams | [in] Periodicity parameters |
|
inline |
Returns the repeated shape.
const TopoDS_Shape& BOPAlgo_MakePeriodic::RepeatShape | ( | const Standard_Integer | theDirectionID, |
const Standard_Integer | theTimes | ||
) |
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.
theDirectionID | [in] The direction's ID; |
theTimes | [in] Requested number of repetitions. |
|
inline |
Sets the periodicity parameters.
theParams | [in] Periodicity parameters |
|
inline |
Sets the shape to make it periodic.
theShape | [in] The shape to make periodic. |
|
inline |
Defines whether the input shape is already trimmed in specified direction to fit the period in this direction. Direction is defined by an ID:
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.
theDirectionID | [in] The direction's ID; |
theIsTrimmed | [in] The flag defining trimming of the shape in given direction; |
theFirst | [in] The first periodic parameter in the given direction. |
|
inline |
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.
theIsTrimmed | [in] Flag defining whether the shape is already trimmed in X direction to fit the X period; |
theFirst | [in] The first X periodic parameter. |
|
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.
theIsTrimmed | [in] Flag defining whether the shape is already trimmed in Y direction to fit the Y period; |
theFirst | [in] The first Y periodic parameter. |
|
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.
theIsTrimmed | [in] Flag defining whether the shape is already trimmed in Z direction to fit the Z period; |
theFirst | [in] The first Z periodic parameter. |
|
inline |
Returns the resulting periodic shape.
|
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.
|
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.
|
protected |
Splits the shape by the given tools, copying the geometry of coinciding parts from the given tools to the split shape.
theTools | [in] The tools to split the shape and take the geometry for coinciding parts. |
theSplitShapeHistory | [out] The history of shape split |
theSplitToolsHistory | [out] The history of tools modifications during the split |
|
inlinestatic |
Converts the integer to ID of periodic direction.
|
protected |
Trims the shape to fit to the periodic bounds.
|
protected |
Updates the map of twins after periodic shape repetition.
theTranslationHistory | [in] The history of translation of the periodic shape. |
theGluingHistory | [in] The history of gluing of the repeated shapes. |
|
inline |
Returns the XPeriod of the shape.
|
inline |
Returns the first parameter for the X period.
|
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.
theTimes | [in] Requested number of repetitions. |
|
inline |
Returns the YPeriod of the shape.
|
inline |
Returns the first parameter for the Y period.
|
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.
theTimes | [in] Requested number of repetitions. |
|
inline |
Returns the ZPeriod of the shape.
|
inline |
Returns the first parameter for the Z period.
|
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.
theTimes | [in] Requested number of repetitions. |
|
protected |
Final history of shapes modifications (to include the history of shape repetition)
|
protected |
Input shape to make periodic.
|
protected |
Periodicity parameters.
|
protected |
Resulting shape after making repetitions of the base.
|
protected |
Map of associations of the identical sub-shapes after repetition of the periodic shape.
|
protected |
XYZ repeat period.
|
protected |
Resulting periodic shape (base for repetitions)
|
protected |
Split history - history of shapes modification after the split for making the shape periodic.
|
protected |
Map of associations of the identical sub-shapes located on the opposite sides of the shape.