GMOperatorsInterfaces Interface CATICGMTopPattern
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICGMTopPattern
Class dedicated to pattern operations.
The pattern operation consists in creating multiple instances of an object
according to a transformation.
A pattern can be a:
- user pattern: the way the object is repeated is defined by a list of transformations
which is specified in the operator creation function.
- a rectangular pattern which is created by repeating an object along two directions.
- a circular pattern is created by repeating an object around an axis at various distances.
Whatever the pattern type, the list of tranformations is to be specified.
For rectangular and circular patterns, it is recommended to use the SetRectPattern<\tt>
and SetCirPattern<\tt> settings in addition to the list of transformations passed to the creation function.
This prevents the operator algorithm to launch useless computations. The performances are then enhanced.
The CATICGMTopPattern operator follows the global frame of topological operators and satisfies the smart mechanism:
the input bodies are not modified. A new resulting body is created,
possibly sharing data with the input body.
- A CATICGMTopPattern operator is created with the CATCGMCreateTopPattern global method:
It must be directly Released after use. It is not streamable.
- Options can be precised with the SetXxx methods, before
asking for the computation with the Run method
- The result is accessed with the GetResult method. If you do not want
to keep the resulting body, use the method to remove it from the geometric factory.
Method Index
- o
GetNumberOfInvalidTransformation(CATListOfInt&)
- Get the number of invalid transformation in case when partial result mode is active for pattern faces
This service is useful after "Run" only in case of "SetPartialResultAllowed".
- o
SetCirPattern(int,CATMathTransformation*,int,CATMathTransformation*)
- Defines a canonical circular pattern.
- o
SetPartialResultAllowed()
- Allows partial result in case of pattern faces mode.
- o
SetRectPattern(int,CATMathTransformation*,int,CATMathTransformation*)
- Defines a canonical rectangular pattern.
- o
SimplifyTool()
- Removes the internal faces between the body to be patterned and the support body.
Methods
o GetNumberOfInvalidTransformation
| public virtual GetNumberOfInvalidTransformation( | | oListTransfoStatus) |
-
Get the number of invalid transformation in case when partial result mode is active for pattern faces
This service is useful after "Run" only in case of "SetPartialResultAllowed".
If partial result situation detected , the service the numbers of invalid transformation.
- Parameters:
-
- oListTransfoStatus
- The list will be filled for a value for each transformation :
- CATPatternOKWithSewing : if instance OK ( made by sewing , specific case ).
- CATPatternOKWithDuplication : if instance OK ( made by model duplication , standard case ).
- CATPatternKO : if instance KO ( close to the body but in non isotopological / geometrical situation ).
- CATPatternKOAndFar : if instance KO ( totally out of the body bounding box ).
- CATPatternOKWithBoolean : if instance OK ( made by boolean , specific case for non isotopologicaul / geometrical situation in "FullResult" mode).
o SetCirPattern
| public virtual SetCirPattern( | | NumberOfRows, |
| | RowTransfo, |
| | NumberOfColumns, |
| | ColumnsTransfo) |
-
Defines a canonical circular pattern. This method is to be used
in addition to the list of transformations (better performances).
- Parameters:
-
- NumberOfRows
- The number of circular rows.
- RowTransfo
- The anguler transformation to be applied to the object to pattern in the circular rows. It must not be
set to NULL except if there is only one row.
- NumberOfColumns
- The number of columns. The columns are sets of instances located along the circle radii.
- ColumnsTransfo
- The radius transformation to be applied to the object to pattern. It must not be
set to NULL except if there is only one column.
o SetPartialResultAllowed
| public virtual SetPartialResultAllowed( | ) |
-
Allows partial result in case of pattern faces mode.
In this case the result body may contain only the result of some transformation because
transformation works only when faces can be sew in invariant geometric / topological mode.
Note : however , even in this mode , if all transformation failed , the operator will return an error.
o SetRectPattern
| public virtual SetRectPattern( | | NumberOfRows, |
| | RowTransfo, |
| | NumberOfColumns, |
| | ColumnsTransfo) |
-
Defines a canonical rectangular pattern. This method is to be used
in addition to the list of transformations (better performances).
- Parameters:
-
- NumberOfRows
- The number of rows.
- RowTransfo
- The transformation to be applied to the object to pattern in the rows. It must not be
set to NULL except if there is only one row.
- NumberOfColumns
- The number of columns.
- ColumnsTransfo
- The transformation to be applied to the object to pattern in the columns. It must not be
set to NULL except if there is only one column.
o SimplifyTool
| public virtual SimplifyTool( | ) |
-
Removes the internal faces between the body to be patterned and the support body. This operation
is performed prior to creating new instances.
This object is included in the file: CATICGMTopPattern.h
If needed, your Imakefile.mk should include the module: CATGMOperatorsInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.